charton

Appearance

charton API

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

Interface: TimeScaleOptions ​

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

Settings a TimeScale starts with: its view limits plus the initial bar spacing.

Extends ​

Properties ​

barSpacing ​

barSpacing: number

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

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.

Inherited from ​

TimeScaleLimits.fixLeftEdge

fixRightEdge? ​

optional fixRightEdge?: boolean

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

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

Inherited from ​

TimeScaleLimits.fixRightEdge

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.

Inherited from ​

TimeScaleLimits.grouped

maxBarSpacing ​

maxBarSpacing: number

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

Inherited from ​

TimeScaleLimits.maxBarSpacing

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.

Inherited from ​

TimeScaleLimits.maxRightOffset

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.

Inherited from ​

TimeScaleLimits.minBarCoverage

minBarSpacing ​

minBarSpacing: number

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

Inherited from ​

TimeScaleLimits.minBarSpacing

rightOffset ​

rightOffset: number

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

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

Inherited from ​

TimeScaleLimits.rightOffset