- BimExplorer- Parameters
- getUrl
- getUrl
- [sendMessage](#WebClientApidescription-sendMessage]
- [sendMessage](#WebClientApidescription-sendMessage.1]
- [getDOMElementId](#WebClientApidescription-getDOMElementId]
- [getDOMElementId](#WebClientApidescription-getDOMElementId.1]
- [load](#WebClientApidescription-load]
- [load](#WebClientApidescription-load.1]
- [load](#WebClientApidescription-load.2]
- [resetView|#resetview]
- [centerObject](#WebClientApidescription-centerObject]
- [BimExplorer](#WebClientApidescription-BimExplorer.1]- [Parameters](#WebClientApidescription-Parameters.1]
- [getUrl](#WebClientApidescription-getUrl.2]
- [getUrl](#WebClientApidescription-getUrl.3]
- [sendMessage](#WebClientApidescription-sendMessage.2]
- [sendMessage](#WebClientApidescription-sendMessage.3]
- [getDOMElementId](#WebClientApidescription-getDOMElementId.2]
- [getDOMElementId](#WebClientApidescription-getDOMElementId.3]
- [load](#WebClientApidescription-load.3]
- [load](#WebClientApidescription-load.4]
- [load](#WebClientApidescription-load.5]
- [resetView|#resetview-1]
- [centerObject](#WebClientApidescription-centerObject.1]
- [BimPortal|#bimportal]- [Parameters](#WebClientApidescription-Parameters.2]
- [getUrl](#WebClientApidescription-getUrl.4]
- [sendMessage](#WebClientApidescription-sendMessage.4]
- [getDOMElementId](#WebClientApidescription-getDOMElementId.4]
- [load](#WebClientApidescription-load.6]
- [BimProjectNavigationBar|#bimprojectnavigationbar]- [Parameters](#WebClientApidescription-Parameters.3]
- [getUrl](#WebClientApidescription-getUrl.5]
- [sendMessage](#WebClientApidescription-sendMessage.5]
- [getDOMElementId](#WebClientApidescription-getDOMElementId.5]
- [load](#WebClientApidescription-load.7]
- [BimTaskList|#bimtasklist]- [Parameters](#WebClientApidescription-Parameters.4]
- [getUrl](#WebClientApidescription-getUrl.6]
- [sendMessage](#WebClientApidescription-sendMessage.6]
- [getDOMElementId](#WebClientApidescription-getDOMElementId.6]
- [ExternalClient|#externalclient]- [Parameters](#WebClientApidescription-Parameters.5]
- [initialize|#initialize]
- [addMessageHandler](#WebClientApidescription-addMessageHandler]
- [removeMessageHandler](#WebClientApidescription-removeMessageHandler]
- [messageReceived](#WebClientApidescription-messageReceived]
- [sendMessage](#WebClientApidescription-sendMessage.7]
- [getClientName|#getclientname]
- [getUrlParameter](#WebClientApidescription-getUrlparameter]- [Parameters](#WebClientApidescription-Parameters.6]
h2. BimExplorer
h3. Parameters
- {{domId}} [string|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] DOM Element Id of the containing iframe
- {{token}} [string|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] a valid bimplus accesstoken
- {{client}} [object|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object] The external client to connect with
- {{env}} [string|https://developer.mozilla.org/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] Team id
- {{projectId}} [string|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] Project id
Returns [string|https://developer.mozilla.org/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] Team id
- {{projectId}} [string|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] Project id
- {{objectId}}
Returns [string|https://developer.mozilla.org/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] message name
- {{data}} [object|https://developer.mozilla.org/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] message name
- {{data}} [object|https://developer.mozilla.org/en-US/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/en-US/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/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] Team id
- {{projectId}} [string|https://developer.mozilla.org/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] Team id
- {{projectId}} [string|https://developer.mozilla.org/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] Team id
- {{projectId}} [string|https://developer.mozilla.org/en-US/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/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] DOM Element Id of the containing iframe
- {{token}} [string|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] a valid bimplus accesstoken
- {{client}} [object|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object] The external client to connect with
- {{env}} [string|https://developer.mozilla.org/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] Team id
- {{projectId}} [string|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] Project id
Returns [string|https://developer.mozilla.org/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] Team id
- {{projectId}} [string|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] Project id
- {{objectId}}
Returns [string|https://developer.mozilla.org/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] message name
- {{data}} [object|https://developer.mozilla.org/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] message name
- {{data}} [object|https://developer.mozilla.org/en-US/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/en-US/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/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] Team id
- {{projectId}} [string|https://developer.mozilla.org/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] Team id
- {{projectId}} [string|https://developer.mozilla.org/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] Team id
- {{projectId}} [string|https://developer.mozilla.org/en-US/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/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] DOM Element Id of the containing iframe
- {{token}} [string|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] a valid bimplus accesstoken
- {{client}} [object|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object] The external client to connect with
- {{env}} [string|https://developer.mozilla.org/en-US/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/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] message name
- {{data}} [object|https://developer.mozilla.org/en-US/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/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] DOM Element Id of the containing iframe
- {{token}} [string|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] a valid bimplus accesstoken
- {{client}} [object|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object] The external client to connect with
- {{env}} [string|https://developer.mozilla.org/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] Team id
- {{projectId}} [string|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] Project id
Returns [string|https://developer.mozilla.org/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] message name
- {{data}} [object|https://developer.mozilla.org/en-US/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/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] Team id
- {{projectId}} [string|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] Project id
h2. BimTaskList
h3. Parameters
- {{domId}} [string|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] DOM Element Id of the containing iframe
- {{token}} [string|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] a valid bimplus accesstoken
- {{client}} [object|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object] The external client to connect with
- {{env}} [string|https://developer.mozilla.org/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] Team id
- {{projectId}} [string|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] Project id
Returns [string|https://developer.mozilla.org/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] message name
- {{data}} [object|https://developer.mozilla.org/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] url to embedded bim portal
h2. ExternalClient
h3. Parameters
- {{clientName}} [string|https://developer.mozilla.org/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] message id
- {{handler}} [function|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function] handler function
h3. removeMessageHandler
remove a message handler
h4. Parameters
- {{message}} [string|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] message id
h3. messageReceived
Handle a received messages
h4. Parameters
- {{message}} [object|https://developer.mozilla.org/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] DOM Element Id of the containing iframe
- {{message}} [string|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] Message name
- {{data}} [object|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object] message data
h3. getClientName
get the client id
Returns [string|https://developer.mozilla.org/en-US/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/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] Paramter name
Returns [string|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] Paramter value
