Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,20 @@ description: "Describes the configuration and usage of the Data Widgets module,

## Introduction

[Data Widgets](https://marketplace.mendix.com/link/component/116540) is a module containing widgets that show data in a specific structure.
[Data Widgets](https://marketplace.mendix.com/link/component/116540) is a module containing widgets that show data in a specific structure. It requires Studio Pro 10.24.0 or above.

This module contains the following widgets:

* [Data Grid 2](/appstore/modules/data-grid-2/)
* [Data Grid 2 Properties](/appstore/modules/data-grid-2-properties/)
* [Data Grid 2 Properties](/appstore/modules/data-grid-2-properties/)
* [Date Filter](/appstore/modules/datagrid-date-filter/)
* [Drop-Down Sort](/appstore/modules/gallery/#dropdown)
* [Filters](/appstore/modules/data-grid-2/#filters)
* [Dropdown Filter](/appstore/modules/datagrid-dropdown-filter/)
* [Gallery](/appstore/modules/gallery/)
* [Selection helper](/appstore/modules/selection-helper/)
* [Tree node](/appstore/modules/tree-node/)
* [Number Filter](/appstore/modules/datagrid-number-filter/)
* [Selection Helper](/appstore/modules/selection-helper/)
* [Text Filter](/appstore/modules/datagrid-text-filter/)
* [Tree Node](/appstore/modules/tree-node/)

## Migration

Expand Down

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -14,33 +14,35 @@ For more information on using filter widgets, see [Data Grid 2](/appstore/module

### General Tab

#### Filter Attributes
#### General

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.
##### Filter Attributes

#### Data Source to Filter
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 shows the **Attributes** property, where you select the attributes to filter on, including multiple attributes.

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**.
##### Datasource to Filter

#### Attributes
Shows the data source that the filter is linked to. The filter is linked to the data source of the data widget it is placed in, and the attributes in **Attributes** are selected from this data source. This property is only shown when **Filter attributes** is set to **Custom**.

Allows specification of multiple DateTime attributes that users can filter on. Each attribute in the list becomes a potential target for filtering operations, enabling sophisticated multi-attribute date search capabilities. Only DateTime attributes are supported for date filtering operations.
##### Attributes

#### Default Value
Allows specification of multiple DateTime attributes that users can filter on. Each attribute in the list becomes a potential target for filtering operations, enabling sophisticated multi-attribute date search capabilities. Only DateTime attributes are supported for date filtering operations. This property is only shown when **Filter attributes** is set to **Custom**.

Sets the initial date value that appears in the filter input when the page loads. This value is applied immediately when the widget initializes. The default value respects expression-based configurations and can be dynamically determined based on business logic.
##### Default Value

#### Default Start Date
Sets the initial date value that appears in the filter input when the page loads. This value is applied immediately when the widget initializes. The default value is an expression that returns a Date and time value, so it can be determined dynamically. This property is hidden when **Default filter** is set to **Between**.

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.
##### Default Start Date

#### Default End Date
When **Default filter** is set to **Between**, this property defines the initial start date for the date range. This value works in conjunction with **Default end date** to establish a default date range when the widget loads. This property is only shown when **Default filter** is set to **Between**.

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.
##### Default End Date

#### Default Filter
When **Default filter** is set to **Between**, this property defines the initial end date for the date range. This value works in conjunction with **Default start date** to establish a default date range when the widget loads. This property is only shown when **Default filter** is set to **Between**.

Determines the initial filter operation type when the widget loads. Available options include the following:
##### Default Filter

Determines the initial filter operation type when the widget loads. The default is **Equal**. Available options include the following:

* **Between**: matches records where the date falls within a specified range (requires both start and end dates)
* **Greater than**: matches records where the date is after the specified date
Expand All @@ -52,44 +54,46 @@ Determines the initial filter operation type when the widget loads. Available op
* **Empty**: matches records where the date attribute has no value
* **Not empty**: matches records where the date attribute has any value

#### Placeholder
##### Placeholder

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.

#### Adjustable by User
##### Adjustable by User

Controls whether users can change the filter operation type. When set to **Yes**, a dropdown button appears next to the date input allowing users to select different filter operations. When set to **No**, only the default filter operation is available and the dropdown is hidden.
Controls whether users can change the filter operation type. When set to **Yes**, a drop-down button appears next to the date input allowing users to select different filter operations. When set to **No**, only the default filter operation is available and the drop-down button is hidden.

### Configurations
#### Configurations

#### Saved Attribute
##### Saved Attribute

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**.
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. The saved value is not applied to the widget automatically. To restore a previously saved value, use the same attribute in the **Default value** expression. This property is hidden when **Default filter** is set to **Between**.

#### Saved Start Date Attribute
##### Saved Start Date Attribute

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.
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 **Saved end date attribute** to persist date range selections. To restore a previously saved value, use the same attribute in the **Default start date** expression. This property is only shown when **Default filter** is set to **Between**.

#### Saved End Date Attribute
##### Saved End Date Attribute

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.
Specifies an entity attribute used to store the end date when using the **Between** filter mode. The attribute must be of type DateTime. This works in conjunction with **Saved start date attribute** to persist date range selections. To restore a previously saved value, use the same attribute in the **Default end date** expression. This property is only shown when **Default filter** is set to **Between**.

### Events
#### Events

#### On Change
##### On Change

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.

### Accessibility
### Accessibility Tab

#### Screen Reader

#### Comparison Button Caption
##### Comparison Button Caption

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.
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. This property is only shown when **Adjustable by user** is set to **Yes**.

#### Calendar Button Caption
##### Calendar Button Caption

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.

#### Input Caption
##### Input Caption

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.
Defines the accessible label for the date input field. Screen readers announce this label when users focus on the input field. This property helps users understand that date input is expected, and may include format guidance or context-specific information.
Loading