fcharts-js - v0.3.0
    Preparing search index...

    Interface FChartOptions

    interface FChartOptions {
        ariaLabel?: string;
        exportControl?: boolean;
        forcedColors?: boolean;
        formatX?: Formatter;
        formatY?: Formatter;
        highContrast?: boolean;
        legend?: boolean;
        locale?: string;
        maxDpr?: number;
        onRenderPath?: (path: RenderPath) => void;
        reducedMotion?: boolean;
        sonify?: boolean;
        strings?: Partial<FChartStrings>;
        xInteger?: boolean;
        xLabel?: string;
        xPad?: number;
        xTickCount?: number;
        xType?: "linear" | "time";
        yLabel?: string;
        yPadding?: number;
        yScale?: "linear" | "log";
        yTickCount?: number;
    }
    Index

    Properties

    ariaLabel? exportControl? forcedColors? formatX? formatY? highContrast? legend? locale? maxDpr? onRenderPath? reducedMotion? sonify? strings? xInteger? xLabel? xPad? xTickCount? xType? yLabel? yPadding? yScale? yTickCount?

    Properties

    ariaLabel?: string

    Accessible name for the whole chart.

    exportControl?: boolean

    Render a small "Download data (CSV)" button (localizable via strings.exportCsv) in the plot's lower-left — a visible alternative-format affordance backing the hidden data table. Off by default; fixed at construction. The data is always available via toCSV().

    forcedColors?: boolean

    Force forced-colors (Windows High Contrast) behavior (otherwise auto-detected + live).

    formatX?: Formatter
    formatY?: Formatter
    highContrast?: boolean

    Force high-contrast behavior (otherwise auto-detected).

    legend?: boolean

    Render the accessible legend. Default true.

    locale?: string

    BCP-47 tag (e.g. 'de', 'fr-CH') localizing the DEFAULT tick/value formatters via Intl.NumberFormat/Intl.DateTimeFormat. Only the defaults: an explicit formatX/ formatY always wins, and without locale the deterministic English defaults are unchanged. Pairs with strings (e.g. stringsDE), which localizes the UI prose. An invalid tag throws at construction.

    maxDpr?: number

    Cap on device pixel ratio (perf). Default 2.

    onRenderPath?: (path: RenderPath) => void

    Notified when the live render path changes after construction — e.g. when the HTML-in-Canvas path self-heals to the DOM overlay because the experimental composite painted nothing. Read chart.renderPath for the initial value; this fires only on a change. Lets a host reflect the live path (a status badge, diagnostics).

    reducedMotion?: boolean

    Force reduced-motion behavior (otherwise auto-detected).

    sonify?: boolean

    Play an audible tone for the focused value as the keyboard cursor moves (audio charts). Off by default.

    strings?: Partial<FChartStrings>

    Localize the library's fixed UI strings (legend, keyboard help, summary, caption).

    xInteger?: boolean

    Treat x as integer indices (ticks step >= 1). Default false.

    xLabel?: string
    xPad?: number

    X-domain padding in x data units beyond the first/last sample (it widens the view's hard bounds). Candle bodies have width in x, so charts with a visible candle series default to half the average sample step — edge candles render whole instead of clipping to slivers at the plot border. Other charts default to 0. Set it explicitly to keep multi-panel layouts (e.g. price + volume) on identical domains.

    xTickCount?: number
    xType?: "linear" | "time"

    X-axis flavor. 'time' treats x as epoch milliseconds: ticks land on calendar boundaries (midnights, month starts) and formatX defaults to an adaptive date/clock formatter. Default 'linear'. The formatX default is resolved at construction — patch formatX explicitly if you change xType via update().

    yLabel?: string
    yPadding?: number

    Fractional y-extent padding. Default 0.06.

    yScale?: "linear" | "log"

    Y-axis scale. 'log' (base 10) needs positive data: the domain is fitted to the positive values and non-positive samples clamp to the plot bottom. Default 'linear'.

    yTickCount?: number

    Settings

    Member Visibility

    On This Page

    Properties