DataObjectView

Description

The DataObjectView object contains settings and data for representing and displaying a DataObject in a user-defined frontend. This allows modelling generic and dynamic user interfaces. None of the properties are evaluated or used by any InCore objects so that no restrictions apply. However some objects with ConfigurationItem properties may provide sensible and generic default values for some properties such as widget and widgetData.

› Inherits:

Object

› Inherited by:

MeasurementView

Overview

Properties

color decimals disabled hidden orderIndex placeholder

range readOnly stepSize toolTip widget

widgetData widgetDataMap widgetWidth Object.objectId Object.parent

Methods

Object.deserializeProperties() Object.fromJson() Object.serializeProperties() Object.toJson()

Signals

Object.completed()

Enumerations

Widget

Properties

color

This property holds the color to use for visualizing the data, e.g. the measurement curve in a plot.

This property was introduced in InCore 2.4.

› Type:

String

› Signal:

colorChanged()

› Attributes:

Writable

decimals

This property holds the number of digits after the decimal point to show for DataObject.Float or DataObject.Double data in widgets such as spinboxes.

This property was introduced in InCore 2.4.

› Type:

SignedInteger

› Default:

0

› Signal:

decimalsChanged()

› Attributes:

Writable

disabled

This property holds whether the view/widget should be disabled.

› Type:

Boolean

› Default:

false

› Signal:

disabledChanged()

› Attributes:

Writable

hidden

This property holds whether the view/widget should be hidden.

› Type:

Boolean

› Default:

false

› Signal:

hiddenChanged()

› Attributes:

Writable

orderIndex

This property holds an index which can be evaluated by a frontend do determine how to order views/widgets.

› Type:

SignedInteger

› Default:

0

› Signal:

orderIndexChanged()

› Attributes:

Writable

placeholder

This property holds the placeholder for the input widget which usually is shown if no value has been entered yet.

› Type:

String

› Signal:

placeholderChanged()

› Attributes:

Writable

range

This property holds the range which to display or allow for input, usually a minimum and a maximum value.

This property was introduced in InCore 2.4.

› Type:

List

› Signal:

rangeChanged()

› Attributes:

Writable

readOnly

This property holds whether the view/widget should be read-only. If set to true no changes should be allowed. This property is intended as an indication for the frontend only. This means even if set to true neither the DataObject nor the DataObjectView will prevent actual writes to the DataObject.data property.

› Type:

Boolean

› Default:

false

› Signal:

readOnlyChanged()

› Attributes:

Writable

stepSize

This property holds the step size for widgets such as spinboxes or sliders.

This property was introduced in InCore 2.4.

› Type:

Double

› Default:

1

› Signal:

stepSizeChanged()

› Attributes:

Writable

toolTip

This property holds the tooltip for the widget which is shown when hovering with the mouse.

› Type:

String

› Signal:

toolTipChanged()

› Attributes:

Writable

widget

This property holds an enumeration value for the frontend indicating which kind of widget to use for the related DataObject. See the Widget enumeration for details.

› Type:

DataObjectView.Widget

› Default:

DataObjectView.NoWidget

› Signal:

widgetChanged()

› Attributes:

Writable

widgetData

This property holds the data in any representation required for populating or operating the specified widget. This is mainly used for widgets that allow the user to select one or more items. In such cases a list of items can be specified here. In either case the data and its format entirely depend on the frontend used and is not processed by any InCore objects.

› Type:

Variant

› Signal:

widgetDataChanged()

› Attributes:

Writable

widgetDataMap

This property holds the widget-specific data in a special map representation. This may be required for widgets such as comboboxes where keys are used internally and values displayed as choices to the user.

› Type:

Map

› Attributes:

Readonly

widgetWidth

This property holds the width of the widget which allows specifying relative widget sizes.

› Type:

SignedInteger

› Default:

100

› Signal:

widgetWidthChanged()

› Attributes:

Writable

Enumerations

Widget

This enumeration describes predefined values for the widget property.

Name	Value	Description
DataObjectView.NoWidget	0	Use none of the predefined widgets.
DataObjectView.Label	1	Use a simple text label for informational purposes.
DataObjectView.TextInput	2	Use a text input widget allowing the user to enter text.
DataObjectView.Slider	3	Use a slider widget to quickly adjust a number value.
DataObjectView.Switch	4	Use a switch widget to toggle a boolean value.
DataObjectView.Combobox	5	Use a combobox widget to select from a number of items.
DataObjectView.Gauge	6	Display the data value in a gauge.
DataObjectView.Chart	7	Display the data value in a chart.
DataObjectView.SpinBox	8	Use a spinbox widget for number input.
DataObjectView.EditableCombobox	9	Use a combobox which allows editing the text.
DataObjectView.PasswordField	10	Use text field widget which shows asterisks instead of the actual input.
DataObjectView.TextFileField	11	a text field which also can be filled from a local text file.
DataObjectView.BinaryFilePicker	12	a widget allowing to select a file and use its content for the DataObject’s data in base64 representation.

Example

See DataObject example on how to use DataObjectView.