Appboard/2.4/builder/widgets/tile map: Difference between revisions
imported>Jason.nicholls |
imported>Mike.berman (update for latest properties and settings in 2.4) |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:Tile Map Widget}} | {{DISPLAYTITLE:Tile Map Widget}} | ||
The '''Tile Map Widget''' | The '''Tile Map Widget''' displays tile-based maps from a server that conforms to the [http://www.openstreetmap.org Open Street Maps] architecture. | ||
This Widget provides advantages over the Vector Map Widget because it can show details such as streets and satellite imagery. The Widget also provides advantages over the Google Map Widget, because it does not require an internet connection and is not reliant upon the Google mapping technology and data. | |||
As in other AppBoard map Widgets, the data source for the Widget must contain fields with Longitude and Latitude for each node to be drawn on the map. | |||
The use of KML is not supported in the Tile Map Widget. | |||
[[File:Tile_Map_Widget.PNG]] | [[File:Tile_Map_Widget.PNG]] | ||
== How To Create a Tile Map Widget == | == How To Create a Tile Map Widget == | ||
For instructions on creating a Widget, see the general instructions in [[appboard/2.4/builder/Widgets#Adding_Widgets|Adding Widgets]]. The '''Tile Map''' type is located under the '''Maps''' category on the Widget selection screen. | For instructions on creating a Widget, see the general instructions in [[appboard/2.4/builder/Widgets#Adding_Widgets|Adding Widgets]]. The '''Tile Map''' type is located under the '''Maps''' category on the Widget Type selection screen. | ||
== How To Configure a Tile Map Widget == | == How To Configure a Tile Map Widget == | ||
# Follow the instructions above to create the basic '''Tile Map Widget'''. | # Follow the instructions above to create the basic '''Tile Map Widget'''. | ||
#: | |||
# Enter the following information on the '''Data''' tab: | # Enter the following information on the '''Data''' tab: | ||
#* '''Data Collection''' - Select the name of the Data Collection that will provide the data to be displayed in the '''Tile Map'''. | #* '''Data Collection''' - Select the name of the Data Collection that will provide the data to be displayed in the '''Tile Map'''. | ||
#** | #** For convenience, buttons are provided for Adding or Editing a Data Collection. | ||
#** If you are using the AppBoard [[appboard/2.4/builder/Sample_Chart_Data|Sample Chart Data]], select the ''sample.Data.Airport'' Data Collection. | #** If you are using the AppBoard [[appboard/2.4/builder/Sample_Chart_Data|Sample Chart Data]], select the ''sample.Data.Airport'' Data Collection. | ||
#** The selected Data Collection must contain two separate fields with geographical coordinates representing the Latitude and Longitude of each node to be drawn on the map. | |||
#* '''Widget Name''' - Enter the name to display for the Widget in the Widget Title Bar. | |||
#* [Optional] Configure an [[appboard/2.4/Configure_Alternate_Widget|Alternate Widget]] to be displayed on mobile devices, since this Widget is only supported for display in the desktop AppBoard Viewer. | |||
#: | |||
# Enter the following information on the '''Visualization''' tab: | # Enter the following information on the '''Visualization''' tab: | ||
#* '''Map Tiles''' - Select the tile style or server that you wish to use. | #* '''Map Tiles''' - Select the tile style or server that you wish to use from the list of available tile types. | ||
#* '''Latitude Field''' - Select the column of data that | #* '''Latitude Field''' - Select the column of data that provides latitude coordinates. | ||
#* '''Longitude Field''' - Select the column of data that | #* '''Longitude Field''' - Select the column of data that provides longitude coordinates. | ||
#* '''Marker Type''' - Toggle this switch to choose | #* '''Marker Type''' - Toggle this switch to choose the type of image to draw for each node on the map: | ||
#* ''' | #** '''Status Shape''' - Display a colored shape for each node on the map | ||
#* ''' | #** '''Icon''' - Display an icon with a status shape in the top left corner for each node on the map. | ||
#* ''' | #* '''Auto Zoom''' - Toggle the automatic zoom controls: | ||
#* '''Default | #** '''Off''' - The full map is displayed when the Widget is invoked on the Board. | ||
#* | #** '''Fit To Data''' - AppBoard will automatically zoom to the "best fit" zoom level when the Widget is invoked on the Board. | ||
#* '''Default Shape''' - The default | #* '''Default Shape''' - The default shape to use when the "Status Shape" Marker Type is selected (see above). | ||
#* [Optional] '''Shape Filter''' - Select the name of the filter you would like to use or click "Add" to create a new filter. A | #* '''Default Color''' - The default color to apply to the shape when the "Status Shape" Marker Type is selected (see above). | ||
#* [ | #* '''Default Shape Size''' - The default size to use for the shape when the "Status Shape" Marker Type is selected (see above). | ||
#* [ | #* [Optional] '''Colored Shape Filter''' - Select the name of the filter you would like to use or click "Add" to create a new filter. A Color Filter allows you to set rules for displaying different colors for the markers on the map where certain conditions are met in the corresponding data. For more information, see [[Color_Filter|Color Filter]] | ||
#* [Optional] '''Default Icon''' - When the "Icon" Marker Type is selected (see above), this item selects the icon to display for each node. | |||
#* [Optional] '''Icon Size''' - When the "Icon" Marker Type is selected (see above), this item determines the size of each icon. | |||
#* [Optional] '''Icon Badge Filter''' - When the "Icon" Marker Type is selected (see above), this allows for different icons to be displayed conditionally based on the attributes of each individual node on the map. | |||
#* '''Preview''' - This section provides a small preview of the Tile Map. | #* '''Preview''' - This section provides a small preview of the Tile Map. | ||
# | #: | ||
# Provide additional configuration on the '''Options''' tab. For details on the available Options, see [[Options|Options]]. | # Provide additional configuration on the '''Options''' tab. For details on the available Options, see [[Options|Options]]. | ||
# | #: | ||
# Click ''' | # Click '''Close'''. | ||
# | #: | ||
# In the '''Builder Modes''' panel, select '''Builder''' and navigate to the appropriate Board to observe the new Tile Map Widget. | # In the '''Builder Modes''' panel, select '''Builder''' and navigate to the appropriate Board to observe the new Tile Map Widget. | ||
{{Note|Changes to the preview map positioning or zooming will be saved.}} | {{Note|Changes made to the preview map positioning or zooming during configuration will be saved as defaults for the widget.}} | ||
== Importing Offline Tile Data == | == Importing Offline Tile Data == | ||
The Tile Map Widget supports the use of custom tiles as offline tile data. Perform the following steps to import offline tile data into AppBoard for use in the Tile Map Widget: | |||
# Open a terminal window (i.e., CMD/shell prompt) | # Open a terminal window (i.e., CMD/shell prompt) | ||
# Shutdown | # Shutdown the AppBoard server | ||
# Change directory to server/bin/ | # Change directory to [Install_Home]/server/bin/ | ||
# Run the following command: | # Run the following command: | ||
#* UNIX: <tt>./portal.sh FilesImport -jar <OfflineTilePackage></tt> | |||
#* Windows: <tt>portal.bat FilesImport -jar <OfflineTilePackage></tt> | |||
Revision as of 00:44, 3 August 2013
The Tile Map Widget displays tile-based maps from a server that conforms to the Open Street Maps architecture.
This Widget provides advantages over the Vector Map Widget because it can show details such as streets and satellite imagery. The Widget also provides advantages over the Google Map Widget, because it does not require an internet connection and is not reliant upon the Google mapping technology and data.
As in other AppBoard map Widgets, the data source for the Widget must contain fields with Longitude and Latitude for each node to be drawn on the map.
The use of KML is not supported in the Tile Map Widget.
How To Create a Tile Map Widget
For instructions on creating a Widget, see the general instructions in Adding Widgets. The Tile Map type is located under the Maps category on the Widget Type selection screen.
How To Configure a Tile Map Widget
- Follow the instructions above to create the basic Tile Map Widget.
- Enter the following information on the Data tab:
- Data Collection - Select the name of the Data Collection that will provide the data to be displayed in the Tile Map.
- For convenience, buttons are provided for Adding or Editing a Data Collection.
- If you are using the AppBoard Sample Chart Data, select the sample.Data.Airport Data Collection.
- The selected Data Collection must contain two separate fields with geographical coordinates representing the Latitude and Longitude of each node to be drawn on the map.
- Widget Name - Enter the name to display for the Widget in the Widget Title Bar.
- [Optional] Configure an Alternate Widget to be displayed on mobile devices, since this Widget is only supported for display in the desktop AppBoard Viewer.
- Data Collection - Select the name of the Data Collection that will provide the data to be displayed in the Tile Map.
- Enter the following information on the Visualization tab:
- Map Tiles - Select the tile style or server that you wish to use from the list of available tile types.
- Latitude Field - Select the column of data that provides latitude coordinates.
- Longitude Field - Select the column of data that provides longitude coordinates.
- Marker Type - Toggle this switch to choose the type of image to draw for each node on the map:
- Status Shape - Display a colored shape for each node on the map
- Icon - Display an icon with a status shape in the top left corner for each node on the map.
- Auto Zoom - Toggle the automatic zoom controls:
- Off - The full map is displayed when the Widget is invoked on the Board.
- Fit To Data - AppBoard will automatically zoom to the "best fit" zoom level when the Widget is invoked on the Board.
- Default Shape - The default shape to use when the "Status Shape" Marker Type is selected (see above).
- Default Color - The default color to apply to the shape when the "Status Shape" Marker Type is selected (see above).
- Default Shape Size - The default size to use for the shape when the "Status Shape" Marker Type is selected (see above).
- [Optional] Colored Shape Filter - Select the name of the filter you would like to use or click "Add" to create a new filter. A Color Filter allows you to set rules for displaying different colors for the markers on the map where certain conditions are met in the corresponding data. For more information, see Color Filter
- [Optional] Default Icon - When the "Icon" Marker Type is selected (see above), this item selects the icon to display for each node.
- [Optional] Icon Size - When the "Icon" Marker Type is selected (see above), this item determines the size of each icon.
- [Optional] Icon Badge Filter - When the "Icon" Marker Type is selected (see above), this allows for different icons to be displayed conditionally based on the attributes of each individual node on the map.
- Preview - This section provides a small preview of the Tile Map.
- Provide additional configuration on the Options tab. For details on the available Options, see Options.
- Click Close.
- In the Builder Modes panel, select Builder and navigate to the appropriate Board to observe the new Tile Map Widget.
Importing Offline Tile Data
The Tile Map Widget supports the use of custom tiles as offline tile data. Perform the following steps to import offline tile data into AppBoard for use in the Tile Map Widget:
- Open a terminal window (i.e., CMD/shell prompt)
- Shutdown the AppBoard server
- Change directory to [Install_Home]/server/bin/
- Run the following command:
- UNIX: ./portal.sh FilesImport -jar <OfflineTilePackage>
- Windows: portal.bat FilesImport -jar <OfflineTilePackage>
