GeometryEditorStyle QML Type

GeometryEditor."> GeometryEditorStyle QML Type | ArcGISQtQml
  • Esri.ArcGISRuntime
  • GeometryEditorStyle
  • Defines the visual appearance of a geometry displayed by the GeometryEditor. More...

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

    Object

    Properties

    Signals

    Detailed Description

    Each GeometryEditorTool has a GeometryEditorStyle which controls the appearance of the different elements of the GeometryEditor::geometry. You can change the symbology used for vertices, selections, lines and fills. For example, in a Feature editing workflow, you can set the lineSymbol to match the symbol of a polyline feature in order to provide visual consistency.

    When a GeometryEditorTool is created, a consistent set of default symbology appropriate for that tool type is applied to its GeometryEditorTool::style property.

    You can change the opacity of the overall style, or alternatively set different opacity (alpha) values on the individual symbols of the style, so that the underlying map components are visible through the geometry being edited.

    You can set each symbol to null - consider carefully how this can affect your workflows, as you will not be able to see, select, or otherwise interact with those GeometryEditorElement types.

    See also InteractionConfiguration and Symbol.

    Property Documentation

    [since Esri.ArcGISRuntime 200.2] boundingBoxHandleSymbol : Symbol

    The symbol used to draw control handles for interactive scaling when a scalable element is selected in the GeometryEditor and InteractionConfiguration::allowScalingSelectedElement is true.

    When the GeometryEditor::selectedElement is scalable, this symbol displays control handles to allow interactive scaling (resizing) of the element. The handles are drawn upon the bounding box (see boundingBoxSymbol). If the selected element cannot be scaled (see GeometryEditorElement::canScale) then this symbol is ignored and no handles are drawn.

    The default symbol is a white square SimpleMarkerSymbol with a black outline. Use either a MarkerSymbol or an appropriate advanced symbol if setting this property.

    This property was introduced in Esri.ArcGISRuntime 200.2.

    See also InteractionConfiguration::allowScalingSelectedElement and GeometryEditor::scaleSelectedElement(double, double, Point).


    [since Esri.ArcGISRuntime 200.2] boundingBoxSymbol : Symbol

    The symbol used to draw a bounding box when a movable, rotatable, or scalable element is selected in the GeometryEditor and InteractionConfiguration::allowScalingSelectedElement is true.

    When the GeometryEditor::selectedElement is movable, rotatable, or scalable, this symbol displays its minimum bounding box. If the selected element cannot be moved (GeometryEditorElement::canMove), rotated (GeometryEditorElement::canRotate), or scaled (GeometryEditorElement::canScale) then this symbol is ignored and no box is drawn.

    Control handles for interactively scaling the element are drawn upon the bounding box (see boundingBoxHandleSymbol).

    The default value is a dashed black SimpleLineSymbol. Use either a LineSymbol, a FillSymbol, or an appropriate advanced symbol if setting this property.

    This property was introduced in Esri.ArcGISRuntime 200.2.

    See also InteractionConfiguration::allowScalingSelectedElement and GeometryEditor::scaleSelectedElement(double, double, Point).


    feedbackLineSymbol : Symbol

    The symbol used to draw the edges currently being changed by an interactive edit, when editing polyline or polygon geometries.

    During an interactive edit, this symbol displays the current location of edges (polylines, or boundaries of polygons) that are changed by the interaction in progress. Unchanged lines remain displayed with lineSymbol.

    The default value is a dotted red SimpleLineSymbol.

    See also feedbackVertexSymbol.


    feedbackVertexSymbol : Symbol

    The symbol used to draw vertices currently being changed by an interactive edit, when editing any geometry type.

    During an interactive edit, this symbol displays the current location of vertices that are changed by the interaction in progress. Unchanged vertices remain displayed with vertexSymbol.

    Vertex numbers are not displayed for the changed vertices. The default value is the same as the default vertexSymbol.

    See also feedbackVertexSymbol and vertexTextSymbol.


    fillSymbol : Symbol

    The symbol used to fill the current geometry when editing polygon geometries.

    The default value is a red semi-transparent SimpleFillSymbol with a red outline.

    See also lineSymbol.


    lineSymbol : Symbol

    The symbol used to draw the current geometry when editing polyline geometries, and the outline of the geometry when editing polygon geometries.

    The default value is a solid red SimpleLineSymbol.

    See also feedbackLineSymbol and fillSymbol.


    midVertexSymbol : Symbol

    The symbol used to draw the mid-vertices of the current geometry when editing polygon or polyline geometries.

    Mid-vertices do not exist in the GeometryEditor::geometry, but instead exist only in the display, located between vertices in polygon and polyline geometries as a visual cue for interactive editing. When moved interactively, a new vertex is inserted at that location.

    If null, no mid-vertex is displayed. In this case, you can still insert vertices between existing vertices by selecting an existing GeometryEditorVertex and tapping on the map.

    See also GeometryEditorMidVertex, vertexSymbol, selectedMidVertexSymbol, and InteractionConfiguration::allowMidVertexSelection.


    opacity : real

    The opacity of the GeometryEditor display in the view, a value between 0 (fully transparent) and 1 (fully opaque). Default is 1.

    It can be useful to change opacity of the entire GeometryEditor display to allow features, graphics, or imagery in the underlying map view to show through the geometry editor display, which can help allow precise placement of new vertices relative to those map components.

    Alternatively, you can set opacity separately on each of the symbols used by this style, allowing you to make specific aspects of the geometry editor semi-transparent.

    See also GeometryEditor::visible.


    [since Esri.ArcGISRuntime 200.2] rotateHandleSymbol : Symbol

    The symbol used to draw a control handle for interactive rotation of the selected element, when a rotatable element is selected in the GeometryEditor and InteractionConfiguration::allowRotatingSelectedElement is true.

    When the GeometryEditor::selectedElement is rotatable, this symbol displays a control handle to allow interactive rotation of the element. The handle is drawn above the top of the bounding box (see boundingBoxSymbol). If the selected element cannot be rotated (see GeometryEditorElement::canRotate) then this symbol is ignored and no rotation handle is drawn.

    The default symbol is a black circular arrow advanced marker symbol. Use either a MarkerSymbol or an appropriate advanced symbol if setting this property.

    This property was introduced in Esri.ArcGISRuntime 200.2.

    See also InteractionConfiguration::allowRotatingSelectedElement and GeometryEditor::rotateSelectedElement.


    selectedMidVertexSymbol : Symbol

    The symbol used to draw the currently selected mid-vertex of the current geometry when editing polygon or polyline geometries.

    When a mid-vertex is selected, it is displayed with this symbol instead of midVertexSymbol.

    As soon as a mid-vertex is moved interactively, it is replaced by a vertex that is part of the GeometryEditor::geometry, and is displayed with the selectedVertexSymbol.

    See also midVertexSymbol, selectedVertexSymbol, and GeometryEditorMidVertex.


    selectedVertexSymbol : Symbol

    The symbol used to draw the currently selected vertex of the current geometry when editing any geometry type.

    This symbol can be used to emphasize the currently selected vertex, which can be useful if you require extra emphasis in addition to the selection halo, or wish to make the selected vertex a larger target for user interactions.

    See also vertexSymbol, selectedMidVertexSymbol, and GeometryEditorVertex.


    vertexSymbol : Symbol

    The symbol used to draw the vertices of the current geometry when editing any geometry type.

    Setting a larger symbol can help users on touch devices select and work with vertices, especially for field apps where users may wear thick gloves that work with touch screens.

    If null, the vertices of the geometry are not explicitly displayed. By default when using a FreehandTool, this is null, as you work with geometry parts instead of individual vertices. For a VertexTool, consider your workflow carefully before setting this property to null, as you must be able to see vertices in order to select, move, or otherwise interact with them.

    See also selectedVertexSymbol, vertexTextSymbol, and midVertexSymbol.


    vertexTextSymbol : Symbol

    The symbol used to draw vertex numbers for the current geometry. If null, no numbers are displayed.

    By default when using a FreehandTool, this symbol is null.


    Signal Documentation

    [since Esri.ArcGISRuntime 200.2] boundingBoxHandleSymbolChanged()

    Emitted when the boundingBoxHandleSymbol property changes.

    Note: The corresponding handler is onBoundingBoxHandleSymbolChanged.

    This signal was introduced in Esri.ArcGISRuntime 200.2.


    [since Esri.ArcGISRuntime 200.2] boundingBoxSymbolChanged()

    Emitted when the boundingBoxSymbol property changes.

    Note: The corresponding handler is onBoundingBoxSymbolChanged.

    This signal was introduced in Esri.ArcGISRuntime 200.2.


    feedbackLineSymbolChanged()

    Emitted when the feedbackLineSymbol property changes.

    Note: The corresponding handler is onFeedbackLineSymbolChanged.


    feedbackVertexSymbolChanged()

    Emitted when the feedbackVertexSymbol property changes.

    Note: The corresponding handler is onFeedbackVertexSymbolChanged.


    fillSymbolChanged()

    Emitted when the fillSymbol property changes.

    Note: The corresponding handler is onFillSymbolChanged.


    lineSymbolChanged()

    Emitted when the lineSymbol property changes.

    Note: The corresponding handler is onLineSymbolChanged.


    midVertexSymbolChanged()

    Emitted when the midVertexSymbol property changes.

    Note: The corresponding handler is onMidVertexSymbolChanged.


    opacityChanged()

    Emitted when the opacity property changes.

    Note: The corresponding handler is onOpacityChanged.


    [since Esri.ArcGISRuntime 200.2] rotateHandleSymbolChanged()

    Emitted when the rotateHandleSymbol property changes.

    Note: The corresponding handler is onRotateHandleSymbolChanged.

    This signal was introduced in Esri.ArcGISRuntime 200.2.


    selectedMidVertexSymbolChanged()

    Emitted when the selectedMidVertexSymbol property changes.

    Note: The corresponding handler is onSelectedMidVertexSymbolChanged.


    selectedVertexSymbolChanged()

    Emitted when the selectedVertexSymbol property changes.

    Note: The corresponding handler is onSelectedVertexSymbolChanged.


    vertexSymbolChanged()

    Emitted when the vertexSymbol property changes.

    Note: The corresponding handler is onVertexSymbolChanged.


    vertexTextSymbolChanged()

    Emitted when the vertexTextSymbol property changes.

    Note: The corresponding handler is onVertexTextSymbolChanged.


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