Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update with Outlier table information #3013

Merged
merged 3 commits into from
Apr 11, 2024
Merged
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
8 changes: 5 additions & 3 deletions docs/data-visualizer.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ For each visualization type there is a brief description with suggestions about
| Single value | Displays a single value in a dashboard friendly way. If the dimension displayed has an indicator type assigned, a % symbol or a string (per thousand, per hundred thousand, etc...) is appended to the value.<br/>If an icon is assigned to the dimension in the Maintenance app, it can be shown on the side of the value, the icon can be toggled in the Options panel.<br><br>Layout restrictions: same as Gauge. |
| Pivot table | Summarizes the data of a more extensive table and might include sums, averages, or other statistics, which the pivot table groups together in a meaningful way.<br><br>Layout restrictions: none. |
| Scatter | Scatter plots enable users to chart organisational units as points against two variables for a single fixed or relative period.<br><br>Layout restrictions: exactly 1 item each as vertical and horizontal, data dimension is locked to vertical and horizontal, organisation unit is locked to points. |
| Outlier table | Displays a list of outliers based on historical data.<br><br>Layout restrictions: organisation unit, period and data dimensions are locked to columns, no other dimensions can be added. |

### Select dimensions

Expand Down Expand Up @@ -171,6 +172,7 @@ The display of a visualization can be changed by enabling/disabling and configur
| Hide empty categories | Hides the category items with no data from the visualization.<br>**Before first**: hides missing values only before the first value<br>**After last**: hides missing values only after the last value<br>**Before first and after last**: hides missing values only before the first value and after the last value<br>**All**: hides all missing values<br>This is useful for example when you create Column and Bar visualizations. |
| Hide empty columns | Hides empty columns from a Pivot table. This is useful when you look at large tables where a large portion of the dimension items don't have data in order to keep the table more readable. |
| Hide empty rows | Hides empty rows from a Pivot table. This is useful when you look at large tables where a large portion of the dimension items don't have data in order to keep the table more readable. |
| Max results | Sets the maximum number of rows to display in a Outlier table. The allowed range is 1 to 500. |
| Number type | Sets the type of value you want to display in a Pivot table: Value, Percentage of row or Percentage of column.<br>The options Percentage of row and Percentage of column mean that you'll display values as percentages of row total or percentage of column total instead of the aggregated value. This is useful when you want to see the contribution of data elements, categories or organisation units to the total value. |
| Only include completed events | Includes only completed events in the aggregation process. This is useful for example to exclude partial events in indicator calculations. |
| Row sub-totals | Displays sub-totals in a Pivot table for each dimension.<br>If you only select one dimension, sub-totals will be hidden for those rows. This is because the values will be equal to the sub-totals. |
Expand All @@ -180,7 +182,7 @@ The display of a visualization can be changed by enabling/disabling and configur
| Target line | Displays a horizontal line at the given domain value. Useful for example when you want to compare your performance to the current target. |
| Trend line | Displays the trend line that visualizes how your data evolves over time. For example if performance is improving or deteriorating. Useful when periods are selected as category. |
| Value labels | Shows the values above the series in the visualization. |
| | Axes tab |
| | **Axes tab** |
| Axis range | Defines the maximum and minimum value that will be visible on the range axis. |
| Axis title | Type a title here to display a label next to the x or y axis. Useful when you want to give context information to the visualization, for example about the unit of measure.<br>`Auto generated from axis items` provides a title based on the content of the axis.<br>None removes the title.<br>`Custom` allows you to type a custom title. |
| Decimals | Defines the number of decimals that will be used for range axis values. |
Expand Down Expand Up @@ -308,14 +310,14 @@ Saving your visualizations makes it easy to find them later. You can also choose

2. Click **Delete**.

![](resources/images/data-visualizer-delete-dialog.png)

### Get the link to the visualization

1. Click **File** \> **Get Link**.

2. The URL can be copied via the browser's context menu that opens when right clicking on the link.

![](resources/images/data-visualizer-delete-dialog.png)

## Visualization interpretations

When viewing a saved visualization, you can expand the interpretations on the right side by clicking on the Interpretations button in the upper right corner. The visualization description will also be shown. The description supports rich text format.
Expand Down
Binary file modified docs/resources/images/data-visualizer-delete-dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/resources/images/data-visualizer-file-open.png
Binary file not shown.
Binary file modified docs/resources/images/data-visualizer-open-dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/resources/images/data-visualizer-share-dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/resources/images/data-visualizer-view-interpretation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/resources/images/data-visualizer-visualization-type.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading