OpenSpace

The OpenSpace object provides a namespace for all OpenSpace classes

Summary
OpenSpaceThe OpenSpace object provides a namespace for all OpenSpace classes
Properties and Functions
_scriptName{String} Relative path of this script.
_getScriptLocationReturn the path to this script.
apikey{String} API key.
resolutionRange{Array} resolutionRange.
getResolutionRangeset the value for Property: resolutionRange
getServerBaseGets the address of the base server.
getImagesLocation{String} The fully formatted image location string
getThemeLocation{String} The fully formatted theme location string
getTileServerPathGets the relative path of the tile server.
getGazetteerServerPathGets the relative path of the gazetteer server.
getPostcodeServerPathGets the relative path of the postcode server.
getBoundaryServerPathGets the relative path of the boundary server.
getSupportServerPathGets the relative path of the API support server.
getApiKeyGets the current API key.
getURLGets the current document’s URL.

Properties and Functions

_scriptName

{String} Relative path of this script.

_getScriptLocation

_getScriptLocation: function()

Return the path to this script.

Returns

{String} Path to this script

apikey

{String} API key.

resolutionRange

{Array} resolutionRange.

getResolutionRange

getResolutionRange:function()

set the value for Property: resolutionRange

Returns

{Array}Property: resolutionRange.

getServerBase

getServerBase: function()

Gets the address of the base server.

Returns

{String}The URL of the base server.

getImagesLocation

getImagesLocation: function()

Returns

{String} The fully formatted image location string

getThemeLocation

getThemeLocation: function()

Returns

{String} The fully formatted theme location string

getTileServerPath

getTileServerPath: function()

Gets the relative path of the tile server.

Returns

{String} The relative path of the tile server.

getGazetteerServerPath

getGazetteerServerPath: function()

Gets the relative path of the gazetteer server.

Returns

{String} The relative path of the gazetteer server.

getPostcodeServerPath

getPostcodeServerPath: function()

Gets the relative path of the postcode server.

Returns

{String} The relative path of the postcode server.

getBoundaryServerPath

getBoundaryServerPath: function()

Gets the relative path of the boundary server.

Returns

{String} The relative path of the boundary server.

getSupportServerPath

getSupportServerPath: function()

Gets the relative path of the API support server.

Returns

{String} The relative path of the support server.

getApiKey

getApiKey: function()

Gets the current API key.

Returns

{String} The API Key.

getURL

getURL: function()

Gets the current document’s URL.

Returns

{String} The document’s URL.

_getScriptLocation: function()
Return the path to this script.
getResolutionRange:function()
set the value for Property: resolutionRange
getServerBase: function()
Gets the address of the base server.
getImagesLocation: function()
{String} The fully formatted image location string
getThemeLocation: function()
{String} The fully formatted theme location string
getTileServerPath: function()
Gets the relative path of the tile server.
getGazetteerServerPath: function()
Gets the relative path of the gazetteer server.
getPostcodeServerPath: function()
Gets the relative path of the postcode server.
getBoundaryServerPath: function()
Gets the relative path of the boundary server.
getSupportServerPath: function()
Gets the relative path of the API support server.
getApiKey: function()
Gets the current API key.
getURL: function()
Gets the current document’s URL.
Close