Generate d.ts #835

kingyue737 · 2025-05-26T10:03:45Z

Output Preview

import * as echarts_core from 'echarts/core';
import { init, SetOptionOpts } from 'echarts/core';
import * as vue from 'vue';
import { Ref, ShallowRef, WritableComputedRef, ComputedRef, InjectionKey, PropType } from 'vue';

type MaybeRef<T = any> = T | Ref<T> | ShallowRef<T> | WritableComputedRef<T>;
type MaybeRefOrGetter<T = any> = MaybeRef<T> | ComputedRef<T> | (() => T);
type Injection<T> = MaybeRefOrGetter<T | null>;
type InitType = typeof init;
type InitParameters = Parameters<InitType>;
type Theme = NonNullable<InitParameters[1]>;
type ThemeInjection = Injection<Theme>;
type InitOptions = NonNullable<InitParameters[2]>;
type InitOptionsInjection = Injection<InitOptions>;
type UpdateOptions = SetOptionOpts;
type UpdateOptionsInjection = Injection<UpdateOptions>;
type EChartsType = ReturnType<InitType>;
type SetOptionType = EChartsType["setOption"];
type Option = Parameters<SetOptionType>[0];
type AutoResize = boolean | {
    throttle?: number;
    onResize?: () => void;
};
type LoadingOptions = {
    text?: string;
    textColor?: string;
    fontSize?: number | string;
    fontWeight?: number | string;
    fontStyle?: string;
    fontFamily?: string;
    maskColor?: string;
    showSpinner?: boolean;
    color?: string;
    spinnerRadius?: number;
    lineWidth?: number;
    zlevel?: number;
};
type LoadingOptionsInjection = Injection<LoadingOptions>;

interface EChartsElement extends HTMLElement {
    __dispose: (() => void) | null;
}

declare const LOADING_OPTIONS_KEY: InjectionKey<LoadingOptionsInjection>;

declare const THEME_KEY: InjectionKey<ThemeInjection>;
declare const INIT_OPTIONS_KEY: InjectionKey<InitOptionsInjection>;
declare const UPDATE_OPTIONS_KEY: InjectionKey<UpdateOptionsInjection>;

declare const _default: vue.DefineComponent<vue.ExtractPropTypes<{
    loading: BooleanConstructor;
    loadingOptions: PropType<LoadingOptions>;
    autoresize: PropType<AutoResize>;
    option: PropType<Option>;
    theme: {
        type: PropType<Theme>;
    };
    initOptions: PropType<InitOptions>;
    updateOptions: PropType<UpdateOptions>;
    group: StringConstructor;
    manualUpdate: BooleanConstructor;
}>, {
    getWidth: () => number;
    getHeight: () => number;
    getDom: () => HTMLElement;
    getOption: () => echarts_core.EChartsCoreOption;
    resize: (opts?: echarts_core.ResizeOpts) => void;
    dispatchAction: (payload: echarts_core.Payload, opt?: boolean | {
        silent?: boolean;
        flush?: boolean | undefined;
    }) => void;
    convertToPixel: {
        (finder: string | {
            seriesIndex?: number | false | number[] | "all" | "none";
            seriesId?: (string | number) | (string | number)[];
            seriesName?: (string | number) | (string | number)[];
            geoIndex?: number | false | number[] | "all" | "none";
            geoId?: (string | number) | (string | number)[];
            geoName?: (string | number) | (string | number)[];
            bmapIndex?: number | false | number[] | "all" | "none";
            bmapId?: (string | number) | (string | number)[];
            bmapName?: (string | number) | (string | number)[];
            xAxisIndex?: number | false | number[] | "all" | "none";
            xAxisId?: (string | number) | (string | number)[];
            xAxisName?: (string | number) | (string | number)[];
            yAxisIndex?: number | false | number[] | "all" | "none";
            yAxisId?: (string | number) | (string | number)[];
            yAxisName?: (string | number) | (string | number)[];
            gridIndex?: number | false | number[] | "all" | "none";
            gridId?: (string | number) | (string | number)[];
            gridName?: (string | number) | (string | number)[];
            dataIndex?: number;
            dataIndexInside?: number;
        }, value: Date | (string | number)): number;
        (finder: string | {
            seriesIndex?: number | false | number[] | "all" | "none";
            seriesId?: (string | number) | (string | number)[];
            seriesName?: (string | number) | (string | number)[];
            geoIndex?: number | false | number[] | "all" | "none";
            geoId?: (string | number) | (string | number)[];
            geoName?: (string | number) | (string | number)[];
            bmapIndex?: number | false | number[] | "all" | "none";
            bmapId?: (string | number) | (string | number)[];
            bmapName?: (string | number) | (string | number)[];
            xAxisIndex?: number | false | number[] | "all" | "none";
            xAxisId?: (string | number) | (string | number)[];
            xAxisName?: (string | number) | (string | number)[];
            yAxisIndex?: number | false | number[] | "all" | "none";
            yAxisId?: (string | number) | (string | number)[];
            yAxisName?: (string | number) | (string | number)[];
            gridIndex?: number | false | number[] | "all" | "none";
            gridId?: (string | number) | (string | number)[];
            gridName?: (string | number) | (string | number)[];
            dataIndex?: number;
            dataIndexInside?: number;
        }, value: (Date | (string | number))[]): number[];
    };
    convertFromPixel: {
        (finder: string | {
            seriesIndex?: number | false | number[] | "all" | "none";
            seriesId?: (string | number) | (string | number)[];
            seriesName?: (string | number) | (string | number)[];
            geoIndex?: number | false | number[] | "all" | "none";
            geoId?: (string | number) | (string | number)[];
            geoName?: (string | number) | (string | number)[];
            bmapIndex?: number | false | number[] | "all" | "none";
            bmapId?: (string | number) | (string | number)[];
            bmapName?: (string | number) | (string | number)[];
            xAxisIndex?: number | false | number[] | "all" | "none";
            xAxisId?: (string | number) | (string | number)[];
            xAxisName?: (string | number) | (string | number)[];
            yAxisIndex?: number | false | number[] | "all" | "none";
            yAxisId?: (string | number) | (string | number)[];
            yAxisName?: (string | number) | (string | number)[];
            gridIndex?: number | false | number[] | "all" | "none";
            gridId?: (string | number) | (string | number)[];
            gridName?: (string | number) | (string | number)[];
            dataIndex?: number;
            dataIndexInside?: number;
        }, value: number): number;
        (finder: string | {
            seriesIndex?: number | false | number[] | "all" | "none";
            seriesId?: (string | number) | (string | number)[];
            seriesName?: (string | number) | (string | number)[];
            geoIndex?: number | false | number[] | "all" | "none";
            geoId?: (string | number) | (string | number)[];
            geoName?: (string | number) | (string | number)[];
            bmapIndex?: number | false | number[] | "all" | "none";
            bmapId?: (string | number) | (string | number)[];
            bmapName?: (string | number) | (string | number)[];
            xAxisIndex?: number | false | number[] | "all" | "none";
            xAxisId?: (string | number) | (string | number)[];
            xAxisName?: (string | number) | (string | number)[];
            yAxisIndex?: number | false | number[] | "all" | "none";
            yAxisId?: (string | number) | (string | number)[];
            yAxisName?: (string | number) | (string | number)[];
            gridIndex?: number | false | number[] | "all" | "none";
            gridId?: (string | number) | (string | number)[];
            gridName?: (string | number) | (string | number)[];
            dataIndex?: number;
            dataIndexInside?: number;
        }, value: number[]): number[];
    };
    containPixel: (finder: string | {
        seriesIndex?: number | false | number[] | "all" | "none";
        seriesId?: (string | number) | (string | number)[];
        seriesName?: (string | number) | (string | number)[];
        geoIndex?: number | false | number[] | "all" | "none";
        geoId?: (string | number) | (string | number)[];
        geoName?: (string | number) | (string | number)[];
        bmapIndex?: number | false | number[] | "all" | "none";
        bmapId?: (string | number) | (string | number)[];
        bmapName?: (string | number) | (string | number)[];
        xAxisIndex?: number | false | number[] | "all" | "none";
        xAxisId?: (string | number) | (string | number)[];
        xAxisName?: (string | number) | (string | number)[];
        yAxisIndex?: number | false | number[] | "all" | "none";
        yAxisId?: (string | number) | (string | number)[];
        yAxisName?: (string | number) | (string | number)[];
        gridIndex?: number | false | number[] | "all" | "none";
        gridId?: (string | number) | (string | number)[];
        gridName?: (string | number) | (string | number)[];
        dataIndex?: number;
        dataIndexInside?: number;
    }, value: number[]) => boolean;
    getDataURL: (opts?: {
        type?: "png" | "jpeg" | "svg";
        pixelRatio?: number;
        backgroundColor?: echarts_core.Color;
        excludeComponents?: string[];
    }) => string;
    getConnectedDataURL: (opts?: {
        type?: "png" | "jpeg" | "svg";
        pixelRatio?: number;
        backgroundColor?: echarts_core.Color;
        connectedBackgroundColor?: echarts_core.Color;
        excludeComponents?: string[];
    }) => string;
    appendData: (params: {
        seriesIndex: number;
        data: any;
    }) => void;
    clear: () => void;
    isDisposed: () => boolean;
    dispose: () => void;
    chart: vue.ShallowRef<echarts_core.ECharts | undefined, echarts_core.ECharts | undefined>;
    root: vue.ShallowRef<EChartsElement | undefined, EChartsElement | undefined>;
    setOption: (option: Option, updateOptions?: UpdateOptions) => void;
    nonEventAttrs: vue.ComputedRef<{
        [x: string]: any;
    }>;
    nativeListeners: Record<string, unknown>;
}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
    click: (params: echarts_core.ECElementEvent) => void;
    dblclick: (params: echarts_core.ECElementEvent) => void;
    mouseout: (params: echarts_core.ECElementEvent) => void;
    mouseover: (params: echarts_core.ECElementEvent) => void;
    mouseup: (params: echarts_core.ECElementEvent) => void;
    mousedown: (params: echarts_core.ECElementEvent) => void;
    mousemove: (params: echarts_core.ECElementEvent) => void;
    contextmenu: (params: echarts_core.ECElementEvent) => void;
    globalout: (params: echarts_core.ECElementEvent) => void;
} & {
    highlight: (params: any) => void;
    downplay: (params: any) => void;
    selectchanged: (params: any) => void;
    legendselectchanged: (params: any) => void;
    legendselected: (params: any) => void;
    legendunselected: (params: any) => void;
    legendselectall: (params: any) => void;
    legendinverseselect: (params: any) => void;
    legendscroll: (params: any) => void;
    datazoom: (params: any) => void;
    datarangeselected: (params: any) => void;
    graphroam: (params: any) => void;
    georoam: (params: any) => void;
    treeroam: (params: any) => void;
    timelinechanged: (params: any) => void;
    timelineplaychanged: (params: any) => void;
    restore: (params: any) => void;
    dataviewchanged: (params: any) => void;
    magictypechanged: (params: any) => void;
    geoselectchanged: (params: any) => void;
    geoselected: (params: any) => void;
    geounselected: (params: any) => void;
    axisareaselected: (params: any) => void;
    brush: (params: any) => void;
    brushEnd: (params: any) => void;
    brushselected: (params: any) => void;
    globalcursortaken: (params: any) => void;
} & {
    rendered: (params: {
        elapsedTime: number;
    }) => void;
    finished: () => void;
} & {
    "zr:mousewheel": (params: echarts_core.ElementEvent) => void;
    "zr:drag": (params: echarts_core.ElementEvent) => void;
    "zr:dragstart": (params: echarts_core.ElementEvent) => void;
    "zr:dragend": (params: echarts_core.ElementEvent) => void;
    "zr:dragenter": (params: echarts_core.ElementEvent) => void;
    "zr:dragleave": (params: echarts_core.ElementEvent) => void;
    "zr:dragover": (params: echarts_core.ElementEvent) => void;
    "zr:drop": (params: echarts_core.ElementEvent) => void;
    "zr:click": (params: echarts_core.ElementEvent) => void;
    "zr:dblclick": (params: echarts_core.ElementEvent) => void;
    "zr:mouseout": (params: echarts_core.ElementEvent) => void;
    "zr:mouseover": (params: echarts_core.ElementEvent) => void;
    "zr:mouseup": (params: echarts_core.ElementEvent) => void;
    "zr:mousedown": (params: echarts_core.ElementEvent) => void;
    "zr:mousemove": (params: echarts_core.ElementEvent) => void;
    "zr:contextmenu": (params: echarts_core.ElementEvent) => void;
    "zr:globalout": (params: echarts_core.ElementEvent) => void;
}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
    loading: BooleanConstructor;
    loadingOptions: PropType<LoadingOptions>;
    autoresize: PropType<AutoResize>;
    option: PropType<Option>;
    theme: {
        type: PropType<Theme>;
    };
    initOptions: PropType<InitOptions>;
    updateOptions: PropType<UpdateOptions>;
    group: StringConstructor;
    manualUpdate: BooleanConstructor;
}>> & Readonly<{
    onClick?: ((params: echarts_core.ECElementEvent) => any) | undefined;
    onDblclick?: ((params: echarts_core.ECElementEvent) => any) | undefined;
    onMouseout?: ((params: echarts_core.ECElementEvent) => any) | undefined;
    onMouseover?: ((params: echarts_core.ECElementEvent) => any) | undefined;
    onMouseup?: ((params: echarts_core.ECElementEvent) => any) | undefined;
    onMousedown?: ((params: echarts_core.ECElementEvent) => any) | undefined;
    onMousemove?: ((params: echarts_core.ECElementEvent) => any) | undefined;
    onContextmenu?: ((params: echarts_core.ECElementEvent) => any) | undefined;
    onGlobalout?: ((params: echarts_core.ECElementEvent) => any) | undefined;
    onHighlight?: ((params: any) => any) | undefined;
    onDownplay?: ((params: any) => any) | undefined;
    onSelectchanged?: ((params: any) => any) | undefined;
    onLegendselectchanged?: ((params: any) => any) | undefined;
    onLegendselected?: ((params: any) => any) | undefined;
    onLegendunselected?: ((params: any) => any) | undefined;
    onLegendselectall?: ((params: any) => any) | undefined;
    onLegendinverseselect?: ((params: any) => any) | undefined;
    onLegendscroll?: ((params: any) => any) | undefined;
    onDatazoom?: ((params: any) => any) | undefined;
    onDatarangeselected?: ((params: any) => any) | undefined;
    onGraphroam?: ((params: any) => any) | undefined;
    onGeoroam?: ((params: any) => any) | undefined;
    onTreeroam?: ((params: any) => any) | undefined;
    onTimelinechanged?: ((params: any) => any) | undefined;
    onTimelineplaychanged?: ((params: any) => any) | undefined;
    onRestore?: ((params: any) => any) | undefined;
    onDataviewchanged?: ((params: any) => any) | undefined;
    onMagictypechanged?: ((params: any) => any) | undefined;
    onGeoselectchanged?: ((params: any) => any) | undefined;
    onGeoselected?: ((params: any) => any) | undefined;
    onGeounselected?: ((params: any) => any) | undefined;
    onAxisareaselected?: ((params: any) => any) | undefined;
    onBrush?: ((params: any) => any) | undefined;
    onBrushEnd?: ((params: any) => any) | undefined;
    onBrushselected?: ((params: any) => any) | undefined;
    onGlobalcursortaken?: ((params: any) => any) | undefined;
    "onZr:mousewheel"?: ((params: echarts_core.ElementEvent) => any) | undefined;
    "onZr:drag"?: ((params: echarts_core.ElementEvent) => any) | undefined;
    "onZr:dragstart"?: ((params: echarts_core.ElementEvent) => any) | undefined;
    "onZr:dragend"?: ((params: echarts_core.ElementEvent) => any) | undefined;
    "onZr:dragenter"?: ((params: echarts_core.ElementEvent) => any) | undefined;
    "onZr:dragleave"?: ((params: echarts_core.ElementEvent) => any) | undefined;
    "onZr:dragover"?: ((params: echarts_core.ElementEvent) => any) | undefined;
    "onZr:drop"?: ((params: echarts_core.ElementEvent) => any) | undefined;
    "onZr:click"?: ((params: echarts_core.ElementEvent) => any) | undefined;
    "onZr:dblclick"?: ((params: echarts_core.ElementEvent) => any) | undefined;
    "onZr:mouseout"?: ((params: echarts_core.ElementEvent) => any) | undefined;
    "onZr:mouseover"?: ((params: echarts_core.ElementEvent) => any) | undefined;
    "onZr:mouseup"?: ((params: echarts_core.ElementEvent) => any) | undefined;
    "onZr:mousedown"?: ((params: echarts_core.ElementEvent) => any) | undefined;
    "onZr:mousemove"?: ((params: echarts_core.ElementEvent) => any) | undefined;
    "onZr:contextmenu"?: ((params: echarts_core.ElementEvent) => any) | undefined;
    "onZr:globalout"?: ((params: echarts_core.ElementEvent) => any) | undefined;
    onRendered?: ((params: {
        elapsedTime: number;
    }) => any) | undefined;
    onFinished?: (() => any) | undefined;
}>, {
    manualUpdate: boolean;
    loading: boolean;
}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;

export { INIT_OPTIONS_KEY, LOADING_OPTIONS_KEY, THEME_KEY, UPDATE_OPTIONS_KEY, _default as default };

vercel · 2025-05-26T10:03:50Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
vue-echarts	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 1, 2025 3:34am

src/ECharts.ts

src/composables/loading.ts

Justineo

👍

build: generate d.ts

729c454

kingyue737 force-pushed the remove-dts branch from 03dcdbb to 729c454 Compare May 26, 2025 10:05

vercel bot deployed to Preview May 26, 2025 10:05 View deployment

fix: preserve PublicMethods

68c6ee9

vercel bot deployed to Preview May 27, 2025 06:45 View deployment

kingyue737 commented May 27, 2025

View reviewed changes

src/ECharts.ts Outdated Show resolved Hide resolved

fix: avoid exposing types of attrs

40c6bdb

vercel bot deployed to Preview May 27, 2025 12:38 View deployment

kingyue737 commented May 27, 2025

View reviewed changes

src/ECharts.ts Outdated Show resolved Hide resolved

kingyue737 commented May 27, 2025

View reviewed changes

src/ECharts.ts Outdated Show resolved Hide resolved

kingyue737 commented May 27, 2025

View reviewed changes

src/ECharts.ts Outdated Show resolved Hide resolved

refactor: use existing setoption type

c6801ef

vercel bot deployed to Preview May 28, 2025 10:56 View deployment

fix: expose root and chart

958229e

vercel bot deployed to Preview May 28, 2025 12:07 View deployment

Justineo reviewed May 31, 2025

View reviewed changes

src/ECharts.ts Show resolved Hide resolved

src/composables/loading.ts Outdated Show resolved Hide resolved

kingyue737 added 2 commits June 1, 2025 10:48

feat: use symbol as injection key

19bc344

chore: add comment for the type casting of the exposed

d1545bb

vercel bot deployed to Preview June 1, 2025 03:34 View deployment

Justineo approved these changes Jun 1, 2025

View reviewed changes

Justineo merged commit f7ed1e1 into 8.0 Jun 1, 2025
4 checks passed

kingyue737 deleted the remove-dts branch June 1, 2025 06:08

kingyue737 mentioned this pull request Jul 24, 2025

v8.0 #846

Open

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Generate d.ts #835

Generate d.ts #835

Uh oh!

kingyue737 commented May 26, 2025

Uh oh!

vercel bot commented May 26, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Justineo left a comment

Uh oh!

Uh oh!

Uh oh!

Generate d.ts #835

Generate d.ts #835

Uh oh!

Conversation

kingyue737 commented May 26, 2025

Uh oh!

vercel bot commented May 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Justineo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

vercel bot commented May 26, 2025 •

edited

Loading