Versions Compared

Key

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

...

Web SDK Reference

...

...

Deck of Cards
idsdk3DModel
Card
defaulttrue
labelUI Control
titleInterface for rendering & displaying a 3D model of any size
 
Card
labelController & Methods
titleThe modules to be loaded for using this interface

Controller: viewport3d, viewport3dController

Methods: No public methods

Info

Please note that viewport3dController acts like a proxy to the viewport3d and hence all the public methods are available under viewport3d.

Card
labelTemplate & View
titleThe template that has to be loaded

Template: main.hbs

View: viewport3dView

Anchor
attachments
attachments

Attachments

...

 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

Comments

...

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


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

Controller: commentController, commentsListController

Methods: No public methods

Card
labelTemplate & View
titleThe template that has to be loaded

Template: commentsList.hbs

View: commentsListView

...

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

Issues

...

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

Spots / Pins

 

...

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. 

...