IChangeInsightWidgetInsightPayload
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Payload of the IChangeInsightWidgetInsight command.
export interface IChangeInsightWidgetInsightPayload
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| (BETA) Reference to the new insight to use inside the widget. | ||
| (BETA) Reference to Insight Widget whose insight to change. | ||
| (BETA) (Optional) Specify new visualization properties to use for the insight. If none specified, the properties already included in the widget will be used. |
Property details
IChangeInsightWidgetInsightPayload.insightRefpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Reference to the new insight to use inside the widget.
readonly insightRef: ObjRef;
IChangeInsightWidgetInsightPayload.refpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Reference to Insight Widget whose insight to change.
readonly ref: ObjRef;
IChangeInsightWidgetInsightPayload.visualizationPropertiespropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Specify new visualization properties to use for the insight. If none specified, the properties already included in the widget will be used.
readonly visualizationProperties?: VisualizationProperties;
Remarks
Note: if you don’t want to use any custom visualization properties for the new insight, then pass empty object.