<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
h3. Table of Contents
* [BimExplorer|#bimexplorer]* [Parameters|#parameters]
* * [getUrl|#geturl]
* * [getUrl|#geturl-1]
* * [sendMessage|#sendmessage]
* * [sendMessage|#sendmessage-1]
* * [getDOMElementId|#getdomelementid]
* * [getDOMElementId|#getdomelementid-1]
* * [load|#load]
* * [load|#load-1]
* * [load|#load-2]
* * [resetView|#resetview]
* * [centerObject|#centerobject]
* [BimExplorer|#bimexplorer-1]* [Parameters|#parameters-1]
* * [getUrl|#geturl-2]
* * [getUrl|#geturl-3]
* * [sendMessage|#sendmessage-2]
* * [sendMessage|#sendmessage-3]
* * [getDOMElementId|#getdomelementid-2]
* * [getDOMElementId|#getdomelementid-3]
* * [load|#load-3]
* * [load|#load-4]
* * [load|#load-5]
* * [resetView|#resetview-1]
* * [centerObject|#centerobject-1]
* [BimPortal|#bimportal]* [Parameters|#parameters-2]
* * [getUrl|#geturl-4]
* * [sendMessage|#sendmessage-4]
* * [getDOMElementId|#getdomelementid-4]
* * [load|#load-6]
* [BimProjectNavigationBar|#bimprojectnavigationbar]* [Parameters|#parameters-3]
* * [getUrl|#geturl-5]
* * [sendMessage|#sendmessage-5]
* * [getDOMElementId|#getdomelementid-5]
* * [load|#load-7]
* [BimTaskList|#bimtasklist]* [Parameters|#parameters-4]
* * [getUrl|#geturl-6]
* * [sendMessage|#sendmessage-6]
* * [getDOMElementId|#getdomelementid-6]
* [ExternalClient|#externalclient]* [Parameters|#parameters-5]
* * [initialize|#initialize]
* * [addMessageHandler|#addmessagehandler]
* * [removeMessageHandler|#removemessagehandler]
* * [messageReceived|#messagereceived]
* * [sendMessage|#sendmessage-7]
* * [getClientName|#getclientname]
* [getUrlParameter|#geturlparameter]* [Parameters|#parameters-6]
h2. BimExplorer
h3. Parameters
* {{domId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* DOM Element Id of the containing iframe
* {{token}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* a valid bimplus accesstoken
* {{client}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* The external client to connect with
* {{env}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* environment to use: dev, stage or prod
h3. getUrl
get the remote url of the Bim Portal
h4. Parameters
* {{teamId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Project id
Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded bim explorer
h3. getUrl
get the remote url of the Bim Portal
h4. Parameters
* {{teamId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Project id
* {{objectId}}
Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded bim explorer
h3. sendMessage
send a message to Bim Explorer control
h4. Parameters
* {{message}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* message name
* {{data}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* message data
h3. sendMessage
send a message to Bim Explorer control
h4. Parameters
* {{message}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* message name
* {{data}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* message data
h3. getDOMElementId
get the Id of the bound iframe element
Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded bim portal
h3. getDOMElementId
get the Id of the bound iframe element
Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded bim portal
h3. load
Load the Bim Explorer into the bound iframe, loading the passed project
h4. Parameters
* {{teamId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Project id
h3. load
Load the Bim Explorer into the bound iframe, loading the passed project
h4. Parameters
* {{teamId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Project id
* {{objectId}}
h3. load
Load the Bim Explorer into the bound iframe, loading the passed project
h4. Parameters
* {{teamId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Project id
h3. resetView
Reset the view
h3. centerObject
Zoom to a given object
h4. Parameters
* {{objectId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Object to zoom to
* {{flyTo}} *bool* Animated zoom or jump to object
h2. BimExplorer
h3. Parameters
* {{domId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* DOM Element Id of the containing iframe
* {{token}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* a valid bimplus accesstoken
* {{client}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* The external client to connect with
* {{env}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* environment to use: dev, stage or prod
h3. getUrl
get the remote url of the Bim Portal
h4. Parameters
* {{teamId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Project id
Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded bim explorer
h3. getUrl
get the remote url of the Bim Portal
h4. Parameters
* {{teamId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Project id
* {{objectId}}
Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded bim explorer
h3. sendMessage
send a message to Bim Explorer control
h4. Parameters
* {{message}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* message name
* {{data}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* message data
h3. sendMessage
send a message to Bim Explorer control
h4. Parameters
* {{message}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* message name
* {{data}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* message data
h3. getDOMElementId
get the Id of the bound iframe element
Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded bim portal
h3. getDOMElementId
get the Id of the bound iframe element
Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded bim portal
h3. load
Load the Bim Explorer into the bound iframe, loading the passed project
h4. Parameters
* {{teamId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Project id
h3. load
Load the Bim Explorer into the bound iframe, loading the passed project
h4. Parameters
* {{teamId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Project id
* {{objectId}}
h3. load
Load the Bim Explorer into the bound iframe, loading the passed project
h4. Parameters
* {{teamId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Project id
h3. resetView
Reset the view
h3. centerObject
Zoom to a given object
h4. Parameters
* {{objectId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Object to zoom to
* {{flyTo}} *bool* Animated zoom or jump to object
h2. BimPortal
h3. Parameters
* {{domId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* DOM Element Id of the containing iframe
* {{token}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* a valid bimplus accesstoken
* {{client}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* The external client to connect with
* {{env}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* environment to use: dev, stage or prod
h3. getUrl
get the remote url of the Bim Portal
Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded bim portal
h3. sendMessage
send a message to Bim Portal control
h4. Parameters
* {{message}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* message name
* {{data}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* message data
h3. getDOMElementId
get the Id of the bound iframe element
Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded bim portal
h3. load
Load the Bim Portal into the bound iframe
h2. BimProjectNavigationBar
h3. Parameters
* {{domId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* DOM Element Id of the containing iframe
* {{token}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* a valid bimplus accesstoken
* {{client}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* The external client to connect with
* {{env}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* environment to use: dev, stage or prod
h3. getUrl
get the remote url of the Bim ProjrctManager
h4. Parameters
* {{teamId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Project id
Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded bim projectmanager
h3. sendMessage
send a message to Bim BimProjectNavigationBar control
h4. Parameters
* {{message}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* message name
* {{data}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* message data
h3. getDOMElementId
get the Id of the bound iframe element
Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded bim portal
h3. load
Load the Bim BimProjectNavigationBar into the bound iframe, loading the passed project
h4. Parameters
* {{teamId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Project id
h2. BimTaskList
h3. Parameters
* {{domId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* DOM Element Id of the containing iframe
* {{token}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* a valid bimplus accesstoken
* {{client}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* The external client to connect with
* {{env}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* environment to use: dev, stage or prod
h3. getUrl
get the remote url of the task list control
h4. Parameters
* {{teamId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Project id
Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded task list
h3. sendMessage
send a message to Bim Portal control
h4. Parameters
* {{message}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* message name
* {{data}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* message data
h3. getDOMElementId
get the Id of the bound iframe element
Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded bim portal
h2. ExternalClient
h3. Parameters
* {{clientName}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* client id
h3. initialize
initialize and start listening to incomming messages
h3. addMessageHandler
add a message handler
h4. Parameters
* {{message}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* message id
* {{handler}} *[function|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function]* handler function
h3. removeMessageHandler
remove a message handler
h4. Parameters
* {{message}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* message id
h3. messageReceived
Handle a received messages
h4. Parameters
* {{message}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* message object
h3. sendMessage
Send a message to bimplus web application
h4. Parameters
* {{elemId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* DOM Element Id of the containing iframe
* {{message}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Message name
* {{data}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* message data
h3. getClientName
get the client id
Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* connected client id
h2. getUrlParameter
get the current page url parameter
h3. Parameters
* {{sParam}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Paramter name
Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Paramter value