stz-chart-maker Documentation - v2.3.7
    Preparing search index...

    Interface ChartBuilder<TType>

    interface ChartBuilder<TType extends ChartType> {
        build(id?: string): ChartConfig;
        clearData(datasetUidOrIndex?: string | number): this;
        clone(): this;
        copy(): this;
        getChartData(uid: string): CustomChartDatasets<TType>;
        hasPlugin(pluginId: string): boolean;
        makeConfig(id?: string): ChartConfig;
        mergeOptions(options: DeepPartial<CustomChartOptions<TType>>): this;
        onResize(
            callback: (
                chart: Chart<any>,
                size: { height: number; width: number },
            ) => void,
        ): this;
        removeData(
            datasetUidOrIndex: string | number,
            dataUidOrIndex?: string | number,
        ): this;
        removeDataset(uidOrIndex: string | number): this;
        removePlugin(pluginId: string): this;
        setAllDatasetStyle(style: DeepPartial<CustomChartDatasets<TType>>): this;
        setChartData(uid: string, data: CustomChartDatasets<TType>): void;
        setDatasetGroup(uidOrIndex: string | number, group: string | number): this;
        setDatasetStyle(
            uidOrIndex: string | number,
            style: DeepPartial<CustomChartDatasets<TType>>,
        ): this;
        setDatasetVisible(
            uidOrIndex: string | number,
            visible: boolean,
            syncGroup?: boolean,
        ): this;
        setLegend(legendOptions: DeepPartial<LegendOptions<any>>): this;
        setPlugin(plugins: any): this;
        setSpinnerOverlay(spinnerOverlay: SpinnerOverlayOption): this;
        setTitle(titleOptions: CommonCartesianTitleConfig): this;
        setTooltip(tooltipOptions: DeepPartial<TooltipOptions<any>>): this;
        toggleDataset(uidOrIndex: string | number, syncGroup?: boolean): this;
    }

    Type Parameters

    • TType extends ChartType

    Hierarchy (View Summary)

    Implemented by

    Index

    Methods

    • Parameters

      • Optionalid: string

      Returns ChartConfig

    • Parameters

      • OptionaldatasetUidOrIndex: string | number

      Returns this

    • Returns this

    • Returns this

    • Parameters

      • pluginId: string

      Returns boolean

    • Parameters

      • Optionalid: string

      Returns ChartConfig

    • Parameters

      • callback: (chart: Chart<any>, size: { height: number; width: number }) => void

      Returns this

    • Parameters

      • datasetUidOrIndex: string | number
      • OptionaldataUidOrIndex: string | number

      Returns this

    • Parameters

      • uidOrIndex: string | number

      Returns this

    • Parameters

      • pluginId: string

      Returns this

    • Parameters

      • uidOrIndex: string | number
      • group: string | number

      Returns this

    • Parameters

      • uidOrIndex: string | number
      • visible: boolean
      • OptionalsyncGroup: boolean

      Returns this

    • Parameters

      Returns this

    • Parameters

      • plugins: any

      Returns this

    • Parameters

      Returns this

    • Parameters

      • uidOrIndex: string | number
      • OptionalsyncGroup: boolean

      Returns this