<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
Table of Contents
- BimExplorer(#WebClientApidescription-BimExplorer)- Parameters(#WebClientApidescription-Parameters)
- getUrl(#WebClientApidescription-getUrl)
- getUrl(#WebClientApidescription-getUrl.1)
...
...
- (#WebClientApidescription-sendMessage]
...
...
- (#WebClientApidescription-sendMessage.1]
...
...
- (#WebClientApidescription-getDOMElementId]
...
...
- (#WebClientApidescription-getDOMElementId.1]
...
...
- (#WebClientApidescription-load]
...
...
- (#WebClientApidescription-load.1]
...
...
- (#WebClientApidescription-load.2]
...
...
...
...
- (#WebClientApidescription-centerObject]
...
...
- (#WebClientApidescription-BimExplorer.1]-
...
...
- (#WebClientApidescription-Parameters.1]
...
...
- (#WebClientApidescription-getUrl.2]
...
...
- (#WebClientApidescription-getUrl.3]
...
...
- (#WebClientApidescription-sendMessage.2]
...
...
- (#WebClientApidescription-sendMessage.3]
...
...
- (#WebClientApidescription-getDOMElementId.2]
...
...
- (#WebClientApidescription-getDOMElementId.3]
...
...
- (#WebClientApidescription-load.3]
...
...
- (#WebClientApidescription-load.4]
...
...
- (#WebClientApidescription-load.5]
...
...
...
...
- (#WebClientApidescription-centerObject.1]
...
...
- -
...
...
- (#WebClientApidescription-Parameters.2]
...
...
- (#WebClientApidescription-getUrl.4]
...
...
- (#WebClientApidescription-sendMessage.4]
...
...
- (#WebClientApidescription-getDOMElementId.4]
...
...
- (#WebClientApidescription-load.6]
...
...
- -
...
...
- (#WebClientApidescription-Parameters.3]
...
...
- (#WebClientApidescription-getUrl.5]
...
...
- (#WebClientApidescription-sendMessage.5]
...
...
- (#WebClientApidescription-getDOMElementId.5]
...
...
- (#WebClientApidescription-load.7]
...
...
- -
...
...
- (#WebClientApidescription-Parameters.4]
...
...
- (#WebClientApidescription-getUrl.6]
...
...
- (#WebClientApidescription-sendMessage.6]
...
...
- (#WebClientApidescription-getDOMElementId.6]
...
...
- -
...
...
- (#WebClientApidescription-Parameters.5]
...
...
...
...
- (#WebClientApidescription-addMessageHandler]
...
...
- (#WebClientApidescription-removeMessageHandler]
...
...
- (#WebClientApidescription-messageReceived]
...
...
- (#WebClientApidescription-sendMessage.7]
...
...
...
...
- (#WebClientApidescription-getUrlparameter]-
...
...
- (#WebClientApidescription-Parameters.6]
...
BimExplorer
...
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
...
getUrl
get the remote url of the Bim Portalh4.
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 explorerh3.
getUrl
get the remote url of the Bim Portalh4.
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 explorerh3.
sendMessage
send a message to Bim Explorer controlh4.
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
...
sendMessage
send a message to Bim Explorer controlh4.
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
...
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 portalh3.
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 portalh3.
load
Load the Bim Explorer into the bound iframe, loading the passed projecth4.
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
...
load
Load the Bim Explorer into the bound iframe, loading the passed projecth4.
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}}
...
load
Load the Bim Explorer into the bound iframe, loading the passed projecth4.
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
...
resetView
Reset the viewh3.
centerObject
Zoom to a given objecth4.
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
...
BimExplorer
...
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
...
getUrl
get the remote url of the Bim Portalh4.
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 explorerh3.
getUrl
get the remote url of the Bim Portalh4.
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 explorerh3.
sendMessage
send a message to Bim Explorer controlh4.
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
...
sendMessage
send a message to Bim Explorer controlh4.
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
...
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 portalh3.
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 portalh3.
load
Load the Bim Explorer into the bound iframe, loading the passed projecth4.
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
...
load
Load the Bim Explorer into the bound iframe, loading the passed projecth4.
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}}
...
load
Load the Bim Explorer into the bound iframe, loading the passed projecth4.
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
...
resetView
Reset the viewh3.
centerObject
Zoom to a given objecth4.
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
...
BimPortal
...
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
...
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 portalh3.
sendMessage
send a message to Bim Portal controlh4.
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
...
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 portalh3.
load
Load the Bim Portal into the bound iframeh2.
BimProjectNavigationBar
...
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
...
getUrl
get the remote url of the Bim ProjrctManagerh4.
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 projectmanagerh3.
sendMessage
send a message to Bim BimProjectNavigationBar controlh4.
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
...
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 portalh3.
load
Load the Bim BimProjectNavigationBar into the bound iframe, loading the passed projecth4.
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
...
BimTaskList
...
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
...
getUrl
get the remote url of the task list controlh4.
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 listh3.
sendMessage
send a message to Bim Portal controlh4.
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
...
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 portalh2.
ExternalClient
...
Parameters
- {{
clientName}} [string|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] client id
...
initialize
initialize and start listening to incomming messagesh3.
addMessageHandler
add a message handlerh4.
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
...
removeMessageHandler
remove a message handlerh4.
Parameters
- {{
message}} [string|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] message id
...
messageReceived
Handle a received messagesh4.
Parameters
- {{
message}} [object|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object] message object
...
sendMessage
Send a message to bimplus web applicationh4.
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
...
getClientName
get the client id
Returns [string|https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String] connected client idh2.
getUrlParameter
get the current page url parameterh3.
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