MultilayerPointSymbol QML Type

  • Esri.ArcGISRuntime
  • MultilayerPointSymbol
  • A multi-layer point symbol. More...

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

    MultilayerSymbol

    Properties

    Signals

    Detailed Description

    This is a point symbol with multiple layers. Each layer has its own properties, such as offset, anchor, and rotation, that can be combined to create a point symbol with special efects (concentric circles or a pushpin, for example). These symbols are rendered with point geometry.

    Note: Symbol layers in a multilayer symbol are in reverse order of how they appear in the JSON representation.

    // in this multilayer symbol pseudocode json, the 'symbolLayers' ordered list of symbol
    // layers contains a solid stroke symbol layer followed by a solid fill symbol layer.
    { "symbolLayers": [{"type": "CIMSolidStroke", "color": "black"},{"type": "CIMSolidFill", "color": "red"}],"type": "CIMPointSymbol" }
    
    // this is the solid fill symbol layer, the reverse order from the json representation
    const symbolLayerIndexZero = multilayerSymbol.symboLayers.get(0); // red fill in the image below
    
    // this is the solid stroke symbol layer, the reverse order from the json representation
    const symbolLayerIndexOne = multilayerSymbol.symboLayers.get(1); // black outline in the image below

    "MultilayerPoint symbol"

    Multilayer symbol consisting of two layers.

    Property Documentation

    angle : real

    The angle in degrees.

    Angle for multilayer point symbols is measured in degrees counterclockwise from the east, from 0 to 360. The angle for a multilayer point symbol defaults to 0. Marker symbol layers can have a separate heading value defined (which is also 0 by default). Setting a heading for a marker symbol layer does not affect the angle of the point symbol. When an angle value is set for the point symbol, however, that value is applied cumulatively to all the marker symbol layers it contains. The heading for individual symbol layers must be re-fetched in order to see the updated value.

    Angle for multilayer point symbols and marker symbol layers is measured in degrees counterclockwise from the east, from 0 to 360. The angle for a multilayer point symbol defaults to 0. Marker symbol layers can have their own angle value defined (which is also 0 by default). Setting an angle for a marker symbol layer does not affect the angle of the point symbol. When an angle value is set for the point symbol, however, that value is applied cumulatively to all the marker symbol layers it contains. Clients use the angle provided for the symbol layers when rendering the multilayer symbol.


    angleAlignment : Enums.SymbolAngleAlignment

    The symbol angle alignment of the multilayer point symbol.

    Note: This property is only applicable for 2D and is not supported in 3D.

    See also Enums.SymbolAngleAlignment.


    [since Esri.ArcGISRuntime 100.5] initSimpleMarkerSymbol : SimpleMarkerSymbol

    A SimpleMarkerSymbol that can be used to instantiate this MultilayerPointSymbol.

    This property can only be assigned during instantiation, and only set once. Any changes made to this property after initial assignment will not be reflected in the MultilayerPointSymbol.

    Note: This is a convenience property only and equivalent to calling SimpleMarkerSymbol.toMultilayerSymbol() to create this object.

    This property was introduced in Esri.ArcGISRuntime 100.5.


    size : real

    The size in device independent pixels (DIPs).

    When getting the size from a multilayer point symbol, the value reported is the largest size of all the symbol layers it contains. The symbol size is updated when its symbol layer sizes change (if there is a new largest layer size). When setting a new size at the point symbol level, the size of the largest symbol layer is given the provided value, and all the smaller layers are sized proportionately. An individual symbol layer can be given a specific size without affecting the other layers.

    When getting the size from a multilayer point symbol, the value reported is the largest size of all the symbol layers it contains. The symbol size is updated when its symbol layer sizes change (if there is a new largest layer size). When setting a new size at the point symbol level, the size of the largest symbol layer is given the provided value, and all the smaller layers are sized proportionately. An individual symbol layer can be given a specific size without affecting the other layers.


    Signal Documentation

    angleAlignmentChanged()

    Emitted when the angleAlignment property changes.

    Note: The corresponding handler is onAngleAlignmentChanged.


    angleChanged()

    Emitted when the angle property changes.

    Note: The corresponding handler is onAngleChanged.


    [since Esri.ArcGISRuntime 100.5] initSimpleMarkerSymbolChanged()

    Emitted when the initSimpleMarkerSymbol property changes.

    Note: The corresponding handler is onInitSimpleMarkerSymbolChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.5.


    sizeChanged()

    Emitted when the size property changes.

    Note: The corresponding handler is onSizeChanged.


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