Properties

Properties system for data input and formatting.

Classes

Name Description  
BaseQuantityDescription Base Quantity Property Description Beta
PropertyRecord PropertyRecord contains instance information about a Property, including a Beta

Enumerations

Name Description  
AlternateDateFormats Alternate Data Formats that can be provide by javascript. Beta
PropertyEditorParamTypes Enum for Property Editor Param Types Beta
PropertyValueFormat Enumeration for Format of the property value. Beta
StandardEditorNames Standard Editor Names for property editors. Beta
StandardTypeNames Standard Type Names for converters and editors. Beta
TimeDisplay Enum that defines supported time formats. Beta

Global Functions

Name Description  
isButtonGroupEditorParams ButtonGroupEditorParams type guard. Beta
isColorEditorParams ColorEditorParams type guard. Beta
isCustomFormattedNumberParams CustomFormattedNumberParams type guard. Beta
isIconListEditorParams IconListEditorParams type guard. Beta
isInputEditorSizeParams InputEditorSizeParams type guard. Beta
isSuppressLabelEditorParams SuppressLabelEditorParams type guard. Beta

Interfaces

Name Description  
ArrayValue Array property value Beta
BasePropertyEditorParams BasePropertyEditorParams Base interface for Property Editor Params Beta
BasePropertyValue Base interface for a property value Beta
ButtonGroupEditorParams ButtonGroupEditorParams Parameters used by EnumButtonGroupEditor to define icons in button group. Beta
ColorEditorParams ColorEditorParams Parameters used to populate color type editor with a specific set of colors. Beta
CustomFormattedNumberParams Parameters used with properties that want to control parsing and formatting. Beta
DateFormatter Interface used to provide a custom Date Time formatter and optional parser Beta
EnumerationChoice Information about an enumeration choice Beta
EnumerationChoicesInfo Information about a set of enumeration choices Beta
IconDefinition IconDefinition Information about an icon displayed next to a property editor. Beta
IconEditorParams Parameters used to display an icon next to property editor. Beta
IconListEditorParams IconListEditorParams Parameters used to populate icon type editor with a specific set of icons. Beta
ImageCheckBoxParams Parameters for ImageCheckBoxEditor Beta
InputEditorSizeParams InputEditorSizeParams type guard. Beta
LinkElementsInfo Properties for the PropertyRecord with link info supplied Beta
MultilineTextEditorParams Parameter that is used to indicate that a multiline text editor should be created. Beta
ParseResults defines Results of parsing a string input by a user into its desired value type Beta
PrimitiveValue Primitive property value Beta
PropertyConverterInfo Information about a Property Converter Beta
PropertyDescription PropertyDescription contains metadata about a Property Beta
PropertyEditorInfo Information about a Property Editor Beta
PropertyRendererInfo Property renderer identification and customization attributes Beta
RangeEditorParams Parameters used by PropertyEditors that support defining a minimum and maximum value. Beta
SliderEditorParams Parameters used to indicate that a Slider should be presented for the property Beta
StructValue Struct property value Beta
SuppressLabelEditorParams SuppressLabelEditorParams Parameters used to suppress the label for a type editor in the ToolSettings widget. Beta

Namespaces

Name Description  
Primitives Primitive Property Value Types. Beta

Type Aliases

Name Description  
PropertyEditorParams Type definition for Property Editor params Beta
PropertyValue Type for all property values Beta

Last Updated: 15 October, 2020