| PivotCube Visual Guide | Overview |
| General |
The dimension toolbar is used to manipulate the dimension items of the PivotCube. You link the toolbar to a cube indirectly using the Map property. The appearance of the toolbar is determined by the TPvDimToolbar.Settings property. The appearance of individual dimension items is determined by the TPvDimToolbar.ItemSettings property.
You can also organize the layout of the dimension items in the PivotMap by using the MapBuilder. Please see the visual guide for TPivotGrid to see how to activate the MapBuilder.
| Expand / collapse toolbar |
You can collapse the dimension toolbar in order to have a bigger display area for the other PivotCube user interface elements. To expand it, simply click on the image again.
You can also control the state of the toolbar by using the Collapsed property of the toolbar. The default value of this property is False.
| Dimension items |
The dimensions that are displayed are obtained from the underlying TPivotCube, linked as follows:
TPvDimToolbar.Map > TPivotMap.Cube > TPivotCube.Dimensions
The order of the items on the dimension toolbar has no significance. The order of the dimension items is determined by the order of the items in the underlying TPivotCube. You may want to put the frequently used dimensions first, so that they appear nearer to the left and the user can easily activate the Dimension Editor for those dimensions, or drag them to the dimension rows or dimension columns toolbars.
All dimensions are displayed on the toolbar, except for those dimensions that are displayed on the dimension rows and columns toolbars. The dimensions that are displayed on those toolbars are those listed in the Columns and Rows properties of the TPivotMap specified in the Map property of this dimension toolbar.
| Dimension item labels |
The dimension labels are obtained from the DisplayName property of each dimension, and is linked as follows:
TPvDimToolbar.Map > TPivotMap.Cube > TPivotCube.Dimensions > TDimensions.DimensionItem > TDimensionItem.DisplayName
| Activate dimension editor |
Click on this button to activate the dimension editor. To close the dimension editor, either click on the Cancel button on the dimension editor, or press ESC.
When filtering is active, the color of this button will change to green (by default). When some items are set to a non-visible state and no filtering is active, the color of the button will change to blue (by default).
| Turn incremental filtering mode on / off |
Incremental filtering allows you to filter the values in the cube by individual dimension values. If you need to filter using more than 1 value, you need to use the Dimension Editor instead. Once incremental filtering mode is on, you can cycle through the dimension values by clicking on the filter value selectors. The active value used for incremental filtering will also be displayed, and the filter indicator will turn green (the default color).
You can also control the filtering mode by using the ViewFilter property of the toolbar. The default value of this property is False.
| Active value for incremental filtering |
This is the value currently used for incremental filtering of the dimension item. To check if a dimension is currently filtered, use the TPvDimToolbar.Items[x].Filtered property.
To turn incremental filtering off, activate the dimension editor, set all values to visible, and click on the Apply button.
| Non-visible item indicator |
When there are dimension items that are not visible (due to user settings), and filtering is not active for that item, the color the button will turn blue (by default). To change this color, change the value of the TPvDimToolbar.ItemSettings.InvisibleColor property.
| Filter indicator |
When incremental filtering is active, the color of the button to activate the dimension editor will turn color to green (by default). To change this color, change the value of the TPvDimToolbar.ItemSettings.FilteredColor property.
To know which values are currently active when a dimension is filtered, you need to read properties from both the cube and map. For example, to know which values are currently active for the first dimension item when filtered, you can use the following:
var
Alias: string;
f, g: Integer;
begin
if not pvDimToolbar1.Items[0].Filtered then Exit;
Alias := pvDimToolbar1.Items[0].Alias;
for f := 0 to PivotCube1.Dimensions.Count - 1 do
begin
if PivotMap1.Dimensions[f].AliasName = Alias then
begin
for g := 0 to PivotMap1.Dimensions[f].Count - 1 do
begin
if PivotMap1.Dimensions[f].Items[g].State = disActive then
ShowMessage(PivotMap1.Dimensions[f].Items[g].Name);
break;
end;
end;
end;