Difference between revisions of "ARK2/Maps"
From ARK
(→Configuration) |
(→Configuration) |
||
| Line 12: | Line 12: | ||
! colspan="5" | ark_map_source | ! 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 | ! 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 | + | | 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 || |
|- | |- | ||
|} | |} | ||
Revision as of 13:42, 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 | Required | Description | Example |
| source | varchar | PK | 30 | The key for the source | bing |
| type | varchar | 30 | Y | The type of the source (raster, vector) | raster |
| subtype | varchar | 30 | Y | The subtype of the source (image, tile, vector) | tile |
| format | varchar | 30 | Y | The format of the source (wms, gml, etc) | bing |
| view_class | varchar | 100 | Y | The OL4 Class of the source | BingMaps |
| keyword | varchar | 100 | Y | The ARK translation keyword | map.source.bing |
| ticket | varchar | 100 | N | The API auth ticket for the source | |
| 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 | |
Define OL4 Layers in ark_map_layer.
| ark_map_layer | |||||
|---|---|---|---|---|---|
| Field | Type | Size | Required | Description | Example |
| source | varchar | 30 | PK | The source key from ark_map_source | bing |
| layer | varchar | 30 | PK | The layer key | raster |
| source_name | varchar | 50 | Y | The OL4 Class of the source | BingMaps |
| keyword | varchar | 100 | Y | The ARK translation keyword | map.source.bing |
| url | varchar | 2000 | N | 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 | N | The OL4 Options to pass to the source class | |
