Interface AxisScrollStrategy

Type definition for options of AxisScrollStrategies.

While technically it is possible to define custom axis scroll strategies by passing an object that satisfies this interface, this is not recommended.

All known use cases can be realized with built-in scroll strategies. If you believe this is not the case, please contact us https://lightningchart.com/js-charts/docs/contact/

Hierarchy

  • AxisScrollStrategy

Properties

apply considerVisibleRangeOnly dispose? id init?

Properties

Readonly apply

apply: ((info: {
    axis: GenericAxis<AxisScale, AbstractAxisStrategy, _AbstractAxisTick, _GenericAxisInput, _GenericTickPlottingVariables, _GenericTickInfo, _GenericAxisOutput<_AbstractAxisTick, _GenericTickInfo>>;
    curEnd: number;
    curStart: number;
    seriesDataRange: undefined | Interval<number>;
}) => undefined | {
    allowAnimation?: boolean;
    allowIntervalLengthChange: boolean;
    end: number;
    keepScrolling?: boolean;
    start: number;
})

Type declaration

    • (info: {
          axis: GenericAxis<AxisScale, AbstractAxisStrategy, _AbstractAxisTick, _GenericAxisInput, _GenericTickPlottingVariables, _GenericTickInfo, _GenericAxisOutput<_AbstractAxisTick, _GenericTickInfo>>;
          curEnd: number;
          curStart: number;
          seriesDataRange: undefined | Interval<number>;
      }): undefined | {
          allowAnimation?: boolean;
          allowIntervalLengthChange: boolean;
          end: number;
          keepScrolling?: boolean;
          start: number;
      }

    • Parameters

      • info: {
            axis: GenericAxis<AxisScale, AbstractAxisStrategy, _AbstractAxisTick, _GenericAxisInput, _GenericTickPlottingVariables, _GenericTickInfo, _GenericAxisOutput<_AbstractAxisTick, _GenericTickInfo>>;
            curEnd: number;
            curStart: number;
            seriesDataRange: undefined | Interval<number>;
        }
        • axis: GenericAxis<AxisScale, AbstractAxisStrategy, _AbstractAxisTick, _GenericAxisInput, _GenericTickPlottingVariables, _GenericTickInfo, _GenericAxisOutput<_AbstractAxisTick, _GenericTickInfo>>
        • curEnd: number
        • curStart: number
        • seriesDataRange: undefined | Interval<number>

      Returns undefined | {
          allowAnimation?: boolean;
          allowIntervalLengthChange: boolean;
          end: number;
          keepScrolling?: boolean;
          start: number;
      }

Readonly considerVisibleRangeOnly

considerVisibleRangeOnly: boolean

Optional Readonly dispose

dispose?: ((info: {
    axis: GenericAxis<AxisScale, AbstractAxisStrategy, _AbstractAxisTick, _GenericAxisInput, _GenericTickPlottingVariables, _GenericTickInfo, _GenericAxisOutput<_AbstractAxisTick, _GenericTickInfo>>;
}) => unknown)

Type declaration

    • (info: {
          axis: GenericAxis<AxisScale, AbstractAxisStrategy, _AbstractAxisTick, _GenericAxisInput, _GenericTickPlottingVariables, _GenericTickInfo, _GenericAxisOutput<_AbstractAxisTick, _GenericTickInfo>>;
      }): unknown

    • Parameters

      • info: {
            axis: GenericAxis<AxisScale, AbstractAxisStrategy, _AbstractAxisTick, _GenericAxisInput, _GenericTickPlottingVariables, _GenericTickInfo, _GenericAxisOutput<_AbstractAxisTick, _GenericTickInfo>>;
        }
        • axis: GenericAxis<AxisScale, AbstractAxisStrategy, _AbstractAxisTick, _GenericAxisInput, _GenericTickPlottingVariables, _GenericTickInfo, _GenericAxisOutput<_AbstractAxisTick, _GenericTickInfo>>

      Returns unknown

Readonly id

id: string

Just a means to identify built-in scroll strategies.

Optional Readonly init

init?: ((info: {
    axis: GenericAxis<AxisScale, AbstractAxisStrategy, _AbstractAxisTick, _GenericAxisInput, _GenericTickPlottingVariables, _GenericTickInfo, _GenericAxisOutput<_AbstractAxisTick, _GenericTickInfo>>;
}) => unknown)

Type declaration

    • (info: {
          axis: GenericAxis<AxisScale, AbstractAxisStrategy, _AbstractAxisTick, _GenericAxisInput, _GenericTickPlottingVariables, _GenericTickInfo, _GenericAxisOutput<_AbstractAxisTick, _GenericTickInfo>>;
      }): unknown

    • Parameters

      • info: {
            axis: GenericAxis<AxisScale, AbstractAxisStrategy, _AbstractAxisTick, _GenericAxisInput, _GenericTickPlottingVariables, _GenericTickInfo, _GenericAxisOutput<_AbstractAxisTick, _GenericTickInfo>>;
        }
        • axis: GenericAxis<AxisScale, AbstractAxisStrategy, _AbstractAxisTick, _GenericAxisInput, _GenericTickPlottingVariables, _GenericTickInfo, _GenericAxisOutput<_AbstractAxisTick, _GenericTickInfo>>

      Returns unknown

Settings

Member Visibility

Theme