charturbo - v0.1.0
    Preparing search index...

    Interface PictorialSymbolOptions

    Symbol options of a pictorial bar (chart default, series or item; the most specific wins).

    interface PictorialSymbolOptions {
        symbol?: PictorialSymbol;
        symbolBoundingData?: number | readonly [number, number];
        symbolClip?: boolean;
        symbolMargin?: PictorialLength | `${number}!` | `${number}%!`;
        symbolOffset?:
            | PictorialLength
            | readonly [PictorialLength, PictorialLength];
        symbolPosition?: "center" | "end" | "start";
        symbolRepeat?: number | boolean | "fixed";
        symbolRotate?: number;
        symbolSize?: PictorialLength | readonly [PictorialLength, PictorialLength];
    }

    Hierarchy (View Summary)

    Index
    symbol? symbolBoundingData? symbolClip? symbolMargin? symbolOffset? symbolPosition? symbolRepeat? symbolRotate? symbolSize?
    symbol?: PictorialSymbol

    Default 'circle'. path:// paths are scaled to the symbol box (aspect not kept)

    symbolBoundingData?: number | readonly [number, number]

    Value the symbols are laid out against instead of the bar value: one value, or [negative, positive] bounds for negative / positive bars

    symbolClip?: boolean

    Clip the symbols at the data value (default false)

    symbolMargin?: PictorialLength | `${number}!` | `${number}%!`

    Gap on each side of a repeated symbol, px or percent of its value-axis size (default '15%'); the gaps are re-spread so the run fills its length. A trailing ! ('10%!') keeps gaps at both ends of the run too

    symbolOffset?: PictorialLength | readonly [PictorialLength, PictorialLength]

    Screen [right, down] offset, px or percent of the symbol size; one value for both

    symbolPosition?: "center" | "end" | "start"

    Where a single symbol / the repeated run sits along the bar (default 'start')

    symbolRepeat?: number | boolean | "fixed"

    false (default): one symbol. true: repeated over the bar length. A number: that many. 'fixed': as many as fit the bounding length (plot edge / symbolBoundingData), whatever the value (combine with symbolClip for a "fill level" look)

    symbolRotate?: number

    Rotation in degrees, positive = anticlockwise (default 0)

    symbolSize?: PictorialLength | readonly [PictorialLength, PictorialLength]

    [width, height] on screen, or one value for both (default ['100%', '100%']). Percents: of the bar thickness on the category axis; on the value axis of the bar length (or of the symbolBoundingData length), or of the bar thickness when repeating

    Settings
    Member Visibility

    On This Page
    Properties