charturbo - v0.1.0
    Preparing search index...

    Interface ThemeRiverChartOptions

    ThemeRiver options: 2D line options plus the stream layout.

    interface ThemeRiverChartOptions {
        animation?: ChartAnimationInput;
        axes?: {
            extraY?: ExtraYAxisOptions[];
            x?: LineXAxisOptions;
            y?: LineYAxisOptions;
            y2?: LineYAxisOptions;
        };
        colors?: Record<string, ColorInput>
        | readonly ColorInput[];
        description?: string;
        endLabel?: boolean | LineEndLabelOptions;
        fillOpacity?: number;
        grid?: ChartGridStyle;
        height?: number;
        hover?: ChartHoverStyle;
        labels?: boolean | ThemeRiverLabelOptions;
        legend?: boolean | ChartLegendOptions;
        lineWidth?: number;
        locale?: string;
        navigator?: NavigatorOption;
        offset?: "zero" | "wiggle" | "silhouette";
        order?: "none" | "insideOut";
        padding?: ChartPaddingOptions;
        showBackdropGrid?: boolean;
        smooth?: boolean;
        timeZone?: CharturboTimeZone;
        title?: string;
        width?: number;
        xLabelPrefix?: string;
    }

    Hierarchy

    Index
    animation? axes? colors? description? endLabel? fillOpacity? grid? height? hover? labels? legend? lineWidth? locale? navigator? offset? order? padding? showBackdropGrid? smooth? timeZone? title? width? xLabelPrefix?
    animation?: ChartAnimationInput

    Enter / update animation of this chart (default: the SDK setting, setAnimation)

    axes?: {
        extraY?: ExtraYAxisOptions[];
        x?: LineXAxisOptions;
        y?: LineYAxisOptions;
        y2?: LineYAxisOptions;
    }

    y2: right y axis, used only when a series has yAxis: 'right' / yAxisIndex: 1 (line charts). extraY: more y axes (axis k >= 2 = extraY[k - 2], at most 6) bound by series yAxisIndex, each with its own domain / scale / format / breaks, stacked beside the plot

    colors?: Record<string, ColorInput> | readonly ColorInput[]

    Stream colors by name, or in stream order (default: the theme palette)

    description?: string

    Accessible name of the canvas; replaces the auto summary (which moves to the description)

    endLabel?: boolean | LineEndLabelOptions

    Line race label (2D line charts): series name + value beside the end of each visible line, riding the left -> right enter reveal (animation). true or { format }; reserves room on the right

    fillOpacity?: number

    Fill alpha multiplier of the stream colors (default 0.85)

    grid?: ChartGridStyle
    height?: number
    hover?: ChartHoverStyle

    Hover layer style (crosshair, point markers). See ChartHoverStyle.

    labels?: boolean | ThemeRiverLabelOptions

    Stream name labels at the left end of each visible stream (default: shown)

    legend?: boolean | ChartLegendOptions
    lineWidth?: number

    Stroke width in CSS pixels for every series; constant at any zoom (default: 2)

    locale?: string

    Locale of this chart's default number / time labels and tooltip values (Intl); default: the SDK locale (setLocale), else the runtime locale

    navigator?: NavigatorOption

    Range selector strip below the plot (2D only): an overview of every visible series over the full x range with a draggable / resizable zoom window (click outside it to jump, wheel to zoom). true or { height } in CSS px (default 48). Emits 'rangechange' like zoom / pan.

    offset?: "zero" | "wiggle" | "silhouette"

    Baseline: 'wiggle' (default; minimized weighted wiggle, d3 stackOffsetWiggle), 'silhouette' (centered on zero) or 'zero' (a plain stack)

    order?: "none" | "insideOut"

    Stacking order: 'none' (default: names in order of first appearance, first at the bottom) or 'insideOut' (d3 stackOrderInsideOut: early-peaking streams in the middle)

    padding?: ChartPaddingOptions
    showBackdropGrid?: boolean

    Horizontal gridlines + baseline (default: true). See grid for styling.

    smooth?: boolean

    Smooth (monotone) stream edges (default: true); false = straight segments

    timeZone?: CharturboTimeZone

    Time zone of a time x axis: tick boundaries (midnight, month start, hours on DST days) and labels / tooltips / a11y text / CSV (default: the SDK zone, setTimeZone, else 'local')

    title?: string
    width?: number
    xLabelPrefix?: string

    Prefix of the default x tick / tooltip label without series x, e.g. T -> T+120

    Settings
    Member Visibility

    On This Page
    Properties