Class utils

constructor

• new utils(): utils

  Returns utils

Staticfetch

StaticaddFlag

• addFlag(object: ChartbreakerObject, flag: number): void

  set flag for the specified object has no effect if flag is already set For a list of flags and a detailed explanation see ObjectEFlags

  Parameters

  • object: ChartbreakerObject
  • flag: number

  Returns void

StaticaddOptionFlag

• addOptionFlag(object: ChartbreakerObject, option: string, flag: number): void

  set flag for the specified objects option has no effect if flag is already set For a list of flags and a detailed explanation see ObjectEOptionFlags

  Parameters

  • object: ChartbreakerObject
  • option: string
  • flag: number

  Returns void

StaticaddWatermark

• addWatermark(name: string, watermark: ChartSet_Watermark): void

  add watermark drawing function to watermark registry implementations can be set active by calling utils.set('activeWatermark', $name); Additionally, it needs to be enabled for each Controller-instance by setting the showWatermark-setting to true.

  Parameters

  • name: string
  • watermark: ChartSet_Watermark

  Returns void

StaticadjustIntervalForSpan

• adjustIntervalForSpan(interval: number, span: string | number): number

  adjust interval for span

  Parameters

  • interval: number
  • span: string | number

  Returns number

StaticadjustSpanForInterval

• adjustSpanForInterval(span: string | number, interval: number): string | number

  adjust span for interval

  Parameters

  • span: string | number
  • interval: number

  Returns string | number

StaticcloneObject

• cloneObject(proto: any): any

  Parameters

  • proto: any

  Returns any

StaticcompareIdentifiers

• compareIdentifiers(a: string, b: string, considerIds?: boolean): boolean

  compare an object identifier returns true if identifiers match, false otherwise the optional parameter controls wether ids should be considered for comparison (default = true)

  Parameters

  • a: string
  • b: string
  • OptionalconsiderIds: boolean

  Returns boolean

StaticconvertEODTimestamp

• convertEODTimestamp(t: number, fromTZ: string, toTZ: string): number

  Parameters

  • t: number

    timestamp

  • fromTZ: string

    timezone identifier of source timezone

  • toTZ: string

    timezone identifier of destination timezone

  Returns number

StaticellipsifyString

• ellipsifyString(
      context: CanvasRenderingContext2D,
      text: string,
      width: number,
  ): string

  abbreviate text to specified maximum length by cutting of and appending an ellipsis

  Parameters

  • context: CanvasRenderingContext2D
  • text: string
  • width: number

  Returns string

Staticequals

• equals(
      objectA: { [key: string]: any },
      objectB: { [key: string]: any },
  ): boolean

  compares two objects

  Parameters

  • objectA: { [key: string]: any }
  • objectB: { [key: string]: any }

  Returns boolean

StaticfetchWithTimeout

• fetchWithTimeout<T>(
      url: string | URL | Request,
      timeout?: number,
      options?: RequestInit,
  ): Promise<T>

  modern fetch with timeout

  Type Parameters

  • T

  Parameters

  • url: string | URL | Request
  • Optionaltimeout: number
  • Optionaloptions: RequestInit

  Returns Promise<T>

StaticfindMaxF64

• findMaxF64(array: Float64Array): number

  Max function for Float64 buffers

  Parameters

  • array: Float64Array

  Returns number

StaticfindMinF64

• findMinF64(array: Float64Array): number

  Min function for Float64 buffers

  Parameters

  • array: Float64Array

  Returns number

StaticformatString

• formatString(format: string, cb: (args: string) => string): string

  builds a string using the supplied format and key value callback

  supports variables like {NAME} variables can supply default values like {NAME:DEFAULT} if the value retrieved from the callback matches the default it will be skipped, same as if there was no value at all

  multiple variables can be joined with {SEPARATOR|VARIABLE|VARIABLE|...}

  also supports conditionals that are only displayed when at least one enclosed variable has a non-default value: "[Currency: {currency}]"

  available variables depend on used data loader that has to provide them in the properties object as part of the metadata

  Example: "{name}[ ({, |currency|qs})]" => "DAX (XXP, Last)" or "Foo (Bid)" or "Foo ($)" or "Foo"

  Parameters

  • format: string
  • cb: (args: string) => string

  Returns string

Staticget

• get(
      option: string,
  ):
      | string
      | number
      | string[]
      | { selector: string; values: { [key: string]: any } }[]
      | null

  returns the requested configuration option

  Parameters

  • option: string

  Returns
      | string
      | number
      | string[]
      | { selector: string; values: { [key: string]: any } }[]
      | null

StatichasFlag

• hasFlag(object: ChartbreakerObject, flag: number): number

  check if a flag is set for the specified object For a list of flags and a detailed explanation see ObjectEFlags

  Parameters

  • object: ChartbreakerObject
  • flag: number

  Returns number

StatichasOptionFlag

• hasOptionFlag(object: ChartbreakerObject, option: string, flag: number): number

  check if a flag is set for the specified objects option For a list of flags and a detailed explanation see ObjectEOptionFlags

  Parameters

  • object: ChartbreakerObject
  • option: string
  • flag: number

  Returns number

Statichtmlentities

• htmlentities(value: string | number): string

  replace special characters by html entities

  Parameters

  • value: string | number

  Returns string

StaticintervalName

• intervalName(
      t: number,
      i18n: Translator,
      short?: boolean,
  ): string | I18NString<(string | number)[]>

  returns the name for an interval

  Parameters

  • t: number

    interval

  • i18n: Translator

    ChartbreakerLocale.Translator

  • Optionalshort: boolean

    use short forms (e.g. min instead of Minue), defaults to false

  Returns string | I18NString<(string | number)[]>

StaticisChart

• isChart(
      obj?: ChartbreakerObject<Record<string, (...args: any) => void>> | null,
  ): obj is Chart

  Parameters

  • Optionalobj: ChartbreakerObject<Record<string, (...args: any) => void>> | null

  Returns obj is Chart

StaticisGenerator

• isGenerator(
      obj?: ChartbreakerObject<Record<string, (...args: any) => void>> | null,
  ): obj is ToolGenerator<Record<string, (...args: any) => void>>

  Parameters

  • Optionalobj: ChartbreakerObject<Record<string, (...args: any) => void>> | null

  Returns obj is ToolGenerator<Record<string, (...args: any) => void>>

StaticisIndicator

• isIndicator(
      obj?: ChartbreakerObject<Record<string, (...args: any) => void>> | null,
  ): obj is Indicator<Record<string, (...args: any) => void>>

  Parameters

  • Optionalobj: ChartbreakerObject<Record<string, (...args: any) => void>> | null

  Returns obj is Indicator<Record<string, (...args: any) => void>>

StaticisLayer

• isLayer(
      obj?: ChartbreakerObject<Record<string, (...args: any) => void>> | null,
  ): obj is Layer

  Parameters

  • Optionalobj: ChartbreakerObject<Record<string, (...args: any) => void>> | null

  Returns obj is Layer

StaticisScale

• isScale(
      obj?: ChartbreakerObject<Record<string, (...args: any) => void>> | null,
  ): obj is Scale

  Parameters

  • Optionalobj: ChartbreakerObject<Record<string, (...args: any) => void>> | null

  Returns obj is Scale

StaticisTimeSeries

• isTimeSeries(
      obj?: ChartbreakerObject<Record<string, (...args: any) => void>> | null,
  ): obj is TimeSeries

  Parameters

  • Optionalobj: ChartbreakerObject<Record<string, (...args: any) => void>> | null

  Returns obj is TimeSeries

StaticisTool

• isTool(
      obj?: ChartbreakerObject<Record<string, (...args: any) => void>> | null,
  ): obj is Tool<
      Record<string, unknown>,
      Record<string, (...args: any) => void>,
  >

  Parameters

  • Optionalobj: ChartbreakerObject<Record<string, (...args: any) => void>> | null

  Returns obj is Tool<Record<string, unknown>, Record<string, (...args: any) => void>>

Staticlist

• list(
      type: "indicator",
  ): { [key: string]: Data_TClazzDescriptorIndicator } | null

  Parameters

  • type: "indicator"

  Returns { [key: string]: Data_TClazzDescriptorIndicator } | null

• list(type: "tool"): { [key: string]: Data_TClazzDescriptorTool } | null

  Parameters

  • type: "tool"

  Returns { [key: string]: Data_TClazzDescriptorTool } | null

• list(
      type: "generator",
  ): { [key: string]: Data_TClazzDescriptorGenerator } | null

  Parameters

  • type: "generator"

  Returns { [key: string]: Data_TClazzDescriptorGenerator } | null

• list(type: "loader"): { [key: string]: TClazzDescriptor } | null

  Parameters

  • type: "loader"

  Returns { [key: string]: TClazzDescriptor } | null

• list(type: "layer"): { [key: string]: TClazzDescriptor } | null

  Parameters

  • type: "layer"

  Returns { [key: string]: TClazzDescriptor } | null

StaticmergeObjects

• mergeObjects(obj1: any, obj2: any): { [key: string]: any }

  merges properties of the second object into the first one

  non-existing properties are simply added to the first object. if properties exist in both objects:

  • scalar properties are overwritten with values from second object
  • arrays are concatenated
  • if types of properties do not match, value from the second object is used

  Parameters

  • obj1: any
  • obj2: any

  Returns { [key: string]: any }

StaticnearestSpan

• nearestSpan(span: string | number, spans?: number[]): string | null

  returns the nearest predefined span for an arbitrary time span when passing a custom span array, the values need to be sorted in ascending order

  Parameters

  • span: string | number
  • Optionalspans: number[]

  Returns string | null

StaticnormalizeIdentifier

• normalizeIdentifier(identifier: string): string

  normalize an object identifier (see parseIdentifier) Example: Instrument => Instrument Instrument() => Instrument Instrument(1, 2) => Instrument(1,2) Instrument( ) => Instrument

  Parameters

  • identifier: string

  Returns string

StaticoverrideFetch

• overrideFetch(
      fetchFn: {
          (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
          (input: string | URL | Request, init?: RequestInit): Promise<Response>;
      },
  ): void

  Replaces the default fetch used by utils.fetch with a custom implementation.

  Useful for e.g. debugging, request caching, or providing a mock in tests.

  Parameters

  • fetchFn: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    }
    • • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: URL | RequestInfo
        • Optionalinit: RequestInit

        Returns Promise<Response>

      • (input: string | URL | Request, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: string | URL | Request
        • Optionalinit: RequestInit

        Returns Promise<Response>

  Returns void

StaticparseIdentifier

• parseIdentifier(
      identifier: string,
  ):
      | {
          id?: string
          | null;
          params: (string | number)[];
          resolution: number;
          type: string;
      }
      | null

  parse an object identifier identifiers consist of a type, optional params enclosed by parenthesis, and an optional resolution prefixed with @

  Example: Instrument(133962,4)@86400000 => {type:"Instrument", params:[133962,4], resolution:86400000, id:null} SMA(20) => {type:"SMA", params:[20], resolution:86400000, id:null} MACD => {type:"MACD", params:[], resolution:86400000, id:null} Expression(A/(B+C))@3600000 => {type:"Expression", params:["A/(B+C)"], resolution:3600000, id:null} Instrument(133962)#Foo => {type:"Instrument", params:[133962], resolution:86400000, id:Foo}

  Parameters

  • identifier: string

  Returns
      | {
          id?: string
          | null;
          params: (string | number)[];
          resolution: number;
          type: string;
      }
      | null

StaticrmFlag

• rmFlag(object: ChartbreakerObject, flag: number): void

  remove a flag from the specified object Has no effect if flag is not set. For a list of flags and a detailed explanation see ObjectEFlags

  Parameters

  • object: ChartbreakerObject
  • flag: number

  Returns void

StaticrmOptionFlag

• rmOptionFlag(object: ChartbreakerObject, option: string, flag: number): void

  remove a flag from the specified objects option Has no effect if flag is not set. For a list of flags and a detailed explanation see ObjectEOptionFlags

  Parameters

  • object: ChartbreakerObject
  • option: string
  • flag: number

  Returns void

Staticset

• set(options: string | { [key: string]: any }, value?: any): void

  store the specified global configuration values

  Parameters

  • options: string | { [key: string]: any }
  • Optionalvalue: any

  Returns void

StaticsetFlag

• setFlag(object: ChartbreakerObject, flag: number, state?: boolean): void

  set flag for the specified object For a list of flags and a detailed explanation see ObjectEFlags

  Parameters

  • object: ChartbreakerObject
  • flag: number
  • Optionalstate: boolean

  Returns void

StaticsetOptionFlag

• setOptionFlag(
      object: ChartbreakerObject,
      option: string,
      flag: number,
      state?: boolean,
  ): void

  set flag for the specified objects option For a list of flags and a detailed explanation see ObjectEOptionFlags

  Parameters

  • object: ChartbreakerObject
  • option: string
  • flag: number
  • Optionalstate: boolean

  Returns void

StaticshiftBox

• shiftBox(
      boxStart: number,
      shiftCount: number,
      boxSize: number,
      absolute: boolean,
  ): number

  shift box boxStart by offset shiftCount

  Parameters

  • boxStart: number

    box

  • shiftCount: number

    offset

  • boxSize: number

    box size

  • absolute: boolean

    absolute mode flag

  Returns number

StaticspanName

• spanName(t: number, i18n: Translator): string | I18NString<(string | number)[]>

  returns the name for an interval

  Parameters

  • t: number
  • i18n: Translator

  Returns string | I18NString<(string | number)[]>

StaticstripTags

• stripTags(html: string): string

  strip html tags from a string

  Parameters

  • html: string

  Returns string

StatictickComplete

• tickComplete(
      t: number,
      i: number,
      tz: string,
      startTime: number,
      endTime: number,
  ): boolean

  checks if the specified tick is already complete

  Parameters

  • t: number

    a timestamp (UTC)

  • i: number

    interval to match with

  • tz: string

    timezone identifier for grouping

  • startTime: number

    daily start time in milliseconds

  • endTime: number

    daily end time in milliseconds

  Returns boolean

  flag indicating if tick is complete

StatictickT

• tickT(
      referenceTick: number,
      interval: number,
      timezone: string,
      startTime: number,
  ): number

  Finds the nearest timestamp before the referenceTick that indicates a border between intervals of the given length

  Parameters

  • referenceTick: number

    a timestamp (UTC)

  • interval: number

    interval to match with

  • timezone: string

    timezone identifier for grouping

  • startTime: number

    daily start time in milliseconds

  Returns number

  the matched timestamp (UTC)

StatictypeOf

• typeOf(
      value: any,
  ):
      | "string"
      | "number"
      | "bigint"
      | "boolean"
      | "symbol"
      | "undefined"
      | "object"
      | "function"
      | "date"
      | "array"
      | "null"

  Parameters

  • value: any

  Returns
      | "string"
      | "number"
      | "bigint"
      | "boolean"
      | "symbol"
      | "undefined"
      | "object"
      | "function"
      | "date"
      | "array"
      | "null"

StaticurlWithParams

• urlWithParams(url: string, params?: Record<string, string | number>): string

  Parameters

  • url: string
  • Optionalparams: Record<string, string | number>

  Returns string

  Deprecated

  returns a uri encoded url query string is generated from the provided optional objects keys and values

StaticvalidateExpression

• validateExpression(type: string, value: string | number): boolean

  validate expression

  Parameters

  • type: string
  • value: string | number

  Returns boolean