<!doctype html>
<html>
<head>
<meta charset='utf-- Generated by documentation.js. Update this documentation by updating the source code. -->
h3. Table of Contents
* [BimExplorer|#bimexplorer]* [Parameters|#parameters]
* * [getUrl|#geturl]
* * [getUrl|#geturl-1]
* * [sendMessage|#sendmessage]
* * [sendMessage|#sendmessage-1]
* * [getDOMElementId|#getdomelementid]
* * [getDOMElementId|#getdomelementid-1]
* * [load|#load]
* * [load|#load-1]
* * [load|#load-2]
* * [resetView|#resetview]
* * [centerObject|#centerobject]
* [BimExplorer|#bimexplorer-1]* [Parameters|#parameters-1]
* * [getUrl|#geturl-2]
* * [getUrl|#geturl-3]
* * [sendMessage|#sendmessage-2]
* * [sendMessage|#sendmessage-3]
* * [getDOMElementId|#getdomelementid-2]
* * [getDOMElementId|#getdomelementid-3]
* * [load|#load-3]
* * [load|#load-4]
* * [load|#load-5]
* * [resetView|#resetview-1]
* * [centerObject|#centerobject-1]
* [BimPortal|#bimportal]* [Parameters|#parameters-2]
* * [getUrl|#geturl-4]
* * [sendMessage|#sendmessage-4]
* * [getDOMElementId|#getdomelementid-4]
* * [load|#load-6]
* [BimProjectNavigationBar|#bimprojectnavigationbar]* [Parameters|#parameters-3]
* * [getUrl|#geturl-5]
* * [sendMessage|#sendmessage-5]
* * [getDOMElementId|#getdomelementid-5]
* * [load|#load-7]
* [BimTaskList|#bimtasklist]* [Parameters|#parameters-4]
* * [getUrl|#geturl-6]
* * [sendMessage|#sendmessage-6]
* * [getDOMElementId|#getdomelementid-6]
* [ExternalClient|#externalclient]* [Parameters|#parameters-5]
* * [initialize|#initialize]
* * [addMessageHandler|#addmessagehandler]
* * [removeMessageHandler|#removemessagehandler]
* * [messageReceived|#messagereceived]
* * [sendMessage|#sendmessage-7]
* * [getClientName|#getclientname]
* [getUrlParameter|#geturlparameter]* [Parameters|#parameters-6]
h2. BimExplorer
h3. Parameters
* {{domId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* DOM Element Id of the containing iframe
* {{token}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* a valid bimplus accesstoken
* {{client}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* The external client to connect with
* {{env}} *[string|https://developer.mozilla.org/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/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Project id
Returns *[string|https://developer.mozilla.org/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/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Project id
* {{objectId}}
Returns *[string|https://developer.mozilla.org/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/docs/Web/JavaScript/Reference/Global_Objects/String]* message name
* {{data}} *[object|https://developer.mozilla.org/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/docs/Web/JavaScript/Reference/Global_Objects/String]* message name
* {{data}} *[object|https://developer.mozilla.org/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/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/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/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|https://developer.mozilla.org/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/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|https://developer.mozilla.org/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/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|https://developer.mozilla.org/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/docs/Web/JavaScript/Reference/Global_Objects/String]* Object to zoom to
* {{flyTo}} *bool* Animated zoom or jump to object
h2. BimExplorer
h3. Parameters
8'>
<title>bimplus-webclient 0.0.2 | Documentation</title>
<meta name='description' content='bim+ web client'>
<meta name='viewport' content='width=device-width,initial-scale=1'>
<link href='assets/bass.css' rel='stylesheet'>
<link href='assets/style.css' rel='stylesheet'>
<link href='assets/github.css' rel='stylesheet'>
<link href='assets/split.css' rel='stylesheet'>
</head>
<body class='documentation m0'>
<div class='flex'>
<div id='split-left' class='overflow-auto fs0 height-viewport-100'>
<div class='py1 px2'>
<h3 class='mb0 no-anchor'>bimplus-webclient</h3>
<div class='mb1'><code>0.0.2</code></div>
<input
placeholder='Filter'
id='filter-input'
class='col12 block input'
type='text' />
<div id='toc'>
<ul class='list-reset h5 py1-ul'>
<li><a
href='#bimplus-web-client-integration'
class="h5 bold black caps">
Bimplus Web Client Integration
</a>
</li>
<li><a
href='#bimexplorer'
class=" toggle-sibling">
BimExplorer
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Static members</span></li>
<li><a
href='#bimexplorergeturl'
class='regular pre-open'>
.getUrl
</a></li>
<li><a
href='#bimexplorergeturl'
class='regular pre-open'>
.getUrl
</a></li>
<li><a
href='#bimexplorersendmessage'
class='regular pre-open'>
.sendMessage
</a></li>
<li><a
href='#bimexplorersendmessage'
class='regular pre-open'>
.sendMessage
</a></li>
<li><a
href='#bimexplorergetdomelementid'
class='regular pre-open'>
.getDOMElementId
</a></li>
<li><a
href='#bimexplorergetdomelementid'
class='regular pre-open'>
.getDOMElementId
</a></li>
<li><a
href='#bimexplorerload'
class='regular pre-open'>
.load
</a></li>
<li><a
href='#bimexplorerload'
class='regular pre-open'>
.load
</a></li>
<li><a
href='#bimexplorerload'
class='regular pre-open'>
.load
</a></li>
<li><a
href='#bimexplorerresetview'
class='regular pre-open'>
.resetView
</a></li>
<li><a
href='#bimexplorercenterobject'
class='regular pre-open'>
.centerObject
</a></li>
</ul>
</div>
</li>
<li><a
href='#bimexplorer'
class=" toggle-sibling">
BimExplorer
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Static members</span></li>
<li><a
href='#bimexplorergeturl'
class='regular pre-open'>
.getUrl
</a></li>
<li><a
href='#bimexplorergeturl'
class='regular pre-open'>
.getUrl
</a></li>
<li><a
href='#bimexplorersendmessage'
class='regular pre-open'>
.sendMessage
</a></li>
<li><a
href='#bimexplorersendmessage'
class='regular pre-open'>
.sendMessage
</a></li>
<li><a
href='#bimexplorergetdomelementid'
class='regular pre-open'>
.getDOMElementId
</a></li>
<li><a
href='#bimexplorergetdomelementid'
class='regular pre-open'>
.getDOMElementId
</a></li>
<li><a
href='#bimexplorerload'
class='regular pre-open'>
.load
</a></li>
<li><a
href='#bimexplorerload'
class='regular pre-open'>
.load
</a></li>
<li><a
href='#bimexplorerload'
class='regular pre-open'>
.load
</a></li>
<li><a
href='#bimexplorerresetview'
class='regular pre-open'>
.resetView
</a></li>
<li><a
href='#bimexplorercenterobject'
class='regular pre-open'>
.centerObject
</a></li>
</ul>
</div>
</li>
<li><a
href='#bimportal'
class=" toggle-sibling">
BimPortal
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Static members</span></li>
<li><a
href='#bimportalgeturl'
class='regular pre-open'>
.getUrl
</a></li>
<li><a
href='#bimportalsendmessage'
class='regular pre-open'>
.sendMessage
</a></li>
<li><a
href='#bimportalgetdomelementid'
class='regular pre-open'>
.getDOMElementId
</a></li>
<li><a
href='#bimportalload'
class='regular pre-open'>
.load
</a></li>
</ul>
</div>
</li>
<li><a
href='#bimprojectnavigationbar'
class=" toggle-sibling">
BimProjectNavigationBar
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Static members</span></li>
<li><a
href='#bimprojectnavigationbargeturl'
class='regular pre-open'>
.getUrl
</a></li>
<li><a
href='#bimprojectnavigationbarsendmessage'
class='regular pre-open'>
.sendMessage
</a></li>
<li><a
href='#bimprojectnavigationbargetdomelementid'
class='regular pre-open'>
.getDOMElementId
</a></li>
<li><a
href='#bimprojectnavigationbarload'
class='regular pre-open'>
.load
</a></li>
</ul>
</div>
</li>
<li><a
href='#bimtasklist'
class=" toggle-sibling">
BimTaskList
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Static members</span></li>
<li><a
href='#bimtasklistgeturl'
class='regular pre-open'>
.getUrl
</a></li>
<li><a
href='#bimtasklistsendmessage'
class='regular pre-open'>
.sendMessage
</a></li>
<li><a
href='#bimtasklistgetdomelementid'
class='regular pre-open'>
.getDOMElementId
</a></li>
</ul>
</div>
</li>
<li><a
href='#externalclient'
class=" toggle-sibling">
ExternalClient
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Static members</span></li>
<li><a
href='#externalclientinitialize'
class='regular pre-open'>
.initialize
</a></li>
<li><a
href='#externalclientaddmessagehandler'
class='regular pre-open'>
.addMessageHandler
</a></li>
<li><a
href='#externalclientremovemessagehandler'
class='regular pre-open'>
.removeMessageHandler
</a></li>
<li><a
href='#externalclientmessagereceived'
class='regular pre-open'>
.messageReceived
</a></li>
<li><a
href='#externalclientsendmessage'
class='regular pre-open'>
.sendMessage
</a></li>
<li><a
href='#externalclientgetclientname'
class='regular pre-open'>
.getClientName
</a></li>
</ul>
</div>
</li>
<li><a
href='#geturlparameter'
class="">
getUrlParameter
</a>
</li>
</ul>
</div>
<div class='mt1 h6 quiet'>
<a href='Need'>https://documentation.js.org/reading-documentation.html'>Need help reading this?</a>
</div>
</div>
</div>
<div id='split-right' class='relative overflow-auto height-viewport-100'>
<div class='keyline-top-not py2'><section class='py2 clearfix'>
<h2 id='bimplus-web-client-integration' class='mt0'>
Bimplus Web Client Integration
</h2>
</section></div>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='bimexplorer'>
BimExplorer
</h3>
</div>
<div class='pre p1 fill-light mt0'>BimExplorer</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>domId</span> <code class='quiet'>(<a href="* {{domId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* DOM Element Id of the containing iframe
* {{token}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* a valid bimplus accesstoken
* {{client}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* The external client to connect with
* {{env}} *[string|">string</a>)</code>
DOM Element Id of the containing iframe
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>token</span> <code class='quiet'>(<a href="https://developer.mozilla.org/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
">string</a>)</code>
a valid bimplus accesstoken
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>client</span> <code class='quiet'>(<a href="* {{teamId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Project idObject">object</a>)</code>
The external client to connect with
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>env</span> <code class='quiet'>(<a href="Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded bim explorer
h3. getUrl
get the remote url of the Bim Portal
h4. Parameters
">string</a>)</code>
environment to use: dev, stage or prod
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Static Members</div>
<div class="clearfix">
<div class='border-bottom' id='bimexplorergeturl'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>getUrl(teamId, projectId)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>get the remote url of the Bim Portal</p>
<div class='pre p1 fill-light mt0'>getUrl(teamId: <a href="* {{teamId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Project id
* {{objectId}}Returns *[string|">string</a>, projectId: <a href="https://developer.mozilla.org/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|">string</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* message name
* {{data}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* message data
h3. sendMessage
send a message to Bim Explorer control
h4. Parameters
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>teamId</span> <code class='quiet'>(<a href="* {{message}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* message name
* {{data}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* message data
h3. getDOMElementId
get the Id of the bound iframe element
">string</a>)</code>
Team id
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>projectId</span> <code class='quiet'>(<a href="Returns *[string|https://developer.mozilla.org/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/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
">string</a>)</code>
Project id
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="* {{teamId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|https://developer.mozilla.org/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
">string</a></code>:
url to embedded bim explorer
</section>
</div>
</div>
<div class='border-bottom' id='bimexplorergeturl'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>getUrl(teamId, projectId, objectId)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>get the remote url of the Bim Portal</p>
<div class='pre p1 fill-light mt0'>getUrl(teamId: <a href="https://* {{teamId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|">string</a>, projectId: <a href="https://developer.mozilla.org/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|">string</a>, objectId: any): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Project id
h3. resetView
Reset the view
h3. centerObject
Zoom to a given object
h4. Parameters
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>teamId</span> <code class='quiet'>(<a href="* {{objectId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Object to zoom to
* {{flyTo}} *bool* Animated zoom or jump to object
h2. BimPortal
h3. Parameters
">string</a>)</code>
Team id
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>projectId</span> <code class='quiet'>(<a href="* {{domId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]*">string</a>)</code>
Project id
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>objectId</span> <code class='quiet'>(any)</code>
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href=" DOM Element Id of the containing iframe
* {{token}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* a valid bimplus accesstoken
* {{client}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* The external client to connect with
* {{env}} *[string|https://developer.mozilla.org/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/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded bim portal
h3. sendMessage
send a message to Bim Portal control
h4. Parameters
">string</a></code>:
url to embedded bim explorer
</section>
</div>
</div>
<div class='border-bottom' id='bimexplorersendmessage'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>sendMessage(message, data)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>send a message to Bim Explorer control</p>
<div class='pre p1 fill-light mt0'>sendMessage(message: <a href="https://developer.mozilla.org/docs/* {{message}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* message name
* {{data}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* message data
h3. getDOMElementId
get the Id of the bound iframe element
Returns *[string|String">string</a>, data: <a href="https://developer.mozilla.org/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
Object">object</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>message</span> <code class='quiet'>(<a href="* {{domId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* DOM Element Id of the containing iframe
* {{token}} *[string|">string</a>)</code>
message name
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>data</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* a valid bimplus accesstoken
* {{client}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* The external client to connect with
* {{env}} *[string|https://developer.mozilla.org/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
/Object">object</a>)</code>
message data
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='bimexplorersendmessage'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>sendMessage(message, data)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>send a message to Bim Explorer control</p>
<div class='pre p1 fill-light mt0'>sendMessage(message: <a href="https:* {{teamId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Project idReturns *[string|">string</a>, data: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded bim projectmanager
h3. sendMessage
send a message to Bim BimProjectNavigationBar control
h4. Parameters
Object">object</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>message</span> <code class='quiet'>(<a href="* {{message}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]*">string</a>)</code>
message name* {{data}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* message data
h3. getDOMElementId
get the Id of the bound iframe element
Returns *[string|</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>data</span> <code class='quiet'>(<a href="https://developer.mozilla.org/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
Object">object</a>)</code>
message data
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='bimexplorergetdomelementid'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>getDOMElementId()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>get the Id of the bound iframe element</p>
<div class='pre p1 fill-light mt0'>getDOMElementId(): <a href="* {{teamId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Project id
h2. BimTaskList
h3. Parameters
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="* {{domId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* DOM Element Id of the containing iframe
* {{token}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* a valid bimplus accesstoken
* {{client}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* The external client to connect with
* {{env}} *[string|">string</a></code>:
url to embedded bim portal
</section>
</div>
</div>
<div class='border-bottom' id='bimexplorergetdomelementid'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>getDOMElementId()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>get the Id of the bound iframe element</p>
<div class='pre p1 fill-light mt0'>getDOMElementId(): <a href="https:https://developer.mozilla.org/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
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code>:
url to embedded bim portal
</section>
</div>
</div>
<div class='border-bottom' id='bimexplorerload'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>load(teamId, projectId)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Load the Bim Explorer into the bound iframe, loading the passed project</p>
<div class='pre p1 fill-light mt0'>load(teamId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, projectId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>teamId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
Team id
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>projectId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
Project id
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='bimexplorerload'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>load(teamId, projectId, objectId)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Load the Bim Explorer into the bound iframe, loading the passed project</p>
<div class='pre p1 fill-light mt0'>load(teamId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, projectId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, objectId: any)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>teamId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
Team id
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>projectId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
Project id
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>objectId</span> <code class='quiet'>(any)</code>
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='bimexplorerload'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>load(teamId, projectId)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Load the Bim Explorer into the bound iframe, loading the passed project</p>
<div class='pre p1 fill-light mt0'>load(teamId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, projectId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>teamId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
Team id
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>projectId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
Project id
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='bimexplorerresetview'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>resetView()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Reset the view</p>
<div class='pre p1 fill-light mt0'>resetView()</div>
</section>
</div>
</div>
<div class='border-bottom' id='bimexplorercenterobject'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>centerObject(objectId, flyTo)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Zoom to a given object</p>
<div class='pre p1 fill-light mt0'>centerObject(objectId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, flyTo: bool)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>objectId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
Object to zoom to
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>flyTo</span> <code class='quiet'>(bool)</code>
Animated zoom or jump to object
</div>
</div>
</div>
</section>
</div>
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='bimexplorer'>
BimExplorer
</h3>
</div>
<div class='pre p1 fill-light mt0'>BimExplorer</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>domId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
DOM Element Id of the containing iframe
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>token</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
a valid bimplus accesstoken
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>client</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>)</code>
The external client to connect with
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>env</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
environment to use: dev, stage or prod
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Static Members</div>
<div class="clearfix">
<div class='border-bottom' id='bimexplorergeturl'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>getUrl(teamId, projectId)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>get the remote url of the Bim Portal</p>
<div class='pre p1 fill-light mt0'>getUrl(teamId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, projectId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>teamId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
Team id
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>projectId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
Project id
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code>:
url to embedded bim explorer
</section>
</div>
</div>
<div class='border-bottom' id='bimexplorergeturl'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>getUrl(teamId, projectId, objectId)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>get the remote url of the Bim Portal</p>
<div class='pre p1 fill-light mt0'>getUrl(teamId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, projectId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, objectId: any): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>teamId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
Team id
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>projectId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
Project id
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>objectId</span> <code class='quiet'>(any)</code>
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code>:
url to embedded bim explorer
</section>
</div>
</div>
<div class='border-bottom' id='bimexplorersendmessage'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>sendMessage(message, data)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>send a message to Bim Explorer control</p>
<div class='pre p1 fill-light mt0'>sendMessage(message: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, data: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>message</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
message name
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>data</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>)</code>
message data
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='bimexplorersendmessage'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>sendMessage(message, data)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>send a message to Bim Explorer control</p>
<div class='pre p1 fill-light mt0'>sendMessage(message: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, data: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>message</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
message name
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>data</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>)</code>
message data
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='bimexplorergetdomelementid'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>getDOMElementId()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>get the Id of the bound iframe element</p>
<div class='pre p1 fill-light mt0'>getDOMElementId(): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code>:
url to embedded bim portal
</section>
</div>
</div>
<div class='border-bottom' id='bimexplorergetdomelementid'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>getDOMElementId()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>get the Id of the bound iframe element</p>
<div class='pre p1 fill-light mt0'>getDOMElementId(): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code>:
url to embedded bim portal
</section>
</div>
</div>
<div class='border-bottom' id='bimexplorerload'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>load(teamId, projectId)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Load the Bim Explorer into the bound iframe, loading the passed project</p>
<div class='pre p1 fill-light mt0'>load(teamId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, projectId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>teamId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
Team id
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>projectId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
Project id
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='bimexplorerload'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>load(teamId, projectId, objectId)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Load the Bim Explorer into the bound iframe, loading the passed project</p>
<div class='pre p1 fill-light mt0'>load(teamId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, projectId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, objectId: any)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>teamId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
Team id
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>projectId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
Project id
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>objectId</span> <code class='quiet'>(any)</code>
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='bimexplorerload'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>load(teamId, projectId)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Load the Bim Explorer into the bound iframe, loading the passed project</p>
<div class='pre p1 fill-light mt0'>load(teamId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, projectId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>teamId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
Team id
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>projectId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
Project id
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='bimexplorerresetview'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>resetView()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Reset the view</p>
<div class='pre p1 fill-light mt0'>resetView()</div>
</section>
</div>
</div>
<div class='border-bottom' id='bimexplorercenterobject'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>centerObject(objectId, flyTo)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Zoom to a given object</p>
<div class='pre p1 fill-light mt0'>centerObject(objectId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, flyTo: bool)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>objectId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
Object to zoom to
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>flyTo</span> <code class='quiet'>(bool)</code>
Animated zoom or jump to object
</div>
</div>
</div>
</section>
</div>
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='bimportal'>
BimPortal
</h3>
</div>
<div class='pre p1 fill-light mt0'>BimPortal</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>domId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
DOM Element Id of the containing iframe
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>token</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
a valid bimplus accesstoken
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>client</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>)</code>
The external client to connect with
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>env</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
environment to use: dev, stage or prod
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Static Members</div>
<div class="clearfix">
<div class='border-bottom' id='bimportalgeturl'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>getUrl()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>get the remote url of the Bim Portal</p>
<div class='pre p1 fill-light mt0'>getUrl(): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code>:
url to embedded bim portal
</section>
</div>
</div>
<div class='border-bottom' id='bimportalsendmessage'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>sendMessage(message, data)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>send a message to Bim Portal control</p>
<div class='pre p1 fill-light mt0'>sendMessage(message: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, data: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>message</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
message name
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>data</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>)</code>
message data
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='bimportalgetdomelementid'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>getDOMElementId()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>get the Id of the bound iframe element</p>
<div class='pre p1 fill-light mt0'>getDOMElementId(): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code>:
url to embedded bim portal
</section>
</div>
</div>
<div class='border-bottom' id='bimportalload'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>load()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Load the Bim Portal into the bound iframe</p>
<div class='pre p1 fill-light mt0'>load()</div>
</section>
</div>
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='bimprojectnavigationbar'>
BimProjectNavigationBar
</h3>
</div>
<div class='pre p1 fill-light mt0'>BimProjectNavigationBar</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>domId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
DOM Element Id of the containing iframe
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>token</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
a valid bimplus accesstoken
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>client</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>)</code>
The external client to connect with
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>env</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
environment to use: dev, stage or prod
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Static Members</div>
<div class="clearfix">
<div class='border-bottom' id='bimprojectnavigationbargeturl'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>getUrl(teamId, projectId)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>get the remote url of the Bim ProjrctManager</p>
<div class='pre p1 fill-light mt0'>getUrl(teamId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, projectId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>teamId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
Team id
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>projectId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
Project id
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code>:
url to embedded bim projectmanager
</section>
</div>
</div>
<div class='border-bottom' id='bimprojectnavigationbarsendmessage'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>sendMessage(message, data)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>send a message to Bim BimProjectNavigationBar control</p>
<div class='pre p1 fill-light mt0'>sendMessage(message: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, data: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>message</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
message name
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>data</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>)</code>
message data
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='bimprojectnavigationbargetdomelementid'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>getDOMElementId()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>get the Id of the bound iframe element</p>
<div class='pre p1 fill-light mt0'>getDOMElementId(): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code>:
url to embedded bim portal
</section>
</div>
</div>
<div class='border-bottom' id='bimprojectnavigationbarload'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>load(teamId, projectId)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Load the Bim BimProjectNavigationBar into the bound iframe, loading the passed project</p>
<div class='pre p1 fill-light mt0'>load(teamId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, projectId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>teamId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
Team id
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>projectId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
Project id
</div>
</div>
</div>
</section>
</div>
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='bimtasklist'>
BimTaskList
</h3>
</div>
<div class='pre p1 fill-light mt0'>BimTaskList</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>domId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
DOM Element Id of the containing iframe
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>token</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
a valid bimplus accesstoken
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>client</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>)</code>
The external client to connect with
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>env</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
environment to use: dev, stage or prod
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Static Members</div>
<div class="clearfix">
<div class='border-bottom' id='bimtasklistgeturl'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>getUrl(teamId, projectId)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>get the remote url of the task list control</p>
<div class='pre p1 fill-light mt0'>getUrl(teamId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, projectId: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>teamId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
Team id
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>projectId</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
Project id
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code>:
url to embedded task list
</section>
</div>
</div>
<div class='border-bottom' id='bimtasklistsendmessage'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>sendMessage(message, data)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>send a message to Bim Portal control</p>
<div class='pre p1 fill-light mt0'>sendMessage(message: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, data: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>message</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
message name
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>data</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>)</code>
message data
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='bimtasklistgetdomelementid'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>getDOMElementId()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>get the Id of the bound iframe element</p>
<div class='pre p1 fill-light mt0'>getDOMElementId(): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code>:
url to embedded bim portal
</section>
</div>
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='externalclient'>
ExternalClient
</h3>
</div>
<div class='pre p1 fill-light mt0'>ExternalClient</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>clientName</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
client id
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Static Members</div>
<div class="clearfix">
<div class='border-bottom' id='externalclientinitialize'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>initialize()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>initialize and start listening to incomming messages</p>
<div class='pre p1 fill-light mt0'>initialize()</div>
</section>
</div>
</div>
<div class='border-bottom' id='externalclientaddmessagehandler'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>addMessageHandler(message, handler)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>add a message handler</p>
<div class='pre p1 fill-light mt0'>addMessageHandler(message: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, handler: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function">function</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>message</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
message id
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>handler</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function">function</a>)</code>
handler function
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='externalclientremovemessagehandler'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>removeMessageHandler(message)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>remove a message handler</p>
<div class='pre p1 fill-light mt0'>removeMessageHandler(message: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>message</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
message id
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='externalclientmessagereceived'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>messageReceived(message)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Handle a received messages</p>
<div class='pre p1 fill-light mt0'>messageReceived(message: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>message</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>)</code>
message object
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='externalclientsendmessage'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>sendMessage(elemId, message, data)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Send a message to bimplus web application</p>
<div class='pre p1 fill-light mt0'>sendMessage(elemId: <a href="* {{teamId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Team id
* {{projectId}} *[string|">string</a>, message: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Project idReturns *[string|">string</a>, data: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded task list
h3. sendMessage
send a message to Bim Portal control
h4. Parameters
/Object">object</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>elemId</span> <code class='quiet'>(<a href="* {{message}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* message name
* {{data}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* message data
h3. getDOMElementId
get the Id of the bound iframe element
">string</a>)</code>
DOM Element Id of the containing iframe
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>message</span> <code class='quiet'>(<a href="Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* url to embedded bim portal
h2. ExternalClient
h3. Parameters
* {{clientName}} *[string|https://developer.mozilla.org/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
">string</a>)</code>
Message name
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>data</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>)</code>
message data
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='externalclientgetclientname'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>getClientName()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>get the client id</p>
<div class='pre p1 fill-light mt0'>getClientName(): <a href="* {{message}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* message id
* {{handler}} *[function|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function]* handler function
h3. removeMessageHandler
remove a message handler
h4. Parameters
Global_Objects/String">string</a></div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="* {{message}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* message id
h3. messageReceived
Handle a received messages
h4. Parameters
* {{message}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* message object
h3. sendMessage
Send a message to bimplus web application
h4. Parameters
">string</a></code>:
connected client id
</section>
</div>
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='geturlparameter'>
getUrlParameter
</h3>
</div>
<p>get the current page url parameter</p>
<div class='pre p1 fill-light mt0'>getUrlParameter(sParam: <a href="* {{elemId}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* DOM Element Id of the containing iframe
* {{message}} *[string|">string</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Message name
* {{data}} *[object|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object]* message data
h3. getClientName
get the client id
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>sParam</span> <code class='quiet'>(<a href="Returns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* connected client id
h2. getUrlParameter
get the current page url parameter
h3. Parameters
">string</a>)</code>
Paramter name
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="* {{sParam}} *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Paramter nameReturns *[string|https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String]* Paramter value">string</a></code>:
Paramter value
</section>
</div>
</div>
<script src='assets/anchor.js'></script>
<script src='assets/split.js'></script>
<script src='assets/site.js'></script>
</body>
</html>