novorender-api-docs / DataJsAPI / SearchOptions

Interface: SearchOptions

Search object options

Properties

descentDepth?

optional descentDepth: number;

How many generations of descendants to include in search.

Remarks

0 - object itself

1 - children only

undefined - deepest levels.

---

full?

optional full: boolean;

Preload all matching objects.

Remarks

This param should be set if you want to access some parameters of all results later to prevent per object data request.

---

parentPath?

optional parentPath: string;

Path to search start from.

Remarks

Path is similar to filesystem file/folder hierarchical paths, e.g. my_folder/my_object. Paths reflect original CAD model hierarchy (.ifc, .rvm, etc). Only objects contained within specified folder will be returned.

---

searchPattern?

optional searchPattern: string | SearchPattern[];

Property pattern to search for.