Property

Defined in: js-api/src/entities/property.ts:32

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

Samples:

Extended by

• EntityProperty

Implements

• IProperty

Constructors

Constructor

new Property(dart): Property

Defined in: js-api/src/entities/property.ts:40

Parameters

Parameter	Type
dart	any

Returns

Property

Properties

Property	Modifier	Type	Description	Defined in
dart	readonly	any	-	js-api/src/entities/property.ts:33
options	public	any	The union of the property's tags and its FuncParam options (tags win) — exactly what InputBase.getOption reads. Treat as readonly: writes stick only for FuncParam-backed properties without tags (those get the live options map).	js-api/src/entities/property.ts:38
propertyOptions	static	object	Metadata of the property options themselves (what a property editor shows for each option).	js-api/src/entities/property.ts:248
propertyOptions.caption?	public	IProperty & IPropertyAnnotation	Custom field caption shown in [PropertyGrid]. Alias of friendlyName; both stay.	js-api/src/entities/property-meta.ts:72
propertyOptions.category?	public	IProperty & IPropertyAnnotation	Corresponding category on the context panel; groups the property in a property panel.	js-api/src/entities/property-meta.ts:63
propertyOptions.choices?	public	IProperty & IPropertyAnnotation	List of choices. Applicable to string properties only	js-api/src/entities/property-meta.ts:56
propertyOptions.columnTypeFilter?	public	IProperty & IPropertyAnnotation	Filter for columns, can be numerical, numerical_no_datetime, categorical, datetime, categorical_or_datetime, or directly a column type (string, int...) Applicable when type = Column	js-api/src/entities/property-meta.ts:110
propertyOptions.defaultValue?	public	IProperty & IPropertyAnnotation	Default value used for deserialization and cloning. See also initialValue.	js-api/src/entities/property-meta.ts:89
propertyOptions.description?	public	IProperty & IPropertyAnnotation	Property description	js-api/src/entities/property-meta.ts:32
propertyOptions.editor?	public	IProperty & IPropertyAnnotation	Platform editor hint ('textarea', 'password', 'switch', 'slider'), consulted next, and only for the types Dart honors it for (input_base.dart:702-728).	js-api/src/entities/property-meta.ts:60
propertyOptions.fieldName?	public	IProperty & IPropertyAnnotation	Name of the corresponding JavaScript field. No need to specify it if it is the same as name.	js-api/src/entities/property-meta.ts:100
propertyOptions.format?	public	IProperty & IPropertyAnnotation	Value format, such as '0.000', applied through DG.format where the platform is loaded.	js-api/src/entities/property-meta.ts:66
propertyOptions.friendlyName?	public	IProperty & IPropertyAnnotation	Custom field friendly name shown in [PropertyGrid]	js-api/src/entities/property-meta.ts:69
propertyOptions.get?	public	IProperty & IPropertyAnnotation	Reads the property value off an object. A property with no set renders read-only.	js-api/src/entities/property-meta.ts:80
propertyOptions.initialValue?	public	IProperty & IPropertyAnnotation	Initial value used when initializing UI. See also defaultValue	js-api/src/entities/property-meta.ts:86
propertyOptions.inputType?	public	IProperty & IPropertyAnnotation	Platform InputType ('Radio', 'Color', 'Tags'…): the editor named here wins over every other hint, as it does in input_base.dart:668.	js-api/src/entities/property-meta.ts:26
propertyOptions.max?	public	IProperty & IPropertyAnnotation	Maximum value. Applicable to numerical properties only	js-api/src/entities/property-meta.ts:44
propertyOptions.min?	public	IProperty & IPropertyAnnotation	Minimum value. Applicable to numerical properties only	js-api/src/entities/property-meta.ts:41
propertyOptions.name?	public	IProperty & IPropertyAnnotation	Property name	js-api/src/entities/property-meta.ts:16
propertyOptions.nullable?	public	IProperty & IPropertyAnnotation	Whether an empty value is allowed. This is used by validators.	js-api/src/entities/property-meta.ts:29
propertyOptions.options?	public	IProperty & IPropertyAnnotation	Additional options.	js-api/src/entities/property-meta.ts:105
propertyOptions.propertyType?	public	IProperty & IPropertyAnnotation	Property data type; same as type, and read first where both appear (as on a DG.Property).	js-api/src/entities/property-meta.ts:22
propertyOptions.semType?	public	IProperty & IPropertyAnnotation	Semantic type	js-api/src/entities/property-meta.ts:35
propertyOptions.set?	public	IProperty & IPropertyAnnotation	Writes the property value to an object.	js-api/src/entities/property-meta.ts:83
propertyOptions.showPlusMinus?	public	IProperty & IPropertyAnnotation	Whether a plus/minus clicker appears next to the number input. Applies to numerical columns only.	js-api/src/entities/property-meta.ts:53
propertyOptions.showSlider?	public	IProperty & IPropertyAnnotation	Whether a slider appears next to the number input. Applies to numerical columns only.	js-api/src/entities/property-meta.ts:50
propertyOptions.step?	public	IProperty & IPropertyAnnotation	Step to be used in a slider. Only applies to numerical properties.	js-api/src/entities/property-meta.ts:47
propertyOptions.tags?	public	IProperty & IPropertyAnnotation	-	js-api/src/entities/property-meta.ts:102
propertyOptions.type?	public	IProperty & IPropertyAnnotation	Property data type. See TYPE.	js-api/src/entities/property-meta.ts:19
propertyOptions.units?	public	IProperty & IPropertyAnnotation	Units of measurement. See also: [postfix]	js-api/src/entities/property-meta.ts:38
propertyOptions.userEditable?	public	IProperty & IPropertyAnnotation	Whether the property should be editable via the UI	js-api/src/entities/property-meta.ts:115
propertyOptions.validators?	public	IProperty & IPropertyAnnotation	List of validators. It can include [NAMED_VALIDATORS] as well as any pre-defined function names. Signature: validator(x: DG.Type): string	null. [null] indicates that the value is valid, [string] describes a validation error.
propertyOptions.valueValidators?	public	IProperty & IPropertyAnnotation	List of value validators (functions that take a value and return error message or null)	js-api/src/entities/property-meta.ts:97
propertyOptions.viewer?	public	IProperty & IPropertyAnnotation	-	js-api/src/entities/property-meta.ts:112

Accessors

caption

Get Signature

get caption(): string

Defined in: js-api/src/entities/property.ts:59

Custom field caption shown in the UI. Alias of friendlyName; both stay.

Returns

string

Set Signature

set caption(s): void

Defined in: js-api/src/entities/property.ts:60

Custom field caption shown in [PropertyGrid]. Alias of friendlyName; both stay.

Parameters

Parameter	Type
s	string

Returns

void

Custom field caption shown in [PropertyGrid]. Alias of friendlyName; both stay.

Implementation of

IProperty.caption

---

category

Get Signature

get category(): string

Defined in: js-api/src/entities/property.ts:67

Property category

Returns

string

Set Signature

set category(s): void

Defined in: js-api/src/entities/property.ts:68

Corresponding category on the context panel; groups the property in a property panel.

Parameters

Parameter	Type
s	string

Returns

void

Corresponding category on the context panel; groups the property in a property panel.

Implementation of

IProperty.category

---

choices

Get Signature

get choices(): string[]

Defined in: js-api/src/entities/property.ts:159

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

Returns

string[]

Set Signature

set choices(x): void

Defined in: js-api/src/entities/property.ts:160

List of choices. Applicable to string properties only

Parameters

Parameter	Type
x	string[]

Returns

void

List of choices. Applicable to string properties only

Implementation of

IProperty.choices

---

columnTypeFilter

Get Signature

get columnTypeFilter(): ColumnTypeFilter | null

Defined in: js-api/src/entities/property.ts:174

Column type filter (previously "columnFilter")

Returns

ColumnTypeFilter | null

Filter for columns, can be numerical, numerical_no_datetime, categorical, datetime, categorical_or_datetime, or directly a column type (string, int...) Applicable when type = Column

Implementation of

IProperty.columnTypeFilter

---

defaultValue

Get Signature

get defaultValue(): any

Defined in: js-api/src/entities/property.ts:118

Default value

Returns

any

Set Signature

set defaultValue(s): void

Defined in: js-api/src/entities/property.ts:119

Default value used for deserialization and cloning. See also initialValue.

Parameters

Parameter	Type
s	any

Returns

void

Default value used for deserialization and cloning. See also initialValue.

Implementation of

IProperty.defaultValue

---

description

Get Signature

get description(): string

Defined in: js-api/src/entities/property.ts:101

Description

Returns

string

Set Signature

set description(s): void

Defined in: js-api/src/entities/property.ts:102

Property description

Parameters

Parameter	Type
s	string

Returns

void

Property description

Implementation of

IProperty.description

---

editor

Get Signature

get editor(): string

Defined in: js-api/src/entities/property.ts:122

Property editor

Returns

string

Set Signature

set editor(s): void

Defined in: js-api/src/entities/property.ts:123

Platform editor hint ('textarea', 'password', 'switch', 'slider'), consulted next, and only for the types Dart honors it for (input_base.dart:702-728).

Parameters

Parameter	Type
s	string

Returns

void

Platform editor hint ('textarea', 'password', 'switch', 'slider'), consulted next, and only for the types Dart honors it for (input_base.dart:702-728).

Implementation of

IProperty.editor

---

format

Get Signature

get format(): string

Defined in: js-api/src/entities/property.ts:130

Format to be used for displaying the value.

Returns

string

Set Signature

set format(s): void

Defined in: js-api/src/entities/property.ts:131

Value format, such as '0.000', applied through DG.format where the platform is loaded.

Parameters

Parameter	Type
s	string

Returns

void

Value format, such as '0.000', applied through DG.format where the platform is loaded.

Implementation of

IProperty.format

---

friendlyName

Get Signature

get friendlyName(): string

Defined in: js-api/src/entities/property.ts:63

Custom field caption shown in the UI

Returns

string

Set Signature

set friendlyName(s): void

Defined in: js-api/src/entities/property.ts:64

Custom field friendly name shown in [PropertyGrid]

Parameters

Parameter	Type
s	string

Returns

void

Custom field friendly name shown in [PropertyGrid]

Implementation of

IProperty.friendlyName

---

get

Get Signature

get get(): PropertyGetter

Defined in: js-api/src/entities/property.ts:47

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

Returns

PropertyGetter

Set Signature

set get(x): void

Defined in: js-api/src/entities/property.ts:48

Reads the property value off an object. A property with no set renders read-only.

Parameters

Parameter	Type
x	PropertyGetter

Returns

void

Reads the property value off an object. A property with no set renders read-only.

Implementation of

IProperty.get

---

includeInLayout

Get Signature

get includeInLayout(): boolean

Defined in: js-api/src/entities/property.ts:89

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

Returns

boolean

Set Signature

set includeInLayout(s): void

Defined in: js-api/src/entities/property.ts:90

Parameters

Parameter	Type
s	boolean

Returns

void

---

initialValue

Get Signature

get initialValue(): string

Defined in: js-api/src/entities/property.ts:114

Initial value used when initializing UI

Returns

string

Set Signature

set initialValue(s): void

Defined in: js-api/src/entities/property.ts:115

Initial value used when initializing UI. See also defaultValue

Parameters

Parameter	Type
s	string

Returns

void

Initial value used when initializing UI. See also defaultValue

Implementation of

IProperty.initialValue

---

inputType

Get Signature

get inputType(): string

Defined in: js-api/src/entities/property.ts:97

Input type. See also InputType

Returns

string

Set Signature

set inputType(s): void

Defined in: js-api/src/entities/property.ts:98

Platform InputType ('Radio', 'Color', 'Tags'…): the editor named here wins over every other hint, as it does in input_base.dart:668.

Parameters

Parameter	Type
s	string

Returns

void

Platform InputType ('Radio', 'Color', 'Tags'…): the editor named here wins over every other hint, as it does in input_base.dart:668.

Implementation of

IProperty.inputType

---

isOptional

Get Signature

get isOptional(): boolean

Defined in: js-api/src/entities/property.ts:110

Whether this function parameter is optional (declared with a default value). What the platform's own call machinery consults; false for non-parameter properties.

Returns

boolean

Set Signature

set isOptional(x): void

Defined in: js-api/src/entities/property.ts:111

Parameters

Parameter	Type
x	boolean

Returns

void

---

isVectorizable

Get Signature

get isVectorizable(): boolean

Defined in: js-api/src/entities/property.ts:168

Whether a function parameter of this type can accept a whole column.

Returns

boolean

---

max

Get Signature

get max(): number

Defined in: js-api/src/entities/property.ts:142

Maximum value. Used when constructing UI (sliders), validating, etc.

Returns

number

Set Signature

set max(s): void

Defined in: js-api/src/entities/property.ts:143

Maximum value. Applicable to numerical properties only

Parameters

Parameter	Type
s	number

Returns

void

Maximum value. Applicable to numerical properties only

Implementation of

IProperty.max

---

min

Get Signature

get min(): number

Defined in: js-api/src/entities/property.ts:138

Minimum value. Used when constructing UI (sliders), validating, etc.

Returns

number

Set Signature

set min(s): void

Defined in: js-api/src/entities/property.ts:139

Minimum value. Applicable to numerical properties only

Parameters

Parameter	Type
s	number

Returns

void

Minimum value. Applicable to numerical properties only

Implementation of

IProperty.min

---

name

Get Signature

get name(): string

Defined in: js-api/src/entities/property.ts:55

Property name

Returns

string

Set Signature

set name(s): void

Defined in: js-api/src/entities/property.ts:56

Property name

Parameters

Parameter	Type
s	string

Returns

void

Property name

Implementation of

IProperty.name

---

nullable

Get Signature

get nullable(): boolean

Defined in: js-api/src/entities/property.ts:105

Nullable

Returns

boolean

Set Signature

set nullable(s): void

Defined in: js-api/src/entities/property.ts:106

Whether an empty value is allowed. This is used by validators.

Parameters

Parameter	Type
s	boolean

Returns

void

Whether an empty value is allowed. This is used by validators.

Implementation of

IProperty.nullable

---

propertySubType

Get Signature

get propertySubType(): TYPE

Defined in: js-api/src/entities/property.ts:79

Property subtype

Returns

TYPE

---

propertyType

Get Signature

get propertyType(): TYPE

Defined in: js-api/src/entities/property.ts:75

Property type. Same as type

Returns

TYPE

Set Signature

set propertyType(s): void

Defined in: js-api/src/entities/property.ts:76

Property data type; same as type, and read first where both appear (as on a DG.Property).

Parameters

Parameter	Type
s	TYPE

Returns

void

Property data type; same as type, and read first where both appear (as on a DG.Property).

Implementation of

IProperty.propertyType

---

refType

Get Signature

get refType(): string | null

Defined in: js-api/src/entities/property.ts:82

Type this property points at ('User'), or null when it holds a plain value.

Returns

string | null

---

relationKind

Get Signature

get relationKind(): RELATION_KIND | null

Defined in: js-api/src/entities/property.ts:86

How the property relates to its owner in the database (RELATION_KIND) — null when it carries no database annotation, and is therefore not filterable.

Returns

RELATION_KIND | null

---

semType

Get Signature

get semType(): string

Defined in: js-api/src/entities/property.ts:93

Semantic type

Returns

string

Set Signature

set semType(s): void

Defined in: js-api/src/entities/property.ts:94

Semantic type

Parameters

Parameter	Type
s	string

Returns

void

Semantic type

Implementation of

IProperty.semType

---

set

Get Signature

get set(): PropertySetter

Defined in: js-api/src/entities/property.ts:51

Property setter

Returns

PropertySetter

Set Signature

set set(x): void

Defined in: js-api/src/entities/property.ts:52

Writes the property value to an object.

Parameters

Parameter	Type
x	PropertySetter

Returns

void

Writes the property value to an object.

Implementation of

IProperty.set

---

showPlusMinus

Get Signature

get showPlusMinus(): boolean

Defined in: js-api/src/entities/property.ts:154

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

Returns

boolean

Set Signature

set showPlusMinus(s): void

Defined in: js-api/src/entities/property.ts:155

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

Parameters

Parameter	Type
s	boolean

Returns

void

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

Implementation of

IProperty.showPlusMinus

---

showSlider

Get Signature

get showSlider(): boolean

Defined in: js-api/src/entities/property.ts:150

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

Returns

boolean

Set Signature

set showSlider(s): void

Defined in: js-api/src/entities/property.ts:151

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

Parameters

Parameter	Type
s	boolean

Returns

void

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

Implementation of

IProperty.showSlider

---

step

Get Signature

get step(): number

Defined in: js-api/src/entities/property.ts:146

Step to be used in a slider. Only applies to numerical properties.

Returns

number

Set Signature

set step(s): void

Defined in: js-api/src/entities/property.ts:147

Step to be used in a slider. Only applies to numerical properties.

Parameters

Parameter	Type
s	number

Returns

void

Step to be used in a slider. Only applies to numerical properties.

Implementation of

IProperty.step

---

type

Get Signature

get type(): TYPE

Defined in: js-api/src/entities/property.ts:71

Property type. Same as propertyType

Returns

TYPE

Set Signature

set type(s): void

Defined in: js-api/src/entities/property.ts:72

Property data type. See TYPE.

Parameters

Parameter	Type
s	TYPE

Returns

void

Property data type. See TYPE.

Implementation of

IProperty.type

---

units

Get Signature

get units(): string

Defined in: js-api/src/entities/property.ts:126

Units of measurement.

Returns

string

Set Signature

set units(s): void

Defined in: js-api/src/entities/property.ts:127

Units of measurement. See also: [postfix]

Parameters

Parameter	Type
s	string

Returns

void

Units of measurement. See also: [postfix]

Implementation of

IProperty.units

---

userEditable

Get Signature

get userEditable(): boolean

Defined in: js-api/src/entities/property.ts:134

Whether a user can edit this property from the UI.

Returns

boolean

Set Signature

set userEditable(s): void

Defined in: js-api/src/entities/property.ts:135

Whether the property should be editable via the UI

Parameters

Parameter	Type
s	boolean

Returns

void

Whether the property should be editable via the UI

Implementation of

IProperty.userEditable

---

validators

Get Signature

get validators(): string[]

Defined in: js-api/src/entities/property.ts:164

Validation conditions to be checked when editing the property. See also PropertyValidator.

Returns

string[]

Set Signature

set validators(x): void

Defined in: js-api/src/entities/property.ts:165

List of validators. It can include [NAMED_VALIDATORS] as well as any pre-defined function names. Signature: validator(x: DG.Type): string | null. [null] indicates that the value is valid, [string] describes a validation error.

Parameters

Parameter	Type
x	string[]

Returns

void

List of validators. It can include [NAMED_VALIDATORS] as well as any pre-defined function names. Signature: validator(x: DG.Type): string | null. [null] indicates that the value is valid, [string] describes a validation error.

Implementation of

IProperty.validators

---

vectorName

Get Signature

get vectorName(): string

Defined in: js-api/src/entities/property.ts:171

Name of the vector (column) counterpart of this parameter.

Returns

string

Methods

fromOptions()

fromOptions(opt?): Property

Defined in: js-api/src/entities/property.ts:179

Applies the specified options

Parameters

Parameter	Type
opt?	IProperty

Returns

Property

---

bool()

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

Defined in: js-api/src/entities/property.ts:209

Creates a bool property

Parameters

Parameter	Type
name	string
getter	PropertyGetter
setter	PropertySetter
defaultValue	any

Returns

Property

---

create()

static create(name, type, getter, setter, defaultValue?): Property

Defined in: js-api/src/entities/property.ts:186

Creates a property

Parameters

Parameter	Type	Default value
name	string	undefined
type	"string" | "bigint" | "object" | "map" | "file" | "bool" | "int" | "double" | "byte_array" | "datetime" | "qnum" | "dataframe" | "numerical" | "categorical" | "num" | "string_list" | "dataframe_list" | "cell" | "column" | "column_list" | "graphics" | "blob" | "tablerowfiltercall" | "colfiltercall" | "bitset" | "dynamic" | "viewer" | "list" | "semantic_value" | "func" | "funccall" | "property" | "GridCellRenderArgs" | "element" | "view" | "TableView" | "User" | "Menu" | "Project" | "event_data" | "progressindicator" | "Credentials" | "ScriptEnvironment" | "Notebook"	undefined
getter	PropertyGetter	undefined
setter	PropertySetter	undefined
defaultValue	any	null

Returns

Property

---

dateTime()

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

Defined in: js-api/src/entities/property.ts:214

Creates a datetime property

Parameters

Parameter	Type
name	string
getter	PropertyGetter
setter	PropertySetter
defaultValue	any

Returns

Property

---

float()

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

Defined in: js-api/src/entities/property.ts:199

Creates a float property

Parameters

Parameter	Type
name	string
getter	PropertyGetter
setter	PropertySetter
defaultValue	any

Returns

Property

---

fromOptions()

static fromOptions(options): Property

Defined in: js-api/src/entities/property.ts:238

Parameters

Parameter	Type
options	IProperty

Returns

Property

---

int()

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

Defined in: js-api/src/entities/property.ts:194

Creates an integer property

Parameters

Parameter	Type
name	string
getter	PropertyGetter
setter	PropertySetter
defaultValue	any

Returns

Property

---

js()

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

Defined in: js-api/src/entities/property.ts:219

Creates property for the JavaScript objects with the corresponding property name

Parameters

Parameter	Type
name	string
type	TYPE
options?	IProperty

Returns

Property

---

jsBool()

static jsBool(name, options?): Property

Defined in: js-api/src/entities/property.ts:230

Boolean property backed by the JavaScript field [name].

Parameters

Parameter	Type
name	string
options?	IProperty

Returns

Property

---

jsDateTime()

static jsDateTime(name, options?): Property

Defined in: js-api/src/entities/property.ts:236

Datetime property backed by the JavaScript field [name].

Parameters

Parameter	Type
name	string
options?	IProperty

Returns

Property

---

jsFloat()

static jsFloat(name, options?): Property

Defined in: js-api/src/entities/property.ts:232

Float property backed by the JavaScript field [name].

Parameters

Parameter	Type
name	string
options?	IProperty

Returns

Property

---

jsInt()

static jsInt(name, options?): Property

Defined in: js-api/src/entities/property.ts:228

Integer property backed by the JavaScript field [name].

Parameters

Parameter	Type
name	string
options?	IProperty

Returns

Property

---

jsString()

static jsString(name, options?): Property

Defined in: js-api/src/entities/property.ts:234

String property backed by the JavaScript field [name].

Parameters

Parameter	Type
name	string
options?	IProperty

Returns

Property

---

registerAttachedProperty()

static registerAttachedProperty(typeName, property): void

Defined in: js-api/src/entities/property.ts:243

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

---

string()

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

Defined in: js-api/src/entities/property.ts:204

Creates a string property

Parameters

Parameter	Type
name	string
getter	PropertyGetter
setter	PropertySetter
defaultValue	any

Returns

Property