Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DataInputHighLow

Interface for supplying an Array of High Low data to a component.

Given data is expected to be two number Arrays of equal length, which will be transformed into a single array of AreaPoints. This method is for end user utility, and simply transform given data to the format of add(). As such, they cause additional performance overhead, so use add() whenever possible.

Implemented by

Index

Methods

Methods

addArraysHighLow

  • addArraysHighLow(arrayHigh: number[], arrayLow: number[], step?: undefined | number, start?: undefined | number): this

  • Add an Array of High Low values. Each HighLow value will be paired with an automatically generated HighLow value, based on step-argument. For optimal performance, use add() if possible.

    Parameters

    • arrayHigh: number[]

      Array of first High values.

    • arrayLow: number[]

      Array of Second Low values

    • step: undefined | number

      Optional step between each HighLow coordinate. Defaults to 1.

    • start: undefined | number

      Optional value for first generated HighLow value. Defaults to 0.

    Returns this

    Object itself for fluent interface.