Skip to main content
Version: 4.x

Class: CdfNodeCollectionBase

@cognite/reveal.CdfNodeCollectionBase

Abstract class for implementing a set of nodes to be styled.

Hierarchy

Constructors

constructor

new CdfNodeCollectionBase(classToken, model)

Parameters

NameType
classTokenstring
modelCdfModelNodeCollectionDataProvider

Overrides

NodeCollection.constructor

Defined in

packages/cad-styling/src/CdfNodeCollectionBase.ts:20

Accessors

classToken

get classToken(): string

Returns

string

Inherited from

NodeCollection.classToken

Defined in

packages/cad-styling/src/NodeCollection.ts:23


isLoading

get isLoading(): boolean

Returns

boolean

Overrides

NodeCollection.isLoading

Defined in

packages/cad-styling/src/CdfNodeCollectionBase.ts:25

Methods

clear

clear(): void

Clears the node collection and interrupts any ongoing operations.

Returns

void

Overrides

NodeCollection.clear

Defined in

packages/cad-styling/src/CdfNodeCollectionBase.ts:69


getAreas

getAreas(): AreaCollection

Returns areas surrounding the nodes in the collection. The areas are boxes in "ThreeJS coordinates". Note that not all implementations supports this.

Returns

AreaCollection

Overrides

NodeCollection.getAreas

Defined in

packages/cad-styling/src/CdfNodeCollectionBase.ts:81


getIndexSet

getIndexSet(): IndexSet

Returns

IndexSet

Overrides

NodeCollection.getIndexSet

Defined in

packages/cad-styling/src/CdfNodeCollectionBase.ts:77


off

off(event, listener): void

Parameters

NameType
event"changed"
listener() => void

Returns

void

Inherited from

NodeCollection.off

Defined in

packages/cad-styling/src/NodeCollection.ts:32


on

on(event, listener): void

Parameters

NameType
event"changed"
listener() => void

Returns

void

Inherited from

NodeCollection.on

Defined in

packages/cad-styling/src/NodeCollection.ts:27


serialize

Abstract serialize(): SerializedNodeCollection

Returns

SerializedNodeCollection

Inherited from

NodeCollection.serialize

Defined in

packages/cad-styling/src/NodeCollection.ts:46