Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

 

Info

This page is under construction

...

Web SDK Reference

...

Anchor
3dModelRenderer
3dModelRenderer

...

Anchor
attachments
attachments

...

Attachment

This control is used for uploading & displaying the attachments (attachment control is already included for objects, issues & slideshows)

...

Deck of Cards
idsdkAttachmentsList
Card
defaulttrue
labelUI Control
titleInterface to create,update,delete & display the list of attachments
 
Card
labelController & Methods
titleThe modules to be loaded for using this interface

Controller: attachmentsListController

Methods: No public methods

Card
labelTemplate & View
titleThe template that has to be loaded

Template: attachmentList.hbs

View: attachmentsListView

 

...

Anchor
comments
comments

...

Comment

This control is used for working with the comments (comments control is already included for objects, issues & slideshows)

...

Anchor
hyperlinks
hyperlinks

...

This control is used for working with the hyperlinks (hyperlinks control is already included for objects, issues & slideshows)

...

Deck of Cards
idsdkHyperlinksList
Card
defaulttrue
labelUI Control
titleInterface to create,update,delete & display the list of hyperlinks
 
Card
labelController & Methods
titleThe modules to be loaded for using this interface

Controller: hyperlinksListController

Methods: No public methods

Card
labelTemplate & View
titleThe template that has to be loaded

Template: hyperlinksList.hbs

View: hyperlinksListView

 

...

Anchor
issues
issues

...

Issue

This control is used for working with issues inside a project. Please use Pins/Spot control for visualizing spots/pins(could be a problem) related to an issue (if the issue includes geometrical information)

...

Deck of Cards
idsdkIssues
Card
defaulttrue
labelUI Control
titleInterface to update,delete & display a particular issue details and its related components(pins, attachments, hyperlinks & comments)
 
Card
labelController & Methods
titleThe modules to be loaded for using this interface

Controller: issueController

Methods: No public methods

Card
labelTemplate & View
titleThe template that has to be loaded

Template: issue.hbs

View: issueView

 

...

Anchor
issueList
issueList

Issue List

This control is used for displaying a list of issues inside a project.

...

Deck of Cards
idsdkIssueList
Card
defaulttrue
labelUI Control
titleInterface to display a list of project related issues
 
Card
labelController & Methods
titleThe modules to be loaded for using this interface

Controller: issuesListController

Methods: No public methods

Card
labelTemplate & View
titleThe template that has to be loaded

Template: issuesList.hbs

View: issuesListView

 

...

Anchor
objectProperties
objectProperties

Object Properties 

This control is used for displaying object's properties. It includes comments, attachments & hyperlinks controls.

...

Deck of Cards
idsdkObjects
Card
defaulttrue
labelUI Control
titleInterface for displaying object's properties

 

Please note that the selected objects can also be previewed(visualized) using the viewport3d, viewport3dController and its related templates.

Card
labelController & Methods
titleThe modules to be loaded for using this interface

Controller: object3dController

Methods: No public methods

Card
labelTemplate & View
titleThe template that has to be loaded

Template: object3d.hbs

View: object3dView

 

...

Anchor
spots
spots

...

Spot /

...

Pin

This control is used for visualizing spots/pins(could be a problem) related to an issue (if the issue includes geometrical information)

...

Deck of Cards
idsdkPins
Card
defaulttrue
labelUI Control
titleInterface for working with pins related to an issue

 

Please note that for visualizing the spots/pins, you have to use viewport3d, viewport3dController and its related templates.

Card
labelController & Methods
titleThe modules to be loaded for using this interface

Controller: pinsListController

Methods: No public methods

Card
labelTemplate & View
titleThe template that has to be loaded

Template: pinsList.hbs

View: pinsListView

 

...

Anchor
projects
projects

Projects

This control is used for displaying project information. A project consists of one or more models and each model contains one or more disciplines/layers in it. Each model & discipline could be switched on/off and the transparency of the disciplines could also be switched on/off. 

...

Deck of Cards
idsdkProject
Card
defaulttrue
labelUI Control
titleInterface for displaying project information

Card
labelController & Methods
titleThe modules to be loaded for using this interface

Controller: projectController

Methods: No public methods

Card
labelTemplate & View
titleThe template that has to be loaded

Template: project.hbs, project-details.hbs, mod-layers.hbs(For setting layer transparency & visibility)

View: projectView

 

...

Anchor
projectList
projectList

Project List

This control is used for displaying a list of projects inside a team.

...

Deck of Cards
idsdkProjectList
Card
defaulttrue
labelUI Control
titleInterface for displaying list of projects

Card
labelController & Methods
titleThe modules to be loaded for using this interface

Controller: projectListController

Methods: No public methods

Card
labelTemplate & View
titleThe template that has to be loaded

Template: projectList.hbs

View: projectlistView

...

 

...

Anchor
slideshow
slideshow

Slideshow

This control is used for working with a particular slideshow inside a project.

...

Deck of Cards
idsdkSlideshow
Card
defaulttrue
labelUI Control
titleInterface to update,delete & display a particular slideshow details

Card
labelController & Methods
titleThe modules to be loaded for using this interface

Controller: slideshowController

Methods: No public methods

Card
labelTemplate & View
titleThe template that has to be loaded

Template: slideshow.hbs

View: slideshowView

 

...

Anchor
slideshowList
slideshowList

Slideshow List

This control is used for displaying a list of slideshows inside a project.

...

Deck of Cards
idsdkSlideshowList
Card
defaulttrue
labelUI Control
titleInterface for displaying a list of slideshows

Card
labelController & Methods
titleThe modules to be loaded for using this interface

Controller: slideshowListController

Methods: No public methods

Card
labelTemplate & View
titleThe template that has to be loaded

Template: slideshowsList.hbs

View: slideshowsListView

...

 

...

Anchor
slide
slide

Slide

This control is used for working with a particular slide belonging to a slideshow.

...

Deck of Cards
idsdkSlides
Card
defaulttrue
labelUI Control
titleInterface to update,delete & display a particular slide details

Card
labelController & Methods
titleThe modules to be loaded for using this interface

Controller: slideController

Methods: No public methods

Card
labelTemplate & View
titleThe template that has to be loaded

Template: slide.hbs

View: slideView

 

...

Anchor
slideList
slideList

Slide List

This control is used for displaying a list of slides belonging to a slideshow.

...

Deck of Cards
idsdkSlideList
Card
defaulttrue
labelUI Control
titleInterface for displaying a list of slides

Card
labelController & Methods
titleThe modules to be loaded for using this interface

Controller: slidesListController

Methods: No public methods

Card
labelTemplate & View
titleThe template that has to be loaded

Template: slidesList.hbs

View: slidesListView

 

...

Anchor
teams
teams

Teams

This control is used for displaying the list of teams.

...

Deck of Cards
idsdkTeams
Card
defaulttrue
labelUI Control
titleInterface for displaying the list of teams

Card
labelController & Methods
titleThe modules to be loaded for using this interface

Controller: teamsController

Methods: No public methods

Card
labelTemplate & View
titleThe template that has to be loaded

Template: teams.hbs

View: teamsView

 

...

Anchor
topology
topology

Topology

This control is used for displaying the topology structure of a model.

...

Deck of Cards
idsdkTopology
Card
defaulttrue
labelUI Control
titleInterface for displaying the topology structure of a model

Card
labelController & Methods
titleThe modules to be loaded for using this interface

Controller: topologyController

Methods:

toggleNodeVisibility(Object): Toggles the visibility of the specified node object and its child elements.

Card
labelTemplate & View
titleThe template that has to be loaded

Template: topology.hbs

View: topologyView

 

...

Anchor
user
user

User

This control is used for displaying user information & his application settings (context menus)

...