stz-util Documentation - v1.5.2
    Preparing search index...

    Interface BarChartBuilder

    interface BarChartBuilder {
        addDataLabels(
            defultDataLabels?: boolean,
            dataLabelsOptions?: Partial<DataLabels>,
        ): this;
        addZoom(defaultZoom?: boolean, zoomOption?: object): this;
        build(id?: string): ChartConfig;
        customLegend(obj: HtmlLegendOptions): this;
        getChartData(uid: string): object;
        hasPlugin(pluginId: string): boolean;
        makeConfig(id?: string): ChartConfig;
        onResize(
            callback: (
                chart: Chart<any>,
                size: { height: number; width: number },
            ) => void,
        ): this;
        removePlugin(pluginId: string): this;
        setAllBarPercentage(percentage: number): this;
        setAllBarThickness(thickness: number): this;
        setAllBorderRadius(borderRadius: number): this;
        setAllBorderWidth(borderWidth: number): this;
        setAllCategoryPercentage(percentage: number): this;
        setAllDatasetsParsing(
            xAxisKey: string | false,
            yAxisKey: string | false,
        ): this;
        setAllMaxBarThickness(maxThickness: number): 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;
        setBarImg(axis: string): this;
        setBarPercentage(datasetIndex: number, percentage: number): this;
        setBarThickness(datasetIndex: number, thickness: number): this;
        setBorderRadius(datasetIndex: number, borderRadius: number): this;
        setBorderWidth(datasetIndex: number, borderWidth: number): this;
        setCategoryPercentage(datasetIndex: number, percentage: number): this;
        setChartData(uid: string, data: any): void;
        setDatasetParsing(
            datasetIndex: number,
            xAxisKey: string | false,
            yAxisKey: string | false,
        ): 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;
        setMaxBarThickness(datasetIndex: number, maxThickness: number): this;
        setPadding(padding: any): this;
        setParsingKey(xAxisKey: string | false, yAxisKey: string | false): this;
        setPlugin(plugins: any): this;
        setScales(scales: CommonAxesSacels): this;
        setStacked(isStacked: boolean): this;
        setTitle(titleOptions: CommonCartesianTitleConfig): this;
        setYAxisForDataset(datasetIndex: number, axisId?: string): this;
        setYAxisID(datasetIndex: number, axisID: string): this;
        sparkBarChart(): this;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Methods

    • Parameters

      • OptionaldefultDataLabels: boolean
      • OptionaldataLabelsOptions: Partial<DataLabels>

      Returns this

    • Parameters

      • OptionaldefaultZoom: boolean
      • OptionalzoomOption: object

      Returns this

    • Parameters

      • Optionalid: string

      Returns ChartConfig

    • Parameters

      • pluginId: string

      Returns boolean

    • Parameters

      • Optionalid: string

      Returns ChartConfig

    • Parameters

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

      Returns this

    • Parameters

      • percentage: number

      Returns this

    • Parameters

      • thickness: number

      Returns this

    • Parameters

      • borderRadius: number

      Returns this

    • Parameters

      • borderWidth: number

      Returns this

    • Parameters

      • percentage: number

      Returns this

    • Parameters

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

      Returns this

    • Parameters

      • maxThickness: number

      Returns this

    • Parameters

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

      Returns this

    • Parameters

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

      Returns this

    • Parameters

      • axis: string

      Returns this

    • Parameters

      • datasetIndex: number
      • percentage: number

      Returns this

    • Parameters

      • datasetIndex: number
      • thickness: number

      Returns this

    • Parameters

      • datasetIndex: number
      • borderRadius: number

      Returns this

    • Parameters

      • datasetIndex: number
      • borderWidth: number

      Returns this

    • Parameters

      • datasetIndex: number
      • percentage: number

      Returns this

    • Parameters

      • uid: string
      • data: any

      Returns void

    • Parameters

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

      Returns this

    • Parameters

      • axis: string
      • gridOptions: GridLineOptions

      Returns this

    • Parameters

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

      Returns this

    • Parameters

      • datasetIndex: number
      • maxThickness: number

      Returns this

    • Parameters

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

      Returns this

    • Parameters

      • isStacked: boolean

      Returns this

    • Parameters

      • datasetIndex: number
      • OptionalaxisId: string

      Returns this

    • Parameters

      • datasetIndex: number
      • axisID: string

      Returns this

    • Returns this