Table of Contents

Class orbit.webclient.Client

Class Summary

Constructor Attributes Constructor Name and Description
orbit.webclient.Client(container, options)
Create a new client instance.

Method Summary

Method Attributes Method Name and Description
addEventListener(eventType, handler)
Add an event listener.
addWKTLayer(name, wkt, crs, legendParameters)
Add a layer based on a WKT geometry.
addWKTToWKTLayer(name, wkt)
Add additional objects to an existing WKT layer.
applyStartupParameters()
Apply startup parameters of the publication.
checkConnection(url)
Set the service to connect to.
checkLicense(identifier)
Set the product identfier.
closePublication()
Close the publication.
getCRS()
Get the CRS used by the webclient API.
getMap()
Get the Map object.
getMapVisible(value)
Get the visibility of the map component.
getOblique()
Get the Panorama object.
getPanorama()
Get the Panorama object.
getPanoramaVisible(The)
Get the visibility of the panorama component.
getPublicationCRS()
Get the CRS of the currently loaded Publication.
getPublicationList()
Get the list of available publications.
getSetting(name)
Get a setting.
getVersion()
Get the version of the webclient component.
getVersionDate()
Get the version date of the webclient component.
loadPublication(publicationName, applyStartupParameters)
Load a publication.
loadPublicationList()
Load the list of available publications.
removeEventListener(eventType, handler)
Remove an event listener.
removeLayer(name)
Remove a WKT layer.
setAutoLoginGroup(group)
Set the auto-login group.
setCredentials(username, password)
Set the login credentials.
setCRS(value)
Set the CRS used by the webclient API.
setCustomMapLogo(image, link)
Set a secondary map logo.
setCustomViewerLogo(image, link)
Set a secondary viewer logo.
setDeveloperId(identifier)
Set the developer identfier.
setMapVisible(value)
Set the visibility of the map component.
setPanoramaVisible(value)
Set the visibility of the panorama component.
setProductId(identifier)
Set the product identfier.
setServer(url)
Set the service to connect to.
setSetting(name, value)
Set a setting.
setSize(width, height)
Set the size of the component.

Class Detail

orbit.webclient.Client(container, options)
Create a new client instance.

Parameters

{Element} container The element to add the client to.
{object} options The constructor options.

Method Detail

addEventListener

Add an event listener.

Parameters

{String} eventType The event type to listen to.
{Function} handler The function to call when the event occurs.

addWKTLayer

Add a layer based on a WKT geometry.

Parameters

{String} name Name for the layer.
{String} wkt The WKT geometry to parse.
{String} crs CRS code for the WKT geometry.
{LegendParameters} legendParameters Object describing some basic legend parameters (optional).

Returns

{Boolean} Returns true if the layer was found and the wkt was succesfully parsed.

addWKTToWKTLayer

Add additional objects to an existing WKT layer.

Parameters

{String} name Name of the WKT layer to add to.
{String} wkt The WKT geometry to parse.

Returns

{Boolean} Returns true if the layer was found and the wkt was succesfully parsed.

applyStartupParameters

Apply startup parameters of the publication.

checkConnection

Set the service to connect to.

Parameters

{String} url The url of the service.

checkLicense

Set the product identfier.

Parameters

{String} identifier The product identifier.

closePublication

Close the publication.

getCRS

Get the CRS used by the webclient API.

Returns

{String} Returns the CRS.

getMap

Get the Map object.

Returns

{orbit.webclient.Map} Returns the map object.

getMapVisible

Get the visibility of the map component.

Parameters

value

Returns

{Boolean} The map visibility.

getOblique

Get the Panorama object.

Returns

{orbit.webclient.Oblique} Returns the oblique object.

getPanorama

Get the Panorama object.

Returns

{orbit.webclient.Panorama} Returns the panorama object.

getPanoramaVisible

Get the visibility of the panorama component.

Parameters

{Boolean} The panorama visibility.

getPublicationCRS

Get the CRS of the currently loaded Publication.

Returns

{String} Returns the CRS or null in case no publication is loaded.

getPublicationList

Get the list of available publications.

getSetting

Get a setting. WebClient Settings

Parameters

{String} name The setting name.

Returns

returns the setting value.

getVersion

Get the version of the webclient component.

getVersionDate

Get the version date of the webclient component.

loadPublication

Load a publication.

Parameters

{String} publicationName The name of the publication to open.
{Boolean} applyStartupParameters Apply the startup parameters stored in the publication?

loadPublicationList

Load the list of available publications.

removeEventListener

Remove an event listener.

Parameters

{String} eventType The type of the event.
{Function} handler The handler function.

removeLayer

Remove a WKT layer.

Parameters

{String} name Name of the WKT layer.

setAutoLoginGroup

Set the auto-login group.

Parameters

{String} group The auto login group.

setCredentials

Set the login credentials.

Parameters

{String} username The username to use.
{String} password The password.

setCRS

Set the CRS used by the webclient API.

Parameters

value {String} The CRS to set.

Set a secondary map logo.

Parameters

{String} image the image url.
{String} link the link url.

Set a secondary viewer logo.

Parameters

{String} image the image url.
{String} link the link url.

setDeveloperId

Set the developer identfier.

Parameters

{String} identifier The developer identifier.

setMapVisible

Set the visibility of the map component.

Parameters

{Boolean} value The new map visibility.

setPanoramaVisible

Set the visibility of the panorama component.

Parameters

{Boolean} value The new panorama visibility.

setProductId

Set the product identfier.

Parameters

{String} identifier The product identifier.

setServer

Set the service to connect to.

Parameters

{String} url The url of the service.

setSetting

Set a setting. WebClient Settings

Parameters

{String} name The setting name.
{String} value The value.

setSize

Set the size of the component.

Parameters

{Number} width The width of the component.
{Number} height The height of the component.