Skip to main content

Interface: EntitySchema<M>

Specification for defining an entity

Type parameters#

NameType
MM: Object = any

Properties#

customId#

Optional customId: boolean | EnumValues

If this property is not set, the property will be created by the datasource. You can set the value to true to allow the users to choose the ID. You can also pass a set of values (as an EnumValues object) to allow them to pick from only those

Defined in#

models/entities.ts:27


defaultValues#

Optional defaultValues: any

When creating a new entity, set some values as already initialized

Defined in#

models/entities.ts:37


description#

Optional description: string

Description of this entity

Defined in#

models/entities.ts:18


name#

name: string

Singular name of the entity as displayed in an Add button . E.g. Product

Defined in#

models/entities.ts:13


properties#

properties: PropertiesOrBuilder<M>

Set of properties that compose an entity

Defined in#

models/entities.ts:32


views#

Optional views: EntityCustomView<M>[]

Array of builders for rendering additional panels in an entity view. Useful if you need to render custom views

Defined in#

models/entities.ts:43