IProperty

Defined in: src/entities/property.ts:18

Represents a property. See also Property.

Properties

Property	Type	Description	Defined in
caption?	string	Custom field caption shown in [PropertyGrid] Deprecated The property will be removed soon. Use friendlyName instead	src/entities/property.ts:87
category?	string	Corresponding category on the context panel	src/entities/property.ts:69
choices?	string[]	List of choices. Applicable to string properties only	src/entities/property.ts:57
columnTypeFilter?	"string" | "bigint" | "object" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe" | "categorical" | "numerical" | null	Filter for columns, can be numerical, categorical or directly a column type (string, int...) Applicable when type = Column	src/entities/property.ts:102
defaultValue?	any	Default value used for deserialization and cloning. See also initialValue.	src/entities/property.ts:63
description?	string	Property description	src/entities/property.ts:33
editor?	string	Custom editor (such as slider or text area)	src/entities/property.ts:66
fieldName?	string	Name of the corresponding JavaScript field. No need to specify it if it is the same as name.	src/entities/property.ts:93
format?	string	Value format, such as '0.000'	src/entities/property.ts:72
friendlyName?	string	Custom field friendly name shown in [PropertyGrid]	src/entities/property.ts:90
initialValue?	any	Initial value used when initializing UI. See also defaultValue	src/entities/property.ts:60
inputType?	string	Property input type	src/entities/property.ts:27
max?	number	Maximum value. Applicable to numerical properties only	src/entities/property.ts:45
min?	number	Minimum value. Applicable to numerical properties only	src/entities/property.ts:42
name?	string	Property name	src/entities/property.ts:21
nullable?	boolean	Whether an empty value is allowed. This is used by validators.	src/entities/property.ts:30
options?	any	Additional options.	src/entities/property.ts:98
semType?	string	Semantic type	src/entities/property.ts:36
showPlusMinus?	boolean	Whether a plus/minus clicker appears next to the number input. Applies to numerical columns only.	src/entities/property.ts:54
showSlider?	boolean	Whether a slider appears next to the number input. Applies to numerical columns only.	src/entities/property.ts:51
step?	number	Step to be used in a slider. Only applies to numerical properties.	src/entities/property.ts:48
tags?	any	-	src/entities/property.ts:95
type?	string	Property data type. See TYPE.	src/entities/property.ts:24
units?	string	Units of measurement. See also: [postfix]	src/entities/property.ts:39
userEditable?	boolean	Whether the property should be editable via the UI	src/entities/property.ts:75
validators?	string[]	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.
valueValidators?	ValueValidator<any>[]	List of value validators (functions that take a value and return error message or null)	src/entities/property.ts:83
viewer?	string	-	src/entities/property.ts:105