Class: Property

dg.Property

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

Samples:

Hierarchy

• Property

  ↳ EntityProperty

Constructors

constructor

• new Property(dart)

Parameters

Name	Type
dart	any

Defined in

src/entities.ts:1203

Properties

dart

• Readonly dart: any

Defined in

src/entities.ts:1200

---

options

• options: any

Defined in

src/entities.ts:1201

Accessors

caption

• get caption(): string

Returns

string

Defined in

src/entities.ts:1223

---

category

• get category(): string

Property category

Returns

string

Defined in

src/entities.ts:1226

• set category(s): void

Parameters

Name	Type
s	string

Returns

void

Defined in

src/entities.ts:1227

---

choices

• get choices(): string[]

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

Returns

string[]

Defined in

src/entities.ts:1279

• set choices(x): void

Parameters

Name	Type
x	string[]

Returns

void

Defined in

src/entities.ts:1280

---

columnFilter

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

Column type filter

Returns

null | "string" | "bigint" | "object" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe" | "categorical" | "numerical"

Defined in

src/entities.ts:1283

---

defaultValue

• get defaultValue(): any

Default value

Returns

any

Defined in

src/entities.ts:1246

• set defaultValue(s): void

Parameters

Name	Type
s	any

Returns

void

Defined in

src/entities.ts:1247

---

description

• get description(): string

Description

Returns

string

Defined in

src/entities.ts:1238

• set description(s): void

Parameters

Name	Type
s	string

Returns

void

Defined in

src/entities.ts:1239

---

editor

• get editor(): string

Property editor

Returns

string

Defined in

src/entities.ts:1250

• set editor(s): void

Parameters

Name	Type
s	string

Returns

void

Defined in

src/entities.ts:1251

---

format

• get format(): string

Returns

string

Defined in

src/entities.ts:1261

• set format(s): void

Parameters

Name	Type
s	string

Returns

void

Defined in

src/entities.ts:1262

---

get

• get get(): PropertyGetter<any, any>

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

Returns

PropertyGetter<any, any>

Defined in

src/entities.ts:1212

• set get(x): void

Parameters

Name	Type
x	PropertyGetter<any, any>

Returns

void

Defined in

src/entities.ts:1213

---

max

• get max(): number

Returns

number

Defined in

src/entities.ts:1270

• set max(s): void

Parameters

Name	Type
s	number

Returns

void

Defined in

src/entities.ts:1271

---

min

• get min(): number

Returns

number

Defined in

src/entities.ts:1267

• set min(s): void

Parameters

Name	Type
s	number

Returns

void

Defined in

src/entities.ts:1268

---

name

• get name(): string

Property name

Returns

string

Defined in

src/entities.ts:1220

• set name(s): void

Parameters

Name	Type
s	string

Returns

void

Defined in

src/entities.ts:1221

---

nullable

• get nullable(): boolean

Nullable

Returns

boolean

Defined in

src/entities.ts:1242

• set nullable(s): void

Parameters

Name	Type
s	boolean

Returns

void

Defined in

src/entities.ts:1243

---

propertyType

• get propertyType(): TYPE

Property type

Returns

TYPE

Defined in

src/entities.ts:1230

• set propertyType(s): void

Parameters

Name	Type
s	TYPE

Returns

void

Defined in

src/entities.ts:1231

---

semType

• get semType(): string

Semantic type

Returns

string

Defined in

src/entities.ts:1234

• set semType(s): void

Parameters

Name	Type
s	string

Returns

void

Defined in

src/entities.ts:1235

---

set

• get set(): PropertySetter<any, any>

Property setter

Returns

PropertySetter<any, any>

Defined in

src/entities.ts:1216

• set set(x): void

Parameters

Name	Type
x	PropertySetter<any, any>

Returns

void

Defined in

src/entities.ts:1217

---

showPlusMinus

• get showPlusMinus(): string

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

Returns

string

Defined in

src/entities.ts:1258

• set showPlusMinus(s): void

Parameters

Name	Type
s	string

Returns

void

Defined in

src/entities.ts:1259

---

showSlider

• get showSlider(): string

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

Returns

string

Defined in

src/entities.ts:1254

• set showSlider(s): void

Parameters

Name	Type
s	string

Returns

void

Defined in

src/entities.ts:1255

---

step

• get step(): number

Returns

number

Defined in

src/entities.ts:1273

• set step(s): void

Parameters

Name	Type
s	number

Returns

void

Defined in

src/entities.ts:1274

---

userEditable

• get userEditable(): boolean

Returns

boolean

Defined in

src/entities.ts:1264

• set userEditable(s): void

Parameters

Name	Type
s	boolean

Returns

void

Defined in

src/entities.ts:1265

Methods

fromOptions

▸ fromOptions(opt?): Property

Applies the specified options

Parameters

Name	Type
opt?	PropertyOptions

Returns

Property

Defined in

src/entities.ts:1288

---

bool

▸ Static bool(name, getter, setter, defaultValue): Property

Creates a bool property

Parameters

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

Returns

Property

Defined in

src/entities.ts:1318

---

create

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

Creates a property

Parameters

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

Returns

Property

Defined in

src/entities.ts:1295

---

dateTime

▸ Static dateTime(name, getter, setter, defaultValue): Property

Creates a datetime property

Parameters

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

Returns

Property

Defined in

src/entities.ts:1323

---

float

▸ Static float(name, getter, setter, defaultValue): Property

Creates a float property

Parameters

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

Returns

Property

Defined in

src/entities.ts:1308

---

fromOptions

▸ Static fromOptions(options): Property

Parameters

Name	Type
options	PropertyOptions

Returns

Property

Defined in

src/entities.ts:1341

---

int

▸ Static int(name, getter, setter, defaultValue): Property

Creates an integer property

Parameters

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

Returns

Property

Defined in

src/entities.ts:1303

---

js

▸ Static js(name, type, options?): Property

Creates property for the JavaScript objects with the corresponding property name

Parameters

Name	Type
name	string
type	TYPE
options?	PropertyOptions

Returns

Property

Defined in

src/entities.ts:1328

---

jsBool

▸ Static jsBool(name, options?): Property

Parameters

Name	Type
name	string
options?	PropertyOptions

Returns

Property

Defined in

src/entities.ts:1336

---

jsDateTime

▸ Static jsDateTime(name, options?): Property

Parameters

Name	Type
name	string
options?	PropertyOptions

Returns

Property

Defined in

src/entities.ts:1339

---

jsFloat

▸ Static jsFloat(name, options?): Property

Parameters

Name	Type
name	string
options?	PropertyOptions

Returns

Property

Defined in

src/entities.ts:1337

---

jsInt

▸ Static jsInt(name, options?): Property

Parameters

Name	Type
name	string
options?	PropertyOptions

Returns

Property

Defined in

src/entities.ts:1335

---

jsString

▸ Static jsString(name, options?): Property

Parameters

Name	Type
name	string
options?	PropertyOptions

Returns

Property

Defined in

src/entities.ts:1338

---

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

Name	Type
typeName	string
property	Property

Returns

void

Defined in

src/entities.ts:1346

---

string

▸ Static string(name, getter, setter, defaultValue): Property

Creates a string property

Parameters

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

Returns

Property

Defined in

src/entities.ts:1313