javascript/vueecharts
1
0
Fork 0
mirror of https://github.com/ecomfe/vue-echarts.git synced 2025-10-28 23:48:21 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: improve typings for mouse events

Browse Source
This commit is contained in:
Justineo
2023-01-01 23:51:43 +08:00
parent 0a4601bc1a
commit 58e7b13652
3 changed files with 29 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
src/types.ts
View File

@ -20,7 +20,7 @@ export type EventTarget = EChartsType | ZRenderType;
type SetOptionType = EChartsType["setOption"];
export type Option = Parameters<SetOptionType>[0];
type EChartsEventName =
type EChartsMouseEventName =
| "click"
| "dblclick"
| "mousedown"
@ -29,7 +29,8 @@ type EChartsEventName =
| "mouseover"
| "mouseout"
| "globalout"
| "contextmenu"
| "contextmenu";
type EChartsOtherEventName =
| "highlight"
| "downplay"
| "selectchanged"
@ -77,7 +78,25 @@ type ZRenderEventName =
| "dragover"
| "drop"
| "globalout";
type EventName = EChartsEventName | `zr:${ZRenderEventName}`;
export type Emits = {
[key in EventName]: null;
type OtherEventName = EChartsOtherEventName | `zr:${ZRenderEventName}`;
// See https://echarts.apache.org/en/api.html#events.Mouse%20events
interface MouseEventParams {
componentType: string;
seriesType: string;
seriesIndex: number;
seriesName: string;
name: string;
dataIndex: number;
color: string;
}
type MouseEmits = {
[k in EChartsMouseEventName]: (params: MouseEventParams) => boolean;
};
type OtherEmits = {
[key in OtherEventName]: null;
};
export type Emits = MouseEmits & OtherEmits;