Skip to main content

PropertyOptions

Properties

PropertyTypeDescription
caption?string

Custom field caption shown in [PropertyGrid]

Deprecated

The property will be removed soon. Use friendlyName instead

category?stringCorresponding 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?anyDefault value (used for deserialization, cloning, etc)
description?stringProperty description
editor?stringCustom editor (such as slider or text area)
fieldName?stringName of the corresponding JavaScript field. No need to specify it if it is the same as name.
format?stringValue format
friendlyName?stringCustom field friendly name shown in [PropertyGrid]
inputType?stringProperty input type
max?numberMaximum value. Applicable to numerical properties only
min?numberMinimum value. Applicable to numerical properties only
name?stringProperty name
nullable?booleanWhether an empty value is allowed. This is used by validators.
postfix?stringField postfix shown in [PropertyGrid]. [units] take precedence over the [postfix] value.
semType?stringSemantic type
tags?any-
type?stringProperty type
units?stringUnits of measurement. See also: [postfix]
userEditable?booleanWhether 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)