Class Alerts

Dynamically place AlertTools in the chart

Hierarchy (View Summary)

ToolGenerator<
    {
        changeAlert: (
            alert: { comment: string; id: string; value: string },
        ) => void;
        deleteAlert: (alert: Alert) => void;
        manageAlerts: () => void;
        newAlert: () => void;
        showIndicatorAlerts: (instrumentId: number) => void;
    },
>
- Alerts

Constructors

constructor

new Alerts(tArgs: ToolGeneratorTArgs): Alerts
Parameters
- tArgs: ToolGeneratorTArgs
Returns Alerts
Overrides ToolGenerator.constructor

Properties

`Optional` `Readonly`events

events?: {
    changeAlert: (
        alert: { comment: string; id: string; value: string },
    ) => void;
    deleteAlert: (alert: Alert) => void;
    manageAlerts: () => void;
    newAlert: () => void;
    showIndicatorAlerts: (instrumentId: number) => void;
} & ToolGenerator_Events & Object_Events

Type Declaration

changeAlert: (alert: { comment: string; id: string; value: string }) => void
emits alert id of the alert which is to be changed, and the new value and comment
deleteAlert: (alert: Alert) => void
emits alert which is to be deleted
manageAlerts: () => void
triggered by the manageAlerts button, which should open the alerts list
newAlert: () => void
emits when a new alert should be created
showIndicatorAlerts: (instrumentId: number) => void
triggered by the 'inda' button, which should open the indicator alerts list

Description

Phantom data for type inference

`Optional`optionGroups

optionGroups?: ObjectOptionGroup[]

`Protected`options

options: { [key: string]: any }

`Static`options

options: {
    inda: {
        flags: ObjectEOptionFlags;
        name: string;
        type: string;
        _set(this: Alerts): void;
    };
    manageAlerts: {
        flags: ObjectEOptionFlags;
        name: string;
        type: string;
        _set(this: Alerts): void;
    };
    new: {
        flags: number;
        name: string;
        type: string;
        _set(this: Alerts): void;
    };
}

Methods

addListener

addListener<
    Type extends
        | "deleteAlert"
        | "changeAlert"
        | "newAlert"
        | "showIndicatorAlerts"
        | "manageAlerts"
        | "attrChanged"
        | "optionChanged"
        | "stateChanged"
        | "optionsModified"
        | "moveTool"
        | "removeTool"
        | "addTool"
        | "newInput"
        | "inputUpdated"
        | "selfDestruct",
    Callback extends
        | ((alert: Alert) => void)
        | ((alert: { comment: string; id: string; value: string }) => void)
        | (() => void)
        | ((instrumentId: number) => void)
        | (() => void)
        | (
            (
                optionName: string,
                attributeName: string,
                oldValue: any,
                newValue: any,
            ) => void
        )
        | ((optionName: string, oldValue?: any, newValue?: any) => void)
        | ((state: ObjectState, flags: ObjectStateEFlags) => void)
        | () => void & () => void
        | (
            (
                tool: Tool,
                parent:
                    | undefined
                    | null
                    | Tool<Record<string, unknown>, Record<string, (...args: any) => void>>,
                index: number,
            ) => void
        )
        | ((tool: Tool) => void)
        | (
            (
                tool: Tool,
                parent?:
                    | null
                    | Tool<Record<string, unknown>, Record<string, (...args: any) => void>>,
                index?: number,
                select?: boolean,
            ) => void
        )
        | ((value: string) => void)
        | ((input: ToolGeneratorTInput) => void)
        | (() => void),
>(
    type: Type,
    listener: Callback,
): this
Type Parameters
- Type extends
      | "deleteAlert"
      | "changeAlert"
      | "newAlert"
      | "showIndicatorAlerts"
      | "manageAlerts"
      | "attrChanged"
      | "optionChanged"
      | "stateChanged"
      | "optionsModified"
      | "moveTool"
      | "removeTool"
      | "addTool"
      | "newInput"
      | "inputUpdated"
      | "selfDestruct"
- Callback extends
      | ((alert: Alert) => void)
      | ((alert: { comment: string; id: string; value: string }) => void)
      | (() => void)
      | ((instrumentId: number) => void)
      | (() => void)
      | (
          (
              optionName: string,
              attributeName: string,
              oldValue: any,
              newValue: any,
          ) => void
      )
      | ((optionName: string, oldValue?: any, newValue?: any) => void)
      | ((state: ObjectState, flags: ObjectStateEFlags) => void)
      | () => void & () => void
      | (
          (
              tool: Tool,
              parent:
                  | undefined
                  | null
                  | Tool<Record<string, unknown>, Record<string, (...args: any) => void>>,
              index: number,
          ) => void
      )
      | ((tool: Tool) => void)
      | (
          (
              tool: Tool,
              parent?:
                  | null
                  | Tool<Record<string, unknown>, Record<string, (...args: any) => void>>,
              index?: number,
              select?: boolean,
          ) => void
      )
      | ((value: string) => void)
      | ((input: ToolGeneratorTInput) => void)
      | (() => 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 ToolGenerator.addListener

attr

attr(this: ChartbreakerObject, s: string, a: string, v?: any): any
returns or sets the attribute of an option this function should be used with care - modifications of internal properties might break stuff!
Parameters
- this: ChartbreakerObject
- s: string
- a: string
- Optionalv: any
Returns any
Inherited from ToolGenerator.attr

deserialize

deserialize(state: { [key: string]: any }, asTemplate?: boolean): void
Parameters
- state: { [key: string]: any }
- OptionalasTemplate: boolean
Returns void
Overridable
Inherited from ToolGenerator.deserialize

didUpdateOptions

didUpdateOptions(this: ChartbreakerObject): void
must be called after willUpdateOptions once all actions that might potentially changed values of any options are done

IMPORTANT: methods must be called in balance; e.g. for each call to willUpdateOptions, you must call didUpdateOptions exactly once.
Parameters
- this: ChartbreakerObject
Returns void
Inherited from ToolGenerator.didUpdateOptions

emit

emit<
    Type extends
        | "deleteAlert"
        | "changeAlert"
        | "newAlert"
        | "showIndicatorAlerts"
        | "manageAlerts"
        | "attrChanged"
        | "optionChanged"
        | "stateChanged"
        | "optionsModified"
        | "moveTool"
        | "removeTool"
        | "addTool"
        | "newInput"
        | "inputUpdated"
        | "selfDestruct",
    Callback extends
        | ((alert: Alert) => void)
        | ((alert: { comment: string; id: string; value: string }) => void)
        | (() => void)
        | ((instrumentId: number) => void)
        | (() => void)
        | (
            (
                optionName: string,
                attributeName: string,
                oldValue: any,
                newValue: any,
            ) => void
        )
        | ((optionName: string, oldValue?: any, newValue?: any) => void)
        | ((state: ObjectState, flags: ObjectStateEFlags) => void)
        | () => void & () => void
        | (
            (
                tool: Tool,
                parent:
                    | undefined
                    | null
                    | Tool<Record<string, unknown>, Record<string, (...args: any) => void>>,
                index: number,
            ) => void
        )
        | ((tool: Tool) => void)
        | (
            (
                tool: Tool,
                parent?:
                    | null
                    | Tool<Record<string, unknown>, Record<string, (...args: any) => void>>,
                index?: number,
                select?: boolean,
            ) => void
        )
        | ((value: string) => void)
        | ((input: ToolGeneratorTInput) => void)
        | (() => void),
>(
    type: Type,
    ...params: Parameters<Callback>,
): boolean
Type Parameters
- Type extends
      | "deleteAlert"
      | "changeAlert"
      | "newAlert"
      | "showIndicatorAlerts"
      | "manageAlerts"
      | "attrChanged"
      | "optionChanged"
      | "stateChanged"
      | "optionsModified"
      | "moveTool"
      | "removeTool"
      | "addTool"
      | "newInput"
      | "inputUpdated"
      | "selfDestruct"
- Callback extends
      | ((alert: Alert) => void)
      | ((alert: { comment: string; id: string; value: string }) => void)
      | (() => void)
      | ((instrumentId: number) => void)
      | (() => void)
      | (
          (
              optionName: string,
              attributeName: string,
              oldValue: any,
              newValue: any,
          ) => void
      )
      | ((optionName: string, oldValue?: any, newValue?: any) => void)
      | ((state: ObjectState, flags: ObjectStateEFlags) => void)
      | () => void & () => void
      | (
          (
              tool: Tool,
              parent:
                  | undefined
                  | null
                  | Tool<Record<string, unknown>, Record<string, (...args: any) => void>>,
              index: number,
          ) => void
      )
      | ((tool: Tool) => void)
      | (
          (
              tool: Tool,
              parent?:
                  | null
                  | Tool<Record<string, unknown>, Record<string, (...args: any) => void>>,
              index?: number,
              select?: boolean,
          ) => void
      )
      | ((value: string) => void)
      | ((input: ToolGeneratorTInput) => void)
      | (() => void)
Parameters
- type: Type
- ...params: Parameters<Callback>
Returns boolean
Description
execute each of the listeners in order with the supplied parameters.

Inherited from ToolGenerator.emit

flat

flat(
    readWriteOnly?: boolean,
    modifiedOnly?: boolean,
    nonEphemeralOnly?: boolean,
): { [key: string]: any }
returns a flat representation of all available config options in the form of a key-value-object optionally only values that are not read-only can be returned

IMPORTANT: this method will always convert I18NStrings to strings, so for displaying strings in a UI use individual calls to Object:get instead
Parameters
- OptionalreadWriteOnly: boolean
  default: true
- OptionalmodifiedOnly: boolean
  default: true
- OptionalnonEphemeralOnly: boolean
  default: true
Returns { [key: string]: any }
Inherited from ToolGenerator.flat

get

get(s?: string, flags?: number): any
returns the value of the requested option, or a list of all available config options if no parameter is specified.
Parameters
- Optionals: string
- Optionalflags: number
Returns any
Inherited from ToolGenerator.get

getCurrency

getCurrency(): undefined | string
returns the currency of the chart Can be used by clients to determine which alerts to display or to correctly calculate the value of the alert when using an exchange rate

Returns undefined | string

getData

getData(): null | Data
returns the data object

Returns null | Data
Inherited from ToolGenerator.getData

getExchangeId

getExchangeId(): undefined | number
returns the exchangeId of the chart Can be used by clients to determine which alerts to display

Returns undefined | number

getGroups

getGroups(): ObjectOptionGroup[]
returns the categorization of the objects options can be used for displaying a more structured user interface

Returns ObjectOptionGroup[]
Inherited from ToolGenerator.getGroups

getInput

getInput(): null | ToolGeneratorTInput
returns the input object

Returns null | ToolGeneratorTInput
Inherited from ToolGenerator.getInput

getInputs

getInputs(): string[]
returns the used inputs

Returns string[]
Inherited from ToolGenerator.getInputs

getInstrumentId

getInstrumentId(): undefined | number
returns the instrumentId of the chart Can be used by clients to determine which alerts to display

Returns undefined | number

getLegendEntryChunks

getLegendEntryChunks(pickerIndex: number): LegendEntryChunk[]
Creates list of legend entry chunks to be displayed in the legend for the index pickerIndex
Parameters
- pickerIndex: number
Returns LegendEntryChunk[]
Inherited from ToolGenerator.getLegendEntryChunks

getPrecision

getPrecision(): number
returns the precision of the chart. Can be used by clients to determine how many decimals are needed

Returns number

getState

getState(): ObjectState
returns the objects current state

Returns ObjectState
Inherited from ToolGenerator.getState

getSupplementaryBuffers

getSupplementaryBuffers(
    identifier: string,
    span: ESpans,
): Promise<
    Result<
        { buffers: ToolGeneratorTSupplementaryBuffers },
        { err: ChartbreakerError },
    >,
>
Parameters
- identifier: string
- span: ESpans
Returns Promise<
    Result<
        { buffers: ToolGeneratorTSupplementaryBuffers },
        { err: ChartbreakerError },
    >,
>
Inherited from ToolGenerator.getSupplementaryBuffers

getTranslator

getTranslator(): Translator
return a Translator instance

Returns Translator
Inherited from ToolGenerator.getTranslator

handleOptionDependencyVisibility

handleOptionDependencyVisibility(
optionDependencies: OptionExposureRelations,
): void
Automatically toggles the EXPOSED flag on dependent options when a 'parent' option changes value.

For each entry in optionDependencies, whenever the parent option emits an optionChanged event, its dependents (listed in dependentNames) will be exposed (flag added) if the new value === exposeWhen, or hidden (flag removed) otherwise.
Parameters
- optionDependencies: OptionExposureRelations
  Map where:
  
  key = name of the 'parent' option to watch
  
  value = an object with:
  
  exposeWhen: the boolean that triggers exposing the dependents or a function with the newValue for custom validation
  
  dependentNames: array of dependent option names whose EXPOSED flag will be toggled
Returns void
Example
```
class Test extends ChartbreakerObject {
  constructor() {
    super();
    this.registerOptionDependencyVisibility(new Map([
      ['showLine', { exposeWhen: true,   dependentNames: ['lineColor', 'lineStyle'] }],
      ['advancedMode', { exposeWhen: false, dependentNames: ['simpleModeOnlyOption'] }],
          ['description'], { exposeWhen: (text) => !!text.length, ['fontSize', 'fontColor']}
    ]));
  }
}
```
Inherited from ToolGenerator.handleOptionDependencyVisibility

listeners

listeners<
    Type extends
        | "deleteAlert"
        | "changeAlert"
        | "newAlert"
        | "showIndicatorAlerts"
        | "manageAlerts"
        | "attrChanged"
        | "optionChanged"
        | "stateChanged"
        | "optionsModified"
        | "moveTool"
        | "removeTool"
        | "addTool"
        | "newInput"
        | "inputUpdated"
        | "selfDestruct",
    Callback extends
        | ((alert: Alert) => void)
        | ((alert: { comment: string; id: string; value: string }) => void)
        | (() => void)
        | ((instrumentId: number) => void)
        | (() => void)
        | (
            (
                optionName: string,
                attributeName: string,
                oldValue: any,
                newValue: any,
            ) => void
        )
        | ((optionName: string, oldValue?: any, newValue?: any) => void)
        | ((state: ObjectState, flags: ObjectStateEFlags) => void)
        | () => void & () => void
        | (
            (
                tool: Tool,
                parent:
                    | undefined
                    | null
                    | Tool<Record<string, unknown>, Record<string, (...args: any) => void>>,
                index: number,
            ) => void
        )
        | ((tool: Tool) => void)
        | (
            (
                tool: Tool,
                parent?:
                    | null
                    | Tool<Record<string, unknown>, Record<string, (...args: any) => void>>,
                index?: number,
                select?: boolean,
            ) => void
        )
        | ((value: string) => void)
        | ((input: ToolGeneratorTInput) => void)
        | (() => void),
>(
    type: Type,
): Callback[]
Type Parameters
- Type extends
      | "deleteAlert"
      | "changeAlert"
      | "newAlert"
      | "showIndicatorAlerts"
      | "manageAlerts"
      | "attrChanged"
      | "optionChanged"
      | "stateChanged"
      | "optionsModified"
      | "moveTool"
      | "removeTool"
      | "addTool"
      | "newInput"
      | "inputUpdated"
      | "selfDestruct"
- Callback extends
      | ((alert: Alert) => void)
      | ((alert: { comment: string; id: string; value: string }) => void)
      | (() => void)
      | ((instrumentId: number) => void)
      | (() => void)
      | (
          (
              optionName: string,
              attributeName: string,
              oldValue: any,
              newValue: any,
          ) => void
      )
      | ((optionName: string, oldValue?: any, newValue?: any) => void)
      | ((state: ObjectState, flags: ObjectStateEFlags) => void)
      | () => void & () => void
      | (
          (
              tool: Tool,
              parent:
                  | undefined
                  | null
                  | Tool<Record<string, unknown>, Record<string, (...args: any) => void>>,
              index: number,
          ) => void
      )
      | ((tool: Tool) => void)
      | (
          (
              tool: Tool,
              parent?:
                  | null
                  | Tool<Record<string, unknown>, Record<string, (...args: any) => void>>,
              index?: number,
              select?: boolean,
          ) => void
      )
      | ((value: string) => void)
      | ((input: ToolGeneratorTInput) => void)
      | (() => void)
Parameters
- type: Type
Returns Callback[]
Description
returns an array of listeners for the specified event.

Inherited from ToolGenerator.listeners

on

on<
    Type extends
        | "deleteAlert"
        | "changeAlert"
        | "newAlert"
        | "showIndicatorAlerts"
        | "manageAlerts"
        | "attrChanged"
        | "optionChanged"
        | "stateChanged"
        | "optionsModified"
        | "moveTool"
        | "removeTool"
        | "addTool"
        | "newInput"
        | "inputUpdated"
        | "selfDestruct",
    Callback extends
        | ((alert: Alert) => void)
        | ((alert: { comment: string; id: string; value: string }) => void)
        | (() => void)
        | ((instrumentId: number) => void)
        | (() => void)
        | (
            (
                optionName: string,
                attributeName: string,
                oldValue: any,
                newValue: any,
            ) => void
        )
        | ((optionName: string, oldValue?: any, newValue?: any) => void)
        | ((state: ObjectState, flags: ObjectStateEFlags) => void)
        | () => void & () => void
        | (
            (
                tool: Tool,
                parent:
                    | undefined
                    | null
                    | Tool<Record<string, unknown>, Record<string, (...args: any) => void>>,
                index: number,
            ) => void
        )
        | ((tool: Tool) => void)
        | (
            (
                tool: Tool,
                parent?:
                    | null
                    | Tool<Record<string, unknown>, Record<string, (...args: any) => void>>,
                index?: number,
                select?: boolean,
            ) => void
        )
        | ((value: string) => void)
        | ((input: ToolGeneratorTInput) => void)
        | (() => void),
>(
    type: Type,
    listener: Callback,
): this
Type Parameters
- Type extends
      | "deleteAlert"
      | "changeAlert"
      | "newAlert"
      | "showIndicatorAlerts"
      | "manageAlerts"
      | "attrChanged"
      | "optionChanged"
      | "stateChanged"
      | "optionsModified"
      | "moveTool"
      | "removeTool"
      | "addTool"
      | "newInput"
      | "inputUpdated"
      | "selfDestruct"
- Callback extends
      | ((alert: Alert) => void)
      | ((alert: { comment: string; id: string; value: string }) => void)
      | (() => void)
      | ((instrumentId: number) => void)
      | (() => void)
      | (
          (
              optionName: string,
              attributeName: string,
              oldValue: any,
              newValue: any,
          ) => void
      )
      | ((optionName: string, oldValue?: any, newValue?: any) => void)
      | ((state: ObjectState, flags: ObjectStateEFlags) => void)
      | () => void & () => void
      | (
          (
              tool: Tool,
              parent:
                  | undefined
                  | null
                  | Tool<Record<string, unknown>, Record<string, (...args: any) => void>>,
              index: number,
          ) => void
      )
      | ((tool: Tool) => void)
      | (
          (
              tool: Tool,
              parent?:
                  | null
                  | Tool<Record<string, unknown>, Record<string, (...args: any) => void>>,
              index?: number,
              select?: boolean,
          ) => void
      )
      | ((value: string) => void)
      | ((input: ToolGeneratorTInput) => void)
      | (() => void)
Parameters
- type: Type
- listener: Callback
Returns this
Description
alias for addListener

Inherited from ToolGenerator.on

once

once<
    Type extends
        | "deleteAlert"
        | "changeAlert"
        | "newAlert"
        | "showIndicatorAlerts"
        | "manageAlerts"
        | "attrChanged"
        | "optionChanged"
        | "stateChanged"
        | "optionsModified"
        | "moveTool"
        | "removeTool"
        | "addTool"
        | "newInput"
        | "inputUpdated"
        | "selfDestruct",
    Callback extends
        | ((alert: Alert) => void)
        | ((alert: { comment: string; id: string; value: string }) => void)
        | (() => void)
        | ((instrumentId: number) => void)
        | (() => void)
        | (
            (
                optionName: string,
                attributeName: string,
                oldValue: any,
                newValue: any,
            ) => void
        )
        | ((optionName: string, oldValue?: any, newValue?: any) => void)
        | ((state: ObjectState, flags: ObjectStateEFlags) => void)
        | () => void & () => void
        | (
            (
                tool: Tool,
                parent:
                    | undefined
                    | null
                    | Tool<Record<string, unknown>, Record<string, (...args: any) => void>>,
                index: number,
            ) => void
        )
        | ((tool: Tool) => void)
        | (
            (
                tool: Tool,
                parent?:
                    | null
                    | Tool<Record<string, unknown>, Record<string, (...args: any) => void>>,
                index?: number,
                select?: boolean,
            ) => void
        )
        | ((value: string) => void)
        | ((input: ToolGeneratorTInput) => void)
        | (() => void),
>(
    type: Type,
    listener: Callback,
): this
Type Parameters
- Type extends
      | "deleteAlert"
      | "changeAlert"
      | "newAlert"
      | "showIndicatorAlerts"
      | "manageAlerts"
      | "attrChanged"
      | "optionChanged"
      | "stateChanged"
      | "optionsModified"
      | "moveTool"
      | "removeTool"
      | "addTool"
      | "newInput"
      | "inputUpdated"
      | "selfDestruct"
- Callback extends
      | ((alert: Alert) => void)
      | ((alert: { comment: string; id: string; value: string }) => void)
      | (() => void)
      | ((instrumentId: number) => void)
      | (() => void)
      | (
          (
              optionName: string,
              attributeName: string,
              oldValue: any,
              newValue: any,
          ) => void
      )
      | ((optionName: string, oldValue?: any, newValue?: any) => void)
      | ((state: ObjectState, flags: ObjectStateEFlags) => void)
      | () => void & () => void
      | (
          (
              tool: Tool,
              parent:
                  | undefined
                  | null
                  | Tool<Record<string, unknown>, Record<string, (...args: any) => void>>,
              index: number,
          ) => void
      )
      | ((tool: Tool) => void)
      | (
          (
              tool: Tool,
              parent?:
                  | null
                  | Tool<Record<string, unknown>, Record<string, (...args: any) => void>>,
              index?: number,
              select?: boolean,
          ) => void
      )
      | ((value: string) => void)
      | ((input: ToolGeneratorTInput) => void)
      | (() => 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 ToolGenerator.once

onDestroy

onDestroy(): void
called when an object will be permanently discarded no other methods will be called on it ever again after this point

IMPORTANT: this method should ONLY be called directly on the Controller all other objects will be destroyed automatically by the implementation

Returns void
Overridable
Inherited from ToolGenerator.onDestroy

onRecover

onRecover(): void
life cycle method; called when the object should recover from an error and resume normal operation

this will only be called if the object encountered a RecoverableChartbreakerError, and is always triggered by a manual user interaction

always called between start and stop

Returns void
Overridable
Inherited from ToolGenerator.onRecover

onStart

onStart(): void
life cycle method; called when the object should start normal operation at this point is is already completely initialized

Returns void
Overridable
Overrides ToolGenerator.onStart

onStop

onStop(): void
life cycle method; called when the object should stop normal operation if objects have any pending subscriptions/requests, they should all be stopped here

the object is also responsible for clearing the loading flag from it's state if it is currently active failing to do so will trigger a fatal error

object might be started again afterwards (start) or destroyed (destroy) this is not known yet at this point

called after start or restart

Returns void
Overridable
Overrides ToolGenerator.onStop

recover

recover(): boolean
can be called to tell the object that it should recover from an error and resume will have no effect if no retryable error is currently associated with the object

Returns boolean
Inherited from ToolGenerator.recover

removeAlert

removeAlert(alert: Pick<Alert, "id">): void
removes an alert from the generator and stops displaying it in the chart.
Parameters
- alert: Pick<Alert, "id">
Returns void

removeAllListeners

removeAllListeners<
    Type extends
        | "deleteAlert"
        | "changeAlert"
        | "newAlert"
        | "showIndicatorAlerts"
        | "manageAlerts"
        | "attrChanged"
        | "optionChanged"
        | "stateChanged"
        | "optionsModified"
        | "moveTool"
        | "removeTool"
        | "addTool"
        | "newInput"
        | "inputUpdated"
        | "selfDestruct",
>(
    type?: Type,
): this
Type Parameters
- Type extends
      | "deleteAlert"
      | "changeAlert"
      | "newAlert"
      | "showIndicatorAlerts"
      | "manageAlerts"
      | "attrChanged"
      | "optionChanged"
      | "stateChanged"
      | "optionsModified"
      | "moveTool"
      | "removeTool"
      | "addTool"
      | "newInput"
      | "inputUpdated"
      | "selfDestruct"
Parameters
- Optionaltype: Type
Returns this
Description
removes all listeners, or those of the specified event.

Inherited from ToolGenerator.removeAllListeners

removeListener

removeListener<
    Type extends
        | "deleteAlert"
        | "changeAlert"
        | "newAlert"
        | "showIndicatorAlerts"
        | "manageAlerts"
        | "attrChanged"
        | "optionChanged"
        | "stateChanged"
        | "optionsModified"
        | "moveTool"
        | "removeTool"
        | "addTool"
        | "newInput"
        | "inputUpdated"
        | "selfDestruct",
    Callback extends
        | ((alert: Alert) => void)
        | ((alert: { comment: string; id: string; value: string }) => void)
        | (() => void)
        | ((instrumentId: number) => void)
        | (() => void)
        | (
            (
                optionName: string,
                attributeName: string,
                oldValue: any,
                newValue: any,
            ) => void
        )
        | ((optionName: string, oldValue?: any, newValue?: any) => void)
        | ((state: ObjectState, flags: ObjectStateEFlags) => void)
        | () => void & () => void
        | (
            (
                tool: Tool,
                parent:
                    | undefined
                    | null
                    | Tool<Record<string, unknown>, Record<string, (...args: any) => void>>,
                index: number,
            ) => void
        )
        | ((tool: Tool) => void)
        | (
            (
                tool: Tool,
                parent?:
                    | null
                    | Tool<Record<string, unknown>, Record<string, (...args: any) => void>>,
                index?: number,
                select?: boolean,
            ) => void
        )
        | ((value: string) => void)
        | ((input: ToolGeneratorTInput) => void)
        | (() => void),
>(
    type: Type,
    listener: Callback,
): this
Type Parameters
- Type extends
      | "deleteAlert"
      | "changeAlert"
      | "newAlert"
      | "showIndicatorAlerts"
      | "manageAlerts"
      | "attrChanged"
      | "optionChanged"
      | "stateChanged"
      | "optionsModified"
      | "moveTool"
      | "removeTool"
      | "addTool"
      | "newInput"
      | "inputUpdated"
      | "selfDestruct"
- Callback extends
      | ((alert: Alert) => void)
      | ((alert: { comment: string; id: string; value: string }) => void)
      | (() => void)
      | ((instrumentId: number) => void)
      | (() => void)
      | (
          (
              optionName: string,
              attributeName: string,
              oldValue: any,
              newValue: any,
          ) => void
      )
      | ((optionName: string, oldValue?: any, newValue?: any) => void)
      | ((state: ObjectState, flags: ObjectStateEFlags) => void)
      | () => void & () => void
      | (
          (
              tool: Tool,
              parent:
                  | undefined
                  | null
                  | Tool<Record<string, unknown>, Record<string, (...args: any) => void>>,
              index: number,
          ) => void
      )
      | ((tool: Tool) => void)
      | (
          (
              tool: Tool,
              parent?:
                  | null
                  | Tool<Record<string, unknown>, Record<string, (...args: any) => void>>,
              index?: number,
              select?: boolean,
          ) => void
      )
      | ((value: string) => void)
      | ((input: ToolGeneratorTInput) => void)
      | (() => void)
Parameters
- type: Type
- listener: Callback
Returns this
Description
remove a listener from the listener array for the specified event.

Inherited from ToolGenerator.removeListener

selfDestruct

selfDestruct(this: ToolGenerator): boolean
Method to be optionally called when the ToolGenerator is no longer in use and should be removed from the chart, e.g. if all the managed tools have been removed by the user or if the generator has become irrelevant. This method will have no effect if the generator is still managing tools. As such, they should first be removed before calling this method.

The return value indicates if the self-destruction was successful.
Parameters
- this: ToolGenerator
Returns boolean
Inherited from ToolGenerator.selfDestruct

serialize

serialize(): {}
Not serializing any of the options, not even the underlying ones from Object

Returns {}
Overrides ToolGenerator.serialize

set

set(
    this: ChartbreakerObject,
    s: null | string | { [key: string]: any },
    v?: any,
    flags?: ObjectEFlags,
): boolean
will set validate and then set the specified option(s) to the provided value(s) after validation

NOTE: if multiple options are used, will return false if at least one value is not valid values are applied individually however, so one option might be set even if the value for another is invalid
Parameters
- this: ChartbreakerObject
- s: null | string | { [key: string]: any }
- Optionalv: any
- Optionalflags: ObjectEFlags
Returns boolean
Inherited from ToolGenerator.set

setAlert

setAlert(alert: Alert): null | AlertsTool
adds an alert to the generator and displays it in the chart at the position of the value.
Parameters
- alert: Alert
Returns null | AlertsTool

setAlerts

setAlerts(alerts: Alert[]): (null | AlertsTool)[]
method for clients to set multiple alerts at once
Parameters
- alerts: Alert[]
Returns (null | AlertsTool)[]

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 ToolGenerator.setMaxListeners

setNumberOfInputs

setNumberOfInputs(
    this: ToolGenerator,
    numInputs: number,
    names?: string | string[],
): boolean
set number of usable inputs; must be at least 1 calling this method resets previously required buffers

the optional second parameter can be used to provide name(s) for the input option(s) Note: number of provided names needs to be identical to requested number of inputs
Parameters
- this: ToolGenerator
- numInputs: number
- Optionalnames: string | string[]
Returns boolean
Inherited from ToolGenerator.setNumberOfInputs

setTypeAndName

setTypeAndName(objType?: string, objName?: string): void
Sets the objName and objType of the Object reverts to the default ones if no arguments are given
Parameters
- OptionalobjType: string
- OptionalobjName: string
Returns void
Inherited from ToolGenerator.setTypeAndName

toString

toString(): string
Returns a string representation of an object.

Returns string
Inherited from ToolGenerator.toString

validate

validate(
    this: ChartbreakerObject,
    s: string | { [key: string]: any },
    v?: any,
    flags?: ObjectEFlags,
): boolean
will set validate value(s) for the specified option(s)

NOTE: if multiple options are used, will return false if at least one value is not valid
Parameters
- this: ChartbreakerObject
- s: string | { [key: string]: any }
- Optionalv: any
- Optionalflags: ObjectEFlags
Returns boolean
Inherited from ToolGenerator.validate

willUpdateOptions

willUpdateOptions(options?: string | string[]): void
when using custom getters/setters (via _get/_set) in options, the values of options can change without .set being called - or there might not even be a setter for readonly options; for example, if the getter simply returns the value of a member variable this variable could be modified directly. In this case, events such as optionChanged would not be fired, and listeners would not be informed about the change.

To account for such cases, the methods willUpdateOptions and didUpdateOptions should be called directly BEFORE and AFTER actions that might potentially change values of options. the correct events will then automatically be triggered when calling didUpdateOptions.

if the options that could change are known, they can be supplied via the optional parameter. This provides a small performance gain in most situations.

IMPORTANT: methods must be called in balance; e.g. for each call to willUpdateOptions, you must call didUpdateOptions exactly once.
Parameters
- Optionaloptions: string | string[]
Returns void
Inherited from ToolGenerator.willUpdateOptions

`Static`getAlternatives

getAlternatives(): {
    identifier: string;
    replace: (
        generator: Record<string, any>,
    ) => { identifier: string; input: any; objType: string; state: any };
}[]
Method for plugins to describe which other plugins they want to replace

Returns {
    identifier: string;
    replace: (
        generator: Record<string, any>,
    ) => { identifier: string; input: any; objType: string; state: any };
}[]
Overrides ToolGenerator.getAlternatives

`Static`guard

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

Inherited from ToolGenerator.guard

`Static`listenerCount

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

Inherited from ToolGenerator.listenerCount

`Static`setDefaultMaxListeners

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

Inherited from ToolGenerator.setDefaultMaxListeners

`Static`visualizeValidity

visualizeValidity(visualize: boolean): void
Enable/disable visualizing the validity of alerts globally
Parameters
- visualize: boolean
Returns void

Class Alerts

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Alerts

Properties

Optional Readonlyevents

Type Declaration

changeAlert: (alert: { comment: string; id: string; value: string }) => void

deleteAlert: (alert: Alert) => void

manageAlerts: () => void

newAlert: () => void

showIndicatorAlerts: (instrumentId: number) => void

Description

OptionaloptionGroups

Protectedoptions

Staticoptions

Methods

addListener

Type Parameters

Parameters

Returns this

Description

attr

Parameters

Returns any

deserialize

Parameters

Returns void

Overridable

didUpdateOptions

Parameters

Returns void

emit

Type Parameters

Parameters

Returns boolean

Description

flat

Parameters

Returns { [key: string]: any }

get

Parameters

Returns any

getCurrency

Returns undefined | string

getData

Returns null | Data

getExchangeId

Returns undefined | number

getGroups

Returns ObjectOptionGroup[]

getInput

Returns null | ToolGeneratorTInput

getInputs

Returns string[]

getInstrumentId

Returns undefined | number

getLegendEntryChunks

Parameters

Returns LegendEntryChunk[]

getPrecision

Returns number

getState

Returns ObjectState

getSupplementaryBuffers

Parameters

Returns Promise< Result< { buffers: ToolGeneratorTSupplementaryBuffers }, { err: ChartbreakerError }, >,>

getTranslator

Returns Translator

handleOptionDependencyVisibility

Parameters

Returns void

Example

listeners

`Optional` `Readonly`events

`Optional`optionGroups

`Protected`options

`Static`options

Returns Promise<
Result<
{ buffers: ToolGeneratorTSupplementaryBuffers },
{ err: ChartbreakerError },
>,
>