IPropertyMeta
Defined in: js-api/src/entities/property-meta.ts:13
The pure property-metadata vocabulary: what a form generator, a property grid or a spec registry reads off a property descriptor. See also IProperty, Property.
Extended by
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
caption? | string | Custom field caption shown in [PropertyGrid] Deprecated The property will be removed soon. Use friendlyName instead | js-api/src/entities/property-meta.ts:73 |
category? | string | Corresponding category on the context panel; groups the property in a property panel. | js-api/src/entities/property-meta.ts:63 |
choices? | string[] | List of choices. Applicable to string properties only | js-api/src/entities/property-meta.ts:56 |
description? | string | Property 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). | js-api/src/entities/property-meta.ts:60 |
format? | string | Value format, such as '0.000', applied through DG.format where the platform is loaded. | js-api/src/entities/property-meta.ts:66 |
friendlyName? | string | Custom field friendly name shown in [PropertyGrid] | js-api/src/entities/property-meta.ts:69 |
inputType? | string | 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 |
max? | number | Maximum value. Applicable to numerical properties only | js-api/src/entities/property-meta.ts:44 |
min? | number | Minimum value. Applicable to numerical properties only | js-api/src/entities/property-meta.ts:41 |
name? | string | Property name | js-api/src/entities/property-meta.ts:16 |
nullable? | boolean | Whether an empty value is allowed. This is used by validators. | js-api/src/entities/property-meta.ts:29 |
propertyType? | string | 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 |
semType? | string | Semantic type | js-api/src/entities/property-meta.ts:35 |
showPlusMinus? | boolean | Whether a plus/minus clicker appears next to the number input. Applies to numerical columns only. | js-api/src/entities/property-meta.ts:53 |
showSlider? | boolean | Whether a slider appears next to the number input. Applies to numerical columns only. | js-api/src/entities/property-meta.ts:50 |
step? | number | Step to be used in a slider. Only applies to numerical properties. | js-api/src/entities/property-meta.ts:47 |
type? | string | Property data type. See TYPE. | js-api/src/entities/property-meta.ts:19 |
units? | string | Units of measurement. See also: [postfix] | js-api/src/entities/property-meta.ts:38 |