Skip to main content

UiPropertyMeta

Interface representing Ui-specific metadata for a property. Contains display and behavior settings for Ui components.

Properties

colorful

colorful: boolean

Determines if the property should be displayed with color highlighting in the Ui. Can be controlled using the colorful decorator to enable or notColorful decorator to disable.


isDisplayable

isDisplayable: boolean

Indicates whether the property is visible in Ui interface elements. Can be set to false using the notDisplayable decorator.


isEditDisplayable

isEditDisplayable: boolean

Indicates whether the property is visible in edit forms. Can be set to false using the notEditDisplayable decorator.


isFilterDisplayable

isFilterDisplayable: boolean

Indicates whether the property is visible in filter panels. Can be set to false using the notFilterDisplayable decorator.


isListDisplayable

isListDisplayable: boolean

Indicates whether the property is visible in list views. Can be set to false using the notListDisplayable decorator.


isSearchable?

optional isSearchable: boolean

Indicates whether this property should be included in search operations. Can be set to true using the searchable decorator.


name

name: string

Property name from the resource class.


notColorful?

optional notColorful: boolean

Opposite of colorful, but currently cannot be modified by any decorator.


uiRelation?

optional uiRelation: UiRelation

Property's Ui priority. Can be set using the uiRelationPriority decorator.