Interface: ChartImageSupplier
Defined in: src/sdk/charts/ChartImageSupplier.ts:47
A supplier of chart images via image URLs.
Properties
image
readonly
image:Subscribable
<ChartImage
>
Defined in: src/sdk/charts/ChartImageSupplier.ts:49
The current supplied chart image.
Methods
destroy()
destroy():
void
Defined in: src/sdk/charts/ChartImageSupplier.ts:61
Destroys this supplier.
Returns
void
showChartImage()
showChartImage(
chartUrl
):void
Defined in: src/sdk/charts/ChartImageSupplier.ts:56
Updates this supplier to show a new chart image.
Parameters
Parameter | Type | Description |
---|---|---|
chartUrl | string | The URL of the chart page for which to show an image. The URL should be sourced from a valid ChartPage record. Specifying the empty string will clear the requested chart image. |
Returns
void