Property
Defined in: js-api/src/entities/property.ts:32
Strongly-typed property associated with an object. Used for reflection, serialization, UI generation, and other introspection-dependent tasks.
Samples:
Extended by
Implements
Constructors
Constructor
new Property(
dart):Property
Defined in: js-api/src/entities/property.ts:40
Parameters
| Parameter | Type |
|---|---|
dart | any |
Returns
Property
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
dart | readonly | any | - | js-api/src/entities/property.ts:33 |
options | public | any | The union of the property's tags and its FuncParam options (tags win) — exactly what InputBase.getOption reads. Treat as readonly: writes stick only for FuncParam-backed properties without tags (those get the live options map). | js-api/src/entities/property.ts:38 |
propertyOptions | static | object | Metadata of the property options themselves (what a property editor shows for each option). | js-api/src/entities/property.ts:248 |
propertyOptions.caption? | public | IProperty & IPropertyAnnotation | Custom field caption shown in [PropertyGrid]. Alias of friendlyName; both stay. | js-api/src/entities/property-meta.ts:72 |
propertyOptions.category? | public | IProperty & IPropertyAnnotation | Corresponding category on the context panel; groups the property in a property panel. | js-api/src/entities/property-meta.ts:63 |
propertyOptions.choices? | public | IProperty & IPropertyAnnotation | List of choices. Applicable to string properties only | js-api/src/entities/property-meta.ts:56 |
propertyOptions.columnTypeFilter? | public | IProperty & IPropertyAnnotation | 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 | js-api/src/entities/property-meta.ts:110 |
propertyOptions.defaultValue? | public | IProperty & IPropertyAnnotation | Default value used for deserialization and cloning. See also initialValue. | js-api/src/entities/property-meta.ts:89 |
propertyOptions.description? | public | IProperty & IPropertyAnnotation | Property description | js-api/src/entities/property-meta.ts:32 |
propertyOptions.editor? | public | IProperty & IPropertyAnnotation | Platform editor hint ('textarea', 'password', 'switch', 'slider'), consulted next, and only for the types Dart honors it for (input_base.dart:702-728). | js-api/src/entities/property-meta.ts:60 |
propertyOptions.fieldName? | public | IProperty & IPropertyAnnotation | Name of the corresponding JavaScript field. No need to specify it if it is the same as name. | js-api/src/entities/property-meta.ts:100 |
propertyOptions.format? | public | IProperty & IPropertyAnnotation | Value format, such as '0.000', applied through DG.format where the platform is loaded. | js-api/src/entities/property-meta.ts:66 |
propertyOptions.friendlyName? | public | IProperty & IPropertyAnnotation | Custom field friendly name shown in [PropertyGrid] | js-api/src/entities/property-meta.ts:69 |
propertyOptions.get? | public | IProperty & IPropertyAnnotation | Reads the property value off an object. A property with no set renders read-only. | js-api/src/entities/property-meta.ts:80 |
propertyOptions.initialValue? | public | IProperty & IPropertyAnnotation | Initial value used when initializing UI. See also defaultValue | js-api/src/entities/property-meta.ts:86 |
propertyOptions.inputType? | public | IProperty & IPropertyAnnotation | Platform InputType ('Radio', 'Color', 'Tags'…): the editor named here wins over every other hint, as it does in input_base.dart:668. | js-api/src/entities/property-meta.ts:26 |
propertyOptions.max? | public | IProperty & IPropertyAnnotation | Maximum value. Applicable to numerical properties only | js-api/src/entities/property-meta.ts:44 |
propertyOptions.min? | public | IProperty & IPropertyAnnotation | Minimum value. Applicable to numerical properties only | js-api/src/entities/property-meta.ts:41 |
propertyOptions.name? | public | IProperty & IPropertyAnnotation | Property name | js-api/src/entities/property-meta.ts:16 |
propertyOptions.nullable? | public | IProperty & IPropertyAnnotation | Whether an empty value is allowed. This is used by validators. | js-api/src/entities/property-meta.ts:29 |
propertyOptions.options? | public | IProperty & IPropertyAnnotation | Additional options. | js-api/src/entities/property-meta.ts:105 |
propertyOptions.propertyType? | public | IProperty & IPropertyAnnotation | Property data type; same as type, and read first where both appear (as on a DG.Property). | js-api/src/entities/property-meta.ts:22 |
propertyOptions.semType? | public | IProperty & IPropertyAnnotation | Semantic type | js-api/src/entities/property-meta.ts:35 |
propertyOptions.set? | public | IProperty & IPropertyAnnotation | Writes the property value to an object. | js-api/src/entities/property-meta.ts:83 |
propertyOptions.showPlusMinus? | public | IProperty & IPropertyAnnotation | Whether a plus/minus clicker appears next to the number input. Applies to numerical columns only. | js-api/src/entities/property-meta.ts:53 |
propertyOptions.showSlider? | public | IProperty & IPropertyAnnotation | Whether a slider appears next to the number input. Applies to numerical columns only. | js-api/src/entities/property-meta.ts:50 |
propertyOptions.step? | public | IProperty & IPropertyAnnotation | Step to be used in a slider. Only applies to numerical properties. | js-api/src/entities/property-meta.ts:47 |
propertyOptions.tags? | public | IProperty & IPropertyAnnotation | - | js-api/src/entities/property-meta.ts:102 |
propertyOptions.type? | public | IProperty & IPropertyAnnotation | Property data type. See TYPE. | js-api/src/entities/property-meta.ts:19 |
propertyOptions.units? | public | IProperty & IPropertyAnnotation | Units of measurement. See also: [postfix] | js-api/src/entities/property-meta.ts:38 |
propertyOptions.userEditable? | public | IProperty & IPropertyAnnotation | Whether the property should be editable via the UI | js-api/src/entities/property-meta.ts:115 |
propertyOptions.validators? | public | IProperty & IPropertyAnnotation | 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. |
propertyOptions.valueValidators? | public | IProperty & IPropertyAnnotation | List of value validators (functions that take a value and return error message or null) | js-api/src/entities/property-meta.ts:97 |
propertyOptions.viewer? | public | IProperty & IPropertyAnnotation | - | js-api/src/entities/property-meta.ts:112 |
Accessors
caption
Get Signature
get caption():
string
Defined in: js-api/src/entities/property.ts:59
Custom field caption shown in the UI. Alias of friendlyName; both stay.
Returns
string
Set Signature
set caption(
s):void
Defined in: js-api/src/entities/property.ts:60
Custom field caption shown in [PropertyGrid]. Alias of friendlyName; both stay.
Parameters
| Parameter | Type |
|---|---|
s | string |
Returns
void
Custom field caption shown in [PropertyGrid]. Alias of friendlyName; both stay.
Implementation of
category
Get Signature
get category():
string
Defined in: js-api/src/entities/property.ts:67
Property category
Returns
string
Set Signature
set category(
s):void
Defined in: js-api/src/entities/property.ts:68
Corresponding category on the context panel; groups the property in a property panel.
Parameters
| Parameter | Type |
|---|---|
s | string |