DefineDataViewsFieldDefinition

Defined in: wp-typia-dataviews/src/index.ts:559

Extends

• Omit<DataViewsField<TItem, TItem[TKey]>, "elements" | "id" | "label" | "type">

Type Parameters

TItem

TItem extends object

TKey

TKey extends DataViewsFieldId<TItem>

Properties

description?

readonly optional description?: string

Defined in: wp-typia-dataviews/src/index.ts:176

Inherited from

Omit.description

---

enableGlobalSearch?

readonly optional enableGlobalSearch?: boolean

Defined in: wp-typia-dataviews/src/index.ts:178

Inherited from

Omit.enableGlobalSearch

---

enableHiding?

readonly optional enableHiding?: boolean

Defined in: wp-typia-dataviews/src/index.ts:179

Inherited from

Omit.enableHiding

---

enableSorting?

readonly optional enableSorting?: boolean

Defined in: wp-typia-dataviews/src/index.ts:180

Inherited from

Omit.enableSorting

---

filterBy?

readonly optional filterBy?: DataViewsFieldFilter

Defined in: wp-typia-dataviews/src/index.ts:181

Inherited from

Omit.filterBy

---

format?

readonly optional format?: DataViewsFieldFormat

Defined in: wp-typia-dataviews/src/index.ts:182

Inherited from

Omit.format

---

getValue?

readonly optional getValue?: (context) => TItem[TKey]

Defined in: wp-typia-dataviews/src/index.ts:183

Parameters

context

DataViewsFieldContext<TItem, TItem[TKey]>

Returns

TItem[TKey]

Inherited from

Omit.getValue

---

getValueFormatted?

readonly optional getValueFormatted?: (context) => string

Defined in: wp-typia-dataviews/src/index.ts:184

Parameters

context

DataViewsFieldContext<TItem, TItem[TKey]>

Returns

string

Inherited from

Omit.getValueFormatted

---

header?

readonly optional header?: string

Defined in: wp-typia-dataviews/src/index.ts:185

Inherited from

Omit.header

---

isValid?

readonly optional isValid?: DataViewsFieldValidationRules<TItem, TItem[TKey]>

Defined in: wp-typia-dataviews/src/index.ts:187

Inherited from

Omit.isValid

---

placeholder?

readonly optional placeholder?: string

Defined in: wp-typia-dataviews/src/index.ts:189

Inherited from

Omit.placeholder

---

readOnly?

readonly optional readOnly?: boolean

Defined in: wp-typia-dataviews/src/index.ts:190

Inherited from

Omit.readOnly

---

render?

readonly optional render?: (context) => unknown

Defined in: wp-typia-dataviews/src/index.ts:191

Parameters

context

DataViewsFieldContext<TItem, TItem[TKey]>

Returns

unknown

Inherited from

Omit.render

---

setValue?

readonly optional setValue?: (context) => TItem

Defined in: wp-typia-dataviews/src/index.ts:192

Parameters

context

DataViewsFieldUpdateContext<TItem, TItem[TKey]>

Returns

TItem

Inherited from

Omit.setValue

---

sort?

readonly optional sort?: (left, right, direction) => number

Defined in: wp-typia-dataviews/src/index.ts:193

Parameters

left

TItem

right

TItem

direction

"desc" | "asc"

Returns

number

Inherited from

Omit.sort

---

elements?

readonly optional elements?: readonly DataViewsFieldElement<DataViewsFieldElementValue<TItem[TKey]>>[]

Defined in: wp-typia-dataviews/src/index.ts:563

---

label?

readonly optional label?: string

Defined in: wp-typia-dataviews/src/index.ts:564

---

schema?

readonly optional schema?: DataViewsFieldSchemaMetadata<TItem[TKey]>

Defined in: wp-typia-dataviews/src/index.ts:565

---

type?

readonly optional type?: DataViewsCompatibleFieldType<TItem[TKey]>

Defined in: wp-typia-dataviews/src/index.ts:566