Edge Documentation

Latest revision as of 20:54, 7 January 2014

The Tile Map Widget displays tile-based maps from a server that conforms to the Open Street Maps architecture.

Tile based mapping allows users to zoom through different levels of detail and pan quickly without having to load excessive amounts of data. Each zoom level is served by a different set of tiles of fixed size and the tiles are loaded on demand for performance reasons. Google Maps is a well known tile-based map tool and AppBoard supports the use of Google Maps through the Google Map widget.

The advantages to AppBoard users with the OpenStreetMap based Tile Map widget is:

Native Adobe Flex based widget which better fits into the AppBoard framework providing flexible marker configuration, full access to widget actions, and better performance.
Ability to pick, or create your own, set of base layer tilesets and overlay tilesets.
Ability to serve up tilesets from AppBoard itself, avoiding the need for clients or the server having external Internet access.
Avoid commercial licensing requirements of using Google Maps.

AppBoard also includes a Vector Map widget that uses internal maps so external Internet access is not required. This widget continues to be available but in many cases it is recommended to switch or use the Tile Map instead thanks to greater marker flexibility and map detail.

As with all other AppBoard geographic mapping widgets the data collection driving the widget must include latitude and longitude co-ordinates in order to plot markers on the map.

Tile Map widget using MapQuest tiles with atmospheric pressure overlay from OpenWeatherMap and icon markers with status indicators. The toolbar is also shown (hidden by default).

Creating Tile Map Widgets

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.

Tile Map Widget Configuration

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.
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 tilesets. Refer to the Additional Information section for more information on managing this list.
- 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 Colored Shape 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. See Icon Filter for more information on configuring an Icon Filter.
- Preview - This section provides a small preview of the Tile Map.
Enter the following information on the Overlays tab:
- [Optional] Add a tile overlay from the registered Overlays by pressing the "Add" button. Choose the overlay tile type, alpha value, and the refresh time for the overlay. (A value of 0 minutes turns off refresh). Refer to the Additional Information section for more information on managing this list.
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.

Changes made to the preview map positioning or zooming during configuration will be saved as defaults for the widget.

If the Tile Map widget encounters data in the latitude or longitude fields that can not be converted to numbers it will ignore the data and it will not plot it. Latitude values that exceed +/-84 will be plotted on the +/- 84 boundary.

The Toolbar

The Tile Map toolbar is available to users within the Builder or Viewer and changes made are only temporary for the session. On reloading the client the configured defaults will be used. The following controls are provided:

Toggle Toolbar: click the wrench icon to show or hide the toolbar.
Fit to Data: use the magnifying glass icon to force the widget to zoom and center on the current dataset. This is actually a toggle button and if left selected (or configured by the administrator by default) the map will always zoom to fit on any changes to the data collection.
Adjust Zoom Level - The - and + buttons and slider indicate the current zoom level and allow changes by clicking the symbols or dragging the slider.
Overlays - This button allows the user to disable or enable overlays. Only overlays configured by the administrator are visible in this list.
Pan View - The circle with four arrows icon can be used to pan the map horizontally or vertically.

Panning and zooming are more simply performed by using a mouse scroll-wheel for zooming, and click-to-drag for panning.

When the zoom level on the map is such that tiles for different parts of the world are duplicated in the widget, data points will not be shown in the duplicated sections. Those sections will instead have a "letterbox" appearance with a layer of grey over the tiles.

Included Tile Sets

AppBoard includes configuration to access the following OpenStreetMap tile sets. Each provider of tile sets may have their own terms of use. Please visit the provider site for more details.

Tile Set	Provider
OpenStreetMap	http://www.openstreetmap.org/
MapQuest OpenStreetMap	http://developer.mapquest.com/web/products/open/map
Watercolor OpenStreetMap	http://maps.stamen.com/watercolor/
Toner OpenStreetMap	http://maps.stamen.com/toner/

Additional Information

Registering Additional Tilesets: for making existing tilesets served remotely available within AppBoard.
Importing Tilesets: for serving up tilesets locally with AppBoard.
Creating Custom Tiles from Images

@@ Line 1: / Line 1: @@
-The '''Tile Map Widget''' can display tile based maps from a server that conforms to the [http://www.openstreetmap.org Open Street Maps] architecture.
+{{DISPLAYTITLE:Tile Map Widget}}
-[[File:Tile_Map_Widget.PNG]]
+[[Category:AppBoard 2.4]]
+The '''Tile Map Widget''' displays tile-based maps from a server that conforms to the [http://www.openstreetmap.org Open Street Maps] architecture.
-== How To Create a Tile Map Widget ==
+Tile based mapping allows users to zoom through different levels of detail and pan quickly without having to load excessive amounts of data. Each zoom level is served by a different set of tiles of fixed size and the tiles are loaded on demand for performance reasons. Google Maps is a well known tile-based map tool and AppBoard supports the use of Google Maps through the [[appboard/2.4/builder/widgets/google_map|Google 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.
-== How To Configure a Tile Map Widget ==
+The advantages to AppBoard users with the OpenStreetMap based Tile Map widget is:
+* Native Adobe Flex based widget which better fits into the AppBoard framework providing flexible marker configuration, full access to widget actions, and better performance.
+* Ability to pick, or create your own, set of base layer tilesets and overlay tilesets.
+* Ability to serve up tilesets from AppBoard itself, avoiding the need for clients or the server having external Internet access.
+* Avoid commercial licensing requirements of using Google Maps.
+AppBoard also includes a [[appboard/2.4/builder/widgets/vector_map|Vector Map]] widget that uses internal maps so external Internet access is not required. This widget continues to be available but in many cases it is recommended to switch or use the Tile Map instead thanks to greater marker flexibility and map detail.
+As with all other AppBoard geographic mapping widgets the data collection driving the widget must include ''latitude'' and ''longitude'' co-ordinates in order to plot markers on the map.
+[[File:appboard-2.4-tilemap.png|frame|center|link=|Tile Map widget using MapQuest tiles with atmospheric pressure overlay from OpenWeatherMap and icon markers with status indicators. The toolbar is also shown (hidden by default).]]
+== Creating Tile Map Widgets ==
+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.
+== Tile Map Widget Configuration ==
 # 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'''.
-#** Note: For convenience, buttons are provided for Adding, Editing, or Previewing a Data Collection.
+#** 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/builder/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:
-#* '''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 tilesets. Refer to the [[#Additional Information|Additional Information]] section for more information on managing this list.
-#* '''Latitude Field''' - Select the column of data that represents latitude.
+#* '''Latitude Field''' - Select the column of data that provides latitude coordinates.
-#* '''Longitude Field''' - Select the column of data that represents longitude.
+#* '''Longitude Field''' - Select the column of data that provides longitude coordinates.
-#* '''Marker Type''' - Toggle this switch to choose between a simple status shape (colored shape) or an icon with a status shape in the top left corner as markers on the map.
+#* '''Marker Type''' - Toggle this switch to choose the type of image to draw for each node on the map:
-#* '''Default Shape Size''' - Adjust the size of the default status shape, by dragging the slider bar.
+#** '''Status Shape''' - Display a colored shape for each node on the map
-#* '''Pan Controls''' - Toggle the visibility of the onscreen pan controls
+#** '''Icon''' - Display an icon with a status shape in the top left corner for each node on the map.
-#* '''Zoom Controls''' - Toggle the visibility of the onscreen zoom controls
+#* '''Auto Zoom''' - Toggle the automatic zoom controls:
-#* '''Default Color''' - The default color to apply to the shape when a status filter is not available or if it doesn't match a given rule within the filter.
+#** '''Off''' - The full map is displayed when the Widget is invoked on the Board.
-#* [Optional] '''Colored 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]]
+#** '''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 a shape filter is not available or if it doesn't match a given rule within the filter.
+#* '''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 Shape Filter allows you to set rules for displaying different shapes for the markers on the map where certain conditions are met in the corresponding data.  For more information, see [[Shape_Filter|Shape Filter]]
+#* '''Default Color''' - The default color to apply to the shape when the "Status Shape" Marker Type is selected (see above).
-#* [If Using Icon] '''Default Icon''' - Select the icon to use when an Icon Filter does not exist or a rule within the filter does not match.
+#* '''Default Shape Size''' - The default size to use for the shape when the "Status Shape" Marker Type is selected (see above).
-#* [If Using Icon - Optional] '''Icon Filter''' - Select the name of the filter you would like to use or click "Add" to create a new filter.  An Icon Filter allows you to set rules for displaying different icons for the markers on the map where certain conditions are met in the corresponding data.  For more information, see [[Icon_Filter|Icon Filter]]
+#* [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 [[appboard/2.4/builder/colored_shape_filter|Colored Shape 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. See [[appboard/2.4/builder/icon_filter|Icon Filter]] for more information on configuring an Icon Filter.
 #* '''Preview''' - This section provides a small preview of the Tile Map.
-# Click '''Next''' to proceed to the '''Options''' tab.
+#:
-# Provide additional configuration on the '''Options''' tab.  For details on the available Options, see [[Options|Options]].
+# Enter the following information on the '''Overlays''' tab:
-# Click '''Next''' to proceed to the '''Actions''' tab.
+#* [Optional] Add a tile overlay from the registered Overlays by pressing the "Add" button.  Choose the overlay tile type, alpha value, and the refresh time for the overlay.  (A value of 0 minutes turns off refresh). Refer to the [[#Additional Information|Additional Information]] section for more information on managing this list.
-# Click '''Add Event Action''' to configure one or more [[Actions|Actions]] to be invoked when a user clicks on the Tile Map Widget.  The action will apply to the current data record being displayed.
+#:
-# Click '''Finish'''.
+# Provide additional configuration on the '''Options''' tab.  For details on the available Options, see [[appboard/2.4/builder/widgets/options|Options]].
+#:
+# Click '''Close'''.
+#:
 # 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.}}
-== Importing Offline Tile Data ==
+{{Note|Changes made to the preview map positioning or zooming during configuration will be saved as defaults for the widget.}}
+{{Note|If the Tile Map widget encounters data in the latitude or longitude fields that can not be converted to numbers it will ignore the data and it will not plot it.  Latitude values that exceed +/-84 will be plotted on the +/- 84 boundary.}}
+== The Toolbar ==
+The Tile Map toolbar is available to users within the Builder or Viewer and changes made are only temporary for the session. On reloading the client the configured defaults will be used. The following controls are provided:
+* Toggle Toolbar: click the wrench icon to show or hide the toolbar.
+* Fit to Data: use the magnifying glass icon to force the widget to zoom and center on the current dataset. This is actually a toggle button and if left selected (or configured by the administrator by default) the map will always zoom to fit on any changes to the data collection.
+* Adjust Zoom Level - The <tt>-</tt> and <tt>+</tt> buttons and slider indicate the current zoom level and allow changes by clicking the symbols or dragging the slider.
+* Overlays - This button allows the user to disable or enable overlays. Only overlays configured by the administrator are visible in this list.
+* Pan View - The circle with four arrows icon can be used to pan the map horizontally or vertically.
+{{Tip|Panning and zooming are more simply performed by using a mouse scroll-wheel for zooming, and click-to-drag for panning.}}
+{{Note|When the zoom level on the map is such that tiles for different parts of the world are duplicated in the widget, data points will not be shown in the duplicated sections.  Those sections will instead have a "letterbox" appearance with a layer of grey over the tiles.}}
+== Included Tile Sets ==
+AppBoard includes configuration to access the following OpenStreetMap tile sets.  Each provider of tile sets may have their own terms of use.  Please visit the provider site for more details.
+{|class="wikitable" border="1" style="text-align:center; background-color:#eeeeee;"
+!Tile Set
+!Provider
+|-
+|OpenStreetMap
+|http://www.openstreetmap.org/
+|-
+|MapQuest OpenStreetMap
+|http://developer.mapquest.com/web/products/open/map
+|-
+|Watercolor OpenStreetMap
+|http://maps.stamen.com/watercolor/
+|-
+<!--|NASA
+|<Need link>
+|- -->
+|Toner OpenStreetMap
+|http://maps.stamen.com/toner/
+|}
+== Additional Information ==
-# Open a terminal window (i.e., CMD/shell prompt)
+* [[appboard/2.4/builder/widgets/tile_map/registering_tilesets|Registering Additional Tilesets]]: for making existing tilesets served remotely available within AppBoard.
-# Shutdown appboard server
+* [[appboard/2.4/builder/widgets/tile_map/offline_data|Importing Tilesets]]: for serving up tilesets locally with AppBoard.
-# Change directory to server/bin/
+* [[appboard/2.4/builder/widgets/tile_map/tileset_from_images|Creating Custom Tiles from Images]]
-# Run the following command:
-## UNIX: <tt>./portal.sh FilesImport -jar <OfflineTilePackage></tt>
-## Windows: <tt>portal.bat FilesImport -jar <OfflineTilePackage></tt>

Edge Documentation

Appboard/2.4/builder/widgets/tile map: Difference between revisions

Latest revision as of 20:54, 7 January 2014

Page Contents

Creating Tile Map Widgets

Tile Map Widget Configuration

The Toolbar

Included Tile Sets

Additional Information

Search

Personal tools

Tools