Class: CompositeOverlay

Cadcorp.GeognoSIS.CompositeOverlay

new CompositeOverlay(config)

Represents an overlay served from a WMS
Parameters:
Name Type Description
config Object Configuration for this object. The config supplied directly extends the control

Extends

Members

(readonly) allParams

Properties:
Name Type Description
allParams Array.<string> Array of values in the wms layer param hashtable. Uses the param property as the key to the hashtable

delimiter

Properties:
Name Type Description
delimiter string The delimiter used to split the values from the wms layer hashtable.
Default Value:
  • ,

events

Properties:
Name Type Description
events Cadcorp.Util.Events The events object
Inherited From:

id

Properties:
Name Type Description
id string A unique ID generated during object instantiation.
Inherited From:

isInGroup

Properties:
Name Type Description
isInGroup boolean True if this layer is in a group otherwise false
Inherited From:

layer

Properties:
Name Type Description
layer OpenLayers.Layer The Open Layers layer this overlay belongs to
Inherited From:

layerName

Properties:
Name Type Description
layerName string The name of this layer

legendImageHeight

Properties:
Name Type Description
legendImageWidth number The height in pixels of the legend image

legendImageWidth

Properties:
Name Type Description
legendImageWidth number The width in pixels of the legend image

legendUrl

Properties:
Name Type Description
legendUrl string The url to the legend for this layer

name

Properties:
Name Type Description
name string The name of this overlay
Inherited From:

param

Properties:
Name Type Description
param string The parameter to look up the the wms layer param hastable.
Default Value:
  • LAYERS

visibility

Properties:
Name Type Description
visibility boolean The visibility of this overlay, true if this overlay is visible otherwise false
Inherited From:

Methods

createId() → {string}

Create a unique ID value for the layer. If the property CLASS_NAME is defined it will be used as a prefix to the ID, otherwise it will default to 'Cadcorp.GeognoSIS.OverlayBase'.
Inherited From:
Returns:
The unique ID.
Type
string

destroy()

Destroy this object
Inherited From:

redraw(force)

Redraw the layer
Parameters:
Name Type Description
force boolean Force redraw by adding random parameter.
Inherited From:

setVisibility(visibility)

Set the visibility flag for the layer and hide/show & redraw accordingly.
Parameters:
Name Type Description
visibility visibility True to show the overlay otherwsie false
Inherited From:

setVisibilityFromLayers()

Sets the visibility of the group.
Inherited From: