charturbo - v0.1.0
    Preparing search index...

    Interface NodeInteractionOptions

    interface NodeInteractionOptions {
        autoRender?: boolean;
        brush?: false | BrushMode;
        brushStyle?: BrushStyleOptions;
        builtInTooltip?: boolean;
        cameraControls?: false | CameraControlOptions;
        chartNavigation?: boolean;
        editable?: boolean | ChartEditOptions;
        focusOnDoubleClick?: boolean;
        formatChartTooltip?: (ctx: ChartTooltipContext) => string;
        formatTooltip?: (details: NodeDetails) => string;
        highlightNeighborsOnClick?: number;
        onNodeClick?: (details: NodeDetails | null, event: PointerEvent) => void;
        onNodeHover?: (
            details: NodeDetails | null,
            pointer: { clientX: number; clientY: number },
        ) => void;
        tooltip?: ChartTooltipOptions;
        tooltipClassName?: string;
        tooltipContainer?: HTMLElement;
        tooltipStyle?: Partial<CSSStyleDeclaration>;
        touch?: false | TouchInteractionOptions;
        zoom?: ChartZoomAxis;
        zoomMode?: ChartZoomMode;
    }
    Index
    autoRender? brush? brushStyle? builtInTooltip? cameraControls? chartNavigation? editable? focusOnDoubleClick? formatChartTooltip? formatTooltip? highlightNeighborsOnClick? onNodeClick? onNodeHover? tooltip? tooltipClassName? tooltipContainer? tooltipStyle? touch? zoom? zoomMode?
    autoRender?: boolean

    Automatically call sdk.render() on hover/click changes (default: false)

    brush?: false | BrushMode

    Brush / box selection on 2D charts (mouse): 'x' selects an x interval (time range), 'xy' a rectangle (bars always brush x). While enabled, drag draws the brush and Alt + drag pans; wheel zoom and double-click reset keep working. Release emits 'select'; Escape or a click clears it. Same as setChartBrush (default: unchanged, i.e. off)

    brushStyle?: BrushStyleOptions

    Brush rectangle look (see setChartBrush)

    builtInTooltip?: boolean

    Render a built-in floating tooltip when hovering over a 3D node (default: true)

    cameraControls?: false | CameraControlOptions

    Built-in camera controls of graph / point-cloud / scene views (no chart shown). Mouse: left drag orbits, Shift + left / right / middle drag pans, wheel zooms (dolly). The same switches gate the camera moves of touch gestures (drag orbit, two-finger pan, pinch zoom). { orbit: false } makes a left drag pan (2D-style navigation); false turns every built-in camera move off (hosts driving the camera themselves). Charts keep their own wheel / drag navigation either way (default: all on).

    chartNavigation?: boolean

    2D line charts: wheel zooms the x axis, drag pans it; scatter charts zoom / pan both axes; double-click resets (default: true)

    editable?: boolean | ChartEditOptions

    Point editing on 2D line / scatter charts: drag a point (pointDrag, pointDragEnd; Escape cancels), click an empty part of the plot to add one (addOnClick, pointAdd), Shift / Alt

    • arrows on the keyboard-focused point. Same as setChartEditable (default: unchanged, i.e. off)
    focusOnDoubleClick?: boolean

    Focus camera on double-clicked node (default: true)

    formatChartTooltip?: (ctx: ChartTooltipContext) => string

    Optional custom HTML formatter for line / bar / scatter chart tooltips

    formatTooltip?: (details: NodeDetails) => string

    Optional custom HTML formatter for the floating tooltip (graph / point-cloud nodes)

    highlightNeighborsOnClick?: number

    Hop count to highlight when clicking a node (default: 1; set 0 to disable)

    onNodeClick?: (details: NodeDetails | null, event: PointerEvent) => void

    Fired when a node is clicked (or null when empty space is clicked without dragging)

    onNodeHover?: (
        details: NodeDetails | null,
        pointer: { clientX: number; clientY: number },
    ) => void

    Fired whenever the hovered node changes

    tooltip?: ChartTooltipOptions

    Built-in chart tooltip: row sort, shared (all series at x vs the nearest one), click pin, valueFormatter (chart-tooltip.ts). sort / shared also shape the context passed to formatChartTooltip; valueFormatter applies to the default tooltip only

    tooltipClassName?: string

    Extra CSS class(es) added to the tooltip element (base class: charturbo-sdk-node-tooltip)

    tooltipContainer?: HTMLElement

    Optional container to mount the floating tooltip (defaults to canvas.parentElement or document.body)

    tooltipStyle?: Partial<CSSStyleDeclaration>

    Inline style overrides merged over the default tooltip style

    touch?: false | TouchInteractionOptions

    Touch / pen gestures (Pointer Events; mouse is unaffected). Line charts: pinch / drag navigate the x axis, tap pins the tooltip, long-press scrubs, double-tap resets. Graph / 3D: drag orbits, pinch zooms, two-finger drag pans, tap selects, double-tap focuses. false disables (default: all on).

    zoom?: ChartZoomAxis

    Axes the wheel zooms on navigable 2D charts: 'x' (default), 'y', or 'xy'; Shift + wheel always zooms y. A y zoom pins the line y domain (autoscale pauses) until double-click / reset.

    zoomMode?: ChartZoomMode

    Plain drag: 'pan' (default; Ctrl / Cmd + drag box-zooms) or 'box' (drag box-zooms x + y, Alt + drag pans). Each gesture records an undo step (Ctrl / Cmd + Z, undoZoom).

    Settings
    Member Visibility

    On This Page
    Properties