Class BoolField

BoolField defines "bool" type field to store a single true/false value.

The respective zero record field value is false.

Hierarchy

core.BoolField
- BoolField

Implements

core.BoolField

Index

Constructors

constructor

new BoolField(data?): BoolField
Parameters
- Optional data: Partial<core.BoolField>
Returns BoolField
Inherited from core.BoolField.constructor
- Defined in types.d.ts:356

Methods

columnType

columnType(app): string
ColumnType implements [Field.ColumnType] interface method.
Parameters
- app: App
Returns string
Inherited from BoolField.columnType
- Defined in types.d.ts:9296

getHidden

getHidden(): boolean
GetHidden implements [Field.GetHidden] interface method.

Returns boolean
Inherited from BoolField.getHidden
- Defined in types.d.ts:9284

getId

getId(): string
GetId implements [Field.GetId] interface method.

Returns string
Inherited from BoolField.getId
- Defined in types.d.ts:9248

getName

getName(): string
GetName implements [Field.GetName] interface method.

Returns string
Inherited from BoolField.getName
- Defined in types.d.ts:9260

getSystem

getSystem(): boolean
GetSystem implements [Field.GetSystem] interface method.

Returns boolean
Inherited from BoolField.getSystem
- Defined in types.d.ts:9272

prepareValue

prepareValue(record, raw): any
PrepareValue implements [Field.PrepareValue] interface method.
Parameters
- record: core.Record
- raw: any
Returns any
Inherited from BoolField.prepareValue
- Defined in types.d.ts:9302

setHidden

setHidden(hidden): void
SetHidden implements [Field.SetHidden] interface method.
Parameters
- hidden: boolean
Returns void
Inherited from BoolField.setHidden
- Defined in types.d.ts:9290

setId

setId(id): void
SetId implements [Field.SetId] interface method.
Parameters
- id: string
Returns void
Inherited from BoolField.setId
- Defined in types.d.ts:9254

setName

setName(name): void
SetName implements [Field.SetName] interface method.
Parameters
- name: string
Returns void
Inherited from BoolField.setName
- Defined in types.d.ts:9266

setSystem

setSystem(system): void
SetSystem implements [Field.SetSystem] interface method.
Parameters
- system: boolean
Returns void
Inherited from BoolField.setSystem
- Defined in types.d.ts:9278

type

type(): string
Type implements [Field.Type] interface method.

Returns string
Inherited from BoolField.type
- Defined in types.d.ts:9242

validateSettings

validateSettings(ctx, app, collection): void
ValidateSettings implements [Field.ValidateSettings] interface method.
Parameters
- ctx: context.Context
- app: App
- collection: core.Collection
Returns void
Inherited from BoolField.validateSettings
- Defined in types.d.ts:9314

validateValue

validateValue(ctx, app, record): void
ValidateValue implements [Field.ValidateValue] interface method.
Parameters
- ctx: context.Context
- app: App
- record: core.Record
Returns void
Inherited from BoolField.validateValue
- Defined in types.d.ts:9308

Properties

hidden

hidden: boolean

Hidden hides the field from the API response.

id

id: string

Id is the unique stable field identifier.

It is automatically generated from the name when adding to a collection FieldsList.

name

name: string

Name (required) is the unique name of the field.

presentable

presentable: boolean

Presentable hints the Dashboard UI to use the underlying field record value in the relation preview label.

required

required: boolean

Required will require the field value to be always "true".

system

system: boolean

System prevents the renaming and removal of the field.

Class BoolField

Hierarchy

Implements

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Optional data: Partial<core.BoolField>

Returns BoolField

Methods

columnType

Parameters

app: App

Returns string

getHidden

Returns boolean

getId

Returns string

getName

Returns string

getSystem

Returns boolean

prepareValue

Parameters

record: core.Record

raw: any

Returns any

setHidden

Parameters

hidden: boolean

Returns void

setId

Parameters

id: string

Returns void

setName

Parameters

name: string

Returns void

setSystem

Parameters

system: boolean

Returns void

type

Returns string

validateSettings

Parameters

ctx: context.Context

app: App

collection: core.Collection

Returns void

validateValue

Parameters

ctx: context.Context

app: App

record: core.Record

Returns void

Properties

hidden

id

name

presentable

required

system

Settings

Member Visibility

Theme

On This Page

`Optional` data: Partial<core.BoolField>