Interface ZoomBandChartDashboardOptions

Interface that can be used to define ZoomBandChart configurations, when inside a Dashboard, that can't be changed after creation.

Hierarchy

Properties

animationsEnabled?: boolean

Convenience flag that can be used to enable/disable all animations in a component.

columnIndex: number

Column index on dashboard (X location, 0 = left)

columnSpan?: number

Column span (X width), default = 1

defaultAxis?: AxisOptions

Interface for specifying Axis configurations that can't be changed after creation of the Zoom Band Chart.

Mainly intended to be able to use high precision axis in time series use cases.

 // Example usage
const zoomBandChart = lightningChart().ZoomBandChart({
defaultAxis: { type: 'linear-highPrecision' },
})
disableAnimations?: boolean

Convenience flag that can be used to disable all animations in a component.

Deprecated

Deprecated in v5.0.0. Use animationsEnabled instead (note that value should be inverted from previous applications!)

orientation?: "x" | "y"

Select orientation of ZoomBandChart.

'x' = primary axis is X axis (commonly used when X = Time axis).

'y' = opposite mode, for example when Time axis is Y and chart is rotated 90 degrees.

Defaults to 'x'

rowIndex: number

Row index on dashboard (Y location, 0 = top)

rowSpan?: number

Row span (Y height), default = 1

useSharedValueAxis?: boolean

ZoomBandChart can display series belonging to several different axes. By default, every unique value axis will have its own scale in the zoom band chart. By setting this flag to true, the zoom band chart will display all its series with 1 shared scale.

For example, imagine an use case where you have 3 temperature (celsius) time series. Each trend has the same Time (X) view, but different ranges of values (1: 0 - 10 celsius, 2: 40 - 60 celsius, 3: -10 - 0 celsius) If you need to be able to compare the temperatures in the zoom band chart, then you would set this flag to true.

Defaults to false