IChangeKpiWidgetConfigurationPayload
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Payload of the IChangeKpiWidgetConfiguration command.
export interface IChangeKpiWidgetConfigurationPayload
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| IKpiWidgetConfiguration | undefined | (BETA) Configuration to use for the kpi that is rendered by the widget. These will replace the existing configuration. To clear any widget-level configuration currently in effect for the widget, set the configuration to | |
| (BETA) Reference to Kpi Widget whose configuration to change. |
Property details
IChangeKpiWidgetConfigurationPayload.configpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Configuration to use for the kpi that is rendered by the widget.
These will replace the existing configuration. To clear any widget-level configuration currently in effect for the widget, set the configuration to undefined.
readonly config: IKpiWidgetConfiguration | undefined;
IChangeKpiWidgetConfigurationPayload.refpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Reference to Kpi Widget whose configuration to change.
readonly ref: ObjRef;