Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.symbology

Class SymbolReferenceProperties

java.lang.Object
com.esri.arcgisruntime.symbology.SymbolReferenceProperties
public final class SymbolReferenceProperties extends Object
Symbol properties that changes how symbols behave when attached to a renderer.

SymbolReferenceProperties contains conditional properties that are not used directly by the symbol but rather by the renderer to change how a symbol is visualized based on the state of the view and the data. For example, getMinScale() and getMaxScale() will be used by class breaks and unique value renderers to determine if a symbol break or unique value is visible at a certain scale. Additional symbols can be assigned as alternate symbols for the renderers. This allows the map author to control which symbol is displayed at certain scales.

Since:
100.13.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    SymbolReferenceProperties()
    Creates a SymbolReferenceProperties object.
    SymbolReferenceProperties(double minScale, double maxScale)
    Creates a symbol reference properties object with minimum and maximum scales.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getMaxScale()
    Gets the maximum scale at which the symbol will be visible.
    double
    getMinScale()
    Gets the minimum scale at which the symbol will be visible.
    void
    setMaxScale(double maxScale)
    Sets the maximum scale at which the symbol will be visible.
    void
    setMinScale(double minScale)
    Sets the minimum scale at which the symbol will be visible.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • SymbolReferenceProperties

      public SymbolReferenceProperties()
      Creates a SymbolReferenceProperties object.
      Since:
      100.13.0

    • SymbolReferenceProperties

      public SymbolReferenceProperties(double minScale, double maxScale)
      Creates a symbol reference properties object with minimum and maximum scales.

      Minimum and maximum scales are used in the context of alternate symbols.

      Parameters:
      minScale - scale at which the symbol starts rendering
      maxScale - scale at which the symbol stops rendering
      Since:
      100.13.0

  • Method Details

    • getMaxScale

      public double getMaxScale()
      Gets the maximum scale at which the symbol will be visible.

      This is the scale at which the symbol starts rendering. The default value is 0.

      Returns:
      the maximum scale at which the symbol will be visible
      Since:
      100.13.0

    • setMaxScale

      public void setMaxScale(double maxScale)
      Sets the maximum scale at which the symbol will be visible.

      This is the scale at which the symbol starts rendering. The default value is 0.

      Parameters:
      maxScale - the maximum scale at which the symbol will be visible
      Since:
      100.13.0

    • getMinScale

      public double getMinScale()
      Gets the minimum scale at which the symbol will be visible.

      This is the scale at which the symbol stops rendering. The default value is 0.

      Returns:
      the minimum scale at which the symbol will be visible
      Since:
      100.13.0

    • setMinScale

      public void setMinScale(double minScale)
      Sets the minimum scale at which the symbol will be visible.

      This is the scale at which the symbol stops rendering. The default value is 0.

      Parameters:
      minScale - the minimum scale at which the symbol will be visible
      Since:
      100.13.0