Differences

This shows you the differences between two versions of the page.

--- panels:msupply-region-map [2021/01/15 04:25] – created Mark Prins
+++ panels:msupply-region-map [2021/01/15 04:40] (current) – Mark Prins
@@ Line 1: / Line 1: @@
-===== mSupply Table =====
+===== mSupply Region Map =====
-This is a custom panel which will need to be installed on your server. Contact mSupply support if this panel is not available to you.
-The mSupply table is an extension of the bundled Table plugin, which adds
- * clickable actions to cells which update filter values
- * a button which allows exporting the data direct to excel (requires the msupply-dashboard-app plugin also )
-Be aware that it also removes the Filter functionality of the bundled table plugin.
+This is a custom panel which will need to be installed on your server. Contact mSupply support if this panel is not available to you.\\
+The region map displays a value and a geographic outline on a map, and allows you to set the colour thresholds for each region. This gives a quick visualisation of geographical data.\\
+Additionally, you can define clickable actions to update filter values based on the region selected, as shown
-{{:en:dashboard:msupply-table.gif?direct|}}
+{{:en:dashboard:region-map.gif?|}}
-To use, select the msupply-table visualisation option:
+To use, select the msupply-regionmap visualisation option:
-{{:en:dashboard:msupply-table-visualisation.png?direct&200|}}
+{{:dashboard:regionmap-visualisation.png?200|}}
-The new options available in the **Display** section are:
+There are a number of options available in the **Display** section:
-{{:en:dashboard:msupply-table-display-properties.png?direct&400|}}
+{{:en:dashboard:region-map-display-properties.png?400|}}
- * **Show export button** toggles display of the export button
+  * **Centre** the latitude and longitude of the centre of the map
- * **Export button title** which allows customising of the export button text
+  * **Initial Zoom** a numerical value for the initial zoom level of the map. Higher values are more zoomed in
+  * **Show Legend** toggles the display of a tooltip on mouse over
+  * **Mouse Wheel Zoom** toggles the ability to zoom the map using the mouse wheel
+  * **Label template** specifies a custom format for the tooltip. Use ${name} for the name field, ${value} for the numerical value and ${unit} for the unit field ( if used )
+  * **Linked Variable** Is where you can specify a linked filter - the variable with this name is updated when a region is clicked
+  * **Decimals** the number of decimals to truncate the display value to
+  * **geoJSON Field** specify the name of the field in your query which returns geoJSON data
+  * **Metric Field** specifies the name of the numerical value field
+  * **Location Name Field** specifies the name of the field containing a text value. Used in the tooltip / label as the name of the region
-And the option to link a cell to a variable is per field, so it can be specified as an override to select this for a single column only:
-{{:en:dashboard:msupply-table-linked-variable.png?direct&400|}}