Skip to main content

Element-Hierarchy Table

The Element-Hierarchy table connects the data model to the VIM custom visual to render the filtered context in your report. It also represents the grouping information of an element (i.e. the Descendant) with a parent or ancestor element (i.e. the Element).

_key​

Unique key value representing each record in the table.

Descendant​

The foreign key to the Element table which defines the current element, or the terminal element if it is contained in a hierarchy of groups.

DescendantGeometry​

The foreign key to the Element-Geometry table which defines the geometry of the current/terminal element. Records with no geometry will

DescendantNode​

The foreign key to the Node table which defines the Descendant element's Node.

note

One Descendant element may be composed of multiple nodes, in which case the Element-Hierarchy record referencing this Descendant will appear for as many times as there are nodes which compose that Descendant element.

Element​

The foreign key to the Element table which defines the current parent or ancestor element, or the same value as the Descendant element if it has no parents or ancestors.

Self​

When true, the Descendant and the Element are the same element.

Distance​

The distance (in "hops") from the Descendant to its parent or ancestor Element.

  • A distance of 0 denotes that the Descendant and the Element are the same element.
  • A distance of 1 denotes that the Descendant is a direct child of the Element.
  • A distance of 2 denotes that the Descendant is a grand-child of the Element.

RootDistance​

The distance (in "hops") from the root level.

  • Descendants with a Distance of 0 and a RootDistance of 0 are considered root-level elements.
  • Descendants with a non-zero RootDistance are considered children of an Element.

BimDocument_key​

The foreign key to the BimDocument table which defines the BIM document that contains the Descendant.

FilePath​

The file path of the VIM file which contains the Descendant element.

Url​

The URL of the VIM file which contains the Descendant element.

AccessToken​

If specified, this value is supplied in the request to the VIM URL in case the URL is gated behind a special access token.

Geometry.Index​

The Descendant element's geometry index in the VIM file.

Node.Index​

The Descendant element's node index in the VIM file.