You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/marketplace/platform-supported-content/modules/data-widgets/datagrid-date-filter.md
+22-22Lines changed: 22 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,11 +16,11 @@ For more information on using filter widgets, see [Data Grid 2](/appstore/module
16
16
17
17
#### Filter Attributes
18
18
19
-
Provides flexibility in how the filter determines which data to filter. **Auto** mode automatically detects filterable attributes from the parent grid when placed in grid columns. **Custom** mode allows manual specification of target datasource and attributes for more complex filtering scenarios including multi-attribute support and cross-entity filtering.
19
+
Provides flexibility in how the filter determines which data to filter. **Auto** mode automatically detects filterable attributes from the parent grid when placed in grid columns. **Custom** mode allows manual specification of target data source and attributes for more complex filtering scenarios including multi-attribute support and cross-entity filtering.
20
20
21
-
#### Datasource to Filter
21
+
#### Data Source to Filter
22
22
23
-
Specifies the target datasource that the filter should operate on when using Custom mode. Creates a direct reference to the specified datasource object, providing access to entity metadata and enabling real-time synchronization with datasource state changes. This property is required when Filter Attributes is set to Custom.
23
+
Specifies the target data source that the filter should operate on when using custom mode. Creates a direct reference to the specified data source object, providing access to entity metadata and enabling real-time synchronization with data source state changes. This property is required when **Filter Attributes** is set to **Custom**.
24
24
25
25
#### Attributes
26
26
@@ -32,29 +32,29 @@ Sets the initial date value that appears in the filter input when the page loads
32
32
33
33
#### Default Start Date
34
34
35
-
When the default filter is set to "Between", this property defines the initial start date for the date range. This value works in conjunction with the Default End Date to establish a default date range when the widget loads.
35
+
When the default filter is set to **Between**, this property defines the initial start date for the date range. This value works in conjunction with the **Default End Date** to establish a default date range when the widget loads.
36
36
37
37
#### Default End Date
38
38
39
-
When the default filter is set to "Between", this property defines the initial end date for the date range. This value works in conjunction with the Default Start Date to establish a default date range when the widget loads.
39
+
When the default filter is set to **Between**, this property defines the initial end date for the date range. This value works in conjunction with the **Default Start Date** to establish a default date range when the widget loads.
40
40
41
41
#### Default Filter
42
42
43
-
Determines the initial filter operation type when the widget loads. Available options include:
43
+
Determines the initial filter operation type when the widget loads. Available options include the following:
44
44
45
-
***Between**: Matches records where the date falls within a specified range (requires both start and end dates)
46
-
***Greater than**: Matches records where the date is after the specified date
47
-
***Greater than or equal**: Matches records where the date is on or after the specified date
48
-
***Equal**: Matches records where the date exactly equals the specified date
49
-
***Not equal**: Matches records where the date does not equal the specified date
50
-
***Smaller than**: Matches records where the date is before the specified date
51
-
***Smaller than or equal**: Matches records where the date is on or before the specified date
52
-
***Empty**: Matches records where the date attribute has no value
53
-
***Not empty**: Matches records where the date attribute has any value
45
+
***Between**: matches records where the date falls within a specified range (requires both start and end dates)
46
+
***Greater than**: matches records where the date is after the specified date
47
+
***Greater than or equal**: matches records where the date is on or after the specified date
48
+
***Equal**: matches records where the date exactly equals the specified date
49
+
***Not equal**: matches records where the date does not equal the specified date
50
+
***Smaller than**: matches records where the date is before the specified date
51
+
***Smaller than or equal**: matches records where the date is on or before the specified date
52
+
***Empty**: matches records where the date attribute has no value
53
+
***Not empty**: matches records where the date attribute has any value
54
54
55
55
#### Placeholder
56
56
57
-
Displays hint text in the input field when no date is selected. Helps users understand the expected date format or provides guidance on date selection. Supports text templates for dynamic content and localization.
57
+
Displays hint text in the input field when no date is selected. It can help users understand the expected date format, or can provide guidance on date selection. Supports text templates for dynamic content and localization.
58
58
59
59
#### Adjustable by User
60
60
@@ -64,32 +64,32 @@ Controls whether users can change the filter operation type. When set to **Yes**
64
64
65
65
#### Saved Attribute
66
66
67
-
Specifies an entity attribute used to store the last filter value for persistence. The attribute must be of type DateTime. When configured, the filter automatically saves its current value to this attribute when changes occur. To restore previously saved values, configure the same attribute as the Default Value.
67
+
Specifies an entity attribute used to store the last filter value for persistence. The attribute must be of type DateTime. When configured, the filter automatically saves its current value to this attribute when changes occur. To restore previously saved values, configure the same attribute as the **Default Value**.
68
68
69
69
#### Saved Start Date Attribute
70
70
71
-
Specifies an entity attribute used to store the start date when using "Between" filter mode. The attribute must be of type DateTime. This works in conjunction with the Saved End Date Attribute to persist date range selections across user sessions.
71
+
Specifies an entity attribute used to store the start date when using the **Between** filter mode. The attribute must be of type DateTime. This works in conjunction with the **Saved End Date Attribute** to persist date range selections across user sessions.
72
72
73
73
#### Saved End Date Attribute
74
74
75
-
Specifies an entity attribute used to store the end date when using "Between" filter mode. The attribute must be of type DateTime. This works in conjunction with the Saved Start Date Attribute to persist date range selections across user sessions.
75
+
Specifies an entity attribute used to store the end date when using **Between** filter mode. The attribute must be of type DateTime. This works in conjunction with the **Saved Start Date Attribute** to persist date range selections across user sessions.
76
76
77
77
### Events
78
78
79
79
#### On Change
80
80
81
-
Defines an action to be executed whenever the filter value or filter type changes. This event is triggered for every user interaction including date selection, changing filter operations, or clearing the filter. Can be used to trigger microflows, nanoflows, or other actions for custom business logic.
81
+
Defines an action to be executed whenever the filter value or filter type changes. This event is triggered for every user interaction including date selection, changing filter operations, or clearing the filter. It can be used to trigger microflows, nanoflows, or other actions for custom business logic.
82
82
83
83
### Accessibility
84
84
85
85
#### Comparison Button Caption
86
86
87
-
Provides an accessible label for the filter type selection button. This label is announced by screen readers when users navigate to the dropdown that shows available filter operations (Between, Greater than, etc.). Essential for users relying on assistive technology to understand the purpose of the button.
87
+
Provides an accessible label for the filter type selection button. This label is announced by screen readers when users navigate to the drop-down menu that shows available filter operations. Employing this correctly is essential for users relying on assistive technology.
88
88
89
89
#### Calendar Button Caption
90
90
91
91
Defines the accessible label for the calendar picker button that opens the date selection interface. Screen readers announce this label when users navigate to the button, helping them understand how to access the date picker functionality.
92
92
93
93
#### Input Caption
94
94
95
-
Defines the accessible label for the date input field. Screen readers announce this label when users focus on the input field. Helps users understand that date input is expected and may include format guidance or context-specific information.
95
+
Defines the accessible label for the date input field. Screen readers announce this label when users focus on the input field. This property users understand that date input is expected, and may include format guidance or context-specific information.
Copy file name to clipboardExpand all lines: content/en/docs/marketplace/platform-supported-content/modules/data-widgets/datagrid-dropdown-filter.md
+25-25Lines changed: 25 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ description: "This document describes the properties of the Dropdown Filter widg
6
6
7
7
## Introduction
8
8
9
-
This guide lists all the properties of the Dropdown Filter widget used with the [Data Grid 2](/appstore/modules/data-grid-2/) widget. The Dropdown Filter allows users to filter enumeration values, Boolean attributes, or association attributes through a dropdown selection interface with advanced features like multi-select and search capabilities.
9
+
This guide lists all the properties of the Dropdown Filter widget used with the [Data Grid 2](/appstore/modules/data-grid-2/) widget. The dropdown filter allows users to filter enumeration values, Boolean attributes, or association attributes through a dropdown selection interface with advanced features like multi-select and search capabilities.
10
10
11
11
For more information on using filter widgets, see [Data Grid 2](/appstore/modules/data-grid-2/#filters).
12
12
@@ -18,70 +18,70 @@ For more information on using filter widgets, see [Data Grid 2](/appstore/module
18
18
19
19
##### Filter By
20
20
21
-
Determines the type of filtering the dropdown will perform:
21
+
Determines the type of filtering the dropdown filter will perform:
22
22
23
-
***Attribute**: Filters based on entity attributes (enumerations, booleans)
24
-
***Association**: Filters based on entity associations and references
23
+
***Attribute**: filters based on entity attributes (enumerations, Booleans)
24
+
***Association**: filters based on entity associations and references
25
25
26
-
##### Data source of [widget]
26
+
##### Data Source of Widget
27
27
28
28
This setting is displaying what data sourced is currently used to configure the filter.
29
29
30
30
#### Attribute Type Configuration
31
31
32
32
##### Attribute Config
33
33
34
-
Provides flexibility in how the filter determines which data to filter. **Auto** mode automatically detects filterable attributes from the parent grid when placed in grid columns. **Custom** mode allows manual specification of target datasource and attributes for more complex filtering scenarios.
34
+
Provides flexibility in how the filter determines which data to filter. **Auto** mode automatically detects filterable attributes from the parent grid when placed in grid columns. **Custom** mode allows manual specification of target data source and attributes for more complex filtering scenarios.
35
35
36
36
##### Attribute
37
37
38
-
Specifies the target attribute for filtering when using attribute-based filtering. Supported attribute types include:
38
+
Specifies the target attribute for filtering when using attribute-based filtering. Supported attribute types include the following:
39
39
40
-
***Enum**: Enumeration attributes with predefined values
41
-
***Boolean**: True/false attributes
40
+
***Enum**: enumeration attributes with predefined values
41
+
***Boolean**: true/false attributes
42
42
43
43
##### Automatic Options
44
44
45
-
When set to **Yes**, the dropdown automatically populates with all available values from the enumeration or boolean attribute. When set to **No**, custom options must be manually configured in the Options list.
45
+
When set to **Yes**, the dropdown automatically populates with all available values from the enumeration or Boolean attribute. When set to **No**, custom options must be manually configured in the **Options** list.
46
46
47
47
##### Options
48
48
49
-
Allows manual specification of dropdown options when Automatic Options is disabled. Each option contains:
49
+
Allows manual specification of dropdown options when Automatic Options is disabled. Each option contains the following:
50
50
51
-
***Caption**: Display text shown to users
52
-
***Value**: Actual value used for filtering
51
+
***Caption**: display text shown to users
52
+
***Value**: actual value used for filtering
53
53
54
54
#### Association Type Configuration
55
55
56
56
##### Entity
57
57
58
-
Defines the entity that will be used for filtering over association. Supports both Reference and ReferenceSet association types. This property is required when Filter By is set to Association.
58
+
Defines the entity that will be used for filtering over association. Supports both **Reference** and **ReferenceSet** association types. This property is required when **Filter By** is set to **Association**.
59
59
60
60
##### Selectable Objects
61
61
62
-
Defines the datasource that provides the list of entities available for selection. This datasource should return all possible entities that could be associated with the parent entity. The dropdown will display these entities as selectable options.
62
+
Defines the data source that provides the list of entities available for selection. This data source should return all possible entities that could be associated with the parent entity. The dropdown filter will display these entities as selectable options.
63
63
64
64
##### Caption
65
65
66
-
Specifies the attribute from the selectable objects that will be displayed as the option text in the dropdown. Must be a String attribute from the entity defined in the Selectable Objects datasource.
66
+
Specifies the attribute from the selectable objects that will be displayed as the option text in the dropdown filter. Must be a string attribute from the entity defined in the **Selectable Objects** data source.
67
67
68
68
##### Use Lazy Load
69
69
70
-
Controls when dropdown options are loaded. When set to **No** (recommended), options are loaded immediately providing better personalization support and value restoration. When set to **Yes**, options are loaded on-demand when the dropdown is first opened, improving initial page load performance but limiting personalization capabilities.
70
+
Controls when dropdown filter options are loaded. When set to **No** (recommended), options are loaded immediately providing better personalization support and value restoration. When set to **Yes**, options are loaded ondemand when the dropdown filter is first opened, improving initial page load performance but limiting personalization capabilities.
71
71
72
72
#### General Configuration
73
73
74
74
##### Default Value
75
75
76
-
Sets the initial value that is selected in the dropdown when the page loads. For association filtering, this should match one of the available entity values. For attribute filtering, this should match one of the enumeration or boolean values.
76
+
Sets the initial value that is selected in the dropdown filter when the page loads. For association filtering, this should match one of the available entity values. For attribute filtering, this should match one of the enumeration or Boolean values.
77
77
78
78
##### Filterable
79
79
80
80
When set to **Yes**, adds a search input to the dropdown allowing users to quickly find options by typing. This is especially useful for dropdowns with many options. The search functionality works on the display captions.
81
81
82
82
##### Multiselect
83
83
84
-
Enables selection of multiple options simultaneously. When enabled, users can select multiple enumeration values, boolean states, or associated entities. The filter will match records that contain any of the selected values.
84
+
Enables selection of multiple options simultaneously. When enabled, users can select multiple enumeration values, Boolean states, or associated entities. The filter will match records that contain any of the selected values.
85
85
86
86
##### Empty Option Caption
87
87
@@ -95,21 +95,21 @@ When set to **Yes**, adds a clear button that allows users to quickly remove the
95
95
96
96
Controls how selected options are displayed when multiselect is enabled:
97
97
98
-
***Text**: Shows selected items as comma-separated text
99
-
***Labels**: Shows selected items as individual removable labels/tags
98
+
***Text**: shows selected items as comma-separated text
99
+
***Labels**: shows selected items as individual removable labels/tags
100
100
101
101
##### Selection Method
102
102
103
103
Determines how users can select options in multiselect mode:
104
104
105
-
***Checkbox**: Adds checkboxes next to each option for explicit selection
106
-
***Row Click**: Allows selection by clicking anywhere on the option row
105
+
***Checkbox**: adds checkboxes next to each option for explicit selection
106
+
***Row Click**: allows selection by clicking anywhere on the option row
107
107
108
108
### Configurations
109
109
110
110
#### Saved Attribute
111
111
112
-
Specifies an entity attribute used to store the last filter value for persistence. The attribute must be of type String. When configured, the filter automatically saves its current selection to this attribute when changes occur. Note that associations are not supported for saved attributes.
112
+
Specifies an entity attribute used to store the last filter value for persistence. The attribute must be of type string. When configured, the filter automatically saves its current selection to this attribute when changes occur. Note that associations are not supported for saved attributes.
113
113
114
114
### Events
115
115
@@ -121,5 +121,5 @@ Defines an action to be executed whenever the filter selection changes. This eve
121
121
122
122
#### Input Caption
123
123
124
-
Defines the accessible label for the dropdown input element. Screen readers announce this label when users focus on the dropdown. Essential for users relying on assistive technology to understand the purpose and context of the filter dropdown.
124
+
Defines the accessible label for the dropdown input element. Screen readers announce this label when users focus on the dropdown. Employing this correctly is essential for users relying on assistive technology.
0 commit comments