Skip to content
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

Jump to bottom

Fix tooltip align & external types #8782

Merged
merged 1 commit into from Apr 2, 2021
Merged

Fix tooltip align & external types #8782

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 8 additions & 7 deletions types/index.esm.d.ts
View file
Open in desktop
Expand Up @@ -2208,15 +2208,16 @@ export interface TitleOptions {
text: string | string[];
}

export type TooltipAlignment = 'start' | 'center' | 'end';
export type TooltipXAlignment = 'left' | 'center' | 'right';
export type TooltipYAlignment = 'top' | 'center' | 'bottom';

export interface TooltipModel<TType extends ChartType> {
// The items that we are rendering in the tooltip. See Tooltip Item Interface section
dataPoints: TooltipItem<TType>[];

// Positioning
xAlign: TooltipAlignment;
yAlign: TooltipAlignment;
xAlign: TooltipXAlignment;
yAlign: TooltipYAlignment;

// X and Y properties are the top left of the tooltip
x: number;
Expand Down Expand Up @@ -2331,9 +2332,9 @@ export interface TooltipOptions<TType extends ChartType> extends CoreInteraction
*/
enabled: Scriptable<boolean, ScriptableTooltipContext<TType>>;
/**
* See custom tooltip section.
* See external tooltip section.
*/
custom(this: TooltipModel<TType>, args: { chart: Chart; tooltip: TooltipModel<TType> }): void;
external(this: TooltipModel<TType>, args: { chart: Chart; tooltip: TooltipModel<TType> }): void;
/**
* The mode for positioning the tooltip
*/
Expand All @@ -2342,8 +2343,8 @@ export interface TooltipOptions<TType extends ChartType> extends CoreInteraction
/**
* Override the tooltip alignment calculations
*/
xAlign: Scriptable<TooltipAlignment, ScriptableTooltipContext<TType>>;
yAlign: Scriptable<TooltipAlignment, ScriptableTooltipContext<TType>>;
xAlign: Scriptable<TooltipXAlignment, ScriptableTooltipContext<TType>>;
yAlign: Scriptable<TooltipYAlignment, ScriptableTooltipContext<TType>>;

/**
* Sort tooltip items.
Expand Down