ui/build/collection-table/collection-table-filter-fields

Interfaces

CollectionFilterField

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-filter-fields.d.ts:10

Properties

field

readonly field: CollectionField;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-filter-fields.d.ts:12

relation?

readonly optional relation?: object;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-filter-fields.d.ts:13

cardinality

readonly cardinality: "one" | "many";

name

readonly name: string;

target

readonly target: string;

value

readonly value: string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-filter-fields.d.ts:11

---

FilterCollectionDefinition

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-filter-fields.d.ts:4

Properties

fields

readonly fields: readonly CollectionField<string>[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-filter-fields.d.ts:6

name

readonly name: string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-filter-fields.d.ts:5

recordLabel?

readonly optional recordLabel?: string | null;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-filter-fields.d.ts:7

relationships?

readonly optional relationships?: readonly CollectionRelationship[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-filter-fields.d.ts:8

Functions

collectionFilterClause()

function collectionFilterClause(
   filterField,
   operator,
   operand): CollectionFilter;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-filter-fields.d.ts:21

Parameters

Parameter	Type
filterField	CollectionFilterField
operator	| "eq" | "ne" | "gt" | "gte" | "lt" | "lte" | "ilike" | "isNull" | "isNotNull" | "arrayContains" | "arrayOverlaps" | "contains_date" | "overlaps"
operand	unknown

Returns

CollectionFilter

---

collectionFilterFields()

function collectionFilterFields(definition, collections): readonly CollectionFilterField[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-filter-fields.d.ts:20

Parameters

Parameter	Type
definition	FilterCollectionDefinition
collections	Readonly<Record<string, FilterCollectionDefinition>>

Returns

readonly CollectionFilterField[]

---

collectionFilterFieldTree()

function collectionFilterFieldTree(filterFields, t?): readonly BaseTreeItem<
  | CollectionFilterField
  | null>[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-filter-fields.d.ts:19

Parameters

Parameter	Type
filterFields	readonly CollectionFilterField[]
t?	any

Returns

readonly BaseTreeItem< | CollectionFilterField | null>[]

---

relationLabelOptions()

function relationLabelOptions(target, targetName): CollectionRelationOptions;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-table-filter-fields.d.ts:23

Record keys need the target collection's record-label contract, not a UUID text input.

Parameters

Parameter	Type
target	| { recordLabel?: string | null; } | undefined
targetName	string

Returns

CollectionRelationOptions