Class charts

the main namespace of all javascript stock3 AG javascript libraries.

includes the chartbreaker library in BG.charts as well as dependencies like BG.events.EventEmitter, BG.locale, and BG.clazz the main namespace of the ChartBreaker library

includes all classes of ChartBreaker distributed over several sub namespaces some global events are available directly on the namespace object itself

Hierarchy (View Summary)

EventEmitter<NamespaceEvents>
- charts

Constructors

constructor

new charts(): BG.charts
Returns BG.charts
Overrides EventEmitter.constructor

Properties

ActivityIndicator

ActivityIndicator: typeof ActivityIndicator

Bounds

Bounds: typeof Bounds

Chart

Chart: typeof BG.charts.Chart & { EScale: typeof EScale }

ChartSet

ChartSet: typeof BG.charts.ChartSet & { EFormatter: typeof EFormatter }

Color

Color: typeof Color

Controller

Controller: typeof BG.charts.Controller & {
    EChangeFlags: typeof EChangeFlags;
    EObjectQuery: typeof EObjectQuery;
    EPeekFlags: typeof EPeekFlags;
    EQuery: EQuery;
    EQueryFlags: typeof EQueryFlags;
}

Data

Data: typeof BG.charts.Data

EdgeInsets

EdgeInsets: typeof EdgeInsets

EDimension

EDimension: typeof EDimension

ELineType

ELineType: typeof ELineType

Error

Error: typeof Error

ESpans

ESpans: typeof ESpans

Expression

Expression: typeof BG.charts.Expression

gfx

gfx: typeof gfx

IDataLoader

IDataLoader: typeof BG.charts.IDataLoader

Indicator

Indicator: typeof BG.charts.Indicator

Layer

Layer: { ELayerFlags: typeof ELayerFlags }

layers

layers: {
    Band: typeof Band;
    Boxes: typeof Boxes;
    Candle: typeof Candle;
    Circles: typeof Circles;
    DirectionalLine: typeof DirectionalLine;
    Histogram: typeof Histogram;
    Kagi: typeof Kagi;
    Line: typeof Line;
    MCandle: typeof MCandle;
    Mountain: typeof Mountain;
    OHLC: typeof OHLC;
    PointAndFigure: typeof PointAndFigure;
    Ranges: typeof Ranges;
    ThresholdIntersection: typeof ThresholdIntersection;
    ThresholdLine: typeof ThresholdLine;
    Volume: typeof Volume;
}

LegendEntry

LegendEntry: typeof BG.charts.LegendEntry & {
EButton: typeof EButton;
EIcon: typeof EIcon;
}

loaders

loaders: { Expression: typeof BG.charts.loaders.Expression }

math

math: typeof math

Object

Object: typeof BG.charts.Object & {
    EFlags: typeof BG.charts.Object.EFlags;
    EOptionFlags: typeof EOptionFlags;
    State: typeof BG.charts.Object.State & {
        EFlags: typeof BG.charts.Object.State.EFlags;
    };
}

ObjectStyle

ObjectStyle: typeof ObjectStyle

options

options: {
    activeWatermark: null | string;
    dataCacheTTL: number;
    defaultStyle: string;
    defaultStyleOverwrites:
        | null
        | { selector: string; values: { [key: string]: any } }[];
    env: string;
    fixedOrderObjectTypes: string[];
    fixedParentObjectTypes: string[];
    fixedScaleObjectTypes: string[];
    maxTickGapDuration: number;
    mergerTimeout: number;
    os: string;
    valueBasedTypes: string[];
}

Point

Point: typeof Point

Profiler

Profiler: typeof Profiler

RecoverableError

RecoverableError: typeof RecoverableError

Scale

Scale: typeof BG.charts.Scale

setClazz

setClazz: (o: TClazzDescriptor) => boolean

Type declaration

- (o: TClazzDescriptor): boolean
- register a clazz with ChartBreaker
  
  returns false if a clazz with the specified type is already registered, or if an invalid descriptor is provided
  
  previous registration can NOT be updated
  Parameters
  - o: TClazzDescriptor
  Returns boolean

setLanguageData

setLanguageData: (
    lang: string,
    data: {
        domain: "charting";
        locale_data: {
            charting: { [key: string]: [null, ...string[]] } & {
                "": { domain: "charting"; lang: string; plural_forms: string };
            };
        };
    },
) => void

Type declaration

- (
      lang: string,
      data: {
          domain: "charting";
          locale_data: {
              charting: { [key: string]: [null, ...string[]] } & {
                  "": { domain: "charting"; lang: string; plural_forms: string };
              };
          };
      },
  ): void
- provide translations for a specific language to ChartBreaker
  Parameters
  - lang: string
    the language code as used in a locale (e.g. 'de' or 'en')
  - data: {
        domain: "charting";
        locale_data: {
            charting: { [key: string]: [null, ...string[]] } & {
                "": { domain: "charting"; lang: string; plural_forms: string };
            };
        };
    }
    an object containing translations in the format expected by BG.locale.Translator
  Returns void

Span

Span: typeof Span

Sparkline

Sparkline: typeof BG.charts.Sparkline

Style

Style: typeof Style

Timestamp

Timestamp: typeof BG.charts.Timestamp & { EType: typeof EType }

Tool

Tool: typeof BG.charts.Tool

ToolGenerator

ToolGenerator: typeof BG.charts.ToolGenerator

unsetClazz

unsetClazz: (clazz: Clazz) => boolean

Type declaration

- (clazz: Clazz): boolean
- unregister a clazz from ChartBreaker clazz needs to have been previously registered via BG.charts.setClazz
  Parameters
  - clazz: Clazz
    reference to the registered clazz
  Returns boolean

utils

utils: typeof utils

Methods

addListener

addListener<
    Type extends keyof NamespaceEvents,
    Callback extends

            | (sparkline: BG.charts.Sparkline) => void
            | (sparkline: BG.charts.Sparkline) => void
            | (descriptor: TClazzDescriptor) => void
            | (descriptor: TClazzDescriptor) => void
            | (controller: BG.charts.Controller) => void
            | (controller: BG.charts.Controller) => void,
>(
    type: Type,
    listener: Callback,
): this
Type Parameters
- Type extends keyof NamespaceEvents
- Callback extends
      | (sparkline: BG.charts.Sparkline) => void
      | (sparkline: BG.charts.Sparkline) => void
      | (descriptor: TClazzDescriptor) => void
      | (descriptor: TClazzDescriptor) => void
      | (controller: BG.charts.Controller) => void
      | (controller: BG.charts.Controller) => void
Parameters
- type: Type
- listener: Callback
Returns this
Description
adds a listener to the end of the listeners array for the specified event.

Inherited from EventEmitter.addListener

emit

emit<
    Type extends keyof NamespaceEvents,
    Callback extends

            | (sparkline: BG.charts.Sparkline) => void
            | (sparkline: BG.charts.Sparkline) => void
            | (descriptor: TClazzDescriptor) => void
            | (descriptor: TClazzDescriptor) => void
            | (controller: BG.charts.Controller) => void
            | (controller: BG.charts.Controller) => void,
>(
    type: Type,
    ...params: Parameters<Callback>,
): boolean
Type Parameters
- Type extends keyof NamespaceEvents
- Callback extends
      | (sparkline: BG.charts.Sparkline) => void
      | (sparkline: BG.charts.Sparkline) => void
      | (descriptor: TClazzDescriptor) => void
      | (descriptor: TClazzDescriptor) => void
      | (controller: BG.charts.Controller) => void
      | (controller: BG.charts.Controller) => void
Parameters
- type: Type
- ...params: Parameters<Callback>
Returns boolean
Description
execute each of the listeners in order with the supplied parameters.

Inherited from EventEmitter.emit

listeners

listeners<
    Type extends keyof NamespaceEvents,
    Callback extends

            | (sparkline: BG.charts.Sparkline) => void
            | (sparkline: BG.charts.Sparkline) => void
            | (descriptor: TClazzDescriptor) => void
            | (descriptor: TClazzDescriptor) => void
            | (controller: BG.charts.Controller) => void
            | (controller: BG.charts.Controller) => void,
>(
    type: Type,
): Callback[]
Type Parameters
- Type extends keyof NamespaceEvents
- Callback extends
      | (sparkline: BG.charts.Sparkline) => void
      | (sparkline: BG.charts.Sparkline) => void
      | (descriptor: TClazzDescriptor) => void
      | (descriptor: TClazzDescriptor) => void
      | (controller: BG.charts.Controller) => void
      | (controller: BG.charts.Controller) => void
Parameters
- type: Type
Returns Callback[]
Description
returns an array of listeners for the specified event.

Inherited from EventEmitter.listeners

on

on<
    Type extends keyof NamespaceEvents,
    Callback extends

            | (sparkline: BG.charts.Sparkline) => void
            | (sparkline: BG.charts.Sparkline) => void
            | (descriptor: TClazzDescriptor) => void
            | (descriptor: TClazzDescriptor) => void
            | (controller: BG.charts.Controller) => void
            | (controller: BG.charts.Controller) => void,
>(
    type: Type,
    listener: Callback,
): this
Type Parameters
- Type extends keyof NamespaceEvents
- Callback extends
      | (sparkline: BG.charts.Sparkline) => void
      | (sparkline: BG.charts.Sparkline) => void
      | (descriptor: TClazzDescriptor) => void
      | (descriptor: TClazzDescriptor) => void
      | (controller: BG.charts.Controller) => void
      | (controller: BG.charts.Controller) => void
Parameters
- type: Type
- listener: Callback
Returns this
Description
alias for addListener

Inherited from EventEmitter.on

once

once<
    Type extends keyof NamespaceEvents,
    Callback extends

            | (sparkline: BG.charts.Sparkline) => void
            | (sparkline: BG.charts.Sparkline) => void
            | (descriptor: TClazzDescriptor) => void
            | (descriptor: TClazzDescriptor) => void
            | (controller: BG.charts.Controller) => void
            | (controller: BG.charts.Controller) => void,
>(
    type: Type,
    listener: Callback,
): this
Type Parameters
- Type extends keyof NamespaceEvents
- Callback extends
      | (sparkline: BG.charts.Sparkline) => void
      | (sparkline: BG.charts.Sparkline) => void
      | (descriptor: TClazzDescriptor) => void
      | (descriptor: TClazzDescriptor) => void
      | (controller: BG.charts.Controller) => void
      | (controller: BG.charts.Controller) => void
Parameters
- type: Type
- listener: Callback
Returns this
Description
adds a one time listener for the event. This listener is invoked only the next time the event is fired, after which it is removed.

Inherited from EventEmitter.once

removeAllListeners

removeAllListeners<Type extends keyof NamespaceEvents>(type?: Type): this
Type Parameters
- Type extends keyof NamespaceEvents
Parameters
- Optionaltype: Type
Returns this
Description
removes all listeners, or those of the specified event.

Inherited from EventEmitter.removeAllListeners

removeListener

removeListener<
    Type extends keyof NamespaceEvents,
    Callback extends

            | (sparkline: BG.charts.Sparkline) => void
            | (sparkline: BG.charts.Sparkline) => void
            | (descriptor: TClazzDescriptor) => void
            | (descriptor: TClazzDescriptor) => void
            | (controller: BG.charts.Controller) => void
            | (controller: BG.charts.Controller) => void,
>(
    type: Type,
    listener: Callback,
): this
Type Parameters
- Type extends keyof NamespaceEvents
- Callback extends
      | (sparkline: BG.charts.Sparkline) => void
      | (sparkline: BG.charts.Sparkline) => void
      | (descriptor: TClazzDescriptor) => void
      | (descriptor: TClazzDescriptor) => void
      | (controller: BG.charts.Controller) => void
      | (controller: BG.charts.Controller) => void
Parameters
- type: Type
- listener: Callback
Returns this
Description
remove a listener from the listener array for the specified event.

Inherited from EventEmitter.removeListener

setMaxListeners

setMaxListeners(maxListeners: number): this
Parameters
- maxListeners: number
Returns this
Description
by default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default which helps finding memory leaks. Obviously not all Emitters should be limited to 10. This function allows that limit to be increased. Set to zero for unlimited.

Inherited from EventEmitter.setMaxListeners

`Static`guard

guard(cb: Function): void
Parameters
- cb: Function
Returns void
Description
set custom error handler for event listeners

Inherited from EventEmitter.guard

`Static`listenerCount

listenerCount<
    EvType extends BG.events.Events,
    Type extends string | number | symbol,
>(
    emitter: EventEmitter<EvType>,
    type: Type,
): number
Type Parameters
- EvType extends BG.events.Events
- Type extends string | number | symbol
Parameters
- emitter: EventEmitter<EvType>
- type: Type
Returns number
Description
returns number of listeners on specified emitter for specified type

Inherited from EventEmitter.listenerCount

`Static`setDefaultMaxListeners

setDefaultMaxListeners(maxListeners: number): void
Parameters
- maxListeners: number
Returns void
Description
set default amount for limit warning

Inherited from EventEmitter.setDefaultMaxListeners

Class charts

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BG.charts

Properties

ActivityIndicator

Bounds

Chart

ChartSet

Color

Controller

Data

EdgeInsets

EDimension

ELineType

Error

ESpans

Expression

gfx

IDataLoader

Indicator

Layer

layers

LegendEntry

loaders

math

Object

ObjectStyle

options

Point

Profiler

RecoverableError

Scale

setClazz

Type declaration

Parameters

Returns boolean

setLanguageData

Type declaration

Parameters

Returns void

Span

Sparkline

Style

Timestamp

Tool

ToolGenerator

unsetClazz

Type declaration

Parameters

Returns boolean

utils

Methods

addListener

Type Parameters

Parameters

Returns this

Description

emit

Type Parameters

Parameters

Returns boolean

Description

listeners

Type Parameters

Parameters

Returns Callback[]

Description

on

Type Parameters

Parameters

Returns this

Description

once

Type Parameters

`Static`guard

`Static`listenerCount

`Static`setDefaultMaxListeners