Class: Span

Span

Span/Range functionality allows the user to select a span of data to display. A span is a range of data from a certin time in the past, to the present. Selection of a span is done in CompactChart by clicking on a UI button that is configured to display a certain range. Selection via an API function may be provided at a later time.

Since:

  • 9.4.0

Type Definitions

RangeMapEntry

Range map definitions for use with staticRangePeriodicityMap and dynamicRangePeriodicityMap. When multiple definitions are present in a map, the first matching one will end up gtting used.

Type:
  • object
Properties:
Name Type Description
rangeInMS number

Upper limit of range in question. If range is of smaller duration than this, this entry will be used.
period number

Period to use.
interval number

Interval to use.
timeUnit TimeUnit

Time unit to use.
Since:

  • 9.4.0

SpanConfig

Configuration for Span/Range selection.

Type:
Properties:
Name Type Argument Description
staticRangePeriodicityMap Array.<RangeMapEntry> <optional>

Map of intervals to use depending on duration of range, for all ranges.
dynamicRangePeriodicityMap Array.<RangeMapEntry> <optional>

Map of intervals to use depending on candleWidth, when autoPickCandleWidth is set.
autoPickCandleWidth object <optional>

Candlewidth object when dynamicRangePeriodicityMap is desired.

Properties
Name Type Argument Description
candleWidth candleWidth <optional>

Selected candle width.
Since:

  • 9.4.0