Function: getInstance()

> getInstance<TArgs>(tickerId, args, options?): Ticker<TArgs> | undefined

Defined in: src/canvas/tickers/decorators/RegisteredTickers.ts:107

Get a ticker instance by the id.

Type Parameters

TArgs

TArgs extends TickerArgs

Parameters

tickerId

string

The id of the ticker.

args

TArgs

The arguments that you want to pass to the ticker.

options?

canvasElementAliases?

string[]

duration?

number

id?

string

priority?

UPDATE_PRIORITY

Returns

Ticker<TArgs> | undefined

The instance of the ticker