Header menu logo issie

SheetTree Type

Node in the sheet tree, child nodes correspond to custom components in sheet.

Record fields

Record Field Description

BreadcrumbName

Full Usage: BreadcrumbName

Field type: string

unique name to display on breadcrumbs this is usually the design-time name of sheet with instance name added if this is not unique

Field type: string

Depth

Full Usage: Depth

Field type: int

depth of tree beneth this need: 0 for leaves

Field type: int

GridArea

Full Usage: GridArea

Field type: CSSGridPos option

Use only to display tree on a grid

Field type: CSSGridPos option

LabelPath

Full Usage: LabelPath

Field type: string list

path of custom component labels to node or [] if node is top level

Field type: string list

SheetAccessPath

Full Usage: SheetAccessPath

Field type: ComponentId list

path of sheet names to current sheet name - NB this is not unique

Field type: ComponentId list

SheetName

Full Usage: SheetName

Field type: string

design-time name of sheet

Field type: string

SheetPath

Full Usage: SheetPath

Field type: string list

design-time sheet names from the root of the tree down to and including this node. This is what identifies a node once several instances of one sheet inside one parent are collapsed into a single node: unlike LabelPath it does not depend on which of them was kept, and unlike SheetName it tells apart the places one sheet is reached from.

Field type: string list

Size

Full Usage: Size

Field type: int

size of tree including this node (1 for leaves)

Field type: int

SubSheets

Full Usage: SubSheets

Field type: SheetTree list

children

Field type: SheetTree list

Instance members

Instance member Description

this.lookupPath path

Full Usage: this.lookupPath path

Parameters:
    path : string list

Returns: SheetTree option

Keyed by LabelPath, while the wave selector keys its nodes by SheetPath: a node stands for every instance of its sheet at that point in the tree, so it has no one label path.

path : string list
Returns: SheetTree option

Type something to start searching.