API Docs for:
Show:

axisBinding Class

Defined in: src/core/axis_binding.js:9
Module: core
Parent Module: multigraph

Constructor

axisBinding

()

Defined in src/core/axis_binding.js:9

Methods

addAxis

(
  • axis
  • min
  • max
)

Defined in src/core/axis_binding.js:42

Parameters:

  • axis Axis
  • min Number | DataValue
  • max Number | DataValue

findByIdOrCreateNew

(
  • id
)
static

Defined in src/core/axis_binding.js:212

Parameters:

  • id Object

forgetAllBindings

() static

Defined in src/core/axis_binding.js:242

getInstanceById

(
  • id
)
static

Defined in src/core/axis_binding.js:200

Parameters:

  • id Object

removeAxis

(
  • axis
)

Defined in src/core/axis_binding.js:74

Parameters:

setDataRange

(
  • initiatingAxis
  • min
  • max
  • dispatch
)

Defined in src/core/axis_binding.js:133

Parameters:

  • initiatingAxis Axis
  • min Number | DataValue
  • max Number | DataValue
  • dispatch Boolean

sync

() Boolean

Defined in src/core/axis_binding.js:92

Force all the axes in this binding to sync up with each other, if possible.

This is done by looking for an axis in this binding which has its dataMin and dataMax values set, and then calling its setDataRange() method with those values. The main purpose of this method is to facilitate the initial setting of dataMin/dataMax values for axes in a binding that do not already have dataMin/dataMax values set; this forces them to be set based on the binding, as determined by another axis in the binding.

Note that this method is NOT the normal way for bound axes to interact with each other once initialization is complete; that is done via the axes' own setDataRange() method.

Returns:

Boolean:

a value indicating whether the sync was done; this will be true if and only if there is at least one axis in the binding having both its dataMin and dataMax values set.

syncAllBindings

() static

Defined in src/core/axis_binding.js:228

Properties

axes

Array

Defined in src/core/axis_binding.js:28

id

String

Defined in src/core/axis_binding.js:19