Label

Type: Label

Extends View

Script class of the Label view.

Properties

Property Description

Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view.

enabled Enables/disables the view.

Property	Description
	Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view.
`enabled`	Enables/disables the view.
`text`	Get/Set the text displayed by the label. Label text can include macro expansion in the form $[User Scalar Name] to display units.

text

Get/Set the text displayed by the label.

Label text can include macro expansion in the form $[User Scalar Name] to display units.

View Properties

Properties defined by the view that are normally editable via properties editor.

Property	Name	Description
`label`	Label	Sets the label text.
`drag_target`	Drag Target	Enables mouse-dragging of the label to adjust the value of another view, specified using its 'script ID'.
`title`	Title	The title of the window.
`id`	Script ID	The scripting ID of the window. Can be used as an alternative to the title for searching for windows from scripts.
`tooltip`	Tool Tip	Window tool tip.
`text`	Text	Sets the label text.
`icon`	Icon	Sets the icon.
`padding_x`	Padding X	Padding in the horizontal (x) direction
`padding_y`	Padding Y	Padding in the vertical (y) direction
`text_align`	Align Horizontal	Text alignment in the horizontal (x) direction
`text_valign`	Align Vertical	Text alignment in the vertical (y) direction
`font_size`	Font Size	Size of the text.
`font_bold`	Bold Font	Enable bold/normal text.
`word_wrap`	Word Wrap	Enable word wrapping.
`divider_line`	Divider Line	Enable display of divider line (s).

Methods

Method	Description
`callListener(eventName, [args])`	Calls all event listeners for the given event name, useful for testing.
`getParent()`	Get the parent window/view (if any) of this view.
`getViewProperties()`	Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view.
`getViewProperty(id)`	Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view.
`on(eventName, callback)`	Adds an event listener for the given event name. e.g. view.on("click", function() { ... });
`pxFromDimension(dimension)`	Convert a dimension string (e.g. "10em", "50dp", "100px") into pixel units, relative to the view object. Returns the size in pixels.
`removeAllListeners([eventName])`	Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed.
`removeListener(eventName, callback)`	Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback);
`setViewProperty(id, value)`	Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view.