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.

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

Improve LegendElement and TooltipItem type definitions #9376

Merged
merged 3 commits into from Jul 9, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 15 additions & 10 deletions types/index.esm.d.ts
Expand Up @@ -2120,9 +2120,14 @@ export interface LegendItem {
textAlign?: TextAlign;
}

export interface LegendElement extends Element, LayoutItem {}
export interface LegendElement<TType extends ChartType> extends Element, LayoutItem {
chart: Chart<TType>;
ctx: CanvasRenderingContext2D;
legendItems?: LegendItem[];
options: LegendOptions<TType>;
}

export interface LegendOptions {
export interface LegendOptions<TType extends ChartType> {
/**
* Is the legend shown?
* @default true
Expand Down Expand Up @@ -2159,15 +2164,15 @@ export interface LegendOptions {
/**
* A callback that is called when a click event is registered on a label item.
*/
onClick(this: LegendElement, e: ChartEvent, legendItem: LegendItem, legend: LegendElement): void;
onClick(this: LegendElement<TType>, e: ChartEvent, legendItem: LegendItem, legend: LegendElement<TType>): void;
/**
* A callback that is called when a 'mousemove' event is registered on top of a label item
*/
onHover(this: LegendElement, e: ChartEvent, legendItem: LegendItem, legend: LegendElement): void;
onHover(this: LegendElement<TType>, e: ChartEvent, legendItem: LegendItem, legend: LegendElement<TType>): void;
/**
* A callback that is called when a 'mousemove' event is registered outside of a previously hovered label item.
*/
onLeave(this: LegendElement, e: ChartEvent, legendItem: LegendItem, legend: LegendElement): void;
onLeave(this: LegendElement<TType>, e: ChartEvent, legendItem: LegendItem, legend: LegendElement<TType>): void;

labels: {
/**
Expand Down Expand Up @@ -2445,7 +2450,7 @@ export interface ScriptableTooltipContext<TType extends ChartType> {
tooltipItems: TooltipItem<TType>[];
}

export interface TooltipOptions<TType extends ChartType> extends CoreInteractionOptions {
export interface TooltipOptions<TType extends ChartType = ChartType> extends CoreInteractionOptions {
/**
* Are on-canvas tooltips enabled?
* @default true
Expand All @@ -2469,9 +2474,9 @@ export interface TooltipOptions<TType extends ChartType> extends CoreInteraction
/**
* Sort tooltip items.
*/
itemSort: (a: TooltipItem<ChartType>, b: TooltipItem<ChartType>, data: ChartData) => number;
itemSort: (a: TooltipItem<TType>, b: TooltipItem<TType>, data: ChartData) => number;

filter: (e: TooltipItem<ChartType>, index: number, array: TooltipItem<ChartType>[], data: ChartData) => boolean;
filter: (e: TooltipItem<TType>, index: number, array: TooltipItem<TType>[], data: ChartData) => boolean;

/**
* Background color of the tooltip.
Expand Down Expand Up @@ -2648,7 +2653,7 @@ export interface TooltipItem<TType extends ChartType> {
/**
* The dataset the item comes from
*/
dataset: ChartDataset;
dataset: UnionToIntersection<ChartDataset<TType>>;

/**
* Index of the dataset the item comes from
Expand All @@ -2669,7 +2674,7 @@ export interface TooltipItem<TType extends ChartType> {
export interface PluginOptionsByType<TType extends ChartType> {
decimation: DecimationOptions;
filler: FillerOptions;
legend: LegendOptions;
legend: LegendOptions<TType>;
title: TitleOptions;
tooltip: TooltipOptions<TType>;
}
Expand Down
22 changes: 22 additions & 0 deletions types/tests/plugins/plugin.tooltip/tooltip_dataset_type.ts
@@ -0,0 +1,22 @@
import { Chart } from '../../../index.esm';

const chart = new Chart('id', {
type: 'line',
data: {
labels: [],
datasets: [{
data: []
}]
},
options: {
plugins: {
tooltip: {
callbacks: {
label: (item) => {
return `Y Axis ${item.dataset.yAxisID}`;
}
}
}
}
},
});