ArcGIS Developers
Dashboard

LabelStackSeparator QML Type

A separator character in a label, where a line break may be inserted in long text. More...

Import Statement: import Esri.ArcGISRuntime 100.11
Since: Esri.ArcGISRuntime 100.11
Inherits:

Object

Properties

Signals

Detailed Description

A single separator consists of: - the separator character that should potentially be replaced by a line break - if the separator should always be used for line break - if the separator should remain visible - if the separator should appear at the end of one row, or the beginning of the next.

See also JsonSerializable.

Property Documentation

breakPosition : Enums.LabelStackSeparatorBreakPosition

The position where the separator will be written, if used and remaining visible.

Determines whether the separator code point should appear at the end of one row, or the beginning of the next, if chosen as a line break position. This does not matter if the separator is not to be visible when used. The default value is Enums.LabelStackSeparatorBreakPositionAutomatic, which will give the same behavior as Enums.LabelStackSeparatorBreakPositionAfter.


forced : bool

Whether a line break must be inserted when the separator is encountered.

The default value is false.


separator : string

A QString intended to describe one code point.

Each LabelStackSeparator specifies a code point to be looked for in the text. A code point is often thought of as a single character in the text, but may need several chars in a QString to describe it. For example: - to use a comma as a separator, the separator string would be just "," - to use a Hebrew punctuation Paseq as a separator, the separator would need to encode the code point with utf16 value "\u05c0" if your SDK uses utf16 strings (e.g. Java, c#) or with the utf8 string "\x30\x35\x63\x30" if your SDK uses utf8 strings - to use higher range unicode code points such as Aegean Word Separator Dot (which has utf32 hex value 10101), the separator would need to encode the code point with utf16 value "\ud800\udd01" if your SDK uses utf16 strings (e.g. Java, c#) or with the utf8 string "\xf0\x90\x84\x81" if your SDK uses utf8 strings.

The default value is an empty string, meaning that the LabelStackSeparator will be ignored.


visible : bool

Whether the separator should still be visible, if chosen as a line break position.

For example, a user may wish to keep a hyphenation mark at the end of a row of text, but hide a comma. The default value is false.


Signal Documentation

void breakPositionChanged()

Emitted when the breakPosition property changes.

Note: The corresponding handler is onBreakPositionChanged.


void forcedChanged()

Emitted when the forced property changes.

Note: The corresponding handler is onForcedChanged.


void separatorChanged()

Emitted when the separator property changes.

Note: The corresponding handler is onSeparatorChanged.


void visibleChanged()

Emitted when the visible property changes.

Note: The corresponding handler is onVisibleChanged.



Feedback on this topic?