Packages

object SeriesOhlcDataGrouping

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SeriesOhlcDataGrouping
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply(approximation: UndefOr[|[String, Function]] = js.undefined, dateTimeLabelFormats: UndefOr[Object] = js.undefined, enabled: UndefOr[Boolean] = js.undefined, forced: UndefOr[Boolean] = js.undefined, groupPixelWidth: UndefOr[Double] = js.undefined, smoothed: UndefOr[Boolean] = js.undefined, units: UndefOr[Array[Any]] = js.undefined): SeriesOhlcDataGrouping

    approximation

    The method of approximation inside a group. When for example. 30 days are grouped into one month, this determines what value should represent the. group. Possible values are "average", "open", "high", "low", "close" and "sum". For. OHLC and candlestick series the approximation is "ohlc" by default, which finds the . open, high, low and close values within all the grouped data. For ranges, the approximation is "range", which finds the low and high values.. . Custom aggregate methods. can be added by assigning a callback function as the approximation. This function takes. a numeric array as the argument and should return a single numeric value or null. Note that. the numeric array will never contain null values, only true numbers. Instead, if null. values are present in the raw data, the numeric array will have an .hasNulls. property set to true. For single-value data sets the data is available in the first. argument of the callback function. For OHLC data sets, all the open values are in the first. argument, all high values in the second etc.. . Since v4.2.7, grouping meta data is available in the approximation callback from this.dataGroupInfo. It can be used to extract information from the raw data.. . Defaults to average for line-type series, sum for columns, range for range series and ohlc for OHLC and candlestick.

    dateTimeLabelFormats

    Datetime formats for the header of the tooltip in a stock chart. The format can vary within a chart depending on the currently selected time range and the current data grouping.. . The default formats are: . 

    {.    millisecond: ['%A, %b %e, %H:%M:%S.%L', '%A, %b %e, %H:%M:%S.%L', '-%H:%M:%S.%L'],.    second: ['%A, %b %e, %H:%M:%S', '%A, %b %e, %H:%M:%S', '-%H:%M:%S'],.    minute: ['%A, %b %e, %H:%M', '%A, %b %e, %H:%M', '-%H:%M'],.    hour: ['%A, %b %e, %H:%M', '%A, %b %e, %H:%M', '-%H:%M'],.    day: ['%A, %b %e, %Y', '%A, %b %e', '-%A, %b %e, %Y'],.    week: ['Week from %A, %b %e, %Y', '%A, %b %e', '-%A, %b %e, %Y'],.    month: ['%B %Y', '%B', '-%B %Y'],.    year: ['%Y', '%Y', '-%Y']. }
    For each of these array definitions, the first item is the format used when the active time span is one unit. For instance, if the current data applies to one week, the first item of the week array is used. The second and third items are used when the active time span is more than two units. For instance, if the current data applies to two weeks, the second and third item of the week array are used, and applied to the start and end date of the time span.

    enabled

    Enable or disable data grouping.

    forced

    When data grouping is forced, it runs no matter how small the intervals are. This can be handy for example when the sum should be calculated for values appearing at random times within each hour.

    groupPixelWidth

    The approximate pixel width of each group. If for example a series with 30 points is displayed over a 600 pixel wide plot area, no grouping is performed. If however the series contains so many points that the spacing is less than the groupPixelWidth, Highcharts will try to group it into appropriate groups so that each is more or less two pixels wide. Defaults to 10.

    smoothed

    Normally, a group is indexed by the start of that group, so for example when 30 daily values are grouped into one month, that month's x value will be the 1st of the month. This apparently shifts the data to the left. When the smoothed option is true, this is compensated for. The data is shifted to the middle of the group, and min and max values are preserved. Internally, this is used in the Navigator series.

    units

    An array determining what time intervals the data is allowed to be grouped to. Each array item is an array where the first value is the time unit and the second value another array of allowed multiples. Defaults to:. 

    units: [[. 	'millisecond', // unit name. 	[1, 2, 5, 10, 20, 25, 50, 100, 200, 500] // allowed multiples. ], [. 	'second',. 	[1, 2, 5, 10, 15, 30]. ], [. 	'minute',. 	[1, 2, 5, 10, 15, 30]. ], [. 	'hour',. 	[1, 2, 3, 4, 6, 8, 12]. ], [. 	'day',. 	[1]. ], [. 	'week',. 	[1]. ], [. 	'month',. 	[1, 3, 6]. ], [. 	'year',. 	null. ]]

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped