@xeokit/xeokit-sdk
Version:
3D BIM IFC Viewer SDK for AEC engineering applications. Open Source JavaScript Toolkit based on pure WebGL for top performance, real-world coordinates and full double precision
102 lines (89 loc) • 1.85 kB
JavaScript
/**
* @desc A node within a {@link TreeViewPlugin}.
*
* These are provided by {@link TreeViewPlugin#withNodeTree} and the
* [contextmenu](https://developer.mozilla.org/en-US/docs/Web/API/Element/contextmenu_event) event fired by
* TreeViewPlugin whenever we right-click on a tree node.
*
* @interface
* @abstract
*/
class TreeViewNode {
/**
* Globally unique node ID.
*
* @type {String}
* @abstract
*/
get nodeId() {
}
/**
* Title of the TreeViewNode.
*
* @type {String}
* @abstract
*/
get title() {
}
/** Type of the corresponding {@link MetaObject}.
*
* @type {String}
* @abstract
*/
get type() {
}
/**
* ID of the corresponding {@link MetaObject}.
*
* This is only defined if the TreeViewNode represents an object.
*
* @type {String}
* @abstract
*/
get objectId() {
}
/**
* The child TreeViewNodes.
*
* @type {Array}
* @abstract
*/
get children() {
}
/** The parent TreeViewNode.
*
* @type {TreeViewNode}
* @abstract
*/
get parent() {
}
/** The number of {@link Entity}s within the subtree of this TreeViewNode.
*
* @type {Number}
* @abstract
*/
get numEntities() {
}
/** The number of {@link Entity}s that are currently visible within the subtree of this TreeViewNode.
*
* @type {Number}
* @abstract
*/
get numVisibleEntities() {
}
/** Whether or not the TreeViewNode is currently checked.
*
* @type {Boolean}
* @abstract
*/
get checked() {
}
/** Whether or not the TreeViewNode is currently xrayed.
*
* @type {Boolean}
* @abstract
*/
get xrayed() {
}
}
export {TreeViewNode};