Lumagrid
    Preparing search index...

    Interface D3PluginOptions<TData, TConfig>Experimental

    Options for createD3Plugin.

    Experimental: may change in a minor release.

    interface D3PluginOptions<TData, TConfig = Record<string, unknown>> {
        dataAdapter: (data: TransformedData, config?: TConfig) => TData;
        id: string;
        label?: string;
        destroy(container: HTMLDivElement): void;
        mount(
            container: HTMLDivElement,
            data: TData,
            theme: D3Theme,
            width: number,
            height: number,
        ): void;
        update(
            container: HTMLDivElement,
            data: TData,
            theme: D3Theme,
            width: number,
            height: number,
        ): void;
    }

    Type Parameters

    • TData
    • TConfig = Record<string, unknown>
    Index
    dataAdapter: (data: TransformedData, config?: TConfig) => TData

    Reshape TransformedData into whatever structure your D3 code expects.

    id: string
    label?: string
    • Experimental

      Called when the container unmounts. Remove listeners and DOM nodes.

      Parameters

      • container: HTMLDivElement

      Returns void

    • Experimental

      Called once when the container mounts. Append SVG/canvas here.

      Parameters

      • container: HTMLDivElement
      • data: TData
      • theme: D3Theme
      • width: number
      • height: number

      Returns void

    • Experimental

      Called on every re-render (data/size/theme change). Update the chart in-place.

      Parameters

      • container: HTMLDivElement
      • data: TData
      • theme: D3Theme
      • width: number
      • height: number

      Returns void