Class: GeognoSISRest

.Layer.GeognoSISRest

new GeognoSISRest(name, url, paramsnullable, options)

An Open Layers layer that integrates with GeognoSIS http interface. Extends OpenLayers.Layer.Grid
Parameters:
Name Type Attributes Description
name string The name for this layer
url string The base url to GeognoSIS
params Object <nullable>
 Unused
options Object The options used to configure this layer, any valid option for OpenLayers.Layer.Grid can be supplied

Members

(constant) CLASS_NAME :string

The name of this class
Type:
  • string

cswUrl

Properties:
Name Type Attributes Description
cswUrl string <nullable>
 The url to the OGC Catalogue Service

defaultOverlay

Properties:
Name Type Description
defaultOverlay number The default overlay

expandGroups

Properties:
Name Type Description
expandGroups boolean Should the groups be expanded in the layer switcher

groups

Properties:
Name Type Attributes Description
groups Array.<Cadcorp.GeognoSIS.OverlayGroup> <optional>
<nullable>
 The overlay groups in this swd

isBaseLayer

Properties:
Name Type Description
isBaseLayer boolean Is this a base or data layer, defaults to false

layerId

Properties:
Name Type Description
layerId number The database id for this layer

layerIndex

Properties:
Name Type Description
layerIndex number The index of this layer

layers

Properties:
Name Type Description
layers Array.<Cadcorp.GeognoSIS.Overlay> The layers in the swd

mapProperties

Properties:
Name Type Description
mapProperties Object Map properties retrieved from Map/Properties.json

metaData

Properties:
Name Type Attributes Description
metaData Cadcorp.Util.GeognoSIS8MetaData <nullable>
 The object that contains metadata for this layer

numOverlays

Properties:
Name Type Description
numOverlays number The total number of overlays in this swd

photometricInterpretation

Properties:
Name Type Description
photometricInterpretation string How GeognoSIS will render this layer

sessionID

Properties:
Name Type Description
sessionID string The GeognoSIS session ID

Methods

addCookieLayer(layer)

Adds a layer that is stored in a cookie to the current swd
Parameters:
Name Type Description
layer Cadcorp.GeognoSIS8AdditionalFileLayer The cookie layer to add

addFileLayer(layer, successhandler, scope)

Adds a layer that is stored in a cookie to the current swd
Parameters:
Name Type Description
layer Cadcorp.GeognoSIS8AdditionalFileLayer The layer to add
successhandler function The function to call when the layer is successfully added
scope Object The context in which to call successhandler

createInternalLayer(name, successhandler, scope)

Creates an internal layer with the supplied name. This function returns immediately, successhandler will be called when the layer has loaded
Parameters:
Name Type Description
name string The name for the new overlay
successhandler function The function that will be called the layer has been added
scope Object The context that successhandler will be called in

destroy()

Destroys this layer

getLayers(callback) → {Array.<Cadcorp.GeognoSIS.Overlay>}

Gets the layer details for the loaded swd.
If the layers haven't been retrieved then they are queried asynchronously. This function returns null immediately and the callbacks are used
Parameters:
Name Type Description
callback Cadcorp.OpenLayers.Layer.GetLayersCallback The callbacks for asynchronous requests
Returns:
The array of layers or null if the layers haven't been retrieved
Type
Array.<Cadcorp.GeognoSIS.Overlay>

getMapProperties()

Gets the map propeties from GeognoSIS

getURL(bounds) → {String}

Parameters:
Name Type Description
bounds OpenLayers.Bounds
Returns:
A string with the layer's url and parameters and also the passed-in bounds and appropriate tile size specified as parameters.
Type
String

getVisibleLayers(includeScaleThreshold, callback) → {Array.<Cadcorp.GeognoSIS.Overlay>}

Gets the visible layers for the loaded swd.
If the layers haven't been retrieved then they are queried asynchronously. This function returns null immediately and the callbacks are used
Parameters:
Name Type Description
includeScaleThreshold boolean Use the scale threshold as well to determine the layer visibility.
callback GetLayersCallback The callbacks for asynchronous requests
Returns:
The array of layers or null if the layers haven't been retrieved
Type
Array.<Cadcorp.GeognoSIS.Overlay>

removeCookieLayer(layer)

Removes a layer that was stored in a cookie to the from swd
Parameters:
Name Type Description
layer Cadcorp.GeognoSIS8AdditionalFileLayer The cookie layer to remove