Package com.esri.arcgisruntime.symbology

Class MultilayerSymbol

  • All Implemented Interfaces:
    JsonSerializable
    Direct Known Subclasses:
    MultilayerPointSymbol, MultilayerPolygonSymbol, MultilayerPolylineSymbol
    public class MultilayerSymbol
extends Symbol
    A base class for multilayer symbols. Multilayer symbols are built from multiple layers of symbols, which combine to let you add complex symbols to maps and scenes.

    Multilayer symbols can be returned from feature layers based on web maps, feature services (with Use Advanced Symbology set to true), or mobile map packages, and can also be created from JSON by calling Symbol.fromJson(String). The same multilayer symbols and the components used to build them are available in ArcGIS Runtime, allowing you to programmatically create and change them using the MultilayerPointSymbol, MultilayerPolylineSymbol, and MultilayerPolygonSymbol subclasses. You can access the layers that comprise the symbol through getSymbolLayers(). You can modify symbol layer properties, such as the color of a multilayer symbol. Some subclasses also expose additional symbol properties.

    The symbol layers that comprise the symbol can be of different types. For example, a polyline geometry may be drawn with a MultilayerPolylineSymbol that has line (stroke) symbol layers that draw the line geometry, and also point (marker) symbol layers that are drawn at specified point locations relative to the line geometry. When you save an ArcGIS Pro map as a web map, any multilayer symbols in the map are converted to simple symbols. In general, point symbols are converted to picture marker symbols optimized for the web, and line and polygon symbols are simplified while representing the original symbol as closely as possible. If you're authoring a feature service from ArcGIS Pro or ArcGIS Desktop, however, both the original symbols and the simplified symbols are stored. The stored symbols allow clients that support advanced symbols to render the features as originally symbolized, while those that do not support advanced symbols (such as ArcGIS Online Map Viewer) can use the simple symbols for display. Having both sets of symbols allows you to retain the advanced symbology where available and still share the feature service as widely as possible. Symbols used by web scenes are also multilayer but use a different specification than the ArcGIS Pro and ArcGIS Runtime symbols. When you read symbols from a web scene in your ArcGIS Runtime app, you get an ArcGIS Runtime representation of the multilayer symbol. Symbol layers in an ArcGIS Runtime multilayer symbol are in reverse order of how they appear in the JSON representation from the server.

    For more information about multilayer symbols, refer to Symbols in the ArcGIS Pro help.

    Since:
    100.2.0

    • Method Detail

      • getColor

        public int getColor()
        Gets the consensus color of all layers in the symbol (excluding those that are color-locked) using an ARGB(alpha, red, green, blue) value.

        Because MultilayerSymbol may have multiple symbol layers, this property represents the value of all color and tint color properties of constituent symbol layers, excluding any StrokeSymbolLayer in a MultilayerPolygonSymbol, as those symbol layers are outlines. The property defines the color and tint color of symbols contained in VectorMarkerSymbolElement. Constituent symbol layers whose colorLocked property is true do not change color as a result of this function. To change outline colors, modify the outline symbol layer colors individually.

        The color of specific symbol layers within a multilayer symbol can be locked; the new color value will be applied to any symbol layers that are not locked. Color locking can be enabled or disabled through SymbolLayer.setColorLocked(boolean).

        Returns:
        the color in the form 0xAARRGGB
        Since:
        100.2.0

      • setColor

        public void setColor​(int color)
        Sets the consensus color of all layers in the symbol (excluding those that are color-locked) using an ARGB(alpha, red, green, blue) value.

        Because MultilayerSymbol may have multiple symbol layers, this property represents the value of all color and tint color properties of constituent symbol layers, excluding any StrokeSymbolLayer in a MultilayerPolygonSymbol, as those symbol layers are outlines. The property defines the color and tint color of symbols contained in VectorMarkerSymbolElement. Constituent symbol layers whose colorLocked property is true do not change color as a result of this function. To change outline colors, modify the outline symbol layer colors individually.

        The color of specific symbol layers within a multilayer symbol can be locked; the new color value will be applied to any symbol layers that are not locked. Color locking can be enabled or disabled through SymbolLayer.setColorLocked(boolean).

        Parameters:
        color - the color to set, in the form 0xAARRGGBB
        Since:
        100.2.0

      • getSymbolLayers

        public java.util.List<SymbolLayer> getSymbolLayers()
        Gets a list containing the symbol layers within this multilayer symbol. The list is modifiable and symbol layers can be added or removed. The symbol layers are in reverse order of how they appear in the JSON representation from the server.
        Returns:
        the list of symbol layers
        Since:
        100.5.0

      • setReferenceProperties

        public void setReferenceProperties​(SymbolReferenceProperties referenceProperties)
        Sets the SymbolReferenceProperties for this symbol.
        Parameters:
        referenceProperties - the SymbolReferenceProperties for this symbol
        Since:
        100.13.0