This article only applies to Squared Up Version 2.0. If you're looking for help with Squared Up Version 3.0, please visit our new knowledge base

Overview

Squared Up allows you to overlay health status icons over any image such as a map, using the Map plugin. This plugin is installed with Squared Up.

Configuration


Adding an Image section to a dashboard


Create a new section within the designer, then select 'Image' from the Type:



Setting an Image


Either select from a selection of built-in images, or upload an image.


https://freevectormaps.com/ has a selection of maps to download.

Setting the Scope


The scope setting is common to several Squared Up plugins and is described in How to set the scope using the dashboard designer 



Once the scope is configured the image will be overlaid with the items in scope.


Icon Positions


The icons can be placed in the correct locations while in edit mode.

Icons can be resized using the options: normal, small, small and xxsmall.  The colour replace option with the Visio plugin is a good alternative if these icon sizes are not suitable.



Display Completed Map (Image) Plugin



Once the plugin is configured, click 'done' and the settings grid will collapse and display the completed Map (Image) plugin.


Uploading a custom Image


Press the edit button for the section, then upload to an image expand the background section, drag an image and drop it on the drop zone. Various formats are supported, including JPEG, PNG and SVG.


After a few moments the image will be uploaded and displayed.


Then place the icons in the required places.




Once the Image is configured, click 'done'.


XML Configuration

The dashboard designer writes these settings as XML to a dashboard file within C:\inetpub\wwwroot\SquaredUpv2\Configuration\Views. Below is an example of the XML it will write for this section:

    <Section>
      <Id>1426607973608</Id>
      <Title>New section</Title>
      <Plugin>Map</Plugin>
      <ScomData>
        <DataType>object</DataType>
        <Scope>
          <Group>6f7e3306-beeb-2996-3795-7c1eafb925b8</Group>
          <Filters />
          <Objects />
        </Scope>
      </ScomData>
      <Settings>
        <NameValueSetting>
          <Name>imagepath</Name>
          <Value />
        </NameValueSetting>
        <NameValueSetting>
          <Name>imagefilename</Name>
          <Value>world-dots.png</Value>
        </NameValueSetting>
      </Settings>
    </Section>

  

XML Settings Reference

Name Values Comments Required Designer
imagepath <string> path relative to C:\inetpub\wwwroot\SquaredUpv2 e.g. Maps
Defaults to the Map plugin /contents/images directory, which contains world.png.
No Yes
imagefilename <string> an image filename, example: my-dashboard-background.png
Yes Yes
 iconSize
normal (default) |
small | xsmall | xxsmall
Controls the icon size
No No



See also:

The Dashboard Designer - The Quick Start Guide