Map === The map view shows the status of all the links and nodes in the network. The legend shows the status of nodes, links, and sites in the network. Navigation ^^^^^^^^^^ .. |map_compass| image:: _static/map_compass.png .. |map_zoom| image:: _static/map_zoom.png .. |map_zoom_out| image:: _static/map_zoom_out.png .. csv-table:: :header: "Icon", "Function", "Description" :widths: auto "N/A", "Pan", "Left click + drag mouse" "|map_compass|", "Rotate", "Right click + drag mouse, click the compass button to reset rotation to North" "|map_zoom|", "Zoom", "Left click + drag mouse" "N/A", "Search", "Enter a node name, site name, or address in the search box and choose it from the typeahead to select it in the map and zoom to its location." .. figure:: _static/map_navigation.png TGNMS search, zoom, compass, and annotation tools Sidebar ^^^^^^^ Click the title of the sidebar menus to expand or collapse them. Overview """""""" .. |map_gear| image:: _static/map_gear.png The overview menu gives quick information about the state of the :ref:`network `. * **Link Availability** - See the uptime of network :ref:`links ` over the selected time window (use the |map_gear| icon to change the window length. * **Topology** - Show which of the established :ref:`links `, :ref:`sectors `, and :ref:`sites ` are up. * **Ignition State** - Show whether the network has been :ref:`ignited `. Node / Site Details """"""""""""""""""" .. figure:: _static/site_details.png Site details menu By clicking a site on the map, you can view and edit its details. The sectors are shown in blue and correspond to their names below. Choosing one of these selectors takes you to the node details page. On the node details menu under "View Actions" you can issue commands to the node to do tasks, including: reboot the node, restart :ref:`minion `, and edit the :ref:`topology `. .. figure:: _static/node_details.png Node details menu Map Layers """""""""" The map layers menu lets you control the elements shown on the map. The details menu has the following options: * **Links Overlay** - Change the value used to color :ref:`links ` on the map and update the legend accordingly. * **Sites Overlay** - Change the value used to color :ref:`sites ` on the map and update the legend accordingly. * **Nodes Overlay** - Change the value used to color :ref:`nodes ` on the map and update the legend accordingly. * **Areas Overlay** - Group nodes with a color by IP address prefix. * **Map Style** - Choose between satellite and street view for the map tiles. The historical and custom menus can be used to view the statistics on the map for a particular time in the past. .. figure:: _static/map_layers.png Map layers menu Annotations ^^^^^^^^^^^ The annotations tool can be used to mark up the network map to include notes, potential network revisions, issues or plans on the map itself. The tool includes shapes, lines, and sites as well as measurement tools. .. figure:: _static/annotations_pencil.png Activate the annotations tool by clicking the pencil Click the pencil in the top left to activate the tool. This will add the "Annotation Layers" menu to the sidebar where you can configure layers for annotations, select colors for annotations, and give them names. Annotations in different layers can be toggled independently to help organize the annotations. .. figure:: _static/annotation_tools_and_layers_menu.png Annotation tools on the left and layers on the right The annotation tools are: * **Line** - Click and move mouse to draw a line. Click again to add a point, double click to end line. * **Polygon** - Click and move mouse to draw points of a polygon. Click again to add more points, double click to end the polygon. * **Point** - Click to add a single point to the map. * **Delete** - Select an annotation in the map, then click the trash icon to remove it. * **Group** - Shift + click on multiple annotations to add them to a group with a single name. * **Ungroup** - Select a group of annotations and ungroup to break them back into individual annotations. Tables ^^^^^^ .. figure:: _static/tables_button.png Open an inline view of the :ref:`tables ` section.