stz-util Documentation - v2.0.3
    Preparing search index...

    Interface ChartWithFocus

    interface ChartWithFocus {
        _currentFocusedAxis?: null | string;
        aspectRatio: number;
        attached: boolean;
        boxes: LayoutItem[];
        canvas: HTMLCanvasElement;
        chartArea: ChartArea;
        config:
            | ChartConfiguration<
                keyof ChartTypeRegistry,
                (
                    | null
                    | number
                    | Point
                    | [number, number]
                    | BubbleDataPoint
                    | TreemapDataPoint
                )[],
                unknown,
            >
            | ChartConfigurationCustomTypesPerDataset<
                keyof ChartTypeRegistry,
                (
                    | null
                    | number
                    | Point
                    | [number, number]
                    | BubbleDataPoint
                    | TreemapDataPoint
                )[],
                unknown,
            >;
        ctx: CanvasRenderingContext2D;
        currentDevicePixelRatio: number;
        data: ChartData<
            keyof ChartTypeRegistry,
            (
                | null
                | number
                | Point
                | [number, number]
                | BubbleDataPoint
                | TreemapDataPoint
            )[],
            unknown,
        >;
        height: number;
        id: string;
        legend?: LegendElement<keyof ChartTypeRegistry>;
        options: ChartOptions<TType>;
        platform: BasePlatform;
        scales: { [key: string]: Scale<CoreScaleOptions> };
        tooltip?: TooltipModel<keyof ChartTypeRegistry>;
        width: number;
        bindEvents(): void;
        buildOrUpdateControllers(): void;
        buildOrUpdateScales(): void;
        clear(): this;
        destroy(): void;
        draw(): void;
        ensureScalesHaveIDs(): void;
        getActiveElements(): ActiveElement[];
        getContext(): { chart: Chart; type: string };
        getDatasetMeta(datasetIndex: number): ChartMeta;
        getDataVisibility(index: number): boolean;
        getElementsAtEventForMode(
            e: Event,
            mode: string,
            options: InteractionOptions,
            useFinalPosition: boolean,
        ): InteractionItem[];
        getInitialScaleBounds(): Record<
            string,
            { max: number
            | undefined; min: number | undefined },
        >;
        getSortedVisibleDatasetMetas(): ChartMeta<
            keyof ChartTypeRegistry,
            Element<AnyObject, AnyObject>,
            Element<AnyObject, AnyObject>,
        >[];
        getVisibleDatasetCount(): number;
        getZoomedScaleBounds(): Record<string, ScaleRange | undefined>;
        getZoomLevel(): number;
        hide(datasetIndex: number, dataIndex?: number): void;
        isDatasetVisible(datasetIndex: number): boolean;
        isPluginEnabled(pluginId: string): boolean;
        isPointInArea(point: Point): boolean;
        isZoomedOrPanned(): boolean;
        isZoomingOrPanning(): boolean;
        notifyPlugins(hook: string, args?: AnyObject): boolean | void;
        pan(
            pan: PanAmount,
            scales?: Scale<CoreScaleOptions>[],
            mode?:
                | "default"
                | "resize"
                | "reset"
                | "none"
                | "hide"
                | "show"
                | "active"
                | "zoom",
        ): void;
        render(): void;
        reset(): void;
        resetZoom(
            mode?:
                | "default"
                | "resize"
                | "reset"
                | "none"
                | "hide"
                | "show"
                | "active"
                | "zoom",
        ): void;
        resize(width?: number, height?: number): void;
        setActiveElements(active: ActiveDataPoint[]): void;
        setDatasetVisibility(datasetIndex: number, visible: boolean): void;
        show(datasetIndex: number, dataIndex?: number): void;
        stop(): this;
        toBase64Image(type?: string, quality?: unknown): string;
        toggleDataVisibility(index: number): void;
        unbindEvents(): void;
        update(
            mode?:
                | "default"
                | "resize"
                | "reset"
                | "none"
                | "hide"
                | "show"
                | "active"
                | "zoom"
                | (
                    (
                        ctx: { datasetIndex: number },
                    ) =>
                        | "default"
                        | "resize"
                        | "reset"
                        | "none"
                        | "hide"
                        | "show"
                        | "active"
                        | "zoom"
                ),
        ): void;
        updateHoverStyle(
            items: InteractionItem[],
            mode: "dataset",
            enabled: boolean,
        ): void;
        zoom(
            zoom: ZoomAmount,
            mode?:
                | "default"
                | "resize"
                | "reset"
                | "none"
                | "hide"
                | "show"
                | "active"
                | "zoom",
        ): void;
        zoomRect(
            p0: Point,
            p1: Point,
            mode?:
                | "default"
                | "resize"
                | "reset"
                | "none"
                | "hide"
                | "show"
                | "active"
                | "zoom",
        ): void;
        zoomScale(
            id: string,
            range: ScaleRange,
            mode?:
                | "default"
                | "resize"
                | "reset"
                | "none"
                | "hide"
                | "show"
                | "active"
                | "zoom",
        ): void;
    }

    Hierarchy

    • Chart
      • ChartWithFocus
    Index

    Properties

    _currentFocusedAxis? aspectRatio attached boxes canvas chartArea config ctx currentDevicePixelRatio data height id legend? options platform scales tooltip? width

    Methods

    bindEvents buildOrUpdateControllers buildOrUpdateScales clear destroy draw ensureScalesHaveIDs getActiveElements getContext getDatasetMeta getDataVisibility getElementsAtEventForMode getInitialScaleBounds getSortedVisibleDatasetMetas getVisibleDatasetCount getZoomedScaleBounds getZoomLevel hide isDatasetVisible isPluginEnabled isPointInArea isZoomedOrPanned isZoomingOrPanning notifyPlugins pan render reset resetZoom resize setActiveElements setDatasetVisibility show stop toBase64Image toggleDataVisibility unbindEvents update updateHoverStyle zoom zoomRect zoomScale

    Properties

    Optional_currentFocusedAxis

    _currentFocusedAxis?: null | string
    aspectRatio: number
    attached: boolean
    boxes: LayoutItem[]
    canvas: HTMLCanvasElement
    chartArea: ChartArea
    config:
        | ChartConfiguration<
            keyof ChartTypeRegistry,
            (
                | null
                | number
                | Point
                | [number, number]
                | BubbleDataPoint
                | TreemapDataPoint
            )[],
            unknown,
        >
        | ChartConfigurationCustomTypesPerDataset<
            keyof ChartTypeRegistry,
            (
                | null
                | number
                | Point
                | [number, number]
                | BubbleDataPoint
                | TreemapDataPoint
            )[],
            unknown,
        >
    ctx: CanvasRenderingContext2D
    currentDevicePixelRatio: number
    data: ChartData<
        keyof ChartTypeRegistry,
        (
            | null
            | number
            | Point
            | [number, number]
            | BubbleDataPoint
            | TreemapDataPoint
        )[],
        unknown,
    >
    height: number
    id: string
    legend?: LegendElement<keyof ChartTypeRegistry>
    options: ChartOptions<TType>
    platform: BasePlatform
    scales: { [key: string]: Scale<CoreScaleOptions> }
    tooltip?: TooltipModel<keyof ChartTypeRegistry>
    width: number

    Methods

    • Returns void

    • Returns void

    • Returns void

    • Returns this

    • Returns void

    • Returns void

    • Returns void

    • Returns ActiveElement[]

    • Returns { chart: Chart; type: string }

    • Parameters

      • datasetIndex: number

      Returns ChartMeta

    • Parameters

      • index: number

      Returns boolean

    • Parameters

      • e: Event
      • mode: string
      • options: InteractionOptions
      • useFinalPosition: boolean

      Returns InteractionItem[]

    • Returns Record<string, { max: number | undefined; min: number | undefined }>

    • Returns ChartMeta<
          keyof ChartTypeRegistry,
          Element<AnyObject, AnyObject>,
          Element<AnyObject, AnyObject>,
      >[]

    • Returns number

    • Returns Record<string, ScaleRange | undefined>

    • Returns number

    • Parameters

      • datasetIndex: number
      • OptionaldataIndex: number

      Returns void

    • Parameters

      • datasetIndex: number

      Returns boolean

    • Parameters

      • pluginId: string

      Returns boolean

    • Parameters

      • point: Point

      Returns boolean

    • Returns boolean

    • Returns boolean

    • Parameters

      • hook: string
      • Optionalargs: AnyObject

      Returns boolean | void

    • Parameters

      • pan: PanAmount
      • Optionalscales: Scale<CoreScaleOptions>[]
      • Optionalmode: "default" | "resize" | "reset" | "none" | "hide" | "show" | "active" | "zoom"

      Returns void

    • Returns void

    • Returns void

    • Parameters

      • Optionalmode: "default" | "resize" | "reset" | "none" | "hide" | "show" | "active" | "zoom"

      Returns void

    • Parameters

      • Optionalwidth: number
      • Optionalheight: number

      Returns void

    • Parameters

      • active: ActiveDataPoint[]

      Returns void

    • Parameters

      • datasetIndex: number
      • visible: boolean

      Returns void

    • Parameters

      • datasetIndex: number
      • OptionaldataIndex: number

      Returns void

    • Returns this

    • Parameters

      • Optionaltype: string
      • Optionalquality: unknown

      Returns string

    • Parameters

      • index: number

      Returns void

    • Returns void

    • Parameters

      • Optionalmode:
            | "default"
            | "resize"
            | "reset"
            | "none"
            | "hide"
            | "show"
            | "active"
            | "zoom"
            | (
                (
                    ctx: { datasetIndex: number },
                ) =>
                    | "default"
                    | "resize"
                    | "reset"
                    | "none"
                    | "hide"
                    | "show"
                    | "active"
                    | "zoom"
            )

      Returns void

    • Parameters

      • items: InteractionItem[]
      • mode: "dataset"
      • enabled: boolean

      Returns void

    • Parameters

      • zoom: ZoomAmount
      • Optionalmode: "default" | "resize" | "reset" | "none" | "hide" | "show" | "active" | "zoom"

      Returns void

    • Parameters

      • p0: Point
      • p1: Point
      • Optionalmode: "default" | "resize" | "reset" | "none" | "hide" | "show" | "active" | "zoom"

      Returns void

    • Parameters

      • id: string
      • range: ScaleRange
      • Optionalmode: "default" | "resize" | "reset" | "none" | "hide" | "show" | "active" | "zoom"

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods