Skip to content

Commit fd7bfce

Browse files
authored
22.1 bi dashboard (#169)
* coloring, federated wizard, opacity * bi dashboard end user docs * update xref links * Update dashboard-for-web/articles/web-dashboard-designer-mode/appearance-customization/coloring.md
1 parent 44edc8b commit fd7bfce

File tree

72 files changed

+412
-151
lines changed

Some content is hidden

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

72 files changed

+412
-151
lines changed

dashboard-for-desktop/articles/dashboard-designer/dashboard-item-settings/grid.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ This section consists of the following subsections.
2727
* [Layout](grid/layout.md)
2828

2929
Describes the Grid's layout options.
30+
* [Column Filter](grid/column-filter.md)
31+
32+
Describes how you can search data in the Grid item.
3033
* [Style](grid/style.md)
3134

3235
Describes the Grid's style settings.
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Column Filter for a WinForms Grid Item
2+
3+
Column filters (filter row and header filter) allow users to search data in the Grid item. These filters do not affect data outside the Grid.
4+
5+
## Filter Row
6+
7+
The **filter row** allows a user to filter data by individual column values. To display a filter row, go to the Grid's **Design** Ribbon tab in the Designer and enable the **Filter Row** button in the **Column Filter** group:
8+
9+
![WinForms Designer - Display a filter row](../../../../images/win-designer-display-filter-row.png)
10+
11+
When the filter row appears, a user can enter the condition in the text box to filter column values:
12+
13+
![WinForms Designer - Filter row](../../../../images/win-designer-filter-row-text-box.png)
14+
15+
The filter row's cells can be of different types--text boxes for string and numeric values, calendars for dates, and so on.
16+
17+
## Header Filter
18+
19+
The **header filter** allows users to filter values in an individual column. A user can include or exclude values from the applied filter to show the result.
20+
21+
![WinForms Designer - Header filter](../../../../images/win-designer-header-filter.png)
22+
23+
The header filter is always enabled, so you cannot disable it in the UI.
24+
25+
## Update Totals
26+
27+
A user can configure a Grid item to reflect changes in column values and recalculate [totals](totals.md) based on the applied column filters.
28+
29+
To update totals, go to the Grid's **Design** Ribbon tab in the Designer and enable the **Update Totals** button in the **Column Filter** group:
30+
31+
![WinForms Designer - Enable Totals Updates](../../../../images/win-designer-recalculate-totals.png)
32+
33+
As a result, the Grid item recalculates totals depending on the applied column filters:
34+
35+
![WinForms Designer - Updated totals in a filter row](../../../../images/win-designer-filter-row-update-totals.png)
36+
37+
## Limitations
38+
39+
### Filter Row Limitations
40+
41+
The following Grid [columns](columns.md) do not support the filter row:
42+
43+
- Dimension (for Image display mode only)
44+
- Measure (for Bar display mode only)
45+
- Sparkline
46+
- Delta
47+
48+
A Grid item does not support a filter row for window calculations and calculated fields that use the w-function if the **Update Totals** option is enabled.
49+
50+
### Update Totals Limitations
51+
52+
You cannot enable totals recalculation in OLAP data sources.
53+
54+
### Other Limitations
55+
56+
Although column filters within a Grid item are case-insensitive, totals are calculated on the server and their case-sensitivity setting depends on the database settings. If case-sensitivity settings are different, the total value can differ from the Grid's data. Make sure that the Grid item and the database use the same case-sensitivity settings.
16.4 KB
Loading
13.2 KB
Loading
12.1 KB
Loading
10.5 KB
Loading
16.1 KB
Loading

dashboard-for-web/articles/web-dashboard-designer-mode/appearance-customization/coloring.md

Lines changed: 103 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,8 @@ legacyId: 117565
55
---
66
# Coloring
77
The Web Dashboard provides the capability to manage the coloring of dashboard item elements, such as chart series points or pie segments.
8-
* [Supported Dashboard Items](#supporteditems)
9-
* [Color Schemes Overview](#overview)
10-
* [Coloring Measures and Dimensions](#coloring)
11-
* [Customizing Color Palettes Using the Dashboard Item Menu](#customizedim)
12-
* [Customizing Color Palettes Using the Color Scheme Page](#customizecpp)
138

14-
## <a name="supporteditems"/>Supported Dashboard Items
9+
## Supported Dashboard Items
1510
You can manage coloring for the following dashboard items.
1611
* [Chart](../dashboard-item-settings/chart.md)
1712
* [Scatter Chart](../dashboard-item-settings/scatter-chart.md)
@@ -20,54 +15,44 @@ You can manage coloring for the following dashboard items.
2015
* [Range Filter](../dashboard-item-settings/range-filter.md)
2116
* [Treemap](../dashboard-item-settings/treemap.md)
2217

23-
## <a name="overview"/>Color Schemes Overview
24-
The dashboard provides two ways of coloring dashboard item elements.
25-
* **Global color scheme**. This color scheme provides consistent colors for identical values across the dashboard. The image below shows the dashboard containing Pie and Chart dashboard items. Pie segments and chart series points corresponding to _Beverages_, _Condiments_ and _Confections_ dimension values are colored using identical colors from the default palette.
26-
27-
![wdd-coloring-global-scheme](../../../images/img126076.png)
28-
29-
> [!IMPORTANT]
30-
> When a global color scheme is used, the dashboard reserves automatically generated colors for certain values regardless of the filter state.
31-
* **Local color scheme**. This color scheme provides an _independent_ set of colors for each dashboard item.
32-
33-
> [!IMPORTANT]
34-
> When a local color scheme is used, the dashboard reassigns palette colors when the filter state is changed.
18+
## Color Schemes Overview
19+
The dashboard supports two ways to color dashboard item elements:
20+
21+
* **Global color scheme**. This scheme uses consistent colors for identical values across the dashboard. The image below shows a dashboard that contains Pie and Chart dashboard items. Pie segments and chart series points that correspond to Wisconsin, Oregon and Idaho dimension values use identical colors from the default palette.
22+
23+
![wdd-coloring-global-scheme](../../../images/wdd-coloring-global-scheme126076.png)
24+
25+
For a global color scheme, the dashboard reserves automatically generated colors for specific values regardless of the filter state.
3526

36-
To select a type of coloring dashboard item elements, open the [dashboard item menu](../ui-elements/dashboard-item-menu.md), go to the **Color Scheme** section and use the **Color Scheme Type** option.
27+
* **Local color scheme**. This scheme uses an independent set of colors for each dashboard item. The image below shows Pie segments that use colors from a local color scheme. These colors do not affect the Chart item that uses a global scheme.
3728

38-
![wdd-coloring-change-color-scheme](../../../images/img126079.png)
29+
![wdd-coloring-global-scheme](../../../images/common-coloring-local-scheme.png)
3930

40-
## <a name="coloring"/>Coloring Measures and Dimensions
41-
Dashboard items allow you to manage the coloring of individual dimensions or all dashboard item measures using predefined coloring modes.
31+
For a Local color scheme, the dashboard reassigns palette colors when the filter state is changed.
4232

43-
The following coloring settings are available.
33+
## Color Measures and Dimensions
4434

45-
| Setting | Description |
46-
|---|---|
47-
| **Auto** | Dimension values/measures are colored by default. To learn how specific dashboard items color their elements by default, see the **Coloring** topic for the corresponding [dashboard item](../dashboard-item-settings.md). |
48-
| **On** | Dimension values/measures are colored by different hues. |
49-
| **Off** | Dimension values/measures are colored with the same color. |
35+
You can configure color modes as follows:
5036

51-
You can configure coloring in two ways.
52-
* To specify the coloring mode for the specific measure/dimension, open the data item menu and go to **Data Shaping** section. Use the **Coloring** option to specify coloring mode of this data item.
37+
- A specific data item - To specify the color mode for a specific measure/dimension, open the [data item menu](../ui-elements/data-item-menu.md) and go to the **Data Shaping** section. Use the **Coloring** option to specify the color mode of this data item.
5338

54-
![wdd-coloring-data-item-options](../../../images/img126109.png)
55-
* To see a list of all measures/dimensions for which you can specify coloring mode, open the dashboard item's [Options](../ui-elements/dashboard-item-menu.md) menu and go to the **Coloring** section.
39+
![Coloring for Web Dashboard - Data item coloring options](../../../images/wdd-coloring-data-item-options126109.png)
40+
- All data items - To see a list of all measures/dimensions for which you can specify color mode in a dashboard item, open the dashboard item's [Options](../ui-elements/dashboard-item-menu.md) menu and go to the **Coloring** section.
5641

57-
![wdd-coloring-options](../../../images/img126086.png)
42+
![Coloring for Web Dashboard - Dashboard item options](../../../images/wdd-coloring-options126086.png)
5843

59-
For example, the image below shows the Chart dashboard item whose _Country_ **dimension** is colored by different hues...
44+
For example, the image below shows the Chart dashboard item whose _Country_ **dimension** is colored by different hues:
6045

61-
![wdd-coloring-color-by-measure](../../../images/img126084.png)
46+
![wdd-coloring-color-by-measure](../../../images/wdd-coloring-color-by-measure126084.png)
6247

63-
...and this image shows the Pie dashboard item whose **measures** are colored by different hues.
48+
And the following Pie dashboard item colors **measures** by different hues:
6449

65-
![wdd-coloring-by-measure](../../../images/img126108.png)
50+
![wdd-coloring-by-measure](../../../images/wdd-coloring-by-measure126108.png)
6651

6752
> [!NOTE]
68-
> If you enabled coloring by different hues for several dimensions/measures, all combinations of dimension values/measures will be automatically colored using different colors from the default palette.
53+
> If you enable color variation by different hues for several dimensions/measures, all combinations of dimension values/measures are colored with different colors from the default palette.
6954
70-
## <a name="customizedim"/>Customizing Color Palettes Using the Dashboard Item Menu
55+
## Customizing Color Palettes Using the Dashboard Item Menu
7156
The Web Dashboard allows you to customize colors of the specific palette using the **Color Scheme** section of the dashboard item [Options](../ui-elements/dashboard-item-menu.md) menu. To edit the color scheme, click the **Edit** button (the ![wdd-icon-edit-collection-value-item](../../../images/img126050.png) icon) of the corresponding color.
7257

7358
![wdd-coloring-change-dashboard-item-color-scheme](../../../images/img126112.png)
@@ -80,29 +65,84 @@ A new color scheme will be applied to the dashboard item(s).
8065

8166
![wdd-coloring-change-local-scheme](../../../images/img126127.png)
8267

83-
## <a name="customizecpp"/>Customizing Color Palettes Using the Color Schemes Page
84-
The Color Scheme page of the [dashboard menu](../ui-elements/dashboard-menu.md) allows you to customize color tables by editing and adding colors.
68+
## Dashboard Item Color Mode Specifics
8569

86-
![wdd-coloring-scheme-page](../../../images/img126124.png)
87-
* **Edit colors**. You can reassign a color in the selected color table. For this, select one of the available schemes in the **Color Schemes** pane and click the required color in the **Colors** pane to provide access to the **Color** combo box.
88-
89-
Clicking the **Color** dropdown button invokes a color picker where you can specify a new color.
90-
91-
![wdd-coloring-invoke-color-picker](../../../images/img126133.png)
92-
93-
Click **Confirm** to change the automatically assigned color for the selected value and update the current color scheme.
94-
95-
![wdd-coloring-changed-color](../../../images/img126122.png)
96-
97-
The image below demonstrates the dashboard items that are colored using the updated color table.
98-
99-
![wdd-coloring-new-scheme](../../../images/img126123.png)
100-
* **Add colors**. The Color Scheme page allows you to add a new value with the specified color to the selected color scheme. To do this, use the **Add color** button.
101-
102-
![wdd-coloring-adding-color](../../../images/img126969.png)
103-
104-
Specify the dimension value of the added color or select the required measures. This creates a new value whose color can be specified as described in the **Edit colors** section.
105-
106-
![wdd-coloring-added-color](../../../images/img126964.png)
70+
The following table describes how colors are applied based on the dashboard item's type.
71+
72+
| Item's Name | Coloring Specifics |
73+
| -- | -- |
74+
| **Chart** | The Chart colors different measures and series dimensions by hue. |
75+
| **Scatter Chart** |The Scatter Chart does not color its arguments. |
76+
| **Pies** | If the Pie dashboard item contains measures (the _Values_ section) and series dimensions (the _Series_ section), only values that correspond to different measures are colored by hue. <br> If the Pie dashboard item contains arguments (the _Arguments_ section), different argument values are colored by hue. |
77+
|**Choropleth Map** | The Choropleth Map automatically selects palette and scale settings to color map shapes. |
78+
|**Bubble Map** | The Bubble Map automatically selects palette and scale settings used to color bubbles depending on the provided values.
79+
| **Pie Map** | The Pie Map allows you to color segments that correspond to various dimension values/measures. |
80+
| **Range Filter** | The Range Filter colors different measures and series dimensions by hue. |
81+
| **Treemap** | If the Treemap contains only measures (the _Values_ section), values that correspond to different measures are colored by different hues. <br> If the Treemap contains arguments (the _Arguments_ section), values that correspond to the first argument are colored by different hues. |
82+
83+
To change the default coloring behavior, you can [configure color modes](#color-measures-and-dimensions).
84+
85+
## Conditional Formatting
86+
87+
The DevExpress Dashboard allows you to format [dashboard item](../../web-dashboard-viewer-mode/dashboard-items.md) elements whose values meet a specified condition. This feature highlights specific elements with a predefined set of rules.
88+
89+
Refer to the following article for more information about conditional formatting: [Conditional Formatting](../appearance-customization/conditional-formatting.md).
90+
91+
## Switch between Global and Local Color Schemes
92+
93+
The dashboard supports two ways to color dashboard item elements:
94+
- A **Global Color Scheme** uses consistent colors for identical values across the dashboard.
95+
- A **Local Color Scheme** uses an independent set of colors for each dashboard item.
96+
97+
To switch between global and local color schemes in the Web Dashboard, open the dashboard item's [Option](../ui-elements/dashboard-menu.md) menu, go to the *Color Scheme* section, and select the Color Scheme type.
98+
99+
![Switch between Global and Local Color Schemes](../../../images/switching-color-scheme.png)
100+
101+
>[!TIP]
102+
> The **local** color scheme paints dashboard item elements more quickly because the control does not request all possible colors and requests only colors used in the current item.
103+
104+
### Customize Color Palettes in the Dashboard Item Menu
105+
106+
Use the **Color Scheme** section of the dashboard item [Option](../ui-elements/dashboard-menu.md) menu to customize colors of the specific palette. To edit the color scheme, click the **Edit** button ![wdd-icon-edit-collection-value-item](../../../images/wdd-icon-edit-collection-value-item126050.png) of the corresponding color.
107+
108+
![Coloring for Web Dashboard - Change a dashboard item's color scheme](../../../images/wdd-coloring-change-dashboard-item-color-scheme126112.png)
109+
110+
Then, pick any color in the RGB color model of the invoked color picker and click **Confirm** to change the color.
111+
112+
![Coloring for Web Dashboard - Color picker](../../../images/wdd-coloring-color-picker126125.png)
113+
114+
A new color scheme is applied to the dashboard item(s).
115+
116+
![Coloring for Web Dashboard - Change local color scheme](../../../images/wdd-coloring-change-local-scheme126127.png)
117+
118+
### Customize Color Palettes in the Color Scheme Page
119+
120+
The **Color Scheme** page of the [dashboard menu](../ui-elements/dashboard-menu.md) allows you to edit and add colors to customize color tables.
121+
122+
![Coloring for Web Dashboard - Color scheme page](../../../images/wdd-coloring-scheme-page126124.png)
123+
124+
#### Edit Colors
125+
126+
You can reassign a color in the selected color table. For this, select one of the available schemes in the **Color Schemes** pane and click the color in the **Colors** pane to invoke the **Color** combo box.
107127

108-
You can remove manually added values using the **Remove** button (the ![wdd-icon-delete-big](../../../images/img126104.png) icon).
128+
If you click the **Color** dropdown button, it invokes a color picker where you can specify a new color.
129+
130+
![Coloring for Web Dashboard - Invoke color picker](../../../images/wdd-coloring-invoke-color-picker126133.png)
131+
132+
Click **OK** to change the automatically assigned color for the selected value and update the current color scheme.
133+
134+
![Coloring for Web Dashboard - Changed color](../../../images/wdd-coloring-changed-color126122.png)
135+
136+
#### Add Colors
137+
138+
The Color Scheme page allows you to add a new value with the specified color to the selected color scheme. To do this, use the **Add color** button.
139+
140+
![Coloring for Web Dashboard - Adding color](../../../images/wdd-coloring-adding-color126969.png)
141+
142+
Specify the dimension value of the added color or select the measures. This creates a new value whose color can be specified as described in the **Edit colors** section.
143+
144+
![Coloring for Web Dashboard - Newly added color](../../../images/wdd-coloring-added-color126964.png)
145+
146+
Hover over the custom color and click **Remove** (the ![wdd-icon-delete-big](../../../images/wdd-icon-delete-big126104.png) icon) to remove the color.
147+
148+
![Coloring for Web Dashboard - Delete color](../../../images/wdd-coloring-delete-color.png)

0 commit comments

Comments
 (0)