Class AxesState<A>

Readonlyaxes

addAxis

• addAxis(axis: A, id: string): AxesState<A>

  Adds an axis to the current axis state and returns a new axis state. This is an internal state management function. This should generally not be used. Instead, use the UseAxesValues.addXAxis and UseAxesValues.addYAxis functions to add axes.

  Parameters

  • axis: A

    The axis to add

  • id: string

    The ID of the axis to add

  Returns AxesState<A>

  An updated axes state that has the new axis

  See

  • UseAxesValues.addXAxis
  • UseAxesValues.addYAxis

axisDefaultId

• axisDefaultId(): Optional<string>

  Returns Optional<string>

  The default name of the x-axis (in case only on default axis was added)

axisFor

• axisFor(axisId: string): Optional<A>

  Attempts to retrieve the x-axis for the specified ID

  Parameters

  • axisId: string

    The unique ID of the axis

  Returns Optional<A>

  The axis, or undefined if no axis with the specified ID is found

axisIds

• axisIds(): string[]

  Returns string[]

  An array holding all existing the x-axis IDs

copy

• copy(): AxesState<A>

  Creates a deep copy of the current axes state.

  Returns AxesState<A>

  A deep copy of the current axes state.

defaultAxis

• defaultAxis(): Optional<A>

  Returns the default axis

  Returns Optional<A>

  The default axis

  See

  axisDefaultId

isEmpty

• isEmpty(): boolean

  Returns boolean

  true if the axes state is empty, false otherwise.

Staticempty

• empty<A extends BaseAxis>(): AxesState<A>

  Creates an empty axes-state object.

  Type Parameters

  • A extends BaseAxis

  Returns AxesState<A>

  A new axes-state object.

Staticfrom

• from<A extends BaseAxis>(axes: Map<string, A>): AxesState<A>

  Creates a new axes state from the specified map of axes.

  Type Parameters

  • A extends BaseAxis

  Parameters

  • axes: Map<string, A>

    Mapping of the axes ID's to the axes.

  Returns AxesState<A>

  A new axes-state object.