akaba-e-chart-tool v1.0.22

Akaba-E-Chart-Tool

目的(Intention)

书写框架的时候，经常需要预置一些基本样式，故而写了这个库。
Output an instance with a preset of EChart options;

ts主要类型声明(Typescript Declaration)

import { EChartOption } from "echarts";
import TDefaultSeriesMap = NSEChartOptionMixer.TDefaultSeriesMap;
export declare namespace NSEChartOptionMixer {
    interface IDefaultDict {
        optionTpl: Omit<EChartOption, "xAxis" | "yAxis">;
        axisTpl: EChartOption.SingleAxis;
        yAxisTpl: EChartOption.YAxis;
        xAxisTpl: EChartOption.XAxis;
    }
    type TDefaultDictAttr = keyof IDefaultDict;
    type TDefaultDictVal = IDefaultDict[TDefaultDictAttr];
    type DefaultDictMap = Map<TDefaultDictAttr, TDefaultDictVal>;
    interface IDefaultSeriesDict {
        [seriesType: string]: EChartOption.Series;
    }
    type TDefaultSeriesDictType = keyof IDefaultSeriesDict;
    type TDefaultSeriesDictVal = IDefaultSeriesDict[keyof IDefaultSeriesDict];
    type TDefaultSeriesMap = Map<TDefaultSeriesDictType, TDefaultSeriesDictVal>;
}
export declare class EChartOptionMixer {
    readonly defaultDictMap: NSEChartOptionMixer.DefaultDictMap;
    readonly defaultSeriesMap: TDefaultSeriesMap;
    defaultSeriesType: string;
    constructor();

    // 预设option的值。
    // 注意: 这里的option不能含有xAxis,yAxis属性
    setDefaultOptionTpl(val: NSEChartOptionMixer.IDefaultDict["optionTpl"], mixedNew?: boolean): this;

    // 预设xAxis,yAxis共用的option
    setDefaultAxisTpl(val: NSEChartOptionMixer.IDefaultDict["axisTpl"], mixedNew?: boolean): this;

    setDefaultXAxisTpl(val: NSEChartOptionMixer.IDefaultDict["xAxisTpl"], mixedNew?: boolean): this;

    setDefaultYAxisTpl(val: NSEChartOptionMixer.IDefaultDict["yAxisTpl"], mixedNew?: boolean): this;

    setDefaultTpl(attr: NSEChartOptionMixer.TDefaultDictAttr, val: NSEChartOptionMixer.TDefaultDictVal, mixedNew?: boolean): this;

    setDefaultSeriesTpl(seriesType: NSEChartOptionMixer.TDefaultSeriesDictType, seriesVal: NSEChartOptionMixer.TDefaultSeriesDictVal, mixedNew?: boolean): this;
    mixedXAxisOf(copyOption: EChartOption): this;
    mixedYAxisOf(copyOption: EChartOption): this;
    mixedSeries(copyOption: EChartOption): this;
    getMixedSeries(seriesType: string, seriesOption: EChartOption.Series): EChartOption.Series;
    // main function 主方法
    // 传入当前EChart实例的option， 返回混入预设值的option
    mixedOption(option: EChartOption): EChartOption;
    getDefaultOptionTpl(option?: EChartOption): EChartOption;
    getDefaultAxis(axisOption?: EChartOption.SingleAxis): EChartOption.SingleAxis;
    getDefaultXAxis(xAxisOption?: EChartOption.XAxis): EChartOption.XAxis;
    getDefaultYAxis(yAxisOption?: EChartOption.YAxis): EChartOption.YAxis;
    getOriginDataRangeFromOption(option: EChartOption, axisIndexName?: "xAxisIndex" | "yAxisIndex"): Array<{
        min: number;
        max: number;
    }>;
}