ARK2/Maps - Revision history

John Layt: /* Configuration */

2017-11-30T14:21:33Z

‎Configuration

John Layt: /* Configuration */

2017-11-30T14:17:01Z

‎Configuration

John Layt: /* Configuration */

2017-11-30T14:06:20Z

‎Configuration

John Layt: /* Maps */

2017-11-30T14:06:00Z

‎Maps

John Layt: /* Configuration */

2017-11-30T14:05:29Z

‎Configuration

John Layt: /* Configuration */

2017-11-30T14:05:08Z

‎Configuration

John Layt: /* Configuration */

2017-11-30T13:48:35Z

‎Configuration

John Layt: /* Configuration */

2017-11-30T13:43:36Z

‎Configuration

John Layt: /* Configuration */

2017-11-30T13:43:09Z

‎Configuration

John Layt: /* Configuration */

2017-11-30T13:42:53Z

‎Configuration

@@ Line 107: / Line 107: @@
 | layer  || varchar  ||  30  || PK || The layer key from ark_map_layer || aerial
 |-
-| seq  || integer  ||  || Y || The sequence of the layer || 1
+| seq  || integer  ||  || Y || The sequence of the layer in the legend || 1
 |-
 | is_default  || boolean  ||  || Y || If the view layer is the default ||

@@ Line 85: / Line 85: @@
 | center  || varchar  ||  50  || Y || The default center point of the map view in WKT format || POINT (1155972 7580813)
 |-
-| extent  || varchar  ||  100  || N || The default extent of the map view in WKT format || MULTIPOINT (831000 7230000, 1750000 7950000)
+| extent  || varchar  ||  100  || N || The maximum extent of the map view in WKT format || MULTIPOINT (831000 7230000, 1750000 7950000)
 |-
 | keyword  || varchar  ||  100  || N || The ARK translation keyword || ark.map.main
 |-
 | options  || varchar  ||  4000  ||  N || The OL4 Options to pass to the Map class in JSON format ||
 |-
 |}

@@ Line 6: / Line 6: @@
 The following database tables can be configured to define an OL4 map.
 Define available [http://openlayers.org/en/latest/apidoc/ol.source.html OL4 Sources] in ark_map_source.
@@ Line 33: / Line 34: @@
 |-
 |}
 Define available [http://openlayers.org/en/latest/apidoc/ol.layer.html OL4 Layers] for each Source in ark_map_layer.

@@ Line 1: / Line 1: @@
 = 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 [http://openlayers.org/en/latest/apidoc/ OpenLayers4 API].
+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 [http://openlayers.org/en/latest/apidoc/ OpenLayers4 API] as this is the map library used by the ARK2 frontend.
 == Configuration ==

@@ Line 67: / Line 67: @@
 | map  || varchar  || 30 || PK  || The key for the map || ark_map_main
 |-
-| draggable  || boolean  ||  || Y || If teh map view is draggable ||
+| draggable  || boolean  ||  || Y || If the map view is draggable ||
 |-
 | clickable  || boolean  ||  || Y || If the map view is clickable ||

@@ Line 7: / Line 7: @@
 The following database tables can be configured to define an OL4 map.
-Define [http://openlayers.org/en/latest/apidoc/ol.source.html OL4 Sources] in ark_map_source.
+Define available [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"
@@ Line 30: / Line 30: @@
 | ticket_expiry  || datetime  ||  || N || The expiry date for the API auth ticket ||
 |-
-| options  || varchar  ||  4000  ||  N || The OL4 Options to pass to the source class ||
+| options  || varchar  ||  4000  ||  N || The OL4 Options to pass to the Source class in JSON format ||
 |-
 |}
-Define [http://openlayers.org/en/latest/apidoc/ol.layer.html OL4 Layers] in ark_map_layer.
+Define available [http://openlayers.org/en/latest/apidoc/ol.layer.html OL4 Layers] for each Source in ark_map_layer.
 {| class="wikitable" style="margin: 0; border: 1px solid grey; text-align:left" cellpadding="4" cellspacing="2"
@@ Line 51: / Line 51: @@
 | url  || varchar  ||  2000  ||  N || The url of the layer ||
 |-
-| options  || varchar  ||  4000  ||  N || The OL4 Options to pass to the layer class ||
+| options  || varchar  ||  4000  ||  N || The OL4 Options to pass to the Layer class in JSON format ||
 |-
 | parameters  || varchar  ||  4000  ||  N || The layer parameters to pass to the source provider ||
 |-
 |}

@@ Line 43: / Line 43: @@
 | source  || varchar  ||  30  || PK || The source key from ark_map_source || bing
 |-
-| layer  || varchar  ||  30  || PK || The layer key || raster
+| layer  || varchar  ||  30  || PK || The layer key || aerial
 |-
-| source_name  || varchar  ||  50  || Y || The [http://openlayers.org/en/latest/apidoc/ol.source.html OL4 Class] of the source || BingMaps
+| source_name  || varchar  ||  50  || Y || The key of the layer as defined by the source provider || Aerial
 |-
-| keyword  || varchar  ||  100  || Y || The ARK translation keyword || map.source.bing
+| keyword  || varchar  ||  100  || Y || The ARK translation keyword || map.layer.bing.aerial
 |-
-| url  || varchar  ||  2000  ||  N || The OL4 Options to pass to the source class ||
+| url  || varchar  ||  2000  ||  N || The url of the layer ||
 |-
-| options  || varchar  ||  4000  ||  N || The OL4 Options to pass to the source class ||
+| options  || varchar  ||  4000  ||  N || The OL4 Options to pass to the layer class ||
 |-
-| parameters  || varchar  ||  4000  ||  N || The OL4 Options to pass to the source class ||
+| parameters  || varchar  ||  4000  ||  N || The layer parameters to pass to the source provider ||
 |-
 |}

@@ Line 14: / Line 14: @@
 ! Field || Type || Size || Required || Description || Example
 |-
-| source  || varchar  ||  PK || 30  || The key for the source || bing
+| source  || varchar  || 30 || PK  || The key for the source || bing
 |-
 | type  || varchar  ||  30  || Y || The type of the source (raster, vector) || raster

@@ Line 10: / Line 10: @@
 {| class="wikitable" style="margin: 0; border: 1px solid grey; text-align:left" cellpadding="4" cellspacing="2"
-! colspan="5" | ark_map_source
+! colspan="6" | ark_map_source
 |-
 ! Field || Type || Size || Required || Description || Example
@@ Line 37: / Line 37: @@
 {| class="wikitable" style="margin: 0; border: 1px solid grey; text-align:left" cellpadding="4" cellspacing="2"
-! colspan="5" | ark_map_layer
+! colspan="6" | ark_map_layer
 |-
 ! Field || Type || Size || Required || Description || Example

@@ Line 12: / Line 12: @@
 ! colspan="5" | ark_map_source
 |-
-! Field || Type || Size || Description || Example
+! Field || Type || Size || Required || Description || Example
 |-
-| source  || varchar  ||  30  || The key for the source || bing
+| source  || varchar  ||  PK || 30  || The key for the source || bing
 |-
-| type  || varchar  ||  30  || The type of the source (raster, vector) || raster
+| type  || varchar  ||  30  || Y || The type of the source (raster, vector) || raster
 |-
-| subtype  || varchar  ||  30  || The subtype of the source (image, tile, vector) || tile
+| subtype  || varchar  ||  30  || Y || The subtype of the source (image, tile, vector) || tile
 |-
-| format  || varchar  ||  30  || The format of the source (wms, gml, etc) || bing
+| format  || varchar  ||  30  || Y || The format of the source (wms, gml, etc) || bing
 |-
-| view_class  || varchar  ||  100  || The [http://openlayers.org/en/latest/apidoc/ol.source.html OL4 Class] of the source || BingMaps
+| view_class  || varchar  ||  100  || Y || 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
+| keyword  || varchar  ||  100  || Y || The ARK translation keyword || map.source.bing
 |-
-| ticket  || varchar  ||  100  || The API auth ticket for the source ||
+| ticket  || varchar  ||  100  || N || The API auth ticket for the source ||
 |-
-| ticket_expiry  || datetime  ||  || The expiry date for the API auth ticket ||
+| ticket_expiry  || datetime  ||  || N || The expiry date for the API auth ticket ||
 |-
-| options  || varchar  ||  4000  ||  The OL4 Options to pass to the source class ||
+| options  || varchar  ||  4000  ||  N || The OL4 Options to pass to the source class ||
 |-
 |}
@@ Line 39: / Line 39: @@
 ! colspan="5" | ark_map_layer
 |-
-! Field || Type || Size || Description || Example
+! Field || Type || Size || Required || Description || Example
 |-
-| source  || varchar  ||  30  || The source key from ark_map_source || bing
+| source  || varchar  ||  30  || PK || The source key from ark_map_source || bing
 |-
-| layer  || varchar  ||  30  || The type of the source (raster, vector) || raster
+| layer  || varchar  ||  30  || PK || The layer key || raster
 |-
-| source_name  || varchar  ||  50  || The [http://openlayers.org/en/latest/apidoc/ol.source.html OL4 Class] of the source || BingMaps
+| source_name  || varchar  ||  50  || Y || 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
+| keyword  || varchar  ||  100  || Y || The ARK translation keyword || map.source.bing
 |-
-| url  || varchar  ||  2000  ||  The OL4 Options to pass to the source class ||
+| url  || varchar  ||  2000  ||  N || The OL4 Options to pass to the source class ||
 |-
-| options  || varchar  ||  4000  ||  The OL4 Options to pass to the source class ||
+| options  || varchar  ||  4000  ||  N || The OL4 Options to pass to the source class ||
 |-
-| parameters  || varchar  ||  4000  ||  The OL4 Options to pass to the source class ||
+| parameters  || varchar  ||  4000  ||  N || The OL4 Options to pass to the source class ||
 |-
 |}