v1.DashboardTextFilter1
A dashboard text filter
export interface DashboardTextFilter1
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
boolean | (Optional) | ||
“is” | “isNot” | |||
(Optional) | |||
string[] | (Optional) An id of the attributes, labels, facts or metrics to validate the filter by | ||
“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. | ||
(Optional) An ids of the parent local attribute, text, or date 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” | |||
AttributeIdentifier4 | LabelIdentifier4 | ComputedAttributeIdentifier4 | Attribute or label to use in this filter. | ||
(string | null)[] |
Property details
v1.DashboardTextFilter1.case_sensitiveproperty
case_sensitive?: boolean;
v1.DashboardTextFilter1.conditionproperty
condition: "is" | "isNot";
v1.DashboardTextFilter1.display_asproperty
display_as?: DisplayAsLabelIdentifier2;
v1.DashboardTextFilter1.metric_filtersproperty
An id of the attributes, labels, facts or metrics to validate the filter by
metric_filters?: string[];
v1.DashboardTextFilter1.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.DashboardTextFilter1.parentsproperty
An ids of the parent local attribute, text, or date filter
parents?: (LocalAttributeFilter2 | LocalDateFilter2)[];
v1.DashboardTextFilter1.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.DashboardTextFilter1.titleproperty
Optional title of the filter
title?: string;
v1.DashboardTextFilter1.typeproperty
type: "text_filter";
v1.DashboardTextFilter1.usingproperty
Attribute or label to use in this filter.
using: AttributeIdentifier4 | LabelIdentifier4 | ComputedAttributeIdentifier4;
v1.DashboardTextFilter1.valuesproperty
values: (string | null)[];