IAddTextAttributeFilterPayload
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Payload of the IAddTextAttributeFilter command.
export interface IAddTextAttributeFilterPayload
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| (BETA) The text attribute filter to add (arbitrary or match). | ||
| number | (BETA) Index among the attribute filters at which the new filter should be placed. Index of -1 adds the filter at the end. | |
| (BETA) (Optional) Specify the visibility mode of the attribute filter. |
Property details
IAddTextAttributeFilterPayload.filterpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The text attribute filter to add (arbitrary or match).
readonly filter: DashboardTextAttributeFilter;
IAddTextAttributeFilterPayload.indexpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Index among the attribute filters at which the new filter should be placed. Index of -1 adds the filter at the end.
readonly index: number;
IAddTextAttributeFilterPayload.modepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Specify the visibility mode of the attribute filter.
readonly mode?: DashboardAttributeFilterConfigMode;