LabelStackSeparator QML Type

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

    Import Statement: import Esri.ArcGISRuntime
    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 string 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 string to describe it.

    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

    breakPositionChanged()

    Emitted when the breakPosition property changes.

    Note: The corresponding handler is onBreakPositionChanged.


    [since Esri.ArcGISRuntime 100.12] forcedChanged()

    Emitted when the forced property changes.

    Note: The corresponding handler is onForcedChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.12.


    separatorChanged()

    Emitted when the separator property changes.

    Note: The corresponding handler is onSeparatorChanged.


    [since Esri.ArcGISRuntime 100.12] visibleChanged()

    Emitted when the visible property changes.

    Note: The corresponding handler is onVisibleChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.12.


    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.