@deephaven/jsapi-types
    Preparing search index...

    Interface Axis

    Defines one axis used by series. These instances will be found both on the Chart and the Series instances, and may be shared between Series instances.

    interface Axis {
        formatPattern?: string;
        gapBetweenMajorTicks?: number;
        get businessCalendar(): BusinessCalendar;
        get color(): string;
        get formatType(): number;
        get id(): string;
        get invert(): boolean;
        get label(): string;
        get labelFont(): string;
        get log(): boolean;
        get majorTickLocations(): number[];
        get majorTicksVisible(): boolean;
        get maxRange(): number;
        get minorTickCount(): number;
        get minorTicksVisible(): boolean;
        get minRange(): number;
        get position(): number;
        get tickLabelAngle(): number;
        get ticksFont(): string;
        get timeAxis(): boolean;
        get type(): number;
        range(pixelCount?: number, min?: unknown, max?: unknown): void;
    }
    Index
    formatPattern?: string

    The format pattern to use with this axis. Use the formatType to determine which type of formatter to use.

    String

    gapBetweenMajorTicks?: number
    • get color(): string

      Returns string

    • get formatType(): number

      The type for this axis. See the AxisFormatType enum for more details.

      Returns number

      int

    • get id(): string

      The unique id for this axis.

      Returns string

      String

    • get invert(): boolean

      Returns boolean

    • get label(): string

      The label for this axis.

      Returns string

      String

    • get labelFont(): string

      Returns string

    • get log(): boolean

      Returns boolean

    • get majorTickLocations(): number[]

      Returns number[]

    • get majorTicksVisible(): boolean

      Returns boolean

    • get maxRange(): number

      Returns number

    • get minorTickCount(): number

      Returns number

    • get minorTicksVisible(): boolean

      Returns boolean

    • get minRange(): number

      Returns number

    • get position(): number

      The position for this axis. See the AxisPosition enum for more details.

      Returns number

      int

    • get tickLabelAngle(): number

      Returns number

    • get ticksFont(): string

      Returns string

    • get timeAxis(): boolean

      Returns boolean

    • get type(): number

      The type for this axis, indicating how it will be drawn. See the AxisType enum for more details.

      Returns number

      int

    • Indicates that this axis is only widthInPixels wide, so any extra data can be downsampled out, if this can be done losslessly. The second two arguments represent the current zoom range of this axis, and if provided, most of the data outside of this range will be filtered out automatically and the visible width mapped to that range. When the UI zooms, pans, or resizes, this method should be called again to update these three values to ensure that data is correct and current. See Figure for details on how downsampling works.

      Parameters

      • OptionalpixelCount: number
      • Optionalmin: unknown
      • Optionalmax: unknown

      Returns void