Skip to content

Commit e3780a4

Browse files
natakazakovapollyndosDXInfinity
authored
Add dash param topics (#219)
* 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 <[email protected]> * add gitignore * add license * fix word order * move note --------- Co-authored-by: Sergey Avramenko <[email protected]> Co-authored-by: pollyndos <[email protected]> * update winforms part * fix links * fix links --------- Co-authored-by: Polina Tyureva <[email protected]> Co-authored-by: Sergey Avramenko <[email protected]> Co-authored-by: pollyndos <[email protected]>
1 parent a204478 commit e3780a4

File tree

58 files changed

+619
-173
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+619
-173
lines changed

‎dashboard-for-desktop/articles/dashboard-designer/data-analysis/using-dashboard-parameters.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
---
2-
title: Using Dashboard Parameters
2+
title: Use Dashboard Parameters
33
author: Natalia Kazakova
44
legacyId: 16521
55
---
6-
# Using Dashboard Parameters
6+
# Use Dashboard Parameters
77
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).
88

99
The topics in this section describe how to use dashboard parameters.
10-
* [Creating Parameters](using-dashboard-parameters/creating-parameters.md)
11-
* [Passing Parameter Values](using-dashboard-parameters/passing-parameter-values.md)
12-
* [Requesting Parameter Values](using-dashboard-parameters/requesting-parameter-values.md)
10+
* [Create Dashboard Parameters](using-dashboard-parameters/creating-parameters.md)
11+
* [Create Cascading Parameters](using-dashboard-parameters/create-cascading-parameters.md)
12+
* [Reference Dashboard Parameters](using-dashboard-parameters/passing-parameter-values.md)
13+
* [Specify Parameter Values](using-dashboard-parameters/requesting-parameter-values.md)

‎dashboard-for-desktop/articles/dashboard-designer/data-analysis/using-dashboard-parameters/create-cascading-parameters.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: Cascading Parameters
3+
author: Polina Tuyreva
4+
---
5+
# Cascading Parameters
6+
7+
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:
8+
9+
![Dashboard for WinForms - Cascading Parameters](../../../../images/cascading-parameters-winforms.gif)
10+
11+
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.
12+
13+
## Create Cascading Parameters
14+
15+
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.
16+
17+
In this tutorial, you will create two dashboard parameters:
18+
* The **pCategory** parameter filters the *Products* query. The *Products* query is a data source for the **pProducts** parameter.
19+
* The **pProducts** parameter filters the *OrderReports* query.
20+
21+
The steps below create cascading parameters in the WinForms Dashboard Designer:
22+
23+
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.
24+
25+
The parameter settings may look as follows:
26+
27+
![Dashboard for WinForms - Create Dashboard Parameter](../../../../images/category-parameter-cascading.png)
28+
29+
2. Use the created **pCategory** parameter to [filter](../../work-with-data/filter-queries.md) the *Products* query.
30+
31+
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:
32+
33+
![Dashboard for WinForms - Filter Query](../../../../images/category-parameter-filter-cascading.png)
34+
35+
The resulting query looks as follows:
36+
37+
```
38+
[Products.CategoryID]=?pCategory
39+
```
40+
41+
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.
42+
43+
The parameter settings may look as follows:
44+
45+
![Dashboard for WinForms - Create Dashboard Parameter](../../../../images/products-parameter-cascading.png)
46+
47+
48+
4. Use the **pProducts** dashboard parameter to filter the *OrderReports* query.
49+
50+
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:
51+
52+
![Dashboard for WinForms - Filter Queries](../../../../images/products-parameter-filter-cascading.png)
53+
54+
The resulting query looks as follows:
55+
56+
```
57+
[OrderReports.ProductID] In ?pProducts
58+
```
59+
60+
5. Create a Grid item to visualize data from the filtered *OrderReports* query.
61+
62+
>[!TIP]
63+
>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.

‎dashboard-for-desktop/articles/dashboard-designer/data-analysis/using-dashboard-parameters/creating-parameters.md‎

Lines changed: 125 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,139 @@
11
---
2-
title: Creating Parameters
2+
title: Create a Dashboard Parameter
33
author: Natalia Kazakova
44
legacyId: 16522
55
---
6-
# Creating Parameters
7-
This topic explains how to create a new dashboard parameter and specify its settings.
8-
* [Creating Parameters in the Dashboard Designer](#creating-parameters-in-the-dashboard-designer)
9-
* [Look-Up Editor Settings](#look-up-editor-settings)
10-
11-
## <a name="creating-parameters-in-the-dashboard-designer"/>Creating Parameters in the Dashboard Designer
12-
To create dashboard parameters in the Dashboard Designer, do the following:
13-
1. Click the **Parameters** button on the Ribbon's **Data Source** tab.
6+
# Create a Dashboard Parameter in the WinForms Designer
7+
8+
This topic shows how to add a new dashboard parameter and specify its settings in the Dashboard Designer.
9+
10+
## Create a Parameter in the UI
11+
12+
To create dashboard parameters in the Dashboard Designer, follow the steps below.
13+
14+
1. Click the **Parameters** button from the **Dashboard** page group on the Ribbon's **Home** page.
1415

15-
![Parameters_AddParameterButton_Ribbon](../../../../images/img21711.png)
16-
2. In the invoked dialog, click the **Add** button to add a new parameter.
16+
![Ribbon - Parameters Button](../../../../images/parameters_addparameterbutton_ribbon21711.png)
17+
18+
2. In the invoked dialog, click the **Add** button to create a dashboard parameter.
1719

18-
![Parameters_ParametersDialog](../../../../images/img21716.png)
19-
3. Specify the following settings.
20-
* **Visible** - Specifies whether or not the parameter editor is visible in the [Dashboard Parameters](requesting-parameter-values.md) dialog.
21-
* **Allow Null** - Specifies whether or a not null value can be passed as a parameter value.
22-
* **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.
23-
* 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.
24-
* 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.
25-
* Stored procedures used in the [SQL](../../work-with-data/stored-procedures.md) data source do not support multi-select parameters.
26-
* **Name** - Specifies the parameter name. When creating and modifying parameter names, follow the rules below.
27-
* A name can contain letters, numbers and underscores.
28-
* A name cannot contain spaces.
29-
* A name cannot be an empty string.
30-
* The dashboard cannot contain parameters with the same name.
31-
* Names are case-sensitive. For example, you can create the names _Parameter_ and _PARAMETER_ .
32-
* **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.
33-
* **Look-Up Settings** - Specifies the parameter's [look-up editor settings](#look-up-editor-settings).
34-
* **Select All Values** - Specifies whether or not all parameter values should be selected in the initial state of the Dashboard Viewer.
35-
36-
Note that this option is in effect when **Allow Multiselect** is set to **true**.
37-
* **Type** - Specifies the parameter type.
38-
* **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.
20+
![Dashboard Parameters Dialog - Add Parameters](../../../../images/parameters_parametersdialog21716.png)
21+
22+
3. Specify the parameter's settings and click **OK** to save the created parameter.
23+
24+
## Parameter Settings
25+
26+
### Name
27+
28+
Specifies the parameter name.
29+
30+
When you create and modify parameter names, follow the rules below:
31+
32+
* A name can contain letters, numbers, and underscores.
33+
* A name cannot contain spaces.
34+
* A name cannot be an empty string.
35+
* The dashboard cannot contain parameters with the same name.
36+
* Names are case-sensitive. For example, you can create the names _Parameter_ and _PARAMETER_ .
37+
38+
### Description
39+
40+
Specifies the parameter description displayed in the **Parameter** column of the [Dashboard Parameters](requesting-parameter-values.md) dialog.
41+
42+
![Dashboard Parameters Dialog - Parameter Description](../../../../images/dashboard-parameter-description-win.png)
3943

40-
Then, click **OK** to add the created parameters to the dashboard.
44+
### Visible
45+
46+
Specifies whether the parameter is visible in the [Dashboard Parameters](requesting-parameter-values.md) dialog.
4147

42-
## <a name="look-up-editor-settings"/>Look-Up Editor Settings
43-
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.
48+
### Allow Null
4449

45-
![Parameters_ParametersDialog_LookUpSettings](../../../../images/img21718.png)
46-
* **No Look-Up** - set the **Value** to use a static value as a parameter.
50+
Specifies whether a null value can be passed as a parameter value.
4751

48-
![Parameters_LookUpSettings_NoLookUp](../../../../images/img21722.png)
49-
* **Static List** - click the ellipsis button to add static values for the current dashboard parameter.
52+
### Allow Multiselect
53+
54+
Specifies whether multi-selection is enabled for the current parameter.
55+
56+
The following limitations apply to parameters with multi-selection enabled:
57+
58+
* 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.
59+
* Use the **In** or **Not In** operators to pass a multi-select parameter to a calculated field expression.
60+
61+
### Select All Values
62+
63+
Specifies whether all parameter values should be selected in the initial state of the dashboard.
5064

51-
![Parameters_LookUpSettings_Static](../../../../images/img21723.png)
65+
Note that this option is in effect when **Allow Multiselect** is enabled.
66+
67+
### Type
68+
69+
Specifies the parameter type.
70+
71+
The following types are available:
72+
* String
73+
* Date
74+
* Number (16-bit integer)
75+
* Number (32-bit integer)
76+
* Number (64-bit integer)
77+
* Number (floating point)
78+
* Number (double-precision floating point)
79+
* Number (decimal)
80+
* Boolean
81+
* GUID (Globally Unique Identifier)
82+
83+
### Value
84+
85+
Specifies the default parameter value.
86+
87+
Note that when the **Allow Multiselect** option is enabled, the **Value** option allows you to select multiple parameter values.
88+
89+
### Look-Up Settings
90+
91+
Specifies the parameter's look-up settings.
92+
5293

53-
In this case, the **Value** specifies the default parameter's value.
54-
* **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.
94+
Select the option from the **Look-Up Settings** drop-down list.
95+
96+
![Parameters Dialog - Look-Up Settings](../../../../images/parameters_parametersdialog_lookupsettings21718.png)
97+
98+
The following **Look-Up Settings** are available in the WinForms Dashboard:
99+
100+
#### No Look-Up
101+
102+
An end user can specify the parameter value in the [Dashboard Parameters](requesting-parameter-values.md) dialog.
103+
104+
You can set the default value for the parameter in the parameter setting:
105+
106+
![Dashboard Parameter Look-Up Settings - No Look-Up](../../../../images/parameters_lookupsettings_nolookup21722.png)
107+
108+
#### Static List
109+
110+
An end user selects a parameter value from a static list.
111+
112+
To add predefined parameter values, click the ellipsis button in the parameter settings:
55113

56-
![Parameters_LookUpSettings_Dynamic](../../../../images/img21842.png)
57-
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**.
58-
2. Then, specify data members for the dashboard parameter's value and display name using **Value Member** and **Display Member**, respectively.
59-
3. If necessary, specify the data member used to sort parameter values using the **Sort By** option. **Sort Order** specifies the required sort order.
114+
![Dashboard Parameters Look-Up Settings - Static List](../../../../images/parameters_lookupsettings_static21723.png)
115+
116+
117+
#### Dynamic List
118+
119+
An end user selects a parameter value defined in a data source.
60120

61-
> [!NOTE]
62-
> To learn how to create a data source for a dashboard parameter, see [Provide Data](../../provide-data.md).
63-
>
64-
> 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.
121+
![Dashboard Parameters Look-Up Settings - Dynamic List](../../../../images/parameters_lookupsettings_dynamic21842.png)
122+
123+
>[!TIP]
124+
>You can also create cascading parameters in the Dashboard Designer. For more information, refer to the following topic: [Cascading Parameters](create-cascading-parameters.md).
125+
126+
To provide access to data source values, specify the following options:
127+
128+
|UI Settings|Description|
129+
|--------|-----------|---|
130+
|**Data Source**| Specifies the data source for the dashboard parameter.|
131+
|**Data Member**| Specifies the name of the data member with the parameter values for SQL and Entity Framework data sources.|
132+
|**Value Member**|Specifies the name of the data field for the parameter values.|
133+
|**Display Member** (optional)| Specifies the name of the data field displayed in the **Dashboard Parameters** dialog as a value description.|
134+
|**Sort By** (optional)|Specifies the data member used to sort parameter values.|
135+
|**Sort Order** (optional)|Specifies the sort order.|
136+
137+
> [!NOTE]
138+
> You cannot use an OLAP data source as the data source for a dashboard parameter.
139+

0 commit comments

Comments
 (0)