Bimplus WebClient version : 0.0.2
...
Table of Contents
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
BimExplorer
h3. Parameters* {{
domId
...
...
- DOM Element Id of the containing iframe
...
token
...
...
- a valid bimplus accesstoken
...
client
...
...
- The external client to connect with
...
env
...
...
- environment to use: dev, stage or prod
...
getUrl
get the remote url of the Bim Portal
h4. Parameters* {{
teamId
...
...
- Team id
...
projectId
...
...
- Project id
Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded bim explorerh3.
getUrl
get the remote url of the Bim Portal
h4. Parameters* {{
teamId
...
...
- Team id
...
projectId
...
...
- Project id
...
objectId
...
Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded bim explorerh3.
sendMessage
send a message to Bim Explorer control
h4. Parameters* {{
message
...
...
- message name
...
data
...
...
- message data
...
sendMessage
send a message to Bim Explorer control
h4. Parameters* {{
message
...
...
- message name
...
data
...
...
- message data
...
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 portalh3.
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 portalh3.
load
Load the Bim Explorer into the bound iframe, loading the passed project
h4. Parameters* {{
teamId
...
...
- Team id
...
projectId
...
...
- Project id
...
load
Load the Bim Explorer into the bound iframe, loading the passed project
h4. Parameters* {{
teamId
...
...
- Team id
...
projectId
...
...
- Project id
...
objectId
...
...
load
Load the Bim Explorer into the bound iframe, loading the passed project
h4. Parameters* {{
teamId
...
...
- Team id
...
projectId
...
...
- Project id
...
resetView
Reset the viewh3.
centerObject
Zoom to a given object
h4. Parameters* {{
objectId
...
...
- Object to zoom to
...
flyTo
...
- bool
...
- Animated zoom or jump to object
...
BimExplorer
h3. Parameters* {{
domId
...
...
- DOM Element Id of the containing iframe
...
token
...
...
- a valid bimplus accesstoken
...
client
...
...
- The external client to connect with
...
env
...
...
- environment to use: dev, stage or prod
...
getUrl
get the remote url of the Bim Portal
h4. Parameters* {{
teamId
...
...
- Team id
...
projectId
...
...
- Project id
Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded bim explorerh3.
getUrl
get the remote url of the Bim Portal
h4. Parameters* {{
teamId
...
...
- Team id
...
projectId
...
...
- Project id
...
objectId
...
Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded bim explorerh3.
sendMessage
send a message to Bim Explorer control
h4. Parameters* {{
message
...
...
- message name
...
data
...
...
- message data
...
sendMessage
send a message to Bim Explorer control
h4. Parameters* {{
message
...
...
- message name
...
data
...
...
- message data
...
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 portalh3.
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 portalh3.
load
Load the Bim Explorer into the bound iframe, loading the passed project
h4. Parameters* {{
teamId
...
...
- Team id
...
projectId
...
...
- Project id
...
load
Load the Bim Explorer into the bound iframe, loading the passed project
h4. Parameters* {{
teamId
...
...
- Team id
...
projectId
...
...
- Project id
...
objectId
...
...
load
Load the Bim Explorer into the bound iframe, loading the passed project
h4. Parameters* {{
teamId
...
...
- Team id
...
projectId
...
...
- Project id
...
resetView
Reset the viewh3.
centerObject
Zoom to a given object
h4. Parameters* {{
objectId
...
...
- Object to zoom to
...
flyTo
...
- bool
...
- Animated zoom or jump to object
...
BimPortal
h3. Parameters* {{
domId
...
...
- DOM Element Id of the containing iframe
...
token
...
...
- a valid bimplus accesstoken
...
client
...
...
- The external client to connect with
...
env
...
...
- environment to use: dev, stage or prod
...
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 portalh3.
sendMessage
send a message to Bim Portal control
h4. Parameters* {{
message
...
...
- message name
...
data
...
...
- message data
...
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 portalh3.
load
Load the Bim Portal into the bound iframeh2.
BimProjectNavigationBar
h3. Parameters* {{
domId
...
...
- DOM Element Id of the containing iframe
...
token
...
...
- a valid bimplus accesstoken
...
client
...
...
- The external client to connect with
...
env
...
...
- environment to use: dev, stage or prod
...
getUrl
get the remote url of the Bim ProjrctManager
h4. Parameters* {{
teamId
...
...
- Team id
...
projectId
...
...
- Project id
Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded bim projectmanagerh3.
sendMessage
send a message to Bim BimProjectNavigationBar control
h4. Parameters* {{
message
...
...
- message name
...
data
...
...
- message data
...
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 portalh3.
load
Load the Bim BimProjectNavigationBar into the bound iframe, loading the passed project
h4. Parameters* {{
teamId
...
...
- Team id
...
projectId
...
...
- Project id
...
BimTaskList
h3. Parameters* {{
domId
...
...
- DOM Element Id of the containing iframe
...
token
...
...
- a valid bimplus accesstoken
...
client
...
...
- The external client to connect with
...
env
...
...
- environment to use: dev, stage or prod
...
getUrl
get the remote url of the task list control
h4. Parameters* {{
teamId
...
...
- Team id
...
projectId
...
...
- Project id
Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded task listh3.
sendMessage
send a message to Bim Portal control
h4. Parameters* {{
message
...
...
- message name
...
data
...
...
- message data
...
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 portalh2.
ExternalClient
h3. Parameters* {{
clientName
...
...
- client id
...
initialize
initialize and start listening to incomming messagesh3.
addMessageHandler
add a message handler
h4. Parameters* {{
message
...
...
- message id
...
handler
...
...
- handler function
...
removeMessageHandler
remove a message handler
h4. Parameters* {{
message
...
...
- message id
...
messageReceived
Handle a received messages
h4. Parameters* {{
message
...
...
- message object
...
sendMessage
Send a message to bimplus web application
h4. Parameters* {{
elemId
...
...
- DOM Element Id of the containing iframe
...
message
...
...
- Message name
...
data
...
...
- message data
...
getClientName
get the client id
Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* connected client idh2.
getUrlParameter
get the current page url parameter
h3. Parameters* {{
sParam
...
...
- Paramter name
Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Paramter value