PropertyOptions

Properties

Property	Type	Description
caption?	string	Custom field caption shown in [PropertyGrid] Deprecated The property will be removed soon. Use friendlyName instead
category?	string	Corresponding category on the context panel
choices?	string[]	List of choices. Applicable to string properties only
columnTypeFilter?	"string" | "bigint" | "object" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe" | "categorical" | "numerical"	Filter for columns, can be numerical, categorical or directly a column type (string, int...)
defaultValue?	any	Default value (used for deserialization, cloning, etc)
description?	string	Property description
editor?	string	Custom editor (such as slider or text area)
fieldName?	string	Name of the corresponding JavaScript field. No need to specify it if it is the same as name.
format?	string	Value format
friendlyName?	string	Custom field friendly name shown in [PropertyGrid]
inputType?	string	Property input type
max?	number	Maximum value. Applicable to numerical properties only
min?	number	Minimum value. Applicable to numerical properties only
name?	string	Property name
nullable?	boolean	Whether an empty value is allowed. This is used by validators.
postfix?	string	Field postfix shown in [PropertyGrid]. [units] take precedence over the [postfix] value.
semType?	string	Semantic type
tags?	any	-
type?	string	Property type
units?	string	Units of measurement. See also: [postfix]
userEditable?	boolean	Whether the property should be editable via the UI
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)