Skip to content

fix(types): add axis properties to CallbackDataParams. close #17561 #21836

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Prakhar1Ojha wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(types): add axis properties to CallbackDataParams. close #17561 #21836

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 2 additions & 11 deletions src/component/tooltip/TooltipView.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import { bind, each, clone, trim, isString, isFunction, isArray, isObject, exten
import env from 'zrender/src/core/env';
import TooltipHTMLContent from './TooltipHTMLContent';
import TooltipRichContent from './TooltipRichContent';
import { convertToColorString, encodeHTML, formatTpl, TooltipMarker } from '../../util/format';
import { convertToColorString, encodeHTML, formatTpl } from '../../util/format';
import { parsePercent } from '../../util/number';
import { Rect } from '../../util/graphic';
import findPointFromSeries from '../axisPointer/findPointFromSeries';
Expand Down Expand Up @@ -124,16 +124,7 @@ interface TryShowParams {
positionDefault?: TooltipOption['position']
}

type TooltipCallbackDataParams = CallbackDataParams & {
axisDim?: string
axisIndex?: number
axisType?: string
axisId?: string
// TODO: TYPE Value type
axisValue?: string | number
axisValueLabel?: string
marker?: TooltipMarker
};
type TooltipCallbackDataParams = CallbackDataParams;

class TooltipView extends ComponentView {
static type = 'tooltip' as const;
Expand Down
8 changes: 8 additions & 0 deletions src/util/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -980,6 +980,14 @@ export interface CallbackDataParams {
dimensionIndex?: number;
percent?: number; // Only for chart like 'pie'

// Axis context properties (provided in axis callbacks or axis-triggered tooltips)
axisDim?: string;
axisIndex?: number;
axisType?: string;
axisId?: string;
axisValue?: string | number;
axisValueLabel?: string;

// Param name list for mapping `a`, `b`, `c`, `d`, `e`
$vars: string[];
}
Expand Down
64 changes: 64 additions & 0 deletions test/ut/spec/util/types.test.ts
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.