charturbo - v0.1.0
    Preparing search index...

    Interface CharturboChartProps<T>

    Component callbacks: SDK events plus the lifecycle (ready / error).

    interface CharturboChartProps<T extends CharturboChartType = CharturboChartType> {
        canvasClassName?: string;
        canvasStyle?: CSSProperties;
        className?: string;
        createOptions?: {
            animation?: ChartAnimationInput;
            antialias?: CharturboAntialias;
            autoResize?: boolean;
            clusterCount?: number;
            device?: CharturboDevice;
            edgeCount?: number;
            locale?: string;
            nodeCount?: number;
            seed?: number;
            sync?: ChartSyncMemberOptions;
            timeZone?: CharturboTimeZone;
        };
        data: CharturboChartData<T>;
        interactions?: CharturboChartInteractions;
        loading?: CharturboChartLoading;
        onClick?: (e: CharturboClickEvent) => void;
        onDrill?: (e: CharturboDrillEvent) => void;
        onError?: (error: unknown) => void;
        onHover?: (e: CharturboHoverEvent) => void;
        onLegendToggle?: (e: { series: number; visible: boolean }) => void;
        onParallelBrush?: (e: CharturboParallelBrushEvent) => void;
        onPointAdd?: (e: CharturboPointAddEvent) => void;
        onPointDrag?: (e: CharturboPointDragEvent) => void;
        onPointDragEnd?: (e: CharturboPointDragEvent) => void;
        onRangeChange?: (e: CharturboRange) => void;
        onReady?: (sdk: Charturbo) => void;
        onResize?: (e: { height: number; width: number }) => void;
        onSelect?: (e: CharturboSelection) => void;
        onThemeChange?: (e: CharturboTheme) => void;
        onTreeToggle?: (e: CharturboTreeToggleEvent) => void;
        options?: CharturboChartOptions<T>;
        style?: CSSProperties;
        syncGroup?: CharturboChartSync;
        theme?: CharturboChartTheme;
        type: T;
        watermark?: ChartWatermarkOptions | null;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index
    canvasClassName? canvasStyle? className? createOptions? data interactions? loading? onClick? onDrill? onError? onHover? onLegendToggle? onParallelBrush? onPointAdd? onPointDrag? onPointDragEnd? onRangeChange? onReady? onResize? onSelect? onThemeChange? onTreeToggle? options? style? syncGroup? theme? type watermark?
    canvasClassName?: string
    canvasStyle?: CSSProperties
    className?: string
    createOptions?: {
        animation?: ChartAnimationInput;
        antialias?: CharturboAntialias;
        autoResize?: boolean;
        clusterCount?: number;
        device?: CharturboDevice;
        edgeCount?: number;
        locale?: string;
        nodeCount?: number;
        seed?: number;
        sync?: ChartSyncMemberOptions;
        timeZone?: CharturboTimeZone;
    }

    Charturbo.create options (autoResize default true, locale, ...); read on mount

    Type Declaration

    • Optionalanimation?: ChartAnimationInput

      Chart enter / update animations (default off; see setAnimation)

    • Optionalantialias?: CharturboAntialias

      Main-pass MSAA (default off): true / 4 = 4 samples per pixel, smoothing stair-stepped mesh edges; falls back to off with a console warning when the device cannot (see setAntialias).

    • OptionalautoResize?: boolean

      Keep canvas.width / height at its CSS size x device pixel ratio (ResizeObserver + DPR changes) and call resize() + render() on change (default: true). Disable when the host sizes the canvas itself.

    • OptionalclusterCount?: number
    • Optionaldevice?: CharturboDevice

      Shared GPU device (CharturboDevice.create()): no adapter / device request, cached pipelines, compact buffers — use it for pages with many charts. Graph defaults are 0 nodes / edges on this path. WebGL2 devices need a canvas without a context (see charturbo-device.ts).

    • OptionaledgeCount?: number
    • Optionallocale?: string

      Locale of default number / time labels and tooltip values (see setLocale)

    • OptionalnodeCount?: number
    • Optionalseed?: number
    • Optionalsync?: ChartSyncMemberOptions

      Joins a cursor / zoom sync group (see setSync)

    • OptionaltimeZone?: CharturboTimeZone

      Zone of time axes, labels, and tooltips (see setTimeZone; default 'local')

    data: CharturboChartData<T>
    interactions?: CharturboChartInteractions

    Tooltip / zoom / pan / touch / brush options; false = static chart (default: SDK defaults)

    loading?: CharturboChartLoading

    true / showLoading options = loading indicator, falsy = hidden (rendering never hides it)

    onClick?: (e: CharturboClickEvent) => void
    onDrill?: (e: CharturboDrillEvent) => void

    Treemap / sunburst drill-down / up

    onError?: (error: unknown) => void

    create failed (CharturboInitError when the device lacks WebGPU / WebGL2) or a render threw

    onHover?: (e: CharturboHoverEvent) => void
    onLegendToggle?: (e: { series: number; visible: boolean }) => void
    onParallelBrush?: (e: CharturboParallelBrushEvent) => void

    Parallel coordinates brush changed

    onPointAdd?: (e: CharturboPointAddEvent) => void
    onPointDrag?: (e: CharturboPointDragEvent) => void

    editable point moved / drag ended / point added

    onPointDragEnd?: (e: CharturboPointDragEvent) => void
    onRangeChange?: (e: CharturboRange) => void
    onReady?: (sdk: Charturbo) => void
    onResize?: (e: { height: number; width: number }) => void
    onSelect?: (e: CharturboSelection) => void
    onThemeChange?: (e: CharturboTheme) => void
    onTreeToggle?: (e: CharturboTreeToggleEvent) => void

    Tidy tree node expanded / collapsed

    options?: CharturboChartOptions<T>
    style?: CSSProperties
    syncGroup?: CharturboChartSync

    Cursor / zoom sync group key (or member options); null leaves

    theme?: CharturboChartTheme
    type: T
    watermark?: ChartWatermarkOptions | null

    setWatermark options (absent / null = none)

    Settings
    Member Visibility

    On This Page
    Properties