Class ToolHandle

constructor

• new ToolHandle(index: number, identifier: number, value: number): ToolHandle

• creates a new chart tool handle

  Parameters

  • index: number
  • identifier: number
  • value: number

  Returns ToolHandle

identifier

get

• get(
      value:
          | "value"
          | "index"
          | "identifier"
          | "offset"
          | "offsetIdentifier"
          | "offsetInterval",
  ): number

• returns value of requested config option

  Parameters

  • value:
        | "value"
        | "index"
        | "identifier"
        | "offset"
        | "offsetIdentifier"
        | "offsetInterval"

  Returns number

setIdentifier

• setIdentifier(identifier: number, chart: BG.charts.Chart): void

• Parameters

  • identifier: number
  • chart: BG.charts.Chart

  Returns void

setIndex

• setIndex(index: number, chart: BG.charts.Chart): void

• Parameters

  • index: number
  • chart: BG.charts.Chart

  Returns void

setValue

• setValue(value: number, chart: BG.charts.Chart): void

• Parameters

  • value: number
  • chart: BG.charts.Chart

  Returns void