HoopsSheetListElement

class wvc.HoopsSheetListElement()

Displays a flat list of drawing sheets from the model. Clicking a sheet node fires an event that consumers can use to activate the corresponding sheet.

Examples

<hoops-sheet-list></hoops-sheet-list>

<script>
  const el = document.getElementsByTagName('hoops-sheet-list')[0];
  el.model = modelInstance;
  el.addEventListener('hoops-sheet-list-node-click', (e) => console.log(e.detail));
</script>

Custom Element

hoops-sheet-list

Events

hoops-sheet-list-node-click

Emitted when a sheet node is clicked

Since

2026.3.0

Index

Constructors

Accessors

Methods

Constructors

wvc.HoopsSheetListElement.constructor()
HoopsSheetListElement(): HoopsSheetListElement

Returns: HoopsSheetListElement

Accessors

wvc.HoopsSheetListElement.listElement()
get listElement(): (undefined | List)

Gets the internal list component element.

Returns: (undefined | List)

The list element instance or undefined if not initialised
wvc.HoopsSheetListElement.model()
get model(): (undefined | IModel)

Convenience accessor for the model on the underlying adapter.

Returns: (undefined | IModel)

The current model instance or undefined
set model(model: (undefined | IModel)): void

Sets the model instance for sheet data. Setting a new model refreshes the list.

Parameters

model: (undefined | IModel)

The model instance to set

Returns: void

Throws

When setting model before adapter initialisation

wvc.HoopsSheetListElement.selected()
get selected(): number[]

Gets the currently selected sheet nodes.

Returns: number[]

Array of selected node IDs
set selected(value: number[]): void

Sets the currently selected sheet nodes.

Parameters

value: number[]

Array of node IDs to select

Returns: void

Throws

When setting selected nodes before list initialisation

wvc.HoopsSheetListElement.sheetAdapter()
get sheetAdapter(): (undefined | SheetAdapter)

Gets the sheet adapter managing list data.

Returns: (undefined | SheetAdapter)

The current sheet adapter or undefined
set sheetAdapter(value: SheetAdapter): void

Sets the sheet adapter managing list data. Populates elementsData from the adapter’s model before assigning.

Parameters

value: SheetAdapter

The sheet adapter to set

Returns: void

Throws

When setting adapter before list initialisation

Methods

wvc.HoopsSheetListElement.selectNodes()
selectNodes(nodeIds: number[], selected: boolean): void

Selects or deselects sheet nodes.

Parameters

nodeIds: number[]

Array of node IDs to select or deselect

selected: boolean

Whether to select (true) or deselect (false) the nodes

Returns: void

Throws

When list element is not initialised