NamedProperty
Defined in: js-api/src/u2core/protocol.ts:64
A property whose name is guaranteed — what descriptors and bind steps carry.
Extends
Extended by
Properties
| Property | Type | Description | Overrides | Inherited from | Defined in |
|---|---|---|---|---|---|
caption? | string | Custom field caption shown in [PropertyGrid] Deprecated The property will be removed soon. Use friendlyName instead | - | IProperty.caption | js-api/src/entities/property-meta.ts:73 |
category? | string | Corresponding category on the context panel; groups the property in a property panel. | - | IProperty.category | js-api/src/entities/property-meta.ts:63 |
choices? | string[] | List of choices. Applicable to string properties only | - | IProperty.choices | js-api/src/entities/property-meta.ts:56 |
columnTypeFilter? | ColumnTypeFilter | null | Filter for columns, can be numerical, numerical_no_datetime, categorical, datetime, categorical_or_datetime, or directly a column type (string, int...) Applicable when type = Column | - | IProperty.columnTypeFilter | js-api/src/entities/property-meta.ts:111 |
defaultValue? | any | Default value used for deserialization and cloning. See also initialValue. | - | IProperty.defaultValue | js-api/src/entities/property-meta.ts:90 |
description? | string | Property description | - | IProperty.description | js-api/src/entities/property-meta.ts:32 |
editor? | string | Platform editor hint ('textarea', 'password', 'switch', 'slider'), consulted next, and only for the types Dart honors it for (input_base.dart:702-728). | - | IProperty.editor | js-api/src/entities/property-meta.ts:60 |
fieldName? | string | Name of the corresponding JavaScript field. No need to specify it if it is the same as name. | - | IProperty.fieldName | js-api/src/entities/property-meta.ts:101 |
format? | string | Value format, such as '0.000', applied through DG.format where the platform is loaded. | - | IProperty.format | js-api/src/entities/property-meta.ts:66 |
friendlyName? | string | Custom field friendly name shown in [PropertyGrid] | - | IProperty.friendlyName | js-api/src/entities/property-meta.ts:69 |
get? | PropertyGetter | Reads the property value off an object. A property with no set renders read-only. | - | IProperty.get | js-api/src/entities/property-meta.ts:81 |
initialValue? | any | Initial value used when initializing UI. See also defaultValue | - | IProperty.initialValue | js-api/src/entities/property-meta.ts:87 |
inputType? | string | Platform InputType ('Radio', 'Color', 'Tags'…): the editor named here wins over every other hint, as it does in input_base.dart:668. | - | IProperty.inputType | js-api/src/entities/property-meta.ts:26 |
max? | number | Maximum value. Applicable to numerical properties only | - | IProperty.max | js-api/src/entities/property-meta.ts:44 |
min? | number | Minimum value. Applicable to numerical properties only | - | IProperty.min | js-api/src/entities/property-meta.ts:41 |
name | string | Property name | IProperty.name | - | js-api/src/u2core/protocol.ts:65 |
nullable? | boolean | Whether an empty value is allowed. This is used by validators. | - | IProperty.nullable | js-api/src/entities/property-meta.ts:29 |
options? | any | Additional options. | - | IProperty.options | js-api/src/entities/property-meta.ts:106 |
propertyType? | string | Property data type; same as type, and read first where both appear (as on a DG.Property). | - | IProperty.propertyType | js-api/src/entities/property-meta.ts:22 |
semType? | string | Semantic type | - | IProperty.semType | js-api/src/entities/property-meta.ts:35 |
set? | PropertySetter | Writes the property value to an object. | - | IProperty.set | js-api/src/entities/property-meta.ts:84 |
showPlusMinus? | boolean | Whether a plus/minus clicker appears next to the number input. Applies to numerical columns only. | - | IProperty.showPlusMinus | js-api/src/entities/property-meta.ts:53 |
showSlider? | boolean | Whether a slider appears next to the number input. Applies to numerical columns only. | - | IProperty.showSlider | js-api/src/entities/property-meta.ts:50 |
step? | number | Step to be used in a slider. Only applies to numerical properties. | - | IProperty.step | js-api/src/entities/property-meta.ts:47 |
tags? | any | - | - | IProperty.tags | js-api/src/entities/property-meta.ts:103 |
type? | string | Property data type. See TYPE. | - | IProperty.type | js-api/src/entities/property-meta.ts:19 |
units? | string | Units of measurement. See also: [postfix] | - | IProperty.units | js-api/src/entities/property-meta.ts:38 |
userEditable? | boolean | Whether the property should be editable via the UI | - | IProperty.userEditable | js-api/src/entities/property-meta.ts:116 |
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. | - | IProperty.validators |
valueValidators? | ValueValidator<any>[] | List of value validators (functions that take a value and return error message or null) | - | IProperty.valueValidators | js-api/src/entities/property-meta.ts:98 |
viewer? | string | - | - | IProperty.viewer | js-api/src/entities/property-meta.ts:113 |