Skip to content

@serenity-is/corelib / ServiceLookupEditorOptions

Interface: ServiceLookupEditorOptions

Defined in: src/ui/editors/servicelookupeditor.ts:10

Options for the ServiceLookupEditor.

Extends

Properties

allowClear?

optional allowClear: boolean

Defined in: src/ui/editors/comboboxeditor.tsx:19

Whether the selection can be cleared.

Inherited from

ComboboxEditorOptions.allowClear


autoComplete?

optional autoComplete: boolean

Defined in: src/ui/editors/comboboxeditor.tsx:55

Whether arbitrary values are allowed.

Inherited from

ComboboxEditorOptions.autoComplete


capabilities?

optional capabilities: ListRequestCapabilities

Defined in: src/ui/editors/servicelookupeditor.ts:32

Supported ListRequest capabilities. When omitted, all standard properties are sent.


cascadeField?

optional cascadeField: string

Defined in: src/ui/editors/comboboxeditor.tsx:35

Field used for cascading.

Inherited from

ComboboxEditorOptions.cascadeField


cascadeFrom?

optional cascadeFrom: string

Defined in: src/ui/editors/comboboxeditor.tsx:33

Id of the parent editor to cascade from.

Inherited from

ComboboxEditorOptions.cascadeFrom


cascadeValue?

optional cascadeValue: any

Defined in: src/ui/editors/comboboxeditor.tsx:37

Value used for cascading.

Inherited from

ComboboxEditorOptions.cascadeValue


columnSelection?

optional columnSelection: ColumnSelection

Defined in: src/ui/editors/servicelookupeditor.ts:24

Column selection mode.


containsField?

optional containsField: string

Defined in: src/ui/editors/servicelookupeditor.ts:40

Field used for contains-text search.


criteria?

optional criteria: any[]

Defined in: src/ui/editors/servicelookupeditor.ts:44

Criteria applied to the request.


delimited?

optional delimited: boolean

Defined in: src/ui/editors/comboboxeditor.tsx:21

Whether multiple items can be selected.

Inherited from

ComboboxEditorOptions.delimited


dialogType?

optional dialogType: string | DialogType | PromiseLike<DialogType>

Defined in: src/ui/editors/comboboxeditor.tsx:53

Dialog type used for in-place add.

Inherited from

ComboboxEditorOptions.dialogType


equalityFilter?

optional equalityFilter: any

Defined in: src/ui/editors/servicelookupeditor.ts:42

Equality filter applied to the request.


excludeColumns?

optional excludeColumns: string[]

Defined in: src/ui/editors/servicelookupeditor.ts:28

Columns to exclude.


filterField?

optional filterField: string

Defined in: src/ui/editors/comboboxeditor.tsx:39

Field used for filtering.

Inherited from

ComboboxEditorOptions.filterField


filterValue?

optional filterValue: any

Defined in: src/ui/editors/comboboxeditor.tsx:41

Value used for filtering.

Inherited from

ComboboxEditorOptions.filterValue


idField?

optional idField: string

Defined in: src/ui/editors/servicelookupeditor.ts:14

Id field name.


includeColumns?

optional includeColumns: string[]

Defined in: src/ui/editors/servicelookupeditor.ts:26

Columns to include.


includeDeleted?

optional includeDeleted: boolean

Defined in: src/ui/editors/servicelookupeditor.ts:30

Whether to include deleted rows.


inplaceAdd?

optional inplaceAdd: boolean

Defined in: src/ui/editors/comboboxeditor.tsx:49

Whether in-place add is enabled.

Inherited from

ComboboxEditorOptions.inplaceAdd


inplaceAddPermission?

optional inplaceAddPermission: string

Defined in: src/ui/editors/comboboxeditor.tsx:51

Permission required for in-place add.

Inherited from

ComboboxEditorOptions.inplaceAddPermission


minimumResultsForSearch?

optional minimumResultsForSearch: any

Defined in: src/ui/editors/servicelookupeditor.ts:20

Minimum results required to show the search box.

Overrides

ComboboxEditorOptions.minimumResultsForSearch


multiple?

optional multiple: boolean

Defined in: src/ui/editors/comboboxeditor.tsx:25

Whether multiple items can be selected.

Inherited from

ComboboxEditorOptions.multiple


pageSize?

optional pageSize: number

Defined in: src/ui/editors/servicelookupeditor.ts:18

Page size for paged searches.


quickSearchFields?

optional quickSearchFields: string[]

Defined in: src/ui/editors/servicelookupeditor.ts:38

Additional fields searched by the client-side ContainsText fallback. The editor's itemText output is always searched unless ContainsField is set. This fallback cannot reproduce server-side QuickSearch behavior exactly.


service?

optional service: string

Defined in: src/ui/editors/servicelookupeditor.ts:12

Service endpoint to load items from.


sort?

optional sort: string[]

Defined in: src/ui/editors/servicelookupeditor.ts:22

Sort order for results.


textField?

optional textField: string

Defined in: src/ui/editors/servicelookupeditor.ts:16

Text field name.