Interface AxisIntervalConfiguration

Parameters for setInterval method.

Examples:

 // Set interval start and end.
 Axis.setInterval({ start: 0, end: 5000 })

 // Set interval end only.
 Axis.setInterval({ end: 5000 })

 // Set interval but don't stop the axis from scrolling
 Axis.setInterval({ start: 0, end: 5000, stopAxisAfter: false })

 // Set interval with 2000 milliseconds long animation
 Axis.setInterval({ start: 0, end: 5000, animate: 2000 })

Hierarchy

  • AxisIntervalConfiguration

Properties

animate? end? start? stopAxisAfter?

Properties

Optional animate

animate?: number | boolean

Should the change in axis interval be animated or not?

Defaults to false.

  • false -> Don't animate
  • true -> Default animation
  • 1000 or other number -> Animate with this duration as milliseconds

Optional end

end?: number

Axis interval end.

For X axis this refers to RIGHT, while for Y axis this refers to TOP.

Optional start

start?: number

Axis interval start.

For X axis this refers to LEFT, while for Y axis this refers to BOTTOM.

Optional stopAxisAfter

stopAxisAfter?: boolean

Should the axis scrolling be stopped after applying the interval?

Defaults to true.

If true, whatever the active scroll strategy of the Axis is, it will not override the applied axis interval until the axis is released.

Settings

Member Visibility

Theme