Skip to main content

Data JS API

DataJsAPI.ObjectGroup

Scene objects group

Properties​

color​

• Optional color: readonly [number, number, number] | Float32Array | readonly [number, number, number, number]

Group color when selected.

grouping​

• Optional grouping: string

Grouping.

hidden​

• hidden: boolean

Is Group hidden?

id​

• id: string

Object group uuid.

ids​

• Optional ids: ObjectIdArray

List of selected object id's.

Remarks

The array itself is immutable/readonly, so updates are done by assigning a new array.

includeDescendants​

• Optional includeDescendants: boolean

Include descendants.

Remarks

undefined value will be interpret as true

name​

• name: string

Object group name.

opacity​

• Optional opacity: number

Group opacity when selected.

• Optional search: SearchPattern[]

Group filling search criterias.

Remarks

This search criterias will be used to refill ids array on scene rebuilding automatically. If search is not defined then ids array will remain on scene rebuilding.

selected​

• selected: boolean

Is group selected?