Class LibraryTreeViewDataElement

Simple class representing a single Tree Element from the Library Tree View UI element.

Hierarchy (view full)

TreeViewDataElement
- LibraryTreeViewDataElement

Constructors

constructor

new LibraryTreeViewDataElement(libraryPathOrReference, displayName): LibraryTreeViewDataElement
Constructor for creating a Library Tree View element with the given library path and display name.
Parameters
- libraryPathOrReference: LibraryIdentifierPath | CatalogProjectReference
- displayName: string
  The name to be displayed in the tree element.
Returns LibraryTreeViewDataElement
Overrides TreeViewDataElement.constructor

Properties

`Readonly`libraryPath

libraryPath: LibraryIdentifierPath

The Library Path representing this tree element.

`Readonly`projectReference

projectReference: CatalogProjectReference

`Static` `Readonly`iconSize

iconSize = 16

The default icon size.

Accessors

childCount

get childCount(): number
Checks is the provided element part of the parent hierarchy of this element.

Returns number
Inherited from TreeViewDataElement.childCount

doubleClickBehavior

get doubleClickBehavior(): EnumValue<TreeViewElementDoubleClickBehavior, number>
Returns EnumValue<TreeViewElementDoubleClickBehavior, number>
Inherited from TreeViewDataElement.doubleClickBehavior
set doubleClickBehavior(value): void
Parameters
- value: EnumValue<TreeViewElementDoubleClickBehavior, number>
Returns void
Inherited from TreeViewDataElement.doubleClickBehavior

height

get height(): number
Sets the optional height for the element, if not set, the tree element uses the element height of the tree.

Returns number
Inherited from TreeViewDataElement.height
set height(value): void
Parameters
- value: number
Returns void
Inherited from TreeViewDataElement.height

iconImage

get iconImage(): Image
The current icon image.

Returns Image
Inherited from TreeViewDataElement.iconImage
set iconImage(value): void
The current icon image.
Parameters
- value: Image
Returns void
Inherited from TreeViewDataElement.iconImage

iconImageHandle

get iconImageHandle(): ResourceHandle<Image>
The current icon image.

Returns ResourceHandle<Image>
Inherited from TreeViewDataElement.iconImageHandle
set iconImageHandle(value): void
Parameters
- value: Image | ResourceHandle<Image>
Returns void
Inherited from TreeViewDataElement.iconImageHandle

id

get id(): UUID
The ID of the element, useful to correlate the tree element to the object it represents.

Returns UUID
Inherited from TreeViewDataElement.id
set id(value): void
Parameters
- value: UUID
Returns void
Inherited from TreeViewDataElement.id

isDisabled

get isDisabled(): boolean
Determines if the element is currently Disabled.

Returns boolean
Inherited from TreeViewDataElement.isDisabled
set isDisabled(value): void
Parameters
- value: boolean
Returns void
Inherited from TreeViewDataElement.isDisabled

isEditable

get isEditable(): boolean
Determines if the element is currently Editable.

Returns boolean
Inherited from TreeViewDataElement.isEditable
set isEditable(value): void
Parameters
- value: boolean
Returns void
Inherited from TreeViewDataElement.isEditable

isExpandable

get isExpandable(): boolean
Determines if the element is currently Expandable.

Returns boolean
Inherited from TreeViewDataElement.isExpandable
set isExpandable(value): void
Parameters
- value: boolean
Returns void
Inherited from TreeViewDataElement.isExpandable

isExpanded

get isExpanded(): boolean
Determines if the element is currently Expanded.

Returns boolean
Inherited from TreeViewDataElement.isExpanded

isHighlighted

get isHighlighted(): boolean
Determines if the element is currently Highlighted.

Returns boolean
Inherited from TreeViewDataElement.isHighlighted
set isHighlighted(value): void
Parameters
- value: boolean
Returns void
Inherited from TreeViewDataElement.isHighlighted

isProjectReference

get isProjectReference(): boolean
Determines if the entry is a project reference.

Returns boolean

isProjectReferenceRoot

get isProjectReferenceRoot(): boolean
Determines if the entry is a project reference root.

Returns boolean

isSelected

get isSelected(): boolean
Determines if the element is currently Selected.

Returns boolean
Inherited from TreeViewDataElement.isSelected

isVisible

get isVisible(): boolean
Determines if the element is currently visible.

Returns boolean
Inherited from TreeViewDataElement.isVisible
set isVisible(value): void
Parameters
- value: boolean
Returns void
Inherited from TreeViewDataElement.isVisible

name

get name(): string
The current name.

Returns string
Inherited from TreeViewDataElement.name
set name(value): void
Parameters
- value: string
Returns void
Inherited from TreeViewDataElement.name

parent

get parent(): TreeViewDataElement
The parent item.

Returns TreeViewDataElement
Inherited from TreeViewDataElement.parent

tintColor

get tintColor(): Immutable<Color>
The current tint color.

Returns Immutable<Color>
Inherited from TreeViewDataElement.tintColor
set tintColor(value): void
Parameters
- value: Immutable<Color>
Returns void
Inherited from TreeViewDataElement.tintColor

visualElement

get visualElement(): TreeViewVisualElement
Gets the visual element if the data element is currently visible on screen.

Returns TreeViewVisualElement
Note
Not all data element have a visual representation. If the element is currently scrolled out of view, it is possible that it has no visual element representation.

Inherited from TreeViewDataElement.visualElement

Methods

addChild

addChild(element): boolean
Adds the element.
Parameters
- element: TreeViewDataElement
Returns boolean
Inherited from TreeViewDataElement.addChild

checkIsParent

checkIsParent(element): boolean
Checks is the provided element part of the parent hierarchy of this element.
Parameters
- element: TreeViewDataElement
Returns boolean
Inherited from TreeViewDataElement.checkIsParent

getChildAtIndex

getChildAtIndex(index): TreeViewDataElement
Gets the element at the specified index.
Parameters
- index: number
Returns TreeViewDataElement
Inherited from TreeViewDataElement.getChildAtIndex

getIndexOfChild

getIndexOfChild(element): number
Gets the index for the element or no value if the element is not a child of this instance.
Parameters
- element: TreeViewDataElement
Returns number
Inherited from TreeViewDataElement.getIndexOfChild

insertChildAtIndex

insertChildAtIndex(element, index): boolean
Adds the element at the specified index.
Parameters
- element: TreeViewDataElement
- index: number
Returns boolean
Inherited from TreeViewDataElement.insertChildAtIndex

removeChild

removeChild(element): TreeViewDataElement
Removes the element and returns the removed element, or null if the element was not removed.
Parameters
- element: TreeViewDataElement
Returns TreeViewDataElement
Inherited from TreeViewDataElement.removeChild

removeChildAtIndex

removeChildAtIndex(index): TreeViewDataElement
Removes the element at the specified index and returns the removed element.
Parameters
- index: number
Returns TreeViewDataElement
Inherited from TreeViewDataElement.removeChildAtIndex