-
Notifications
You must be signed in to change notification settings - Fork 65
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* update web dashboard * update to new doc fx (#216) * update to new doc fx * Update README.md * fix matomo updated partial for 'default', added layout for modern, fix parameters to pass metadata * Apply suggestions from code review Co-authored-by: pollyndos <56310766+pollyndos@users.noreply.github.com> * add gitignore * add license * fix word order * move note --------- Co-authored-by: Sergey Avramenko <sergey.avramenko@devexpress.com> Co-authored-by: pollyndos <56310766+pollyndos@users.noreply.github.com> * update winforms part * fix links * fix links --------- Co-authored-by: Polina Tyureva <polina.tyureva@devexpress.com> Co-authored-by: Sergey Avramenko <sergey.avramenko@devexpress.com> Co-authored-by: pollyndos <56310766+pollyndos@users.noreply.github.com>
- Loading branch information
4 people
authored
Sep 25, 2024
1 parent
a204478
commit e3780a4
Showing
58 changed files
with
619 additions
and
173 deletions.
There are no files selected for viewing
11 changes: 6 additions & 5 deletions
11
...desktop/articles/dashboard-designer/data-analysis/using-dashboard-parameters.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,13 @@ | ||
| --- | ||
| title: Using Dashboard Parameters | ||
| title: Use Dashboard Parameters | ||
| author: Natalia Kazakova | ||
| legacyId: 16521 | ||
| --- | ||
| # Using Dashboard Parameters | ||
| # Use Dashboard Parameters | ||
| You can use **dashboard parameters** when it is necessary to pass data of a certain type to a dashboard (e.g., to pass a specific value to the data source filter string or a calculated field). | ||
|
|
||
| The topics in this section describe how to use dashboard parameters. | ||
| * [Creating Parameters](using-dashboard-parameters/creating-parameters.md) | ||
| * [Passing Parameter Values](using-dashboard-parameters/passing-parameter-values.md) | ||
| * [Requesting Parameter Values](using-dashboard-parameters/requesting-parameter-values.md) | ||
| * [Create Dashboard Parameters](using-dashboard-parameters/creating-parameters.md) | ||
| * [Create Cascading Parameters](using-dashboard-parameters/create-cascading-parameters.md) | ||
| * [Reference Dashboard Parameters](using-dashboard-parameters/passing-parameter-values.md) | ||
| * [Specify Parameter Values](using-dashboard-parameters/requesting-parameter-values.md) |
63 changes: 63 additions & 0 deletions
63
...esigner/data-analysis/using-dashboard-parameters/create-cascading-parameters.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| --- | ||
| title: Cascading Parameters | ||
| author: Polina Tuyreva | ||
| --- | ||
| # Cascading Parameters | ||
|
|
||
| Create cascading parameters to filter a list of predefined parameter values based on another parameter's values. The following image illustrates cascading parameters where the **pProducts** parameter values are filtered by the selected category: | ||
|
|
||
|  | ||
|
|
||
| In case of two parameters, the first parameter is used to filter the data source for the second parameter with [dynamic list](creating-parameters.md#dynamic-list) settings. | ||
|
|
||
| ## Create Cascading Parameters | ||
|
|
||
| The dashboard in this example is connected to a Northwind database (an SQL Database) and contains three [queries](../../work-with-data/manage-sql-queries.md): *Categories*, *Products*, and *OrderReports*. The Grid item visualizes data from the *OrderReports* query. | ||
|
|
||
| In this tutorial, you will create two dashboard parameters: | ||
| * The **pCategory** parameter filters the *Products* query. The *Products* query is a data source for the **pProducts** parameter. | ||
| * The **pProducts** parameter filters the *OrderReports* query. | ||
|
|
||
| The steps below create cascading parameters in the WinForms Dashboard Designer: | ||
|
|
||
| 1. Create a dashboard parameter called **pCategory** with dynamic list settings. Use the *Categories* query as a data member and the *CategoryID* as a value member. | ||
|
|
||
| The parameter settings may look as follows: | ||
|
|
||
|  | ||
|
|
||
| 2. Use the created **pCategory** parameter to [filter](../../work-with-data/filter-queries.md) the *Products* query. | ||
|
|
||
| To do this, invoke the [Query Builder](../../work-with-data/using-the-query-builder.md) and click the **Filter...** button to specify the filter criteria in the **Filter Editor**. Choose the **Bind To** option to automatically bind a [query parameter](../../work-with-data/pass-query-parameters.md) to the created dashboard parameter: | ||
|
|
||
|  | ||
|
|
||
| The resulting query looks as follows: | ||
|
|
||
| ``` | ||
| [Products.CategoryID]=?pCategory | ||
| ``` | ||
|
|
||
| 3. Create a dashboard parameter called **pProducts** with dynamic list settings. Use the *Products* query as a data member and the *ProductID* as a value member. | ||
|
|
||
| The parameter settings may look as follows: | ||
|
|
||
|  | ||
|
|
||
|
|
||
| 4. Use the **pProducts** dashboard parameter to filter the *OrderReports* query. | ||
|
|
||
| To do this, invoke the [Query Builder](../../work-with-data/using-the-query-builder.md) and click the **Filter...** button to specify the filter criteria in the **Filter Editor**. Choose the **Bind To** option to automatically bind a [query parameter](../../work-with-data/pass-query-parameters.md) to the created dashboard parameter: | ||
|
|
||
|  | ||
|
|
||
| The resulting query looks as follows: | ||
|
|
||
| ``` | ||
| [OrderReports.ProductID] In ?pProducts | ||
| ``` | ||
|
|
||
| 5. Create a Grid item to visualize data from the filtered *OrderReports* query. | ||
|
|
||
| >[!TIP] | ||
| >When using a [multi-value](creating-parameters.md#allow-multiselect) parameter to filter a query, create the condition with the `Is any of` or `Is none of` operator. |
175 changes: 125 additions & 50 deletions
175
...hboard-designer/data-analysis/using-dashboard-parameters/creating-parameters.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,139 @@ | ||
| --- | ||
| title: Creating Parameters | ||
| title: Create a Dashboard Parameter | ||
| author: Natalia Kazakova | ||
| legacyId: 16522 | ||
| --- | ||
| # Creating Parameters | ||
| This topic explains how to create a new dashboard parameter and specify its settings. | ||
| * [Creating Parameters in the Dashboard Designer](#creating-parameters-in-the-dashboard-designer) | ||
| * [Look-Up Editor Settings](#look-up-editor-settings) | ||
|
|
||
| ## <a name="creating-parameters-in-the-dashboard-designer"/>Creating Parameters in the Dashboard Designer | ||
| To create dashboard parameters in the Dashboard Designer, do the following: | ||
| 1. Click the **Parameters** button on the Ribbon's **Data Source** tab. | ||
| # Create a Dashboard Parameter in the WinForms Designer | ||
|
|
||
| This topic shows how to add a new dashboard parameter and specify its settings in the Dashboard Designer. | ||
|
|
||
| ## Create a Parameter in the UI | ||
|
|
||
| To create dashboard parameters in the Dashboard Designer, follow the steps below. | ||
|
|
||
| 1. Click the **Parameters** button from the **Dashboard** page group on the Ribbon's **Home** page. | ||
|
|
||
|  | ||
| 2. In the invoked dialog, click the **Add** button to add a new parameter. | ||
|  | ||
|
|
||
| 2. In the invoked dialog, click the **Add** button to create a dashboard parameter. | ||
|
|
||
|  | ||
| 3. Specify the following settings. | ||
| * **Visible** - Specifies whether or not the parameter editor is visible in the [Dashboard Parameters](requesting-parameter-values.md) dialog. | ||
| * **Allow Null** - Specifies whether or a not null value can be passed as a parameter value. | ||
| * **Allow Multiselect** - Specifies whether or not multi-selection is enabled for the current parameter. The following limitations are applied to parameters with multi-selection enabled. | ||
| * Use the **is any of** or **is none of** operators to pass a multi-select parameter to a [filter](../../data-shaping/filtering.md) criteria or to the [Expression](../../appearance-customization/conditional-formatting/expression.md) format condition. | ||
| * Use the **In** or **Not In** operators to pass a multi-select parameter to a [calculated field](../../work-with-data/creating-calculated-fields.md) expression. | ||
| * Stored procedures used in the [SQL](../../work-with-data/stored-procedures.md) data source do not support multi-select parameters. | ||
| * **Name** - Specifies the parameter name. When creating and modifying parameter names, follow the rules below. | ||
| * A name can contain letters, numbers and underscores. | ||
| * A name cannot contain spaces. | ||
| * A name cannot be an empty string. | ||
| * The dashboard cannot contain parameters with the same name. | ||
| * Names are case-sensitive. For example, you can create the names _Parameter_ and _PARAMETER_ . | ||
| * **Description** - Specifies the parameter's description. The parameter's description is the value displayed in the **Parameter Name** column of the [Dashboard Parameters](requesting-parameter-values.md) dialog. | ||
| * **Look-Up Settings** - Specifies the parameter's [look-up editor settings](#look-up-editor-settings). | ||
| * **Select All Values** - Specifies whether or not all parameter values should be selected in the initial state of the Dashboard Viewer. | ||
| Note that this option is in effect when **Allow Multiselect** is set to **true**. | ||
| * **Type** - Specifies the parameter type. | ||
| * **Value** - Specifies the default parameter’s value. Note that when **Allow Multiselect** is set to **true**, the **Value** option allows you to select multiple parameter values. | ||
|  | ||
|
|
||
| 3. Specify the parameter's settings and click **OK** to save the created parameter. | ||
|
|
||
| ## Parameter Settings | ||
|
|
||
| ### Name | ||
|
|
||
| Specifies the parameter name. | ||
|
|
||
| When you create and modify parameter names, follow the rules below: | ||
|
|
||
| * A name can contain letters, numbers, and underscores. | ||
| * A name cannot contain spaces. | ||
| * A name cannot be an empty string. | ||
| * The dashboard cannot contain parameters with the same name. | ||
| * Names are case-sensitive. For example, you can create the names _Parameter_ and _PARAMETER_ . | ||
|
|
||
| ### Description | ||
|
|
||
| Specifies the parameter description displayed in the **Parameter** column of the [Dashboard Parameters](requesting-parameter-values.md) dialog. | ||
|
|
||
|  | ||
|
|
||
| Then, click **OK** to add the created parameters to the dashboard. | ||
| ### Visible | ||
|
|
||
| Specifies whether the parameter is visible in the [Dashboard Parameters](requesting-parameter-values.md) dialog. | ||
|
|
||
| ## <a name="look-up-editor-settings"/>Look-Up Editor Settings | ||
| There are three types of look-up editor settings that can be specified for a parameter. Select the required type from the **LookUpSettings** drop-down list. | ||
| ### Allow Null | ||
|
|
||
|  | ||
| * **No Look-Up** - set the **Value** to use a static value as a parameter. | ||
| Specifies whether a null value can be passed as a parameter value. | ||
|
|
||
|  | ||
| * **Static List** - click the ellipsis button to add static values for the current dashboard parameter. | ||
| ### Allow Multiselect | ||
|
|
||
| Specifies whether multi-selection is enabled for the current parameter. | ||
|
|
||
| The following limitations apply to parameters with multi-selection enabled: | ||
|
|
||
| * Use the **Is any of** or **Is none of** operators to pass a multi-select parameter to a filter criteria or to the Expression format condition. | ||
| * Use the **In** or **Not In** operators to pass a multi-select parameter to a calculated field expression. | ||
|
|
||
| ### Select All Values | ||
|
|
||
| Specifies whether all parameter values should be selected in the initial state of the dashboard. | ||
|
|
||
|  | ||
| Note that this option is in effect when **Allow Multiselect** is enabled. | ||
|
|
||
| ### Type | ||
|
|
||
| Specifies the parameter type. | ||
|
|
||
| The following types are available: | ||
| * String | ||
| * Date | ||
| * Number (16-bit integer) | ||
| * Number (32-bit integer) | ||
| * Number (64-bit integer) | ||
| * Number (floating point) | ||
| * Number (double-precision floating point) | ||
| * Number (decimal) | ||
| * Boolean | ||
| * GUID (Globally Unique Identifier) | ||
|
|
||
| ### Value | ||
|
|
||
| Specifies the default parameter value. | ||
|
|
||
| Note that when the **Allow Multiselect** option is enabled, the **Value** option allows you to select multiple parameter values. | ||
|
|
||
| ### Look-Up Settings | ||
|
|
||
| Specifies the parameter's look-up settings. | ||
|
|
||
|
|
||
| In this case, the **Value** specifies the default parameter's value. | ||
| * **Dynamic List** - allows you to use a list of values from the existing data source as a parameter. You need to select the required **Data Source** from the list of available data sources and data members for the dashboard parameter's display name and value, respectively. | ||
| Select the option from the **Look-Up Settings** drop-down list. | ||
|
|
||
|  | ||
|
|
||
| The following **Look-Up Settings** are available in the WinForms Dashboard: | ||
|
|
||
| #### No Look-Up | ||
|
|
||
| An end user can specify the parameter value in the [Dashboard Parameters](requesting-parameter-values.md) dialog. | ||
|
|
||
| You can set the default value for the parameter in the parameter setting: | ||
|
|
||
|  | ||
|
|
||
| #### Static List | ||
|
|
||
| An end user selects a parameter value from a static list. | ||
|
|
||
| To add predefined parameter values, click the ellipsis button in the parameter settings: | ||
|
|
||
|  | ||
| 1. First, select the required **Data Source** from the list of available data sources. For the [SQL](../../provide-data/connecting-to-sql-databases.md) data source, select the required **Data Member** that specifies the query from the selected **Data Source**. | ||
| 2. Then, specify data members for the dashboard parameter's value and display name using **Value Member** and **Display Member**, respectively. | ||
| 3. If necessary, specify the data member used to sort parameter values using the **Sort By** option. **Sort Order** specifies the required sort order. | ||
|  | ||
|
|
||
|
|
||
| #### Dynamic List | ||
|
|
||
| An end user selects a parameter value defined in a data source. | ||
|
|
||
| > [!NOTE] | ||
| > To learn how to create a data source for a dashboard parameter, see [Provide Data](../../provide-data.md). | ||
| > | ||
| > Note that you cannot specify an [OLAP](../../provide-data/connecting-to-olap-cubes.md) data source as the data source for the dashboard parameter in the Dashboard Designer. | ||
|  | ||
|
|
||
| >[!TIP] | ||
| >You can also create cascading parameters in the Dashboard Designer. For more information, refer to the following topic: [Cascading Parameters](create-cascading-parameters.md). | ||
| To provide access to data source values, specify the following options: | ||
|
|
||
| |UI Settings|Description| | ||
| |--------|-----------|---| | ||
| |**Data Source**| Specifies the data source for the dashboard parameter.| | ||
| |**Data Member**| Specifies the name of the data member with the parameter values for SQL and Entity Framework data sources.| | ||
| |**Value Member**|Specifies the name of the data field for the parameter values.| | ||
| |**Display Member** (optional)| Specifies the name of the data field displayed in the **Dashboard Parameters** dialog as a value description.| | ||
| |**Sort By** (optional)|Specifies the data member used to sort parameter values.| | ||
| |**Sort Order** (optional)|Specifies the sort order.| | ||
|
|
||
| > [!NOTE] | ||
| > You cannot use an OLAP data source as the data source for a dashboard parameter. | ||
Oops, something went wrong.