Class: PropertyFilterNodeCollection
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
new PropertyFilterNodeCollection()
new PropertyFilterNodeCollection(
client,model,options):PropertyFilterNodeCollection
Parameters
• client: CogniteClient
• model: CdfModelNodeCollectionDataProvider
• options: PropertyFilterNodeCollectionOptions = {}
Returns
Overrides
CdfNodeCollectionBase.constructor
Defined in
packages/cad-styling/src/PropertyFilterNodeCollection.ts:44
Properties
classToken
readonlystaticclassToken:"PropertyFilterNodeCollection"='PropertyFilterNodeCollection'
Defined in
packages/cad-styling/src/PropertyFilterNodeCollection.ts:32
Accessors
classToken
Get Signature
get classToken():
string
Returns
string
Inherited from
CdfNodeCollectionBase.classToken
Defined in
packages/cad-styling/src/NodeCollection.ts:23
isLoading
Get Signature
get isLoading():
boolean
Returns
boolean
Inherited from
CdfNodeCollectionBase.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
Inherited from
Defined in
packages/cad-styling/src/CdfNodeCollectionBase.ts:69
executeFilter()
executeFilter(
filter):Promise<void>
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' }});
Defined in
packages/cad-styling/src/PropertyFilterNodeCollection.ts:64
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
Inherited from
CdfNodeCollectionBase.getAreas
Defined in
packages/cad-styling/src/CdfNodeCollectionBase.ts:81
getIndexSet()
getIndexSet():
IndexSet
Returns
Inherited from
CdfNodeCollectionBase.getIndexSet
Defined in
packages/cad-styling/src/CdfNodeCollectionBase.ts:77
off()
off(
event,listener):void
Parameters
• event: "changed"
• listener
Returns
void
Inherited from
Defined in
packages/cad-styling/src/NodeCollection.ts:32
on()
on(
event,listener):void
Parameters
• event: "changed"
• listener
Returns
void
Inherited from
Defined in
packages/cad-styling/src/NodeCollection.ts:27
serialize()
serialize():
SerializedNodeCollection
Returns
Overrides
CdfNodeCollectionBase.serialize