Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Type

Required

Description

id

string

no

Not "required" but you should set it.

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 if it is not specified Weave will generate one for you (which could result in there being multiple toc entries with the same id, which can cause problems).

It should be set it to a unique value for every entry, it doesn't really 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

entityref urn:com.cohga.server.entity#1.0:entitynoThe id of an entity that should be associated with this layer, by associating an entity with a layer additional functionality is available.
 stylestringno

For map engines that support multiple styles for a layer this value can be used to change the default style.

Note that adding the weave.toc.styleLayer action to the toc panel context menu allows the user to switch styles on the fly.

acl

ref urn:com.cohga.server.acl#1.0:acl

no

A reference to an ACL to attach to the layer

minScalenumbernoSpecifies 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, just the entry in the toc panel.
maxScalenumbernoSpecifies 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, just the entry in the toc panel.

...

Name

Type

Required

Description

id

string

no

Not "required" but you really should set it, since it uniquely identified .

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. Trust me, just , if it is not specified Weave will generate one for you (which could result in there being multiple toc entries with the same id, which can cause problems).

It should be set it to a unique value for every entry, it doesn't really matter what the value is, just make it unique across all toc model entries

This value should never be changed once it has been set, or any bookmarks that reference this entry will be invalidated.

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

entityref urn:com.cohga.server.entity#1.0:entitynoThe id of an entity that should be associated with this group, by associating an entity with a group additional functionality is available.

acl

ref urn:com.cohga.server.acl#1.0:acl

no

A reference to an ACL to attach to the group

minScalenumbernoSpecifies 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, just the entry in the toc panel.
maxScalenumbernoSpecifies 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, just the entry in the toc panel.

...