Difference between revisions of "ARK2/Maps"

From ARK
Jump to: navigation, search
(Configuration)
(Configuration)
Line 7: Line 7:
 
The following database tables can be configured to define an OL4 map.
 
The following database tables can be configured to define an OL4 map.
  
Define the [http://openlayers.org/en/latest/apidoc/ol.source.html OL4 Source] of the Map Layers in ark_map_source.
+
Define [http://openlayers.org/en/latest/apidoc/ol.source.html OL4 Sources] in ark_map_source.
 +
 
 +
{| class="wikitable" style="margin: 0; border: 1px solid grey; text-align:left" cellpadding="4" cellspacing="2"
 +
! colspan="5" | ark_map_source
 +
|-
 +
! Field || Type || Size || Description || Example
 +
|-
 +
| source  || varchar  ||  30  || The key for the source || bing
 +
|-
 +
| type  || varchar  ||  30  || The type of the source (raster, vector) || raster
 +
|-
 +
| subtype  || varchar  ||  30  || The subtype of the source (image, tile, vector) || tile
 +
|-
 +
| format  || varchar  ||  30  || The format of the source (wms, etc) || bing
 +
|-
 +
| view_class  || varchar  ||  100  || The [http://openlayers.org/en/latest/apidoc/ol.source.html OL4 Class] of the source || BingMaps
 +
|-
 +
| keyword  || varchar  ||  100  || The ARK translation keyword || map.source.bing
 +
|-
 +
| ticket  || varchar  ||  100  || The API auth ticket for the source ||
 +
|-
 +
| ticket_expiry  || datetime  ||  || The expiry date for the API auth ticket ||
 +
|-
 +
| options  || varchar  ||  4000  ||  The OL4 Options to pass to the source class ||
 +
|-
 +
|}
 +
 
 +
Define [http://openlayers.org/en/latest/apidoc/ol.source.html OL4 Layers] in ark_map_layer.
  
 
{| class="wikitable" style="margin: 0; border: 1px solid grey; text-align:left" cellpadding="4" cellspacing="2"
 
{| class="wikitable" style="margin: 0; border: 1px solid grey; text-align:left" cellpadding="4" cellspacing="2"

Revision as of 13:31, 30 November 2017

Maps

ARK2 supports the display of maps and mapping layers using OpenLayers4. Maps and layers can be dynamically defined in the config database and then linked to a defined page view. Much of the config closely reflects the OpenLayers4 API.

Configuration

The following database tables can be configured to define an OL4 map.

Define OL4 Sources in ark_map_source.

ark_map_source
Field Type Size Description Example
source varchar 30 The key for the source bing
type varchar 30 The type of the source (raster, vector) raster
subtype varchar 30 The subtype of the source (image, tile, vector) tile
format varchar 30 The format of the source (wms, etc) bing
view_class varchar 100 The OL4 Class of the source BingMaps
keyword varchar 100 The ARK translation keyword map.source.bing
ticket varchar 100 The API auth ticket for the source
ticket_expiry datetime The expiry date for the API auth ticket
options varchar 4000 The OL4 Options to pass to the source class

Define OL4 Layers in ark_map_layer.

ark_map_source
Field Type Size Description Example
source varchar 30 The key for the source bing
type varchar 30 The type of the source (raster, vector) raster
subtype varchar 30 The subtype of the source (image, tile, vector) tile
format varchar 30 The format of the source (wms, etc) bing
view_class varchar 100 The OL4 Class of the source BingMaps
keyword varchar 100 The ARK translation keyword map.source.bing
ticket varchar 100 The API auth ticket for the source
ticket_expiry datetime The expiry date for the API auth ticket
options varchar 4000 The OL4 Options to pass to the source class