IDashboardRichTextWidgetFilterSettingsChangedPayload
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Payload of the IDashboardRichTextWidgetFilterSettingsChanged event.
export interface IDashboardRichTextWidgetFilterSettingsChangedPayload
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| (BETA) (Optional) Date dataset used for date filtering. If undefined, then dashboard’s date filter is not in effect for the widget. | ||
| (BETA) Attribute filters that are ignored for the widget. If empty, then all attribute filters defined for the dashboard are in effect. | ||
| (BETA) (Optional) Date filters with dimension that are ignored for the widget. If empty, then all date filters defined for the dashboard are in effect. | ||
| (BETA) Reference to RichText Widget that was changed. |
Property details
IDashboardRichTextWidgetFilterSettingsChangedPayload.dateDatasetForFilteringpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Date dataset used for date filtering.
If undefined, then dashboard’s date filter is not in effect for the widget.
readonly dateDatasetForFiltering?: ICatalogDateDataset;
IDashboardRichTextWidgetFilterSettingsChangedPayload.ignoredAttributeFilterspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Attribute filters that are ignored for the widget.
If empty, then all attribute filters defined for the dashboard are in effect.
readonly ignoredAttributeFilters: IDashboardAttributeFilter[];
IDashboardRichTextWidgetFilterSettingsChangedPayload.ignoredDateFilterspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Date filters with dimension that are ignored for the widget.
If empty, then all date filters defined for the dashboard are in effect.
readonly ignoredDateFilters?: IDashboardDateFilter[];
IDashboardRichTextWidgetFilterSettingsChangedPayload.refpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Reference to RichText Widget that was changed.
readonly ref: ObjRef;