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

    Interface CartesianChartBuilder<TType>

    interface CartesianChartBuilder<TType extends CartesianChartType> {
        addDataLabels(
            defultDataLabels?: boolean,
            dataLabelsOptions?: Partial<DataLabels>,
        ): this;
        addZoom(
            defaultZoom?: boolean,
            zoomOption?: DeepPartial<CustomZoomType>,
        ): this;
        build(id?: string): ChartConfig;
        clearData(datasetUidOrIndex?: string | number): this;
        clone(): this;
        copy(): this;
        customLegend(obj: HtmlLegendOptions): 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;
        setAllDatasetsParsing(
            xAxisKey: string | false,
            yAxisKey: string | false,
        ): this;
        setAllDatasetStyle(style: DeepPartial<CustomChartDatasets<TType>>): this;
        setAxisPosition(axis: string, position: "left" | "right"): this;
        setAxisRange(axis: "x" | "y", min?: number, max?: number): this;
        setAxisTitle(
            axis: "x" | "y",
            titleConfig: CommonCartesianTitleConfig,
        ): this;
        setBackgroundAlpha(alpha: number): this;
        setBackgroundColor(color: Color): this;
        setChartData(uid: string, data: CustomChartDatasets<TType>): void;
        setDatasetGroup(uidOrIndex: string | number, group: string | number): this;
        setDatasetParsing(
            datasetIndex: number,
            xAxisKey: string | false,
            yAxisKey: string | false,
        ): this;
        setDatasetStyle(
            uidOrIndex: string | number,
            style: DeepPartial<CustomChartDatasets<TType>>,
        ): this;
        setDatasetVisible(
            uidOrIndex: string | number,
            visible: boolean,
            syncGroup?: boolean,
        ): this;
        setGrid(axis: string, gridOptions: GridLineOptions): this;
        setGridOptions(
            axis: "x" | "y",
            gridOptions: { color?: string; display?: boolean; lineWidth?: number },
        ): this;
        setLegend(legendOptions: DeepPartial<LegendOptions<any>>): this;
        setPadding(padding: any): this;
        setParsingKey(xAxisKey: string | false, yAxisKey: string | false): this;
        setPlugin(plugins: any): this;
        setScales(scales: CommonAxesSacels): this;
        setSpinnerOverlay(spinnerOverlay: SpinnerOverlayOption): this;
        setTimeScale(axis?: string, timeScaleConfig?: TimeScaleConfig): this;
        setTitle(titleOptions: CommonCartesianTitleConfig): this;
        setTooltip(tooltipOptions: DeepPartial<TooltipOptions<any>>): this;
        setYAxisForDataset(datasetIndex: number, axisId?: string): this;
        setYAxisID(datasetIndex: number, axisID: string): this;
        setZoom(enabled: boolean, zoomOption?: DeepPartial<CustomZoomType>): this;
        toggleDataset(uidOrIndex: string | number, syncGroup?: boolean): this;
    }

    Type Parameters

    Hierarchy (View Summary)

    Implemented by

    Index

    Methods

    • Parameters

      • OptionaldefultDataLabels: boolean
      • OptionaldataLabelsOptions: Partial<DataLabels>

      Returns this

    • 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

      • xAxisKey: string | false
      • yAxisKey: string | false

      Returns this

    • Parameters

      • axis: string
      • position: "left" | "right"

      Returns this

    • Parameters

      • axis: "x" | "y"
      • Optionalmin: number
      • Optionalmax: number

      Returns this

    • Parameters

      • alpha: number

      Returns this

    • Parameters

      Returns this

    • Parameters

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

      Returns this

    • Parameters

      • datasetIndex: number
      • xAxisKey: string | false
      • yAxisKey: string | false

      Returns this

    • Parameters

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

      Returns this

    • Parameters

      • axis: string
      • gridOptions: GridLineOptions

      Returns this

    • Parameters

      • axis: "x" | "y"
      • gridOptions: { color?: string; display?: boolean; lineWidth?: number }

      Returns this

    • Parameters

      • padding: any

      Returns this

    • Parameters

      • xAxisKey: string | false
      • yAxisKey: string | false

      Returns this

    • Parameters

      • plugins: any

      Returns this

    • Parameters

      Returns this

    • Parameters

      • datasetIndex: number
      • OptionalaxisId: string

      Returns this

    • Parameters

      • datasetIndex: number
      • axisID: string

      Returns this

    • Parameters

      • uidOrIndex: string | number
      • OptionalsyncGroup: boolean

      Returns this