DefinedDataViews

Defined in: wp-typia-dataviews/src/types.ts:609

Type Parameters

TItem

TItem extends object

Properties

actions?

readonly optional actions?: readonly DataViewsAction<TItem>[]

Defined in: wp-typia-dataviews/src/types.ts:610

---

defaultLayouts?

readonly optional defaultLayouts?: Readonly<Partial<Record<"list" | "grid" | "table" | "activity" | "pickerTable" | "pickerGrid", Readonly<Record<string, unknown>>>>>

Defined in: wp-typia-dataviews/src/types.ts:611

---

defaultView

readonly defaultView: DataViewsView<TItem>

Defined in: wp-typia-dataviews/src/types.ts:612

---

fieldMap

readonly fieldMap: DefinedDataViewsFieldMap<TItem>

Defined in: wp-typia-dataviews/src/types.ts:613

---

fields

readonly fields: readonly DataViewsResolvedField<TItem>[]

Defined in: wp-typia-dataviews/src/types.ts:614

---

getItemId?

readonly optional getItemId?: (item) => string

Defined in: wp-typia-dataviews/src/types.ts:615

Parameters

item

TItem

Returns

string

---

getItemLevel?

readonly optional getItemLevel?: (item) => number

Defined in: wp-typia-dataviews/src/types.ts:616

Parameters

item

TItem

Returns

number

---

idField?

readonly optional idField?: DataViewsItemIdField<TItem>

Defined in: wp-typia-dataviews/src/types.ts:617

---

search?

readonly optional search?: boolean

Defined in: wp-typia-dataviews/src/types.ts:618

---

searchLabel?

readonly optional searchLabel?: string

Defined in: wp-typia-dataviews/src/types.ts:619

---

titleField?

readonly optional titleField?: Extract<keyof TItem, string>

Defined in: wp-typia-dataviews/src/types.ts:620

---

createConfig

readonly createConfig: (options) => DataViewsConfig<TItem>

Defined in: wp-typia-dataviews/src/types.ts:621

Parameters

options

DefineDataViewsConfigOptions<TItem>

Returns

DataViewsConfig<TItem>

---

toFormConfig

readonly toFormConfig: (options?) => DataFormConfig<TItem>

Defined in: wp-typia-dataviews/src/types.ts:622

Parameters

options?

DataFormConfigOptions<TItem>

Returns

DataFormConfig<TItem>

---

toQueryArgs

readonly toQueryArgs: <TQuery>(view, …args) => Partial<TQuery>

Defined in: wp-typia-dataviews/src/types.ts:623

Type Parameters

TQuery

TQuery extends object = DataViewsQueryArgs

Parameters

view

DataViewsView<TItem>

args

…DataViewsQueryAdapterFactoryArguments<TItem, TQuery>

Returns

Partial<TQuery>