Skip to main content

Subscription

type Subscription = object;

A single subscription passed to PanelExtensionContext.subscribe.

Properties​

topic​

topic: string;

convertTo?​

optional convertTo: string;

If a topic has additional schema names, specifying a schema name will convert messages on that topic to the convertTo schema using a registered message converter. MessageEvents for the subscription will contain the converted message and an originalMessageEvent field with the original message event.

preload?​

optional preload: boolean;

Setting preload to true hints to the data source that it should attempt to load all available messages for the topic. The default behavior is to only load messages for the current frame.

Only topics with preload: true are available in the allFrames render state.

Deprecated​

Please use PanelExtensionContext.subscribeMessageRange instead.