charton

Appearance

charton API

charton API / @chart-on/core / index / TimeScaleLimits

Interface: TimeScaleLimits ​

Defined in: packages/core/src/scales.ts:12

Where the view may go; the chart keeps these in step with its options.

Extended by ​

Properties ​

fixLeftEdge? ​

optional fixLeftEdge?: boolean

Defined in: packages/core/src/scales.ts:18

The plot's left edge cannot go before the first bar. Default false.

fixRightEdge? ​

optional fixRightEdge?: boolean

Defined in: packages/core/src/scales.ts:20

The view cannot go past the last bar plus rightOffset. Default false.

grouped? ​

optional grouped?: boolean

Defined in: packages/core/src/scales.ts:29

The chart groups bars when zoomed out (grouping), so zooming may go below minBarSpacing, down to half the spacing that fits every bar.

maxBarSpacing ​

maxBarSpacing: number

Defined in: packages/core/src/scales.ts:14

maxRightOffset? ​

optional maxRightOffset?: number

Defined in: packages/core/src/scales.ts:22

Most empty bars allowed right of the last bar; unset for no limit.

minBarCoverage? ​

optional minBarCoverage?: number

Defined in: packages/core/src/scales.ts:24

Share of the plot width (0 to 1) bars keep covering when panning towards either end. Default 0.5.

minBarSpacing ​

minBarSpacing: number

Defined in: packages/core/src/scales.ts:13

rightOffset ​

rightOffset: number

Defined in: packages/core/src/scales.ts:16

Empty bars between the last bar and the right edge, as configured.