Interface

PropertyJSON

PropertyJSON

Members

Array.<object> | null

# availableValues

If property has restricted number of values

Properties:
Name Type Description
label string
value string

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

object

# components Optional

All component names 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 69

object

# custom

Custom parameters passed from the PropertyOptions.custom.

Properties:
Name Type Description
{...} any

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

boolean

# isArray

Indicates if property is an array of properties

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

boolean

# isDisabled

Whether the field should be disabled in edition

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

boolean

# isId

If given property should be treated as a Id field

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

boolean

# isRequired

Whether the field should be marked as required (with a star)

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

boolean

# isSortable

If property is sortable

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

boolean

# isTitle

If given property should be treated as a title

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

number

# position

Property position on a list

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

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 52

string

# resourceId

Resource to which given property belongs

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

Array.<PropertyJSON>

# subProperties

Contain list of all sub properties. This is the case for nested schemas in MongoDB.

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