Skip to main content

Interface: IWatermarkApi

Charting Library.IWatermarkApi

An API object used to change the settings of the watermark.

Methods​

color​

▸ color(): IWatchedValue<string>

Object that can be used to read/set/watch the color of the watermark text.

Returns​

IWatchedValue<string>

customVisibility​

▸ customVisibility(): IWatchedValue<boolean>

Object that can be used to read/set/watch the visibility of the watermark provider by WatermarkContentProvider.

Returns​

IWatchedValue<boolean>

descriptionVisibility​

▸ descriptionVisibility(): IWatchedValue<boolean>

Object that can be used to read/set/watch the visibility of the watermark's description part.

Returns​

IWatchedValue<boolean>

intervalVisibility​

▸ intervalVisibility(): IWatchedValue<boolean>

Object that can be used to read/set/watch the visibility of the watermark's interval part.

Returns​

IWatchedValue<boolean>

provider​

▸ provider(): IWatchedValueReadonly<WatermarkContentProvider>

Returns the current watermark content provider.

Returns​

IWatchedValueReadonly<WatermarkContentProvider>

setContentProvider​

▸ setContentProvider(provider): void

Set a custom content provider for the watermark content. Set any part visible to turn custom watermark visibility on.

Parameters​

NameTypeDescription
providerWatermarkContentProviderCustom watermark content provider, use null if you would like to revert back to the default content for the watermark.

Returns​

void

tickerVisibility​

▸ tickerVisibility(): IWatchedValue<boolean>

Object that can be used to read/set/watch the visibility of the watermark's ticker part.

Returns​

IWatchedValue<boolean>

visibility​

▸ visibility(): IWatchedValue<boolean>

Object that can be used to read/set/watch the visibility of the watermark.

Returns​

IWatchedValue<boolean>

Deprecated

use ticker/resolution/description visibility instead