You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next » 

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

### Table of Contents

-   [BimExplorer][1]
    -   [Parameters][2]
    -   [getUrl][3]
    -   [getUrl][4]
    -   [sendMessage][5]
    -   [sendMessage][6]
    -   [getDOMElementId][7]
    -   [getDOMElementId][8]
    -   [load][9]
    -   [load][10]
    -   [load][11]
    -   [resetView][12]
    -   [centerObject][13]
-   [BimExplorer][14]
    -   [Parameters][15]
    -   [getUrl][16]
    -   [getUrl][17]
    -   [sendMessage][18]
    -   [sendMessage][19]
    -   [getDOMElementId][20]
    -   [getDOMElementId][21]
    -   [load][22]
    -   [load][23]
    -   [load][24]
    -   [resetView][25]
    -   [centerObject][26]
-   [BimPortal][27]
    -   [Parameters][28]
    -   [getUrl][29]
    -   [sendMessage][30]
    -   [getDOMElementId][31]
    -   [load][32]
-   [BimProjectNavigationBar][33]
    -   [Parameters][34]
    -   [getUrl][35]
    -   [sendMessage][36]
    -   [getDOMElementId][37]
    -   [load][38]
-   [BimTaskList][39]
    -   [Parameters][40]
    -   [getUrl][41]
    -   [sendMessage][42]
    -   [getDOMElementId][43]
-   [ExternalClient][44]
    -   [Parameters][45]
    -   [initialize][46]
    -   [addMessageHandler][47]
    -   [removeMessageHandler][48]
    -   [messageReceived][49]
    -   [sendMessage][50]
    -   [getClientName][51]
-   [getUrlParameter][52]
    -   [Parameters][53]

## BimExplorer

### Parameters

-   `domId` **[string][54]** DOM Element Id of the containing iframe
-   `token` **[string][54]** a valid bimplus accesstoken
-   `client` **[object][55]** The external client to connect with
-   `env` **[string][54]** environment to use: dev, stage or prod

### getUrl

get the remote url of the Bim Portal

#### Parameters

-   `teamId` **[string][54]** Team id
-   `projectId` **[string][54]** Project id

Returns **[string][54]** url to embedded bim explorer

### getUrl

get the remote url of the Bim Portal

#### Parameters

-   `teamId` **[string][54]** Team id
-   `projectId` **[string][54]** Project id
-   `objectId`  

Returns **[string][54]** url to embedded bim explorer

### sendMessage

send a message to Bim Explorer control

#### Parameters

-   `message` **[string][54]** message name
-   `data` **[object][55]** message data

### sendMessage

send a message to Bim Explorer control

#### Parameters

-   `message` **[string][54]** message name
-   `data` **[object][55]** message data

### getDOMElementId

get the Id of the bound iframe element

Returns **[string][54]** url to embedded bim portal

### getDOMElementId

get the Id of the bound iframe element

Returns **[string][54]** url to embedded bim portal

### load

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

#### Parameters

-   `teamId` **[string][54]** Team id
-   `projectId` **[string][54]** Project id

### load

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

#### Parameters

-   `teamId` **[string][54]** Team id
-   `projectId` **[string][54]** Project id
-   `objectId`  

### load

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

#### Parameters

-   `teamId` **[string][54]** Team id
-   `projectId` **[string][54]** Project id

### resetView

Reset the view

### centerObject

Zoom to a given object

#### Parameters

-   `objectId` **[string][54]** Object to zoom to
-   `flyTo` **bool** Animated zoom or jump to object

## BimExplorer

### Parameters

-   `domId` **[string][54]** DOM Element Id of the containing iframe
-   `token` **[string][54]** a valid bimplus accesstoken
-   `client` **[object][55]** The external client to connect with
-   `env` **[string][54]** environment to use: dev, stage or prod

### getUrl

get the remote url of the Bim Portal

#### Parameters

-   `teamId` **[string][54]** Team id
-   `projectId` **[string][54]** Project id

Returns **[string][54]** url to embedded bim explorer

### getUrl

get the remote url of the Bim Portal

#### Parameters

-   `teamId` **[string][54]** Team id
-   `projectId` **[string][54]** Project id
-   `objectId`  

Returns **[string][54]** url to embedded bim explorer

### sendMessage

send a message to Bim Explorer control

#### Parameters

-   `message` **[string][54]** message name
-   `data` **[object][55]** message data

### sendMessage

send a message to Bim Explorer control

#### Parameters

-   `message` **[string][54]** message name
-   `data` **[object][55]** message data

### getDOMElementId

get the Id of the bound iframe element

Returns **[string][54]** url to embedded bim portal

### getDOMElementId

get the Id of the bound iframe element

Returns **[string][54]** url to embedded bim portal

### load

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

#### Parameters

-   `teamId` **[string][54]** Team id
-   `projectId` **[string][54]** Project id

### load

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

#### Parameters

-   `teamId` **[string][54]** Team id
-   `projectId` **[string][54]** Project id
-   `objectId`  

### load

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

#### Parameters

-   `teamId` **[string][54]** Team id
-   `projectId` **[string][54]** Project id

### resetView

Reset the view

### centerObject

Zoom to a given object

#### Parameters

-   `objectId` **[string][54]** Object to zoom to
-   `flyTo` **bool** Animated zoom or jump to object

## BimPortal

### Parameters

-   `domId` **[string][54]** DOM Element Id of the containing iframe
-   `token` **[string][54]** a valid bimplus accesstoken
-   `client` **[object][55]** The external client to connect with
-   `env` **[string][54]** environment to use: dev, stage or prod

### getUrl

get the remote url of the Bim Portal

Returns **[string][54]** url to embedded bim portal

### sendMessage

send a message to Bim Portal control

#### Parameters

-   `message` **[string][54]** message name
-   `data` **[object][55]** message data

### getDOMElementId

get the Id of the bound iframe element

Returns **[string][54]** url to embedded bim portal

### load

Load the Bim Portal into the bound iframe

## BimProjectNavigationBar

### Parameters

-   `domId` **[string][54]** DOM Element Id of the containing iframe
-   `token` **[string][54]** a valid bimplus accesstoken
-   `client` **[object][55]** The external client to connect with
-   `env` **[string][54]** environment to use: dev, stage or prod

### getUrl

get the remote url of the Bim ProjrctManager

#### Parameters

-   `teamId` **[string][54]** Team id
-   `projectId` **[string][54]** Project id

Returns **[string][54]** url to embedded bim projectmanager

### sendMessage

send a message to Bim BimProjectNavigationBar control

#### Parameters

-   `message` **[string][54]** message name
-   `data` **[object][55]** message data

### getDOMElementId

get the Id of the bound iframe element

Returns **[string][54]** url to embedded bim portal

### load

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

#### Parameters

-   `teamId` **[string][54]** Team id
-   `projectId` **[string][54]** Project id

## BimTaskList

### Parameters

-   `domId` **[string][54]** DOM Element Id of the containing iframe
-   `token` **[string][54]** a valid bimplus accesstoken
-   `client` **[object][55]** The external client to connect with
-   `env` **[string][54]** environment to use: dev, stage or prod

### getUrl

get the remote url of the task list control

#### Parameters

-   `teamId` **[string][54]** Team id
-   `projectId` **[string][54]** Project id

Returns **[string][54]** url to embedded task list

### sendMessage

send a message to Bim Portal control

#### Parameters

-   `message` **[string][54]** message name
-   `data` **[object][55]** message data

### getDOMElementId

get the Id of the bound iframe element

Returns **[string][54]** url to embedded bim portal

## ExternalClient

### Parameters

-   `clientName` **[string][54]** client id

### initialize

initialize and start listening to incomming messages

### addMessageHandler

add a message handler

#### Parameters

-   `message` **[string][54]** message id
-   `handler` **[function][56]** handler function

### removeMessageHandler

remove a message handler

#### Parameters

-   `message` **[string][54]** message id

### messageReceived

Handle a received messages

#### Parameters

-   `message` **[object][55]** message object

### sendMessage

Send a message to bimplus web application

#### Parameters

-   `elemId` **[string][54]** DOM Element Id of the containing iframe
-   `message` **[string][54]** Message name
-   `data` **[object][55]** message data

### getClientName

get the client id

Returns **[string][54]** connected client id

## getUrlParameter

get the current page url parameter

### Parameters

-   `sParam` **[string][54]** Paramter name

Returns **[string][54]** Paramter value

[1]: #bimexplorer

[2]: #parameters

[3]: #geturl

[4]: #geturl-1

[5]: #sendmessage

[6]: #sendmessage-1

[7]: #getdomelementid

[8]: #getdomelementid-1

[9]: #load

[10]: #load-1

[11]: #load-2

[12]: #resetview

[13]: #centerobject

[14]: #bimexplorer-1

[15]: #parameters-1

[16]: #geturl-2

[17]: #geturl-3

[18]: #sendmessage-2

[19]: #sendmessage-3

[20]: #getdomelementid-2

[21]: #getdomelementid-3

[22]: #load-3

[23]: #load-4

[24]: #load-5

[25]: #resetview-1

[26]: #centerobject-1

[27]: #bimportal

[28]: #parameters-2

[29]: #geturl-4

[30]: #sendmessage-4

[31]: #getdomelementid-4

[32]: #load-6

[33]: #bimprojectnavigationbar

[34]: #parameters-3

[35]: #geturl-5

[36]: #sendmessage-5

[37]: #getdomelementid-5

[38]: #load-7

[39]: #bimtasklist

[40]: #parameters-4

[41]: #geturl-6

[42]: #sendmessage-6

[43]: #getdomelementid-6

[44]: #externalclient

[45]: #parameters-5

[46]: #initialize

[47]: #addmessagehandler

[48]: #removemessagehandler

[49]: #messagereceived

[50]: #sendmessage-7

[51]: #getclientname

[52]: #geturlparameter

[53]: #parameters-6

[54]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String

[55]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object

[56]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function


  • No labels

Impressum

Privacy Policy