stream-charts
    Preparing search index...

    Interface OrdinalStringAxis

    Represents an ordinal string axis.

    interface OrdinalStringAxis {
        axisId: string;
        categorySize: number;
        generator: Axis<string>;
        location: AxisLocation;
        scale: ScaleBand<string>;
        selection: AxisElementSelection;
        update: (
            range: AxisInterval,
            originalRange: AxisInterval,
            plotDimensions: Dimensions,
            margin: Margin,
        ) => number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    axisId categorySize generator location scale selection update

    Properties

    axisId: string
    categorySize: number

    The size of each category on the axis.

    generator: Axis<string>

    A d3 axis generator for an ordinal string axis.

    location: AxisLocation
    scale: ScaleBand<string>

    A d3 scale for an ordinal string axis.

    selection: AxisElementSelection
    update: (
        range: AxisInterval,
        originalRange: AxisInterval,
        plotDimensions: Dimensions,
        margin: Margin,
    ) => number

    Updates the axis based on the specified domain and plot dimensions.

    Type Declaration

      • (
            range: AxisInterval,
            originalRange: AxisInterval,
            plotDimensions: Dimensions,
            margin: Margin,
        ): number

      • Parameters

        • range: AxisInterval

          An interval representing the range of the axis.

        • originalRange: AxisInterval

          An interval representing the original range of the axis (before zooming or panning).

        • plotDimensions: Dimensions

          The dimensions of the plot (without the margins).

        • margin: Margin

          The margins for the plot

        Returns number

        The number of pixels for each category on the axis.

    Settings

    Member Visibility

    On This Page

    Properties