IProperty
Represents a property. See also Property.
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? | null | "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...) Applicable when type = Column |
defaultValue? | any | Default value used for deserialization and cloning. See also initialValue. |
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, such as '0.000' |
friendlyName? | string | Custom field friendly name shown in [PropertyGrid] |
initialValue? | any | Initial value used when initializing UI. See also defaultValue |
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. |
options? | any | Additional options. |
semType? | string | Semantic type |
showPlusMinus? | boolean | Whether a plus/minus clicker appears next to the number input. Applies to numerical columns only. |
showSlider? | boolean | Whether a slider appears next to the number input. Applies to numerical columns only. |
step? | number | Step to be used in a slider. Only applies to numerical properties. |
tags? | any | - |
type? | string | Property data type. See 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) |
viewer? | string | - |