Skip to main content

Interface: ReferenceProperty<M>

Type parameters#

NameType
MM: Object = any

Hierarchy#

  • BaseProperty

    ReferenceProperty

Properties#

columnWidth#

Optional columnWidth: number

Width in pixels of this column in the collection view. If not set the width is inferred based on the other configurations

Inherited from#

BaseProperty.columnWidth

Defined in#

models/properties.ts:96


config#

Optional config: FieldConfig<EntityReference, any>

Configure how this property field is displayed

Defined in#

models/properties.ts:427


dataType#

dataType: "reference"

Overrides#

BaseProperty.dataType

Defined in#

models/properties.ts:407


description#

Optional description: string

Property description, always displayed under the field

Inherited from#

BaseProperty.description

Defined in#

models/properties.ts:85


disabled#

Optional disabled: boolean | PropertyDisabledConfig

Is this field disabled. When set to true, it gets rendered as a disabled field. You can also specify a configuration for defining the behaviour of disabled properties

Inherited from#

BaseProperty.disabled

Defined in#

models/properties.ts:109


longDescription#

Optional longDescription: string

Longer description of a field, displayed under a popover

Inherited from#

BaseProperty.longDescription

Defined in#

models/properties.ts:90


path#

path: string

Absolute collection path of the collection this reference points to. The schema of the entity is inferred based on the root navigation, so the filters and search delegate existing there are applied to this view as well.

Defined in#

models/properties.ts:415


previewProperties#

Optional previewProperties: keyof M[]

Properties that need to be rendered when displaying a preview of this reference. If not specified the first 3 are used. Only the first 3 specified values are considered.

Defined in#

models/properties.ts:422


readOnly#

Optional readOnly: boolean

Is this a read only property. When set to true, it gets rendered as a preview.

Inherited from#

BaseProperty.readOnly

Defined in#

models/properties.ts:102


title#

Optional title: string

Property title (e.g. Product)

Inherited from#

BaseProperty.title

Defined in#

models/properties.ts:80


validation#

Optional validation: PropertyValidationSchema

Rules for validating this property

Inherited from#

BaseProperty.validation

Defined in#

models/properties.ts:114