...

Bimplus WebClient version : 0.0.2

Table of Contents

• BimExplorer* Parameters
  *
  • getUrl
  *
  • getUrl
  *
  • sendMessage
  *
  • sendMessage
  *
  • getDOMElementId
  *
  • getDOMElementId
  *
  • load
  *
  • load
  *
  • load
  *
  • resetView
  *
  • centerObject
  • BimExplorer* Parameters
    *
    • getUrl
    *
    • getUrl
    *
    • sendMessage
    *
    • sendMessage
    *
    • getDOMElementId
    *
    • getDOMElementId
    *
    • load
    *
    • load
    *
    • load
    *
    • resetView
    *
    • centerObject
    • BimPortal* Parameters
      *
      • getUrl
      *
      • sendMessage
      *
      • getDOMElementId
      *
      • load
      • BimProjectNavigationBar* Parameters
        *
        • getUrl
        *
        • sendMessage
        *
        • getDOMElementId
        *
        • load
        • BimTaskList* Parameters
          *
          • getUrl
          *
          • sendMessage
          *
          • getDOMElementId
          • ExternalClient* Parameters
            *
            • initialize
            *
            • addMessageHandler
            *
            • removeMessageHandler
            *
            • messageReceived
            *
            • sendMessage
            *
            • getClientName
            • getUrlParameter* Parameters

            
            

            BimExplorer

            Parameters

            • domId string DOM Element Id of the containing iframe
            • token string a valid bimplus accesstoken
            • client object The external client to connect with
            • env string environment to use: dev, stage or prod

            
            

            getUrl

            get the remote url of the Bim Portal

            Parameters

            • teamId string Team id
            • projectId string Project id

            Returns string url to embedded bim explorer

            
            

            getUrl

            get the remote url of the Bim Portal

            Parameters

            • teamId string Team id
            • projectId string Project id
            • objectId

            Returns string url to embedded bim explorer

            
            

            sendMessage

            send a message to Bim Explorer control

            Parameters

            • message string message name
            • data object message data

            
            

            sendMessage

            send a message to Bim Explorer control

            Parameters

            • message string message name
            • data object message data

            
            

            getDOMElementId

            get the Id of the bound iframe element

            Returns string url to embedded bim portal

            
            

            getDOMElementId

            get the Id of the bound iframe element

            Returns string url to embedded bim portal

            
            

            load

            Load the Bim Explorer into the bound iframe, loading the passed project

            Parameters

            • teamId string Team id
            • projectId string Project id

            
            

            load

            Load the Bim Explorer into the bound iframe, loading the passed project

            Parameters

            • teamId string Team id
            • projectId string Project id
            • objectId

            
            

            load

            Load the Bim Explorer into the bound iframe, loading the passed project

            Parameters

            • teamId string Team id
            • projectId string Project id

            
            

            resetView

            Reset the view

            
            

            centerObject

            Zoom to a given object

            Parameters

            • objectId string Object to zoom to
            • flyTo bool Animated zoom or jump to object

            
            

            BimExplorer

            Parameters

            • domId string DOM Element Id of the containing iframe
            • token string a valid bimplus accesstoken
            • client object The external client to connect with
            • env string environment to use: dev, stage or prod

            
            

            getUrl

            get the remote url of the Bim Portal

            Parameters

            • teamId string Team id
            • projectId string Project id

            Returns string url to embedded bim explorer

            
            

            getUrl

            get the remote url of the Bim Portal

            Parameters

            • teamId string Team id
            • projectId string Project id
            • objectId

            Returns string url to embedded bim explorer

            
            

            sendMessage

            send a message to Bim Explorer control

            Parameters

            • message string message name
            • data object message data

            
            

            sendMessage

            send a message to Bim Explorer control

            Parameters

            • message string message name
            • data object message data

            
            

            getDOMElementId

            get the Id of the bound iframe element

            Returns string url to embedded bim portal

            
            

            getDOMElementId

            get the Id of the bound iframe element

            Returns string url to embedded bim portal

            
            

            load

            Load the Bim Explorer into the bound iframe, loading the passed project

            Parameters

            • teamId string Team id
            • projectId string Project id

            
            

            load

            Load the Bim Explorer into the bound iframe, loading the passed project

            Parameters

            • teamId string Team id
            • projectId string Project id
            • objectId

            
            

            load

            Load the Bim Explorer into the bound iframe, loading the passed project

            Parameters

            • teamId string Team id
            • projectId string Project id

            
            

            resetView

            Reset the view

            
            

            centerObject

            Zoom to a given object

            Parameters

            • objectId string Object to zoom to
            • flyTo bool Animated zoom or jump to object

            
            

            BimPortal

            Parameters

            • domId string DOM Element Id of the containing iframe
            • token string a valid bimplus accesstoken
            • client object The external client to connect with
            • env string environment to use: dev, stage or prod

            
            

            getUrl

            get the remote url of the Bim Portal

            Returns string url to embedded bim portal

            
            

            sendMessage

            send a message to Bim Portal control

            Parameters

            • message string message name
            • data object message data

            
            

            getDOMElementId

            get the Id of the bound iframe element

            Returns string url to embedded bim portal

            
            

            load

            Load the Bim Portal into the bound iframe

            
            

            BimProjectNavigationBar

            Parameters

            • domId string DOM Element Id of the containing iframe
            • token string a valid bimplus accesstoken
            • client object The external client to connect with
            • env string environment to use: dev, stage or prod

            
            

            getUrl

            get the remote url of the Bim ProjrctManager

            Parameters

            • teamId string Team id
            • projectId string Project id

            Returns string url to embedded bim projectmanager

            
            

            sendMessage

            send a message to Bim BimProjectNavigationBar control

            Parameters

            • message string message name
            • data object message data

            
            

            getDOMElementId

            get the Id of the bound iframe element

            Returns string url to embedded bim portal

            
            

            load

            Load the Bim BimProjectNavigationBar into the bound iframe, loading the passed project

            Parameters

            • teamId string Team id
            • projectId string Project id

            
            

            BimTaskList

            Parameters

            • domId string DOM Element Id of the containing iframe
            • token string a valid bimplus accesstoken
            • client object The external client to connect with
            • env string environment to use: dev, stage or prod

            
            

            getUrl

            get the remote url of the task list control

            Parameters

            • teamId string Team id
            • projectId string Project id

            Returns string url to embedded task list

            
            

            sendMessage

            send a message to Bim Portal control

            Parameters

            • message string message name
            • data object message data

            
            

            getDOMElementId

            get the Id of the bound iframe element

            Returns string url to embedded bim portal

            
            

            ExternalClient

            Parameters

            • clientName string client id

            
            

            initialize

            initialize and start listening to incomming messages

            
            

            addMessageHandler

            add a message handler

            Parameters

            • message string message id
            • handler function handler function

            
            

            removeMessageHandler

            remove a message handler

            Parameters

            • message string message id

            
            

            messageReceived

            Handle a received messages

            Parameters

            • message object message object

            
            

            sendMessage

            Send a message to bimplus web application

            Parameters

            • elemId string DOM Element Id of the containing iframe
            • message string Message name
            • data object message data

            
            

            getClientName

            get the client id

            Returns string connected client id

            
            

            getUrlParameter

            get the current page url parameter

            Parameters

            • sParam string Paramter name

            ...