EntityProperty

Strongly-typed property associated with an object. Used for reflection, serialization, UI generation, and other introspection-dependent tasks.

Samples:

Extends

Property

Constructors

new EntityProperty()

new EntityProperty(dart): EntityProperty

Parameters

Parameter	Type
`dart`	`any`

Properties

Property	Modifier	Type	Inherited from
`dart`	`readonly`	`any`	`Property`.`dart`
`options`	`public`	`any`	`Property`.`options`

Accessors

caption

get caption(): string

set caption(s): void

Parameters

Parameter	Type
`s`	`string`

Returns

string

Source

src/entities.ts:1254

choices

get choices(): string[]

List of possible values of that property. PropertyGrid will use it to populate combo boxes.

set choices(x): void

Parameters

Parameter	Type
`x`	`string`[]

Returns

string[]

Source

src/entities.ts:1315

columnFilter

get columnFilter(): null | "string" | "bigint" | "object" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe" | "categorical" | "numerical"

Column type filter

Returns

Source

src/entities.ts:1319

defaultValue

get defaultValue(): any

Default value

set defaultValue(s): void

Parameters

Parameter	Type
`s`	`any`

Returns

any

Source

src/entities.ts:1282

description

get description(): string

Description

set description(s): void

Parameters

Parameter	Type
`s`	`string`

Returns

string

Source

src/entities.ts:1274

editor

get editor(): string

Property editor

set editor(s): void

Parameters

Parameter	Type
`s`	`string`

Returns

string

Source

src/entities.ts:1286

format

get format(): string

set format(s): void

Parameters

Parameter	Type
`s`	`string`

Returns

string

Source

src/entities.ts:1297

get

get get(): PropertyGetter<any, any>

Property getter is a function that accepts one parameter (item) and returns the property value.

set get(x): void

Parameters

Parameter	Type
`x`	`PropertyGetter`<`any`, `any`>

Returns

PropertyGetter<any, any>

Source

src/entities.ts:1243

includeInLayout

get includeInLayout(): boolean

Applies to viewers properties whether to include the property in the layout or not.

set includeInLayout(s): void

Parameters

Parameter	Type
`s`	`boolean`

Returns

boolean

Source

src/entities.ts:1266

max

get max(): number

set max(s): void

Parameters

Parameter	Type
`s`	`number`

Returns

number

Source

src/entities.ts:1306

min

get min(): number

set min(s): void

Parameters

Parameter	Type
`s`	`number`

Returns

number

Source

src/entities.ts:1303

name

get name(): string

Property name

set name(s): void

Parameters

Parameter	Type
`s`	`string`

Returns

string

Source

src/entities.ts:1251

nullable

get nullable(): boolean

Nullable

set nullable(s): void

Parameters

Parameter	Type
`s`	`boolean`

Returns

boolean

Source

src/entities.ts:1278

propertyType

get propertyType(): TYPE

Property type

set propertyType(s): void

Parameters

Parameter	Type
`s`	`TYPE`

Returns

TYPE

Source

src/entities.ts:1262

semType

get semType(): string

Semantic type

set semType(s): void

Parameters

Parameter	Type
`s`	`string`

Returns

string

Source

src/entities.ts:1270

set

get set(): PropertySetter<any, any>

Property setter

set set(x): void

Parameters

Parameter	Type
`x`	`PropertySetter`<`any`, `any`>

Returns

PropertySetter<any, any>

Source

src/entities.ts:1247

showPlusMinus

get showPlusMinus(): string

Whether a plus/minus clicker appears next to the number input. Applies to numerical columns only.

set showPlusMinus(s): void

Parameters

Parameter	Type
`s`	`string`

Returns

string

Source

src/entities.ts:1294

showSlider

get showSlider(): string

Whether a slider appears next to the number input. Applies to numerical columns only.

set showSlider(s): void

Parameters

Parameter	Type
`s`	`string`

Returns

string

Source

src/entities.ts:1290

step

get step(): number

set step(s): void

Parameters

Parameter	Type
`s`	`number`

Returns

number

Source

src/entities.ts:1309

userEditable

get userEditable(): boolean

set userEditable(s): void

Parameters

Parameter	Type
`s`	`boolean`

Returns

boolean

Source

src/entities.ts:1300

Methods

fromOptions()

fromOptions(opt?): Property

Applies the specified options

Parameters

Parameter	Type
`opt`?	`PropertyOptions`

Returns

Property

Inherited from

Property . fromOptions

Source

src/entities.ts:1324

bool()

static bool(name, getter, setter, defaultValue): Property

Creates a bool property

Parameters

Parameter	Type
`name`	`string`
`getter`	`PropertyGetter`<`any`, `any`>
`setter`	`PropertySetter`<`any`, `any`>
`defaultValue`	`any`

Returns

Property

Inherited from

Property . bool

Source

src/entities.ts:1354

create()

static create(name, type): EntityProperty

Creates a property

Parameters

Parameter	Type
`name`	`string`
`type`	`string`

Returns

EntityProperty

Overrides

Property . create

Source

src/entities.ts:1421

dateTime()

static dateTime(name, getter, setter, defaultValue): Property

Creates a datetime property

Parameters

Parameter	Type
`name`	`string`
`getter`	`PropertyGetter`<`any`, `any`>
`setter`	`PropertySetter`<`any`, `any`>
`defaultValue`	`any`

Returns

Property

Inherited from

Property . dateTime

Source

src/entities.ts:1359

float()

static float(name, getter, setter, defaultValue): Property

Creates a float property

Parameters

Parameter	Type
`name`	`string`
`getter`	`PropertyGetter`<`any`, `any`>
`setter`	`PropertySetter`<`any`, `any`>
`defaultValue`	`any`

Returns

Property

Inherited from

Property . float

Source

src/entities.ts:1344

fromOptions()

static fromOptions(options): Property

Parameters

Parameter	Type
`options`	`PropertyOptions`

Returns

Property

Inherited from

Property . fromOptions

Source

src/entities.ts:1377

int()

static int(name, getter, setter, defaultValue): Property

Creates an integer property

Parameters

Parameter	Type
`name`	`string`
`getter`	`PropertyGetter`<`any`, `any`>
`setter`	`PropertySetter`<`any`, `any`>
`defaultValue`	`any`

Returns

Property

Inherited from

Property . int

Source

src/entities.ts:1339

js()

static js(name, type, options?): Property

Creates property for the JavaScript objects with the corresponding property name

Parameters

Parameter	Type
`name`	`string`
`type`	`TYPE`
`options`?	`PropertyOptions`

Returns

Property

Inherited from

Property . js

Source

src/entities.ts:1364

jsBool()

static jsBool(name, options?): Property

Parameters

Parameter	Type
`name`	`string`
`options`?	`PropertyOptions`

Returns

Property

Inherited from

Property . jsBool

Source

src/entities.ts:1372

jsDateTime()

static jsDateTime(name, options?): Property

Parameters

Parameter	Type
`name`	`string`
`options`?	`PropertyOptions`

Returns

Property

Inherited from

Property . jsDateTime

Source

src/entities.ts:1375

jsFloat()

static jsFloat(name, options?): Property

Parameters

Parameter	Type
`name`	`string`
`options`?	`PropertyOptions`

Returns

Property

Inherited from

Property . jsFloat

Source

src/entities.ts:1373

jsInt()

static jsInt(name, options?): Property

Parameters

Parameter	Type
`name`	`string`
`options`?	`PropertyOptions`

Returns

Property

Inherited from

Property . jsInt

Source

src/entities.ts:1371

jsString()

static jsString(name, options?): Property

Parameters

Parameter	Type
`name`	`string`
`options`?	`PropertyOptions`

Returns

Property

Inherited from

Property . jsString

Source

src/entities.ts:1374

registerAttachedProperty()

static registerAttachedProperty(typeName, property): void

Registers the attached (dynamic) property for the specified type. It is editable via the context panel, and gets saved into the view layout as well. Property getter/setter typically uses Widget's "temp" property for storing the value.

Parameters

Parameter	Type
`typeName`	`string`
`property`	`Property`

Returns

void

Inherited from

Property . registerAttachedProperty

Source

src/entities.ts:1382

string()

static string(name, getter, setter, defaultValue): Property

Creates a string property

Parameters

Parameter	Type
`name`	`string`
`getter`	`PropertyGetter`<`any`, `any`>
`setter`	`PropertySetter`<`any`, `any`>
`defaultValue`	`any`

Returns

Property

Inherited from

Property . string

Source

src/entities.ts:1349

EntityProperty

Extends​

Constructors​

new EntityProperty()​

Parameters​

Returns​

Overrides​

Source​

Properties​

Accessors​

caption​

Parameters​

Returns​

Source​

category​

Parameters​

Returns​

Source​

choices​

Parameters​

Returns​

Source​

columnFilter​

Returns​

Source​

defaultValue​

Parameters​

Returns​

Source​

description​

Parameters​

Returns​

Source​

editor​

Parameters​

Returns​

Source​

format​

Parameters​

Returns​

Source​

get​

Parameters​

Returns​

Source​

includeInLayout​

Parameters​

Returns​

Source​

max​

Parameters​

Returns​

Source​

min​

Parameters​

Returns​

Source​

name​

Parameters​

Returns​

Source​

nullable​

Parameters​

Returns​

Source​

propertyType​

Parameters​

Returns​

Source​

semType​

Parameters​

Returns​

Source​

set​

Parameters​

Returns​

Source​

showPlusMinus​

Parameters​

Returns​

Extends

Constructors

new EntityProperty()

Parameters

Returns

Overrides

Source

Properties

Accessors

caption

Parameters

Returns

Source

category

Parameters

Returns

Source

choices

Parameters

Returns

Source

columnFilter

Returns

Source

defaultValue

Parameters

Returns

Source

description

Parameters

Returns

Source

editor

Parameters

Returns

Source

format

Parameters

Returns

Source

get

Parameters

Returns

Source

includeInLayout

Parameters

Returns

Source

max

Parameters

Returns

Source

min

Parameters

Returns

Source

name

Parameters

Returns

Source

nullable

Parameters

Returns

Source

propertyType

Parameters

Returns

Source

semType

Parameters

Returns

Source

set

Parameters

Returns

Source

showPlusMinus

Parameters

Returns

Source