Interface SearchParams

Parameters to configure the depth-first search performed by searchObjects to locate DataObjects.

For detailed usage, refer to @xeokit/sdk/model/data.

interface SearchParams {
    excludeObjects?: string[];
    excludeRelated?: string[];
    excludeRelating?: string[];
    includeObjects?: string[];
    includeRelated?: string[];
    includeRelating?: string[];
    includeStart?: boolean;
    resultCallback?: (dataObject: DataObject) => boolean;
    resultObjectIds?: string[];
    resultObjects?: DataObject[];
    startObject?: DataObject;
    startObjectId?: string;
}

Properties

excludeObjects? excludeRelated? excludeRelating? includeObjects? includeRelated? includeRelating? includeStart? resultCallback? resultObjectIds? resultObjects? startObject? startObjectId?

Properties

OptionalexcludeObjects

excludeObjects?: string[]

The types of DataObjects to exclude from the search results.

OptionalexcludeRelated

excludeRelated?: string[]

The types of Relationships to exclude from being followed in each DataObject.relating during the search.

OptionalexcludeRelating

excludeRelating?: string[]

The Relationship types to skip during the traversal.

Relationships whose type is in this list are not descended. Takes precedence over SearchParams.includeRelating.

OptionalincludeObjects

includeObjects?: string[]

The types of DataObjects to exclusively include in the search results.

OptionalincludeRelated

includeRelated?: string[]

The types of Relationships to exclusively follow in each DataObject.related during the search.

OptionalincludeRelating

includeRelating?: string[]

The Relationship types to exclusively follow during the traversal.

When set, only relationships whose type is in this list are descended; relationships of any other type are skipped. Matched against the relationship type, not the object type.

OptionalincludeStart

includeStart?: boolean

Indicates whether to include the starting SearchParams.startObjectId or SearchParams.startObject in the search results.

The default is true.

OptionalresultCallback

resultCallback?: (dataObject: DataObject) => boolean

Collects the search results via a callback function that is executed for each matching DataObject.

This option is mutually exclusive with SearchParams.resultObjects and SearchParams.resultObjectIds.

OptionalresultObjectIds

resultObjectIds?: string[]

Collects the search results as a list of DataObject IDs.

This option is mutually exclusive with SearchParams.resultObjects and SearchParams.resultCallback.

OptionalresultObjects

resultObjects?: DataObject[]

Collects the search results as a list of DataObjects.

This option is mutually exclusive with SearchParams.resultObjectIds and SearchParams.resultCallback.

OptionalstartObject

startObject?: DataObject

The DataObject to start the traversal from.

This overrides SearchParams.startObjectId.

OptionalstartObjectId

startObjectId?: string

The ID of the DataObject to start the traversal from.

This is overridden by SearchParams.startObject.

Settings

Member Visibility

On This Page

Properties