Dashlets
==========


**Dashlets** allow users to display query results on their **Dashboard**
in four ways:

-  Charts

-  Tables

-  Pivot tables

-  Maps (future)

   To be able to see the query on the Dashboard, a Dashlet needs to be
   created and pinned to the dashboard. In the **Dashboard**, click on
   **Dashlets.**

|image0|

The Dashlet window lists the Dashlets in the same way as the queries
with **My Dashlets, Standard Dashlets, Shared Dashlets** and **All
Dashlets.** Click on **New Dashlet.**

|image1|

The Dashlet window lists the Dashlets in the same way as the queries.
There are four tabs:

-  **My Dashlets –** list of dashlets that you have created

-  **Standard Dashlets** – standard dashlets that the administrator has
   created for all users

-  **Shared Dashlets** – dashlets that has been shared by other users

-  **All Dashlets** – all dashlets available to you

Creating a new Dashlet
-----------------------

|image2|

To create a new dashlet click on **New Dashlet** button. A dialog box
will appear where you can give your new dashlet a name and add a
description.

Give the new Dashlet a name and configure properties. Set the height to
300, width to 10.

|image3|

**Height setting** – the height of the dashlet as it appears on the
dashboard. Increase the height by increasing the height value.

**Width setting** – the width of the dashlet as it appears on the
dashboard. Set the width to 12 if you want you dashlet to take up the
full width of the dashboard.

**Css class** - this displays the dashlet in different colours:

-  Default = light grey

-  Primary = dark blue

-  Info = light blue

-  Success = light green

-  Warning = light red

-  Danger = darker red

-  Muted = white, no colour

|image4|

**Query** - select the query you would like the dashboard to use from
the drop-down list. You will see all queries that has been created in
the system, to which you have access. Typing the name of the query
filters the list of queries for easier selection.

|image5|

|image6|

**Is snapshot -** this setting makes the dashlet either dynamic or
static. When you select snapshot, the query will be fixed in time and
not update as data is updated in the database.

**Is active** - this setting enables or disables the dashlet.

**Update interval -** set the interval (in seconds) to update the data
in the dashlet if snapshot is not selected.

**Is shared -** set the dashlet shared if you want other users to have
access to it.

|image7|

**Is standard –** Keep this un-ticked

**Widget** – select what format you would like the dashlet to appear on
the dashboard

Select Category as **Inventory.**

|image8|

The new Dashlet can be linked to a map and/or layer. Whith this option
the selected layer and map will have the Dashlet linked/reference to it.

|image9|

For this exercise, we will select **georams\_network** as the **Layer,**
and **Madikgetla RNI Condition map** as the **Map**.

|image10|

|image11|

Click on **SAVE**, when done.

|image12|

Refresh the Dashlet window to list the newly created Dashlet by closing
the window, then Open the Dashlet window again. Click on **My
Dashlets.** The new Dashlet is listed as **id 4.**

|image13|

You will see that it does not have a **is pinned** mark.

|image14|

To **Pin** this Dashlet to the dashboard, click on the blue button on
the right-hand side, and select **Pin.**

|image15|

This is also the place where you can **Unpin, Edit Dashlet**, **Edit
Chart** or **Delete** it. If this Dashlet is set to **Standard** when it
was created, only the user that created it will have these options.
Close the Dashlet window and reload the browser to see the updated
Dashboard.

|image16|

|image17|

**Create a Pivot**

Click on Dashlets, Create Dashlet and select a query to use as a Pivot
table. For the purpose of this exercise we will use “\ **Km summary by
Surface type and Municipality**\ ” as the query.

|image18|

|image19|

Select **Pivot** as the Widget option

|image20|

Close the Dashlet window and open it again to reload the newly created
Dashlet. Click on **Pin** to add it to the Dashboard.

|image21|

Reload the Browser to load the newly created Pivot Dashlet. Click on
**FullScreen** to see the columns.

|image22|

Click and drag the columns around to display the results.

|image23|

We need to see the total sum of the length in km. Select **Sum** in the
dropdown list. Click below **Sum,** the column to sum, in this case
**Length(Km)**

|image24|\ |image25|

Drag the column name **municipality** to the left and **surfacetype** to
the bottom. This will give the result for total km of road per surface
type and Municipality.

|image26|

This can now be viewed in many different ways. Click on the **Table**
drop down to select one of the options.

|image27|

|image28|

Click on the **minimize** button to close the **full screen** view or
Click on the **Pin** button to pin it back to the Dashboard

Dashlet navigation bar
-----------------------

|image29|

|image30|

Pin or unpin the dashlet from the dashboards. When unpinned the dashlet
window can be moved anywhere on the screen

|image31|

Minimises the dashlet so that just the dashboard title bas is visible.
This reduces clutter on the dashboard

|image32|

Resizes the dashlet into a full screen window

|image33|

Closes the dashlet window. The dashlet will reload when the screen is
refreshed.

|image34|

Shows the geometries of the features listed in the dashlet on the
dashboard map

Dashlets that are linked to Layers and/or Maps
-----------------------------------------------

Click on **Maps** to open the map that you want to work with

|image35|

Select **View Map** of the Map that we linked to the Dashlet.
“\ **Madikgetla RNI Condition map”.**

|image36|

In the Map window, the left hand side indicates the layers that are
loaded in the map, and the right hand side displays the map.

|image37|

Click on the **georams\_network** layer. The layer will highlight. Click
on **Layer Info** to see the Dashlets that are linked to the layer in
the map.

|image38|

In this layer information window click on **Queries** and **Dashlets**
to see a list of queries and Dashlets that are linked to this layer.

|image39|

In this case only one Dashlet is linked. New Dashlets can also be
created in this view/window.

|image40|

.. |image0| image:: media/image1.png
   :width: 2.04195in
   :height: 0.83345in
.. |image1| image:: media/image2.png
   :width: 6.26806in
   :height: 3.06458in
.. |image2| image:: media/image3.png
   :width: 1.03333in
   :height: 0.39306in
.. |image3| image:: media/image4.png
   :width: 2.54105in
   :height: 3.20833in
.. |image4| image:: media/image5.png
   :width: 3.02039in
   :height: 3.34343in
.. |image5| image:: media/image6.png
   :width: 3.67760in
   :height: 2.06279in
.. |image6| image:: media/image7.png
   :width: 3.06250in
   :height: 2.00000in
.. |image7| image:: media/image8.png
   :width: 2.52708in
   :height: 1.82014in
.. |image8| image:: media/image9.png
   :width: 2.83333in
   :height: 1.20000in
.. |image9| image:: media/image10.png
   :width: 2.75000in
   :height: 1.23711in
.. |image10| image:: media/image11.png
   :width: 3.44840in
   :height: 1.12516in
.. |image11| image:: media/image12.png
   :width: 3.36458in
   :height: 2.14881in
.. |image12| image:: media/image13.png
   :width: 0.71181in
   :height: 0.57292in
.. |image13| image:: media/image14.png
   :width: 5.50000in
   :height: 2.67505in
.. |image14| image:: media/image15.png
   :width: 0.80568in
   :height: 0.76042in
.. |image15| image:: media/image16.png
   :width: 2.62500in
   :height: 1.23214in
.. |image16| image:: media/image17.png
   :width: 1.77502in
   :height: 0.94792in
.. |image17| image:: media/image18.png
   :width: 6.26806in
   :height: 3.10139in
.. |image18| image:: media/image19.png
   :width: 3.40625in
   :height: 1.47349in
.. |image19| image:: media/image20.png
   :width: 3.09375in
   :height: 1.26313in
.. |image20| image:: media/image21.png
   :width: 3.33333in
   :height: 1.38889in
.. |image21| image:: media/image22.png
   :width: 2.28125in
   :height: 1.00011in
.. |image22| image:: media/image23.png
   :width: 2.11493in
   :height: 1.67708in
.. |image23| image:: media/image24.png
   :width: 5.08333in
   :height: 1.51779in
.. |image24| image:: media/image25.png
   :width: 2.43232in
   :height: 1.78080in
.. |image25| image:: media/image26.png
   :width: 2.15625in
   :height: 1.78125in
.. |image26| image:: media/image27.png
   :width: 5.51042in
   :height: 2.67157in
.. |image27| image:: media/image28.png
   :width: 2.35513in
   :height: 2.85417in
.. |image28| image:: media/image29.png
   :width: 5.61458in
   :height: 2.78428in
.. |image29| image:: media/image30.png
   :width: 2.17361in
   :height: 0.62639in
.. |image30| image:: media/image31.png
   :width: 0.30694in
   :height: 0.44028in
.. |image31| image:: media/image32.png
   :width: 0.32014in
   :height: 0.45347in
.. |image32| image:: media/image33.png
   :width: 0.32014in
   :height: 0.44028in
.. |image33| image:: media/image34.png
   :width: 0.32639in
   :height: 0.44028in
.. |image34| image:: media/image35.png
   :width: 1.10694in
   :height: 0.50694in
.. |image35| image:: media/image36.png
   :width: 2.25000in
   :height: 0.58094in
.. |image36| image:: media/image37.png
   :width: 5.97917in
   :height: 1.14072in
.. |image37| image:: media/image38.png
   :width: 5.73657in
   :height: 3.48542in
.. |image38| image:: media/image39.png
   :width: 2.76080in
   :height: 2.30240in
.. |image39| image:: media/image40.png
   :width: 6.26806in
   :height: 2.72292in
.. |image40| image:: media/image41.png
   :width: 6.26806in
   :height: 1.31667in