How to configure a Grid Overlay's legend: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
(Created page with "To influence the visualization for the Grid Overlay, first activate the custom overlay option for the overlay. {{Editor steps|title=activate the custom legend|Select the grid overlay you wish to configure in the editor.|On the right panel, select the "Legend" tab.|Make sure "Has Custom Legend" is checked.}} <gallery mode="nolines"> File:Select_grid_overlay.jpg|Select a grid overlay File:Select_legend.jpg|Select Legend in the right panel File:Select_custom.jpg| Se...")
 
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
To influence the visualization for the [[Grid Overlay]], first activate the custom overlay option for the overlay.
[[Grid Overlay]]s can display wide ranges of values for a wide range of use-cases. The results are computed and stored as individual numeric values on a grid spanning the entire [[Project]]. Based on the [[Legend]] of the [[Grid Overlay]], specific values are visualized with specific colors. Depending on the calculation, the range of results, the theme of the calculation and the intended audience for the results, it is often desirable or even required to configure the legend so that the the full range of data can be easily interpreted visually.
{{Editor steps|title=activate the custom legend|Select the grid overlay you wish to configure in the editor.|On the [[right panel]], select the "Legend" tab.|Make sure "Has Custom Legend" is checked.}}
<gallery mode="nolines">
File:Select_grid_overlay.jpg|Select a grid overlay
File:Select_legend.jpg|Select Legend in the right panel
File:Select_custom.jpg| Select Has Custom Legend
</gallery>


Next, make sure that each color or value you wish to use is defined in the list of legend items.
{{editor location|overlay legend}}
{{Editor steps|title=add a new legend item|Select the grid overlay you wish to configure in the editor.|On the [[right panel]], select the "Legend" tab.|Select "Add" at the bottom of the [[right panel]].|The new legend item is now added with a value of 0.}}
<gallery mode="nolines">
File:Select_grid_overlay.jpg|Select a grid overlay
File:Select_legend.jpg|Select Legend in the right panel
File:Select_add1.jpg| Select Add
File:New_item.jpg| This is the new Legend item
</gallery>


{{Editor steps|title=remove legend item|Select the grid overlay you wish to configure in the editor.|On the [[right panel]], select the "Legend" tab.|Select the legend item you wish to remove.|Select "Remove" at the bottom of the [[right panel]].|The legend item is now removed.}}
{{howto|title=configure a Grid Overlay's legend
<gallery mode="nolines">
| In the [[left panel]] of the editor, select the [[Grid Overlay]] to configure
File:Select_grid_overlay.jpg|Select a grid overlay
| In the [[right panel]], switch to the "Legend" tab
File:Select_legend.jpg|Select Legend in the right panel
| Activate the "Custom Legend" option
File:New_item.jpg| This is the new Legend item
| <!--
File:Select_remove1.jpg| Select Remove
-->{{howtoblock|Ensure the right amount of entries exist:<!--
</gallery>
-->|If the legend should consist of more entries than currently available, click on "Add" at the bottom of the [[right panel]] until the right number of entries exist. (New entries are added with a value of 0).<!--
-->|If the legend should consist of fewer entries than currently listed, select one or more entries to remove and click on "Remove" at the bottom of the [[right panel]].<!--
-->}}
| <!--
-->{{howtoblock|Configure each individual entry in the entry:<!--
-->|To configure the name of the entry, in the top input field of the entry enter the appropriate name/description<!--
-->|To configure the color of the entry, click on the color dropdown and use the color picker to select an appropriate color<!--
-->|To configure the value for which the color should be displayed, enter the appropriate numerical value in the value input field<!--
-->}}
}}


{{Editor steps|title=edit a legend item|Select the grid overlay you wish to configure in the editor.|On the [[right panel]], select the "Legend" tab.|Select the legend item you wish to adjust.|Change the "value" to the value at which you want to show the color.<br>
{{gallery
Note that the legend items are automatically sorted by value.|Click on the color drop-down and select the color you wish to show.|Change the text in the top input field of the legend item to change the caption for this color in the legend.}}
| Select_grid_overlay.jpg | Select a grid overlay
<gallery mode="nolines">
| Select_legend.jpg      | Select Legend in the right panel
File:Select_grid_overlay.jpg|Select a grid overlay
| Select_add1.jpg        | Click on add to "add" an addition entry
File:Select_legend.jpg|Select Legend in the right panel
| New_item.jpg            | Click on an entry to select it
File:New_item.jpg| This is the new Legend item
| Select_remove1.jpg      | Click on "remove" to remove (a) selected entry or entries
File:Change_value.jpg| Change the value of the color
| Change_name.jpg         | Change the name of the entry
File:Change_color.jpg| Change the color of the Legend item
| Change_color.jpg       | Change the color of the entry
File:Change_name.jpg| Change the name of the Legend item
| Change_value.jpg       | Change the value of the entry
</gallery>
}}


{{article end
{{article end
|seealso=[[Grid Overlay]]
|notes=
* The order of entries is dictated by the values of the entries. While editing the values, the entries may reorder automatically.
* Any value in the [[Grid Overlay]] results which exactly matches an entry in the legend, will be displayed with that entry's color.
** Any value higher or lower than the highest or lowest entry in the legend will be displayed with the color of the highest of lowest entry respectively.
** Any value in between the values of two entries in the legend will be displayed with the interpolated color of the two closest entries.
** [[NO_DATA]] values are automatically visualized as transparent.
* The name of an entry cannot be empty. However, a "space" can be used instead to display a color without a (visible) text.
* The [[Grid Overlay]]'s legend can be reset to the default by unchecking the "Custom Legend" option. Any customizations to that [[Grid Overlay]]'s legend are then discarded.
|seealso=
* [[Grid Overlay]]
}}
}}
[[Category:How-to's]]

Latest revision as of 13:31, 30 January 2024

Grid Overlays can display wide ranges of values for a wide range of use-cases. The results are computed and stored as individual numeric values on a grid spanning the entire Project. Based on the Legend of the Grid Overlay, specific values are visualized with specific colors. Depending on the calculation, the range of results, the theme of the calculation and the intended audience for the results, it is often desirable or even required to configure the legend so that the the full range of data can be easily interpreted visually.

Editor → Current Situation (Ribbon tab) → Overlays (Ribbon bar) → The Overlay to edit (Left panel) → Legend tab (Right panel)
How to configure a Grid Overlay's legend:
  1. In the left panel of the editor, select the Grid Overlay to configure
  2. In the right panel, switch to the "Legend" tab
  3. Activate the "Custom Legend" option
  4. Ensure the right amount of entries exist:
    If the legend should consist of more entries than currently available, click on "Add" at the bottom of the right panel until the right number of entries exist. (New entries are added with a value of 0).
    If the legend should consist of fewer entries than currently listed, select one or more entries to remove and click on "Remove" at the bottom of the right panel.
  5. Configure each individual entry in the entry:
    To configure the name of the entry, in the top input field of the entry enter the appropriate name/description
    To configure the color of the entry, click on the color dropdown and use the color picker to select an appropriate color
    To configure the value for which the color should be displayed, enter the appropriate numerical value in the value input field



Notes

  • The order of entries is dictated by the values of the entries. While editing the values, the entries may reorder automatically.
  • Any value in the Grid Overlay results which exactly matches an entry in the legend, will be displayed with that entry's color.
    • Any value higher or lower than the highest or lowest entry in the legend will be displayed with the color of the highest of lowest entry respectively.
    • Any value in between the values of two entries in the legend will be displayed with the interpolated color of the two closest entries.
    • NO_DATA values are automatically visualized as transparent.
  • The name of an entry cannot be empty. However, a "space" can be used instead to display a color without a (visible) text.
  • The Grid Overlay's legend can be reset to the default by unchecking the "Custom Legend" option. Any customizations to that Grid Overlay's legend are then discarded.

See also