java.lang.Object
com.esri.arcgisruntime.mapping.view.SketchStyle
Deprecated, for removal: This API element is subject to removal in a future version.
Defines a set of styles used for the visual appearance of the sketch geometry during editing.
It controls the appearance of vertices, selections, line and fill symbols as well as feedback graphics. Where available
the symbols can be
MultilayerSymbol
instances. The last value set for a
particular symbol takes precedence i.e. calling setFillSymbol(FillSymbol)
after
setMultilayerFillSymbol(MultilayerPolygonSymbol)
will cause the FillSymbol
to replace the
MultilayerPolygonSymbol
and getMultilayerFillSymbol()
will return null. By default the styles are
not multilayer symbols.- Since:
- 100.1.0
-
Constructor Summary
ConstructorDescriptionDeprecated, for removal: This API element is subject to removal in a future version.Constructs the default SketchStyle object. -
Method Summary
Modifier and TypeMethodDescriptionDeprecated, for removal: This API element is subject to removal in a future version.Gets the symbol used to display feedback when editing polygon geometries.Deprecated, for removal: This API element is subject to removal in a future version.Gets the symbol used to display feedback when editing line geometries.Deprecated, for removal: This API element is subject to removal in a future version.Gets the symbol used to display feedback when editing point geometries.Deprecated, for removal: This API element is subject to removal in a future version.Gets the symbol used to fill polygons.Deprecated, for removal: This API element is subject to removal in a future version.Gets the symbol for symbolizing a line geometry.Deprecated, for removal: This API element is subject to removal in a future version.Gets the symbol used to display middle point geometry between two vertices.Deprecated, for removal: This API element is subject to removal in a future version.Gets the multilayer symbol used to display feedback when editing polygon geometries.Deprecated, for removal: This API element is subject to removal in a future version.Gets the multilayer symbol used to display feedback when editing line geometries.Deprecated, for removal: This API element is subject to removal in a future version.Gets the multilayer symbol used to display feedback when editing point geometries.Deprecated, for removal: This API element is subject to removal in a future version.Gets the multiayer symbol used to fill polygons.Deprecated, for removal: This API element is subject to removal in a future version.Gets the multilayer symbol for symbolizing a line geometry.Deprecated, for removal: This API element is subject to removal in a future version.Gets the multilayer symbol used to display middle point geometry between two vertices.Deprecated, for removal: This API element is subject to removal in a future version.Gets the multilayer symbol used to display the selected middle vertex.Deprecated, for removal: This API element is subject to removal in a future version.Gets the multilayer symbol to display the selected vertex.Deprecated, for removal: This API element is subject to removal in a future version.Gets the multilayer symbol used to display the vertices.Deprecated, for removal: This API element is subject to removal in a future version.Gets the symbol used to display the selected middle vertex.Deprecated, for removal: This API element is subject to removal in a future version.Gets the symbol to display the selected vertex.Deprecated, for removal: This API element is subject to removal in a future version.Gets the symbol used to display the vertices.Deprecated, for removal: This API element is subject to removal in a future version.Gets the symbol to display the text over vertices when number labeling is enabled for vertices.boolean
Deprecated, for removal: This API element is subject to removal in a future version.Indicates if every vertex in the sketch is labeled with a number.void
setFeedbackFillSymbol
(FillSymbol feedbackFillSymbol) Deprecated, for removal: This API element is subject to removal in a future version.Sets the symbol used to display feedback when editing polygon geometries.void
setFeedbackLineSymbol
(LineSymbol feedbackLineSymbol) Deprecated, for removal: This API element is subject to removal in a future version.Sets the symbol used to display feedback when editing line geometries.void
setFeedbackVertexSymbol
(MarkerSymbol feedbackVertexSymbol) Deprecated, for removal: This API element is subject to removal in a future version.Sets the symbol used to display feedback when editing point geometries.void
setFillSymbol
(FillSymbol fillSymbol) Deprecated, for removal: This API element is subject to removal in a future version.Sets the symbol used to fill polygons.void
setLineSymbol
(LineSymbol lineSymbol) Deprecated, for removal: This API element is subject to removal in a future version.Sets the symbol for symbolizing a line geometry.void
setMidVertexSymbol
(MarkerSymbol midVertexSymbol) Deprecated, for removal: This API element is subject to removal in a future version.Sets the symbol used to display the point between two vertices.void
setMultilayerFeedbackFillSymbol
(MultilayerPolygonSymbol feedbackFillSymbol) Deprecated, for removal: This API element is subject to removal in a future version.Sets the multilayer symbol used to display feedback when editing polygon geometries.void
setMultilayerFeedbackLineSymbol
(MultilayerPolylineSymbol feedbackLineSymbol) Deprecated, for removal: This API element is subject to removal in a future version.Sets the multilayer symbol used to display feedback when editing line geometries.void
setMultilayerFeedbackVertexSymbol
(MultilayerPointSymbol feedbackVertexSymbol) Deprecated, for removal: This API element is subject to removal in a future version.Sets the multilayer symbol used to display feedback when editing point geometries.void
setMultilayerFillSymbol
(MultilayerPolygonSymbol fillSymbol) Deprecated, for removal: This API element is subject to removal in a future version.Sets the multilayer symbol used to fill polygons.void
setMultilayerLineSymbol
(MultilayerPolylineSymbol lineSymbol) Deprecated, for removal: This API element is subject to removal in a future version.Sets the multilayer symbol for symbolizing a line geometry.void
setMultilayerMidVertexSymbol
(MultilayerPointSymbol midVertexSymbol) Deprecated, for removal: This API element is subject to removal in a future version.Sets the multilayer symbol used to display the point between two vertices.void
setMultilayerSelectedMidVertexSymbol
(MultilayerPointSymbol selectedMidVertexSymbol) Deprecated, for removal: This API element is subject to removal in a future version.Sets the multilayer symbol used to display the selected middle vertex.void
setMultilayerSelectedVertexSymbol
(MultilayerPointSymbol selectedVertexSymbol) Deprecated, for removal: This API element is subject to removal in a future version.Sets the multilayer symbol to display the selected vertex.void
setMultilayerVertexSymbol
(MultilayerPointSymbol vertexSymbol) Deprecated, for removal: This API element is subject to removal in a future version.Sets the multilayer symbol used to display the vertices.void
setSelectedMidVertexSymbol
(MarkerSymbol selectedMidVertexSymbol) Deprecated, for removal: This API element is subject to removal in a future version.Sets the symbol used to display the selected middle vertex.void
setSelectedVertexSymbol
(MarkerSymbol selectedVertexSymbol) Deprecated, for removal: This API element is subject to removal in a future version.Sets the symbol to display the selected vertex.void
setShowNumbersForVertices
(boolean showNumbersForVertices) Deprecated, for removal: This API element is subject to removal in a future version.Sets whether or not the vertices of the sketch geometry are labelled with numbers.void
setVertexSymbol
(MarkerSymbol vertexSymbol) Deprecated, for removal: This API element is subject to removal in a future version.Sets the symbol used to display the vertices.void
setVertexTextSymbol
(TextSymbol vertexTextSymbol) Deprecated, for removal: This API element is subject to removal in a future version.Sets the symbol to display the text over vertices when number labelling is enabled for vertices.
-
Constructor Details
-
SketchStyle
public SketchStyle()Deprecated, for removal: This API element is subject to removal in a future version.Constructs the default SketchStyle object. By default, the symbols for sketch style are set as follows:- vertex symbol: a MarkerSymbol with square style, red color, size 14
- middle vertex symbol: a MarkerSymbol with circle style, white color, light red outline, size 10
- line symbol: a LineSymbol with solid style, red color, size 1
- fill symbol: a FillSymbol with solid style, red color, the default line symbol as outline
- feedback vertex symbol: a MarkerSymbol with circle style, red color, the default line symbol as outline, size 28
- feedback line symbol: a LineSymbol with dash style, red color, size 1
- feedback fill symbol: a FillSymbol with solid style, red color, the default feedback line symbol as outline
- Since:
- 100.1.0
-
-
Method Details
-
isShowNumbersForVertices
public boolean isShowNumbersForVertices()Deprecated, for removal: This API element is subject to removal in a future version.Indicates if every vertex in the sketch is labeled with a number.- Returns:
- true if every vertex in the sketch is labeled with a sequential number, false otherwise
- Since:
- 100.1.0
-
setShowNumbersForVertices
public void setShowNumbersForVertices(boolean showNumbersForVertices) Deprecated, for removal: This API element is subject to removal in a future version.Sets whether or not the vertices of the sketch geometry are labelled with numbers.- Parameters:
showNumbersForVertices
- true to show vertices with number labels, false otherwise- Since:
- 100.1.0
-
getFillSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Gets the symbol used to fill polygons. Will return null if a multilayer symbol is being used to symbolize this.- Returns:
- the symbol used to fill a polygon geometry, or null
- Since:
- 100.1.0
-
getMultilayerFillSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Gets the multiayer symbol used to fill polygons. Will return null if a non-multilayer symbol is being used to symbolize this.- Returns:
- the symbol used to fill a polygon geometry, or null
- Since:
- 100.5.0
-
setFillSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Sets the symbol used to fill polygons.- Parameters:
fillSymbol
- the symbol to fill a polygon geometry- Throws:
IllegalArgumentException
- if the fillSymbol is null- Since:
- 100.1.0
-
setMultilayerFillSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Sets the multilayer symbol used to fill polygons.- Parameters:
fillSymbol
- the symbol to fill a polygon geometry- Throws:
IllegalArgumentException
- if the fillSymbol is null- Since:
- 100.5.0
-
getLineSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Gets the symbol for symbolizing a line geometry. Will return null if a multilayer symbol is being used to symbolize this.- Returns:
- the symbol for symbolizing a line geometry, or null
- Since:
- 100.1.0
-
getMultilayerLineSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Gets the multilayer symbol for symbolizing a line geometry. Will return null if a non-multilayer symbol is being used to symbolize this.- Returns:
- the symbol for symbolizing a line geometry, or null
- Since:
- 100.5.0
-
setLineSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Sets the symbol for symbolizing a line geometry.- Parameters:
lineSymbol
- the symbol for symbolizing a line geometry- Throws:
IllegalArgumentException
- if the lineSymbol is null- Since:
- 100.1.0
-
setMultilayerLineSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Sets the multilayer symbol for symbolizing a line geometry.- Parameters:
lineSymbol
- the symbol for symbolizing a line geometry- Throws:
IllegalArgumentException
- if the lineSymbol is null- Since:
- 100.5.0
-
getVertexSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Gets the symbol used to display the vertices. Will return null if a multilayer symbol is being used to symbolize this.- Returns:
- the symbol to symbolize a point geometry, or null
- Since:
- 100.1.0
-
getMultilayerVertexSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Gets the multilayer symbol used to display the vertices. Will return null if a non-multilayer symbol is being used to symbolize this.- Returns:
- the symbol to symbolize a point geometry, or null
- Since:
- 100.5.0
-
setVertexSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Sets the symbol used to display the vertices.- Parameters:
vertexSymbol
- the symbol used to symbolize vertices- Throws:
IllegalArgumentException
- if the vertexSymbol is null- Since:
- 100.1.0
-
setMultilayerVertexSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Sets the multilayer symbol used to display the vertices.- Parameters:
vertexSymbol
- the symbol used to symbolize vertices- Throws:
IllegalArgumentException
- if the vertexSymbol is null- Since:
- 100.5.0
-
getFeedbackFillSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Gets the symbol used to display feedback when editing polygon geometries. Will return null if a multilayer symbol is being used to symbolize this feedback.- Returns:
- the symbol that is used to symbolize a polygon geometry for feedback, or null
- Since:
- 100.1.0
-
getMultilayerFeedbackFillSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Gets the multilayer symbol used to display feedback when editing polygon geometries. Will return null if a non-multilayer symbol is being used to symbolize this feedback.- Returns:
- the symbol that is used to symbolize a polygon geometry for feedback, or null
- Since:
- 100.5.0
-
setFeedbackFillSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Sets the symbol used to display feedback when editing polygon geometries.- Parameters:
feedbackFillSymbol
- the symbol to symbolize a polygon geometry for feedback- Throws:
IllegalArgumentException
- if the feedbackFillSymbol is null- Since:
- 100.1.0
-
setMultilayerFeedbackFillSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Sets the multilayer symbol used to display feedback when editing polygon geometries.- Parameters:
feedbackFillSymbol
- the symbol to symbolize a polygon geometry for feedback- Throws:
IllegalArgumentException
- if the feedbackFillSymbol is null- Since:
- 100.5.0
-
getFeedbackLineSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Gets the symbol used to display feedback when editing line geometries. Will return null if a multilayer symbol is being used to symbolize this feedback.- Returns:
- the symbol used to display feedback when editing line geometries, or null
- Since:
- 100.1.0
-
getMultilayerFeedbackLineSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Gets the multilayer symbol used to display feedback when editing line geometries. Will return null if a non-multilayer symbol is being used to symbolize this feedback.- Returns:
- the symbol used to display feedback when editing line geometries, or null
- Since:
- 100.5.0
-
setFeedbackLineSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Sets the symbol used to display feedback when editing line geometries.- Parameters:
feedbackLineSymbol
- the symbol used to display feedback when editing line geometries- Throws:
IllegalArgumentException
- if the feedbackLineSymbol is null- Since:
- 100.1.0
-
setMultilayerFeedbackLineSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Sets the multilayer symbol used to display feedback when editing line geometries.- Parameters:
feedbackLineSymbol
- the symbol used to display feedback when editing line geometries- Throws:
IllegalArgumentException
- if the feedbackLineSymbol is null- Since:
- 100.5.0
-
getFeedbackVertexSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Gets the symbol used to display feedback when editing point geometries. Will return null if a multilayer symbol is being used to symbolize this feedback.- Returns:
- the symbol used to display feedback when editing point geometries, or null
- Since:
- 100.1.0
-
getMultilayerFeedbackVertexSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Gets the multilayer symbol used to display feedback when editing point geometries. Will return null if a non-multilayer symbol is being used to symbolize this feedback.- Returns:
- the symbol used to display feedback when editing point geometries, or null
- Since:
- 100.5.0
-
setFeedbackVertexSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Sets the symbol used to display feedback when editing point geometries.- Parameters:
feedbackVertexSymbol
- the symbol used to display feedback when editing point geometries- Throws:
IllegalArgumentException
- if the feedbackVertexSymbol is null- Since:
- 100.1.0
-
setMultilayerFeedbackVertexSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Sets the multilayer symbol used to display feedback when editing point geometries.- Parameters:
feedbackVertexSymbol
- the symbol used to display feedback when editing point geometries- Throws:
IllegalArgumentException
- if the feedbackVertexSymbol is null- Since:
- 100.5.0
-
getMidVertexSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Gets the symbol used to display middle point geometry between two vertices. Will return null if a multilayer symbol is being used to symbolize this.- Returns:
- the symbol used to display the point between two vertices, or null
- Since:
- 100.1.0
-
getMultilayerMidVertexSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Gets the multilayer symbol used to display middle point geometry between two vertices. Will return null if a non-multilayer symbol is being used to symbolize this.- Returns:
- the symbol used to display the point between two vertices, or null
- Since:
- 100.5.0
-
setMidVertexSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Sets the symbol used to display the point between two vertices.- Parameters:
midVertexSymbol
- the symbol used to display the point between two vertices- Throws:
IllegalArgumentException
- if the midVertexSymbol is null- Since:
- 100.1.0
-
setMultilayerMidVertexSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Sets the multilayer symbol used to display the point between two vertices.- Parameters:
midVertexSymbol
- the symbol used to display the point between two vertices- Throws:
IllegalArgumentException
- if the midVertexSymbol is null- Since:
- 100.5.0
-
getSelectedMidVertexSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Gets the symbol used to display the selected middle vertex. Will return null if a multilayer symbol is being used to symbolize this.- Returns:
- the symbol used to display the selected middle vertex, or null
- Since:
- 100.1.0
-
getMultilayerSelectedMidVertexSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Gets the multilayer symbol used to display the selected middle vertex. Will return null if a non-multilayer symbol is being used to symbolize this.- Returns:
- the symbol used to display the selected middle vertex, or null
- Since:
- 100.5.0
-
setSelectedMidVertexSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Sets the symbol used to display the selected middle vertex.- Parameters:
selectedMidVertexSymbol
- the symbol used to display the selected middle vertex- Throws:
IllegalArgumentException
- if the selectedMidVertexSymbol is null- Since:
- 100.1.0
-
setMultilayerSelectedMidVertexSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Sets the multilayer symbol used to display the selected middle vertex.- Parameters:
selectedMidVertexSymbol
- the symbol used to display the selected middle vertex- Throws:
IllegalArgumentException
- if the selectedMidVertexSymbol is null- Since:
- 100.5.0
-
getSelectedVertexSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Gets the symbol to display the selected vertex. Will return null if a multilayer symbol is being used to symbolize this.- Returns:
- the symbol to display the selected vertex, or null
- Since:
- 100.1.0
-
getMultilayerSelectedVertexSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Gets the multilayer symbol to display the selected vertex. Will return null if a non-multilayer symbol is being used to symbolize this.- Returns:
- the symbol to display the selected vertex, or null
- Since:
- 100.5.0
-
setSelectedVertexSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Sets the symbol to display the selected vertex.- Parameters:
selectedVertexSymbol
- the symbol to display the selected vertex- Throws:
IllegalArgumentException
- if the selectedVertexSymbol is null- Since:
- 100.1.0
-
setMultilayerSelectedVertexSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Sets the multilayer symbol to display the selected vertex.- Parameters:
selectedVertexSymbol
- the symbol to display the selected vertex- Throws:
IllegalArgumentException
- if the selectedVertexSymbol is null- Since:
- 100.5.0
-
getVertexTextSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Gets the symbol to display the text over vertices when number labeling is enabled for vertices.- Returns:
- the symbol to display the text over vertices, or null
- Since:
- 100.1.0
-
setVertexTextSymbol
Deprecated, for removal: This API element is subject to removal in a future version.Sets the symbol to display the text over vertices when number labelling is enabled for vertices.- Parameters:
vertexTextSymbol
- the symbol to display the text over vertices- Throws:
IllegalArgumentException
- if the vertexTextSymbol is null- Since:
- 100.1.0
-
SketchEditor
. New development should useGeometryEditor
instead.GeometryEditorStyle
provides analogous functionality forGeometryEditor
.