Hide menu
Loading...
Searching...
No Matches
Data

Defines a PMI data container.

Extends

Constructors

Constructor

‍new Data(): Data

Creates an empty PMI data container.

Returns

Data

Overrides

BaseObject.constructor

Constructor

‍new Data(name): Data

Creates a named PMI data container.

Parameters

name

string

Data name.

Returns

Data

Overrides

BaseObject.constructor

Constructor

‍new Data(element): Data

Creates a PMI data container from one element.

Parameters

element

PMIElement

PMI element.

Returns

Data

Overrides

BaseObject.constructor

Constructor

‍new Data(elements): Data

Creates a PMI data container from elements.

Parameters

elements

PMIElement[]

PMI elements.

Returns

Data

Overrides

BaseObject.constructor

Properties

elements

‍readonly elements: Set<PMIElement>

Accessors

id

Get Signature

‍get id(): bigint

Returns the unique identifier of the object.

Returns

bigint

Inherited from

BaseObject.id


name

Get Signature

‍get name(): string | null

Returns the name of the PMI data container.

Returns

string | null

Set Signature

‍set name(name): void

Sets the name of the PMI data container.

Parameters

name

string | null

Name to assign to the PMI data container.

Returns

void


savedViews

Get Signature

‍get savedViews(): ReadonlySet<SavedView>

Saved views.

Returns

ReadonlySet<SavedView>

Methods

add()

Call Signature

‍add(element): void

Adds a PMI element.

Parameters

element

PMIElement

PMI element.

Returns

void

Call Signature

‍add(data): void

Adds PMI data content.

Parameters

data

Data

PMI data.

Returns

void


addView()

‍addView(view): void

Adds a saved view. Does nothing if the view is already present in the data container or if a view with the same name already exists.

Parameters

view

SavedView

Saved view.

Returns

void


clear()

‍clear(): void

Clears all stored PMI data.

Returns

void


isEmpty()

‍isEmpty(): boolean

Returns whether this data container has no PMI elements or saved views.

Returns

boolean


numberOfElements()

‍numberOfElements(): number

Returns the number of PMI elements.

Returns

number

Deprecated

Use Data.elements and elements.size instead.


numberOfSavedViews()

‍numberOfSavedViews(): number

Returns the number of saved views.

Returns

number

Deprecated

Use Data.savedViews and savedViews.size instead.