Skip to main content
Version: Next

Class: PropertyFilterNodeCollection

Defined in: packages/cad-styling/src/PropertyFilterNodeCollection.ts:30

Represents a set of nodes that has matching node properties to a provided filter. Note that a node is considered to match if it or a NodeCollection ancestors match the filter.

Extends​

Constructors​

Constructor​

new PropertyFilterNodeCollection(client, model, options?): PropertyFilterNodeCollection

Defined in: packages/cad-styling/src/PropertyFilterNodeCollection.ts:43

Parameters​

client​

CogniteClient

model​

CdfModelNodeCollectionDataProvider

options?​

PropertyFilterNodeCollectionOptions = {}

Returns​

PropertyFilterNodeCollection

Overrides​

CdfNodeCollectionBase.constructor

Properties​

classToken​

readonly static classToken: "PropertyFilterNodeCollection" = 'PropertyFilterNodeCollection'

Defined in: packages/cad-styling/src/PropertyFilterNodeCollection.ts:31

Accessors​

classToken​

Get Signature​

get classToken(): string

Defined in: packages/cad-styling/src/NodeCollection.ts:24

Returns​

string

Inherited from​

CdfNodeCollectionBase.classToken

isLoading​

Get Signature​

get isLoading(): boolean

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

Returns​

boolean

Inherited from​

CdfNodeCollectionBase.isLoading

Methods​

clear()​

clear(): void

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

Clears the node collection and interrupts any ongoing operations.

Returns​

void

Inherited from​

CdfNodeCollectionBase.clear

executeFilter()​

executeFilter(filter): Promise<void>

Defined in: packages/cad-styling/src/PropertyFilterNodeCollection.ts:63

Populates the node collection with nodes matching the provided filter. This will replace the current nodes held by the filter.

Parameters​

filter​

A filter for matching node properties.

Returns​

Promise<void>

Example​

set.executeFilter({ 'PDMS': { 'Module': 'AQ550' }});

getAreas()​

getAreas(): AreaCollection

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

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

Returns​

AreaCollection

Inherited from​

CdfNodeCollectionBase.getAreas

getIndexSet()​

getIndexSet(): IndexSet

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

Returns​

IndexSet

Inherited from​

CdfNodeCollectionBase.getIndexSet

off()​

off(event, listener): void

Defined in: packages/cad-styling/src/NodeCollection.ts:33

Parameters​

event​

"changed"

listener​

() => void

Returns​

void

Inherited from​

CdfNodeCollectionBase.off

on()​

on(event, listener): void

Defined in: packages/cad-styling/src/NodeCollection.ts:28

Parameters​

event​

"changed"

listener​

() => void

Returns​

void

Inherited from​

CdfNodeCollectionBase.on

serialize()​

serialize(): SerializedNodeCollection

Defined in: packages/cad-styling/src/PropertyFilterNodeCollection.ts:82

Returns​

SerializedNodeCollection

Overrides​

CdfNodeCollectionBase.serialize