IChangeInsightWidgetDescriptionPayload
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Payload of the IChangeInsightWidgetDescription command.
export interface IChangeInsightWidgetDescriptionPayload
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| (BETA) Description to use for the Insight widget. Contents of the provided description will be used as-is and will be used to replace the current description values. | ||
| (BETA) Reference to Insight Widget whose description to change. |
Property details
IChangeInsightWidgetDescriptionPayload.descriptionpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Description to use for the Insight widget. Contents of the provided description will be used as-is and will be used to replace the current description values.
readonly description: IWidgetDescription;
IChangeInsightWidgetDescriptionPayload.refpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Reference to Insight Widget whose description to change.
readonly ref: ObjRef;