Class BimCTDesignTreeWindow

Class representing the design tree window in the BIM application. Extends the BimCTVirtualScrollWindow class.

Hierarchy (View Summary)

BimCTVirtualScrollWindow
- BimCTDesignTreeWindow

Constructors

constructor

new BimCTDesignTreeWindow(
renderer: BaseRenderer,
rendererElement: HTMLDivElement,
): BimCTDesignTreeWindow
Constructor for BimCTDesignTreeWindow.
Parameters
- renderer: BaseRenderer
  The renderer instance.
- rendererElement: HTMLDivElement
  The HTML element for the renderer.
Returns BimCTDesignTreeWindow
Overrides BimCTVirtualScrollWindow.constructor
- Defined in gui/bimct-design-tree.ts:35

Accessors

windowResizedEvent

get windowResizedEvent(): IEvent<number, number>
Returns IEvent<number, number>
Inherited from BimCTVirtualScrollWindow.windowResizedEvent
- Defined in gui/bimct-window.ts:290

windowStateChangedEvent

get windowStateChangedEvent(): IEvent<BaseRenderer, BimCTWindow>
Returns IEvent<BaseRenderer, BimCTWindow>
Inherited from BimCTVirtualScrollWindow.windowStateChangedEvent
- Defined in gui/bimct-window.ts:294

windowElement

get windowElement(): HTMLElement
Returns HTMLElement
Inherited from BimCTVirtualScrollWindow.windowElement
- Defined in gui/bimct-window.ts:298

index

get index(): number
Returns number
Inherited from BimCTVirtualScrollWindow.index
- Defined in gui/bimct-window.ts:306
set index(index: number): void
Parameters
- index: number
Returns void
Inherited from BimCTVirtualScrollWindow.index
- Defined in gui/bimct-window.ts:310

leafRowHeight

get leafRowHeight(): number
Returns number
Inherited from BimCTVirtualScrollWindow.leafRowHeight
- Defined in gui/bimct-window.ts:314

zIndex

get zIndex(): number
Returns number
Inherited from BimCTVirtualScrollWindow.zIndex
- Defined in gui/bimct-window.ts:318
set zIndex(zIndex: number): void
Parameters
- zIndex: number
Returns void
Inherited from BimCTVirtualScrollWindow.zIndex
- Defined in gui/bimct-window.ts:322

active

get active(): boolean
Returns boolean
Inherited from BimCTVirtualScrollWindow.active
- Defined in gui/bimct-window.ts:326
set active(active: boolean): void
Parameters
- active: boolean
Returns void
Inherited from BimCTVirtualScrollWindow.active
- Defined in gui/bimct-window.ts:330

resetWindowStyle

get resetWindowStyle(): string
Returns string
Inherited from BimCTVirtualScrollWindow.resetWindowStyle
- Defined in gui/bimct-window.ts:334
set resetWindowStyle(val: string): void
Parameters
- val: string
Returns void
Inherited from BimCTVirtualScrollWindow.resetWindowStyle
- Defined in gui/bimct-window.ts:338

title

get title(): string
Returns string
Inherited from BimCTVirtualScrollWindow.title
- Defined in gui/bimct-window.ts:568
set title(title: string): void
Parameters
- title: string
Returns void
Inherited from BimCTVirtualScrollWindow.title
- Defined in gui/bimct-window.ts:572

footerText

get footerText(): string
Returns string
Inherited from BimCTVirtualScrollWindow.footerText
- Defined in gui/bimct-window.ts:579
set footerText(footerText: string): void
Parameters
- footerText: string
Returns void
Inherited from BimCTVirtualScrollWindow.footerText
- Defined in gui/bimct-window.ts:583

renderer

get renderer(): BaseRenderer
Gets the renderer associated with the window.

Returns BaseRenderer
The renderer.
Inherited from BimCTVirtualScrollWindow.renderer
- Defined in gui/bimct-window.ts:1273

Methods

hideExpandToLevel

hideExpandToLevel(): void
Hides the expand-to-level menu.

Returns void
- Defined in gui/bimct-design-tree.ts:407

scrollBodyElement

scrollBodyElement(): HTMLDivElement
Gets the scrollable body element.

Returns HTMLDivElement
- The scrollable body element.
Overrides BimCTVirtualScrollWindow.scrollBodyElement
- Defined in gui/bimct-design-tree.ts:593

zoomToSelected

zoomToSelected(): Promise<boolean>
Zooms to the selected items in the tree.

Returns Promise<boolean>
- True if zoom was successful, false otherwise.
- Defined in gui/bimct-design-tree.ts:835

getSelectedItemsInternalIds

getSelectedItemsInternalIds(): Int64[]
Gets the internal IDs of the selected items.

Returns Int64[]
- The internal IDs of the selected items.
- Defined in gui/bimct-design-tree.ts:870

getSelectedElementNodes

getSelectedElementNodes(
includeModelNode?: boolean,
): BimCTExpandableLevelVirtualRow[]
Gets the selected element nodes.
Parameters
- includeModelNode: boolean = true
  Whether to include model nodes in the selection.
Returns BimCTExpandableLevelVirtualRow[]
- The selected element nodes.
- Defined in gui/bimct-design-tree.ts:893

getSelectedItemsElementIds

getSelectedItemsElementIds(): Int64[]
Gets the element IDs of the selected items.

Returns Int64[]
- The element IDs of the selected items.
- Defined in gui/bimct-design-tree.ts:910

show

show(): boolean
Shows the design tree window.

Returns boolean
- True if the window was shown, false otherwise.
Overrides BimCTVirtualScrollWindow.show
- Defined in gui/bimct-design-tree.ts:930

showDialog

showDialog(expandToLevel2: boolean): boolean
Shows the design tree window with an option to expand to level 2.
Parameters
- expandToLevel2: boolean
  Whether to expand to level 2.
Returns boolean
- True if the window was shown, false otherwise.
- Defined in gui/bimct-design-tree.ts:939

hide

hide(): boolean
Hides the design tree window.

Returns boolean
- True if the window was hidden, false otherwise.
Overrides BimCTVirtualScrollWindow.hide
- Defined in gui/bimct-design-tree.ts:1056

isShowingOnViewport

isShowingOnViewport(row: BimCTVirtualRow, offset: number): boolean
Checks if a row is showing in the viewport.
Parameters
- row: BimCTVirtualRow
  The row to check.
- offset: number
  The offset to apply.
Returns boolean
True if the row is showing, false otherwise.
Inherited from BimCTVirtualScrollWindow.isShowingOnViewport
- Defined in gui/bimct-virtual-scroll-window.ts:260

scrollToRowIndex

scrollToRowIndex(rowIndex: number, forceScroll?: boolean): void
Scrolls to the specified row index.
Parameters
- rowIndex: number
  The row index to scroll to.
- forceScroll: boolean = false
  Whether to force the scroll.
Returns void
Inherited from BimCTVirtualScrollWindow.scrollToRowIndex
- Defined in gui/bimct-virtual-scroll-window.ts:283

scrollToRow

scrollToRow(row: BimCTVirtualRow, forceScroll?: boolean): void
Scrolls to the specified row.
Parameters
- row: BimCTVirtualRow
  The row to scroll to.
- forceScroll: boolean = false
  Whether to force the scroll.
Returns void
Inherited from BimCTVirtualScrollWindow.scrollToRow
- Defined in gui/bimct-virtual-scroll-window.ts:296

activateWindow

activateWindow(activate: boolean, refresh?: boolean): void
Activates or deactivates the window.
Parameters
- activate: boolean
  Whether to activate the window.
- Optionalrefresh: boolean = true
  Whether to refresh the UI.
Returns void
Inherited from BimCTVirtualScrollWindow.activateWindow
- Defined in gui/bimct-window.ts:347

setWindowLoading

setWindowLoading(on: boolean): void
Sets the loading state of the window.
Parameters
- on: boolean
  Whether to show the loading state.
Returns void
Inherited from BimCTVirtualScrollWindow.setWindowLoading
- Defined in gui/bimct-window.ts:506

restoreWindow

restoreWindow(): void
Restores the window to its original size and position.

Returns void
Inherited from BimCTVirtualScrollWindow.restoreWindow
- Defined in gui/bimct-window.ts:1047

maximizeWindow

maximizeWindow(): void
Maximizes the window to fill the screen.

Returns void
Inherited from BimCTVirtualScrollWindow.maximizeWindow
- Defined in gui/bimct-window.ts:1080

isShowing

isShowing(): boolean
Checks if the window is currently showing.

Returns boolean
True if the window is showing, otherwise false.
Inherited from BimCTVirtualScrollWindow.isShowing
- Defined in gui/bimct-window.ts:1101

resetToDefault

resetToDefault(force: boolean): void
Resets the window to its default style.
Parameters
- force: boolean
  Whether to force the reset.
Returns void
Inherited from BimCTVirtualScrollWindow.resetToDefault
- Defined in gui/bimct-window.ts:1109

moveHorizontally

moveHorizontally(pixels: number): void
Moves the window horizontally by a specified number of pixels. Only if already moved one time
Parameters
- pixels: number
  The number of pixels to move the window.
Returns void
Inherited from BimCTVirtualScrollWindow.moveHorizontally
- Defined in gui/bimct-window.ts:1133

refreshUI

refreshUI(): void
Refreshes the UI of the window.

Returns void
Inherited from BimCTVirtualScrollWindow.refreshUI
- Defined in gui/bimct-window.ts:1236