Constructor

# new BaseProperty(options)

Parameters:

Name	Type	Attributes	Default	Description
`options`	`object`
`path`	`string`			property path: usually it its key but when property is for an object the path can be divided to parts by dots: i.e. 'address.street'
`type`	`PropertyType`	<optional>	'string'
`isId`	`boolean`	<optional>	false	true when field should be treated as an ID
`isSortable`	`boolean`	<optional>	true	if property should be sortable

View Source adminjs/src/backend/adapters/property/base-property.ts, line 26

Classes

BaseProperty

Methods

# availableValues() → {Array.<String>|null}

Returns all available values which field can accept. It is used in case of

enums

View Source adminjs/src/backend/adapters/property/base-property.ts, line 241

Returns:

array of all available values or null when field is not an enum.

Type: Array.<String> | null

# isArray() → {boolean}

Returns true when given property is an array

View Source adminjs/src/backend/adapters/property/base-property.ts, line 248

Returns:

Type: boolean

# isDraggable() → {boolean}

Returns true when given property has draggable elements.

Only usable for array properties.

View Source adminjs/src/backend/adapters/property/base-property.ts, line 256

Returns:

Type: boolean

# isEditable() → {boolean}

Indicates if value of given property can be updated

View Source adminjs/src/backend/adapters/property/base-property.ts, line 215

Returns:

Type: boolean

# isId() → {boolean}

Returns true if given property is a uniq key in a table/collection

View Source adminjs/src/backend/adapters/property/base-property.ts, line 222

Returns:

Type: boolean

# isRequired() → {boolean}

Indicates if given property is required

View Source adminjs/src/backend/adapters/property/base-property.ts, line 276

Returns:

Type: boolean

# isSortable() → {boolean}

Indicates if given property can be sorted

View Source adminjs/src/backend/adapters/property/base-property.ts, line 270

Returns:

Type: boolean

# isTitle() → {boolean}

Return true if given property should be treated as a Record Title.

View Source adminjs/src/backend/adapters/property/base-property.ts, line 201

Returns:

Type: boolean

# isVisible() → {Boolean}

Indicates if given property should be visible

View Source adminjs/src/backend/adapters/property/base-property.ts, line 208

Returns:

Type: Boolean

# name() → {string}

Name of the property

View Source adminjs/src/backend/adapters/property/base-property.ts, line 188

Returns:

name of the property

Type: string

# reference() → {string|null}

If property is a reference to a record of different resource

it should contain BaseResource.id of this resource.

When property is responsible for the field: 'user_id' in SQL database reference should be the name of the Resource which it refers to: Users

View Source adminjs/src/backend/adapters/property/base-property.ts, line 232

Returns:

Type: string | null

# subProperties() → {Array.<BaseProperty>}

In case of `mixed` type returns all nested properties.

View Source adminjs/src/backend/adapters/property/base-property.ts, line 263

Returns:

sub properties

Type: Array.<BaseProperty>

# type() → {PropertyType}

Return type of a property

View Source adminjs/src/backend/adapters/property/base-property.ts, line 194

Returns:

Type: PropertyType

Type Definitions

Type: object

# PropertyType

Properties:

Name	Type	Description
`string`	`string`	default property type
`float`	`string`	type of floating point numbers
`number`	`string`	regular number
`boolean`	`string`	boolean value
`date`	`string`	date
`datetime`	`string`	date with time
`mixed`	`string`	type representing an object
`reference`	`string`	many to one reference
`richtext`	`string`	wysiwig editor
`textarea`	`string`	resizable textarea input
`password`	`string`	password field

View Source adminjs/src/backend/adapters/property/base-property.ts, line 3