Class utils

a collection of utility functions used by the chart classes

Constructors

constructor

new utils(): utils
Returns utils

Methods

`Static`addFlag

addFlag(object: BG.charts.Object, 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 BG.charts.Object.EFlags
Parameters
- object: BG.charts.Object
- flag: number
Returns void

`Static`addOptionFlag

addOptionFlag(object: BG.charts.Object, 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 BG.charts.Object.EOptionFlags
Parameters
- object: BG.charts.Object
- option: string
- flag: number
Returns void

`Static`addWatermark

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

`Static`adjustIntervalForSpan

adjustIntervalForSpan(interval: number, span: string | number): number
adjust interval for span
Parameters
- interval: number
- span: string | number
Returns number

`Static`adjustSpanForInterval

adjustSpanForInterval(span: string | number, interval: number): string | number
adjust span for interval
Parameters
- span: string | number
- interval: number
Returns string | number

`Static`cloneObject

cloneObject(proto: any): any
Parameters
- proto: any
Returns any

`Static`compareIdentifiers

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

`Static`convertEODTimestamp

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

`Static`ellipsifyString

ellipsifyString(context: BGContext, text: string, width: number): string
abbreviate text to specified maximum length by cutting of and appending an ellipsis
Parameters
- context: BGContext
- text: string
- width: number
Returns string

`Static`equals

equals(
objectA: { [key: string]: any },
objectB: { [key: string]: any },
): boolean
compares two objects
Parameters
- objectA: { [key: string]: any }
- objectB: { [key: string]: any }
Returns boolean

`Static`fetchWithTimeout

fetchWithTimeout<T>(
    context: BG.charts.TContext,
    url: RequestInfo | URL,
    timeout?: number,
    options?: RequestInit,
): Promise<T>
modern fetch with timeout
Type Parameters
- T
Parameters
- context: BG.charts.TContext
- url: RequestInfo | URL
- Optionaltimeout: number
- Optionaloptions: RequestInit
Returns Promise<T>

`Static`findMaxF64

findMaxF64(array: Float64Array): number
Max function for Float64 buffers
Parameters
- array: Float64Array
Returns number

`Static`findMinF64

findMinF64(array: Float64Array): number
Min function for Float64 buffers
Parameters
- array: Float64Array
Returns number

`Static`formatString

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

`Static`get

get(
    option: string,
):
    | null
    | string
    | number
    | string[]
    | { selector: string; values: { [key: string]: any } }[]
returns the requested configuration option
Parameters
- option: string
Returns
    | null
    | string
    | number
    | string[]
    | { selector: string; values: { [key: string]: any } }[]

`Static`hasFlag

hasFlag(object: BG.charts.Object, flag: number): number
check if a flag is set for the specified object For a list of flags and a detailed explanation see BG.charts.Object.EFlags
Parameters
- object: BG.charts.Object
- flag: number
Returns number

`Static`hasOptionFlag

hasOptionFlag(object: BG.charts.Object, 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 BG.charts.Object.EOptionFlags
Parameters
- object: BG.charts.Object
- option: string
- flag: number
Returns number

`Static`htmlentities

htmlentities(value: string | number): string
replace special characters by html entities
Parameters
- value: string | number
Returns string

`Static`intervalName

intervalName(t: number, i18n: Translator): string | I18NString
returns the name for an interval
Parameters
- t: number
- i18n: Translator
Returns string | I18NString

`Static`list

list(type: string): null | { [key: string]: { [key: string]: any } }
a list containing all available objects of the specified type lists are available for the following types: indicator, tool, generator, loader, layer NOTE: the map can contain duplicates, as one clazz might be registered for multiple types
Parameters
- type: string
Returns null | { [key: string]: { [key: string]: any } }

`Static`mergeObjects

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 }

`Static`nearestSpan

nearestSpan(span: string | number, spans?: number[]): null | string
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 null | string

`Static`normalizeIdentifier

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

`Static`parseIdentifier

parseIdentifier(
    identifier: string,
):
    | null
    | {
        id?: null
        | string;
        params: (string | number)[];
        resolution: number;
        type: string;
    }
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
    | null
    | {
        id?: null
        | string;
        params: (string | number)[];
        resolution: number;
        type: string;
    }

`Static`rmFlag

rmFlag(object: BG.charts.Object, 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 BG.charts.Object.EFlags
Parameters
- object: BG.charts.Object
- flag: number
Returns void

`Static`rmOptionFlag

rmOptionFlag(object: BG.charts.Object, 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 BG.charts.Object.EOptionFlags
Parameters
- object: BG.charts.Object
- option: string
- flag: number
Returns void

`Static`set

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

`Static`setFlag

setFlag(object: BG.charts.Object, flag: number, state?: boolean): void
set flag for the specified object For a list of flags and a detailed explanation see BG.charts.Object.EFlags
Parameters
- object: BG.charts.Object
- flag: number
- Optionalstate: boolean
Returns void

`Static`setOptionFlag

setOptionFlag(
    object: BG.charts.Object,
    option: string,
    flag: number,
    state?: boolean,
): void
set flag for the specified objects option For a list of flags and a detailed explanation see BG.charts.Object.EOptionFlags
Parameters
- object: BG.charts.Object
- option: string
- flag: number
- Optionalstate: boolean
Returns void

`Static`shiftBox

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

`Static`spanName

spanName(t: number, i18n: Translator): string | I18NString
returns the name for an interval
Parameters
- t: number
- i18n: Translator
Returns string | I18NString

`Static`stripTags

stripTags(html: string): string
strip html tags from a string
Parameters
- html: string
Returns string

`Static`tickComplete

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

`Static`tickT

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)

`Static`typeOf

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

`Static`urlWithParams

urlWithParams(url: string, params?: Record<string, string | number>): string
returns a uri encoded url query string is generated from the provided optional objects keys and values
Parameters
- url: string
- Optionalparams: Record<string, string | number>
Returns string

`Static`validateExpression

validateExpression(type: string, value: string | number): boolean
validate expression
Parameters
- type: string
- value: string | number
Returns boolean

Class utils

Index

Constructors

Methods

Constructors

constructor

Returns utils

Methods

StaticaddFlag

Parameters

Returns void

StaticaddOptionFlag

Parameters

Returns void

StaticaddWatermark

Parameters

Returns void

StaticadjustIntervalForSpan

Parameters

Returns number

StaticadjustSpanForInterval

Parameters

Returns string | number

StaticcloneObject

Parameters

Returns any

StaticcompareIdentifiers

Parameters

Returns boolean

StaticconvertEODTimestamp

Parameters

Returns number

StaticellipsifyString

Parameters

Returns string

Staticequals

Parameters

Returns boolean

StaticfetchWithTimeout

Type Parameters

Parameters

Returns Promise<T>

StaticfindMaxF64

Parameters

Returns number

StaticfindMinF64

Parameters

Returns number

StaticformatString

Parameters

Returns string

Staticget

Parameters

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

StatichasFlag

Parameters

Returns number

StatichasOptionFlag

Parameters

Returns number

Statichtmlentities

Parameters

Returns string

StaticintervalName

Parameters

Returns string | I18NString

Staticlist

Parameters

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

StaticmergeObjects

Parameters

Returns { [key: string]: any }

StaticnearestSpan

Parameters

Returns null | string

StaticnormalizeIdentifier

Parameters

Returns string

StaticparseIdentifier

Parameters

`Static`addFlag

`Static`addOptionFlag

`Static`addWatermark

`Static`adjustIntervalForSpan

`Static`adjustSpanForInterval

`Static`cloneObject

`Static`compareIdentifiers

`Static`convertEODTimestamp

`Static`ellipsifyString

`Static`equals

`Static`fetchWithTimeout

`Static`findMaxF64

`Static`findMinF64

`Static`formatString

`Static`get

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

`Static`hasFlag

`Static`hasOptionFlag

`Static`htmlentities

`Static`intervalName

`Static`list

`Static`mergeObjects

`Static`nearestSpan

`Static`normalizeIdentifier

`Static`parseIdentifier

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

`Static`rmFlag

`Static`rmOptionFlag

`Static`set

`Static`setFlag

`Static`setOptionFlag

`Static`shiftBox

`Static`spanName

`Static`stripTags

`Static`tickComplete

`Static`tickT

`Static`typeOf

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

`Static`urlWithParams

`Static`validateExpression