SelectionSearchActor

The SelectionSearchActor is used to start a search triggered by and based on selected objects. This is mostly used for tree structures to find child objects of the selected record.
A commonly used subclass is actor PidSelectionSearchActor which does not require (and does not support) the searchFilterTemplates parameter.

Properties

• Parent:

  • Actor

• Type: SelectionSearchActor

Parameter

Parameters in the Layout

Name	Type	Description
instantSearch	boolean default: false	Defines whether the actor searches immediately at the beginning
searchActor	SearchActor	Used for searching
selectionActor	SelectionActor	Listens for events of the SelectionActor to start a new search.
searchFilterTemplates	array of searchFilterTemplate	The templates define how the selected elements are converted to search filters.

type searchFilterTemplate = {
    operator: string,
    field: string,
    comparator: string,
    valueField: string,
    wildcard?: {
        start: boolean, 
        end: boolean,
    },
}

The properties operator, field, and comparator are directly used for the executed search. The valueField defines the field of the selected objects which is set as filter value.