...
Name | Type | Required | Description |
id | string | no | Not "required" but you should set it. It uniquely identifies an entry when saving a toc model, for example in a bookmark, which make your life a lot easier if you ever want to re-arrange or rename your map layers, otherwise Weave has to guess and it will not always guess correctly. Set it to a unique value for every entry, doesn't matter what the value is, just make it unique across all toc model entries (a combination of map engine id and layer name would work if you have a lot of layers). This value should never be changed once it has been set, or any bookmarks that reference this entry will be invalidated. |
layer | string | yes | The identifier for the layer within the map engine |
label | string | yes | Identifier displayed to the user for the entry |
mapengine | ref urn:com.cohga.server.map.toc#1.0:mapEngine | no | Override the default map engine for this layer |
checked | boolean | no | Determines the entry should be turned on or off by default |
visible | boolean | no | Should the entry be displayed in the TOC at all |
description | string | no | A description to display when the mouse hovers over the layer |
| entity | ref urn:com.cohga.server.entity#1.0:entity | no | The id of an entity that should be associated with this layer, by associating an entity with a layer additional functionality is available. |
| style | string | no | For map engines that support multiple styles for a layer this value can be used to change the default style. Note that adding the |
acl | no | A reference to an ACL to attach to the layer | |
| minScale | number | no | Specifies a minimum scale below which the entry in the toc will not be enabled. Note that this may not affect the display of the layer in the map itself, just the entry in the toc panel. |
| maxScale | number | no | Specifies a maximum scale above which the entry in the toc will not be enabled. Note that this may not affect the display of the layer in the map itself, just just the entry in the toc panel. |
Properties (for a 'toc')
...
Name | Type | Required | Description |
id | string | no | Not "required" but you really should set it, since it uniquely identified an entry when saving a toc model, for example in a bookmark, which make your life a lot easier if you ever want to re-arrange or rename your map layers. Trust me, just set it to a unique value for every entry, doesn't matter what the value is, just make it unique across all toc model entries |
label | string | yes | Identifier displayed to the user for the group |
mapengine | ref urn:com.cohga.server.map.toc#1.0:mapEngine | no | Override the default map engine for this group |
checked | boolean | no | Determines the group should be turned on or off by default |
description | string | no | A description to display when the mouse hovers over the group |
expandable | boolean | no | Will the user be able to expand/collapse the group in the TOC |
expanded | boolean | no | Will the group start out already expanded |
exclusive | boolean | no | Only one item within the group can be checked at a time |
folder | boolean | no | Should the expand/collapse control be hidden for this group |
| entity | ref urn:com.cohga.server.entity#1.0:entity | no | The id of an entity that should be associated with this group, by associating an entity with a group additional functionality is available. |
acl | no | A reference to an ACL to attach to the group | |
| minScale | number | no | Specifies a minimum scale below which the entry in the toc will not be enabled. Note that this may not affect the display of the layer in the map itself, just the entry in the toc panel. |
| maxScale | number | no | Specifies a maximum scale above which the entry in the toc will not be enabled. Note that this may not affect the display of the layer in the map itself, just the entry in the toc panel. |
Sub-tags (for a 'group')
...