changeInsightWidgetVisProperties()
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Creates the ChangeInsightWidgetVisProperties command. Dispatching this command will result is modification of the visualization properties that are effective for the particular insight widget.
Through visualization properties, you can modify how particular visualization looks and behaves (enable/disable tooltips, legend, change axes, enable zooming).
If you want to clear any widget-level properties, set properties to undefined.
export declare function changeInsightWidgetVisProperties(ref: ObjRef, properties: VisualizationProperties | undefined, correlationId?: string): IChangeInsightWidgetVisProperties;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | reference of the insight widget to modify | |
properties | VisualizationProperties | undefined | new properties to set, undefined to clear any widget level visualization properties |
correlationId | string | (Optional) specify correlation id to use for this command. this will be included in all events that will be emitted during the command processing |
Returns