Appboard/2.4/builder/widgets/tile map/registering tilesets - Revision history

imported>Jason.nicholls at 08:39, 14 December 2013

2013-12-14T08:39:59Z

← Older revision		Revision as of 08:39, 14 December 2013
Line 1:		Line 1:
	{{DISPLAYTITLE:Registering Tilesets}}		{{DISPLAYTITLE:Registering Tilesets}}
			[[Category:AppBoard 2.4]]
	The Tile Map widget supports the use of multiple base-layer tilesets and overlay tilesets, but in order to make use of these they must be registered for AppBoard to know about them.		The Tile Map widget supports the use of multiple base-layer tilesets and overlay tilesets, but in order to make use of these they must be registered for AppBoard to know about them.

imported>Jason.nicholls: /* Registry Format */

2013-10-03T07:20:29Z

Registry Format

← Older revision		Revision as of 07:20, 3 October 2013
Line 75:		Line 75:
	\|<tt>isOverlay</tt>		\|<tt>isOverlay</tt>
	\|boolean		\|boolean
	\|Set to <tt>true</tt> for overlays, otherwise set to <tt>false</tt>. This determines whether a map is visible in the set of base layers or o		\|Set to <tt>true</tt> for overlays, otherwise set to <tt>false</tt>. This determines whether a map is visible in the set of base layers or on the Overlays section when configuring a tile map widget.
	n the Overlays section when configuring a tile map widget.
	\|-		\|-
	\|align='right'\|11		\|align='right'\|11

imported>Jason.nicholls: /* Registry Format */

2013-10-03T07:19:49Z

Registry Format

← Older revision		Revision as of 07:19, 3 October 2013
Line 40:		Line 40:
	\|string		\|string
	\|URL of the tileset source using variables for the zoom level (<tt>${z}</tt>), and x/y position (<tt>${x}</tt> and <tt>${y}</tt>). For example:<br>		\|URL of the tileset source using variables for the zoom level (<tt>${z}</tt>), and x/y position (<tt>${x}</tt> and <tt>${y}</tt>). For example:<br>
	http://mytileserver.org/tiles/${z}/${x}/${y}.png		<tt><nowiki>http://mytileserver.org/tiles/${z}/${x}/${y}.png</nowiki></tt>
	\|-		\|-
	\|align='right'\|4		\|align='right'\|4
Line 80:		Line 80:
	\|align='right'\|11		\|align='right'\|11
	\|<tt>initialAlpha</tt>		\|<tt>initialAlpha</tt>
	\|float ~~(0 to 1)~~		\|float
	\|Set between 0 (completely transparent) to 1 (completely opaque) in 0.1 increments. This is primarily for overlays, base layers should be se		\|Set between 0 (completely transparent) to 1 (completely opaque) in 0.1 increments. This is primarily for overlays, base layers should be se
	t to 1.		t to 1.
	\|}		\|}

imported>Jason.nicholls: /* Registry Format */

2013-10-03T07:17:53Z

Registry Format

← Older revision		Revision as of 07:17, 3 October 2013
Line 39:		Line 39:
	\|<tt>source</tt>		\|<tt>source</tt>
	\|string		\|string
	\|URL of the tileset source using variables for the zoom level (<tt>${z}</tt>), and x/y position (<tt>${x}</tt> and <tt>${y}</tt>).		\|URL of the tileset source using variables for the zoom level (<tt>${z}</tt>), and x/y position (<tt>${x}</tt> and <tt>${y}</tt>). For example:<br>
			http://mytileserver.org/tiles/${z}/${x}/${y}.png
	\|-		\|-
	\|align='right'\|4		\|align='right'\|4

imported>Jason.nicholls: /* Registry Format */

2013-10-03T07:16:16Z

Registry Format

← Older revision		Revision as of 07:16, 3 October 2013
Line 21:		Line 21:

	{\|class='wikitable'		{\|class='wikitable'
	!~~Pos~~		!#
	!Field		!Field
	!Type		!Type
	!Description		!Description
	\|-		\|-
	\|1		\|align='right'\|1
	\|<tt>id</tt>		\|<tt>id</tt>
	\|string		\|string
	\|Unique identifier across all tile registry files.		\|Unique identifier across all tile registry files.
	\|-		\|-
	\|2		\|align='right'\|2
	\|<tt>name</tt>		\|<tt>name</tt>
	\|string		\|string
	\|Visible name within the Builder/Viewer for this base-layer or overlay		\|Visible name within the Builder/Viewer for this base-layer or overlay.
	\|-		\|-
	\|3		\|align='right'\|3
	\|<tt>source</tt>		\|<tt>source</tt>
	\|string		\|string
	\|URL of the tileset source using variables for the zoom level (<tt>${z}</tt>), and x/y position (<tt>${x}</tt> and <tt>${y}</tt>).		\|URL of the tileset source using variables for the zoom level (<tt>${z}</tt>), and x/y position (<tt>${x}</tt> and <tt>${y}</tt>).
	\|-		\|-
	\|4		\|align='right'\|4
	\|<tt>minZoom</tt>		\|<tt>minZoom</tt>
	\|integer		\|integer
	\|The most zoomed-out level supported by the tileset.		\|The most zoomed-out level supported by the tileset.
	\|-		\|-
	\|5		\|align='right'\|5
	\|<tt>maxZoom</tt>		\|<tt>maxZoom</tt>
	\|integer		\|integer
	\|The most zoomed-in (detailed) level supported by the tileset.		\|The most zoomed-in (detailed) level supported by the tileset.
	\|-		\|-
	\|6		\|align='right'\|6
	\|<tt>initialZoom</tt>		\|<tt>initialZoom</tt>
	\|integer		\|integer
	\|The default zoom level used in the widget configuration preview.		\|The default zoom level used in the widget configuration preview.
	\|-		\|-
	\|7		\|align='right'\|7
	\|<tt>initialLatitude</tt>		\|<tt>initialLatitude</tt>
	\|float		\|float
	\|The default latitude used in the widget configuration preview.		\|The default latitude used in the widget configuration preview.
	\|-		\|-
	\|8		\|align='right'\|8
	\|<tt>initialLongitude</tt>		\|<tt>initialLongitude</tt>
	\|float		\|float
	\|The default longitude used in the widget configuration preview.		\|The default longitude used in the widget configuration preview.
	\|-		\|-
	\|9		\|align='right'\|9
	\|<tt>copyright</tt>		\|<tt>copyright</tt>
	\|string		\|string
	\|Copyright string displayed on the base layer, should also be included for overlays.		\|Copyright string displayed on the base layer, should also be included for overlays.
	\|-		\|-
	\|10		\|align='right'\|10
	\|<tt>isOverlay</tt>		\|<tt>isOverlay</tt>
	\|boolean		\|boolean
Line 77:		Line 77:
	n the Overlays section when configuring a tile map widget.		n the Overlays section when configuring a tile map widget.
	\|-		\|-
	\|11		\|align='right'\|11
	\|<tt>initialAlpha</tt>		\|<tt>initialAlpha</tt>
	\|float (0 to 1)		\|float (0 to 1)

imported>Jason.nicholls: /* Registry Format */

2013-10-03T07:13:36Z

Registry Format

← Older revision		Revision as of 07:13, 3 October 2013
Line 27:		Line 27:
	\|-		\|-
	\|1		\|1
	\|id		\|<tt>id</tt>
	\|string		\|string
	\|		\|Unique identifier across all tile registry files.
	\|-		\|-
	\|2		\|2
	\|name		\|<tt>name</tt>
	\|string		\|string
	\|		\|Visible name within the Builder/Viewer for this base-layer or overlay
	\|-		\|-
	\|3		\|3
	\|source		\|<tt>source</tt>
	\|string		\|string
	\|		\|URL of the tileset source using variables for the zoom level (<tt>${z}</tt>), and x/y position (<tt>${x}</tt> and <tt>${y}</tt>).
	\|-		\|-
	\|4		\|4
	\|minZoom		\|<tt>minZoom</tt>
	\|integer		\|integer
	\|		\|The most zoomed-out level supported by the tileset.
	\|-		\|-
	\|5		\|5
	\|maxZoom		\|<tt>maxZoom</tt>
	\|integer		\|integer
	\|		\|The most zoomed-in (detailed) level supported by the tileset.
	\|-		\|-
	\|6		\|6
	\|initialZoom		\|<tt>initialZoom</tt>
	\|integer		\|integer
	\|		\|The default zoom level used in the widget configuration preview.
	\|-		\|-
	\|7		\|7
	\|initialLatitude		\|<tt>initialLatitude</tt>
	\|float		\|float
	\|		\|The default latitude used in the widget configuration preview.
	\|-		\|-
	\|8		\|8
	\|initialLongitude		\|<tt>initialLongitude</tt>
	\|float		\|float
	\|		\|The default longitude used in the widget configuration preview.
	\|-		\|-
	\|9		\|9
	\|copyright		\|<tt>copyright</tt>
	\|string		\|string
	\|		\|Copyright string displayed on the base layer, should also be included for overlays.
	\|-		\|-
	\|10		\|10
	\|isOverlay		\|<tt>isOverlay</tt>
	\|boolean		\|boolean
	\|		\|Set to <tt>true</tt> for overlays, otherwise set to <tt>false</tt>. This determines whether a map is visible in the set of base layers or o
			n the Overlays section when configuring a tile map widget.
	\|-		\|-
	\|11		\|11
	\|initialAlpha		\|<tt>initialAlpha</tt>
	\|float (0 to 1)		\|float (0 to 1)
	\|		\|Set between 0 (completely transparent) to 1 (completely opaque) in 0.1 increments. This is primarily for overlays, base layers should be se
			t to 1.
	\|}		\|}

imported>Jason.nicholls: /* Registry Format */

2013-10-03T07:05:51Z

Registry Format

← Older revision		Revision as of 07:05, 3 October 2013
Line 28:		Line 28:
	\|1		\|1
	\|id		\|id
	\|		\|string
	\|		\|
	\|-		\|-
	\|2		\|2
	\|name		\|name
	\|		\|string
	\|		\|
	\|-		\|-
	\|3		\|3
	\|source		\|source
	\|		\|string
	\|		\|
	\|-		\|-
	\|4		\|4
	\|minZoom		\|minZoom
	\|		\|integer
	\|		\|
	\|-		\|-
	\|5		\|5
	\|maxZoom		\|maxZoom
	\|		\|integer
	\|		\|
	\|-		\|-
	\|6		\|6
	\|initialZoom		\|initialZoom
	\|		\|integer
	\|		\|
	\|-		\|-
	\|7		\|7
	\|initialLatitude		\|initialLatitude
	\|		\|float
	\|		\|
	\|-		\|-
	\|8		\|8
	\|initialLongitude		\|initialLongitude
	\|		\|float
	\|		\|
	\|-		\|-
	\|9		\|9
	\|copyright		\|copyright
	\|		\|string
	\|		\|
	\|-		\|-
	\|10		\|10
	\|isOverlay		\|isOverlay
	\|		\|boolean
	\|		\|
	\|-		\|-
	\|11		\|11
	\|initialAlpha		\|initialAlpha
	\|		\|float (0 to 1)
	\|		\|
	\|}		\|}

imported>Jason.nicholls: /* Registry Format */

2013-10-03T07:03:07Z

Registry Format

@@ Line 17: / Line 17: @@
 == Registry Format ==
 {|class='wikitable'
 !Field
 !Description
 |}

imported>Jason.nicholls at 06:26, 3 October 2013

2013-10-03T06:26:21Z

← Older revision		Revision as of 06:26, 3 October 2013
Line 11:		Line 11:

	{{Warning\|The default files should not be modified as they are replaced on upgrade.}}		{{Warning\|The default files should not be modified as they are replaced on upgrade.}}


	The process of registering tilesets is to create a new registry <tt>csv</tt> file with the correct fields and values, place this into the tile registry directory, and as a best practice ensure this file is included in backup archives (see [[appboard/2.4/admin/backup_and_recovery\|Backup & Recovery]]).		The process of registering tilesets is to create a new registry <tt>csv</tt> file with the correct fields and values, place this into the tile registry directory, and as a best practice ensure this file is included in backup archives (see [[appboard/2.4/admin/backup_and_recovery\|Backup & Recovery]]).


			== Registry Format ==

			{\|class='wikitable'
			!Field
			!Description
			\|}

imported>Jason.nicholls at 06:25, 3 October 2013

2013-10-03T06:25:15Z

← Older revision		Revision as of 06:25, 3 October 2013
Line 11:		Line 11:

	{{Warning\|The default files should not be modified as they are replaced on upgrade.}}		{{Warning\|The default files should not be modified as they are replaced on upgrade.}}

			The process of registering tilesets is to create a new registry <tt>csv</tt> file with the correct fields and values, place this into the tile registry directory, and as a best practice ensure this file is included in backup archives (see [[appboard/2.4/admin/backup_and_recovery\|Backup & Recovery]]).