Class: PropertyFilterNodeCollection
@cognite/reveal.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.
Hierarchy
↳
PropertyFilterNodeCollection
Constructors
constructor
• new PropertyFilterNodeCollection(client, model, options?)
Parameters
| Name | Type |
|---|---|
client | default |
model | CdfModelNodeCollectionDataProvider |
options | PropertyFilterNodeCollectionOptions |
Overrides
NodeCollection.constructor
Defined in
packages/cad-styling/src/PropertyFilterNodeCollection.ts:53
Properties
classToken
▪ Static Readonly classToken: "PropertyFilterNodeCollection"
Defined in
packages/cad-styling/src/PropertyFilterNodeCollection.ts:38
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/PropertyFilterNodeCollection.ts:64
Methods
clear
▸ clear(): void
Clears the node collection and interrupts any ongoing operations.
Returns
void
Overrides
Defined in
packages/cad-styling/src/PropertyFilterNodeCollection.ts:126
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.
example
set.executeFilter({ 'PDMS': { 'Module': 'AQ550' }});
Parameters
| Name | Type | Description |
|---|---|---|
filter | Object | A filter for matching node properties. |
Returns
Promise<void>
Defined in
packages/cad-styling/src/PropertyFilterNodeCollection.ts:77
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
Overrides
Defined in
packages/cad-styling/src/PropertyFilterNodeCollection.ts:138
getIndexSet
▸ getIndexSet(): IndexSet
Returns
Overrides
Defined in
packages/cad-styling/src/PropertyFilterNodeCollection.ts:134
off
▸ off(event, listener): void
Parameters
| Name | Type |
|---|---|
event | "changed" |
listener | () => void |
Returns
void
Inherited from
Defined in
packages/cad-styling/src/NodeCollection.ts:32
on
▸ on(event, listener): void
Parameters
| Name | Type |
|---|---|
event | "changed" |
listener | () => void |
Returns
void
Inherited from
Defined in
packages/cad-styling/src/NodeCollection.ts:27
serialize
▸ serialize(): SerializedNodeCollection
Returns
Overrides
Defined in
packages/cad-styling/src/PropertyFilterNodeCollection.ts:142