Interface

PropertyJSON

PropertyJSON

JSON representation of a Property.

View Source admin-bro/src/backend/decorators/property-json.interface.ts, line 11

Members

Array.<object> | null

# availableValues

If property has restricted number of values

Properties:
Name Type Description
] string
] string

View Source admin-bro/src/backend/decorators/property-json.interface.ts, line 35

object

# components Optional

All components overridden by the user in PropertyOptions

Properties:
Name Type Attributes Description
show string <optional>
edit string <optional>
filter string <optional>
list string <optional>

View Source admin-bro/src/backend/decorators/property-json.interface.ts, line 73

object

# custom

Custom parameters passed from the PropertyOptions.custom

Properties:
Name Type Description
{...} boolean | string | number | Date

View Source admin-bro/src/backend/decorators/property-json.interface.ts, line 83

boolean

# isArray

Indicates if property is an array of properties

View Source admin-bro/src/backend/decorators/property-json.interface.ts, line 63

boolean

# isDisabled

Whether the field should be disabled in edition

View Source admin-bro/src/backend/decorators/property-json.interface.ts, line 89

boolean

# isId

If given property should be treated as a Id field

View Source admin-bro/src/backend/decorators/property-json.interface.ts, line 20

boolean

# isSortable

If property is sortable

View Source admin-bro/src/backend/decorators/property-json.interface.ts, line 30

boolean

# isTitle

If given property should be treated as a title

View Source admin-bro/src/backend/decorators/property-json.interface.ts, line 15

string

# label

Property label

View Source admin-bro/src/backend/decorators/property-json.interface.ts, line 47

string

# name

Property uniq name/path

View Source admin-bro/src/backend/decorators/property-json.interface.ts, line 42

number

# position

Property position on a list

View Source admin-bro/src/backend/decorators/property-json.interface.ts, line 25

string | null

# reference

Has a name of a resource to which it is a reference. For instance property userId will have here Users

View Source admin-bro/src/backend/decorators/property-json.interface.ts, line 57

Array.<PropertyJSON>

# subProperties

Contain list of all sub properties

View Source admin-bro/src/backend/decorators/property-json.interface.ts, line 68

string

# type

Property type

View Source admin-bro/src/backend/decorators/property-json.interface.ts, line 52