v1.DashboardTextFilter2
A dashboard text filter
export interface DashboardTextFilter2
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
boolean | (Optional) | ||
“contains” | “doesNotContain” | “startsWith” | “doesNotStartWith” | “endsWith” | “doesNotEndWith” | |||
(Optional) | |||
“readonly” | “hidden” | “active” | (Optional) Setting filter mode to readonly will disable the filter. Setting it to hidden will hide the filter from the dashboard. Setting it to active will enable the filter. | ||
“list” | “text” | “listOrText” | (Optional) Controls which filter presentation types are available to the user in View mode. ’list’ means only elements/list selection, ’text’ means only text-based filtering, ’listOrText’ means both types are available. | ||
string | (Optional) Optional title of the filter | ||
“text_filter” | |||
AttributeIdentifier5 | LabelIdentifier5 | ComputedAttributeIdentifier5 | Attribute or label to use in this filter. | ||
string |
Property details
v1.DashboardTextFilter2.case_sensitiveproperty
case_sensitive?: boolean;
v1.DashboardTextFilter2.conditionproperty
condition: "contains" | "doesNotContain" | "startsWith" | "doesNotStartWith" | "endsWith" | "doesNotEndWith";
v1.DashboardTextFilter2.display_asproperty
display_as?: DisplayAsLabelIdentifier3;
v1.DashboardTextFilter2.modeproperty
Setting filter mode to readonly will disable the filter. Setting it to hidden will hide the filter from the dashboard. Setting it to active will enable the filter.
mode?: "readonly" | "hidden" | "active";
v1.DashboardTextFilter2.selection_typeproperty
Controls which filter presentation types are available to the user in View mode. ’list’ means only elements/list selection, ’text’ means only text-based filtering, ’listOrText’ means both types are available.
selection_type?: "list" | "text" | "listOrText";
v1.DashboardTextFilter2.titleproperty
Optional title of the filter
title?: string;
v1.DashboardTextFilter2.typeproperty
type: "text_filter";
v1.DashboardTextFilter2.usingproperty
Attribute or label to use in this filter.
using: AttributeIdentifier5 | LabelIdentifier5 | ComputedAttributeIdentifier5;
v1.DashboardTextFilter2.valueproperty
value: string;