Interface Field

Field defines a common interface that all Collection fields should implement.

Hierarchy

Field
- Field

Implemented by

Field

Indexable

[key: string]: any

Index

Methods

columnType getHidden getId getName getSystem prepareValue setHidden setId setName setSystem type validateSettings validateValue

Methods

columnType

columnType(app): string
ColumnType returns the DB column definition of the field.
Parameters
- app: App
Returns string
- Defined in types.d.ts:8986

getHidden

getHidden(): boolean
GetHidden returns the field hidden flag state.

Returns boolean
- Defined in types.d.ts:8974

getId

getId(): string
GetId returns the field id.

Returns string
- Defined in types.d.ts:8950

getName

getName(): string
GetName returns the field name.

Returns string
- Defined in types.d.ts:8958

getSystem

getSystem(): boolean
GetSystem returns the field system flag state.

Returns boolean
- Defined in types.d.ts:8966

prepareValue

prepareValue(record, raw): any
PrepareValue returns a properly formatted field value based on the provided raw one.

This method is also called on record construction to initialize its default field value.
Parameters
- record: core.Record
- raw: any
Returns any
- Defined in types.d.ts:8992

setHidden

setHidden(hidden): void
SetHidden changes the field hidden flag state.
Parameters
- hidden: boolean
Returns void
- Defined in types.d.ts:8978

setId

setId(id): void
SetId changes the field id.
Parameters
- id: string
Returns void
- Defined in types.d.ts:8954

setName

setName(name): void
SetName changes the field name.
Parameters
- name: string
Returns void
- Defined in types.d.ts:8962

setSystem

setSystem(system): void
SetSystem changes the field system flag state.
Parameters
- system: boolean
Returns void
- Defined in types.d.ts:8970

type

type(): string
Type returns the unique type of the field.

Returns string
- Defined in types.d.ts:8982

validateSettings

validateSettings(ctx, app, collection): void
ValidateSettings validates the current field settings.
Parameters
- ctx: context.Context
- app: App
- collection: core.Collection
Returns void
- Defined in types.d.ts:9000

validateValue

validateValue(ctx, app, record): void
ValidateSettings validates the current field value associated with the provided record.
Parameters
- ctx: context.Context
- app: App
- record: core.Record
Returns void
- Defined in types.d.ts:8996

Generated using TypeDoc