enableInsightWidgetDateFilter()
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Creates the ChangeInsightWidgetFilterSettings command for IFilterOpEnableDateFilter operation.
Dispatching this command will result in change of Insight widget’s date filter setting. The date filtering will be enabled and the provided date data set will be used for date-filtering widget’s insight.
export declare function enableInsightWidgetDateFilter(ref: ObjRef, dateDataset: ObjRef | "default", correlationId?: string): IChangeInsightWidgetFilterSettings;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | reference of the insight widget to modify | |
dateDataset | ObjRef | “default” | date data set to use for filtering the insight, if “default” is provided, the default date dataset will be resolved and used |
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