Class ScaleRangeDisplayFilter
- java.lang.Object
-
- com.esri.arcgisruntime.layers.DisplayFilter
-
- com.esri.arcgisruntime.layers.ScaleRangeDisplayFilter
-
public class ScaleRangeDisplayFilter extends DisplayFilter
ADisplayFilter
that is applied on the layer based on the provided scale range.- Since:
- 100.13.0
- See Also:
ScaleDisplayFilterDefinition.getFilters()
-
-
Constructor Summary
Constructors Constructor Description ScaleRangeDisplayFilter(java.lang.String name, java.lang.String whereClause, double minScale, double maxScale)
Creates a newScaleRangeDisplayFilter
with the specified filter id, where clause, and scale range.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description double
getMaxScale()
Gets the maximum scale at which this display filter is applied.double
getMinScale()
Gets the minimum scale at which this display filter is applied.void
setMaxScale(double maxScale)
Sets the maximum scale at which this display filter is applied.void
setMinScale(double minScale)
Sets the minimum scale at which this display filter is applied.-
Methods inherited from class com.esri.arcgisruntime.layers.DisplayFilter
getFilterId, getName, getWhereClause, setName, setWhereClause
-
-
-
-
Constructor Detail
-
ScaleRangeDisplayFilter
public ScaleRangeDisplayFilter(java.lang.String name, java.lang.String whereClause, double minScale, double maxScale)
Creates a newScaleRangeDisplayFilter
with the specified filter id, where clause, and scale range.- Parameters:
name
- a descriptive name for this display filterwhereClause
- a SQL expression that defines which features are rendered. An empty where clause is not allowed.minScale
- the minimum scale at which this display filter is applied. IfMapView.getMapScale()
orViewpoint.getTargetScale()
is less than or equal to this value, theDisplayFilter
will be applied. This value should be greater thanmaxScale
. A value of 0 indicates that this display filter is applied without an upper limit.maxScale
- the maximum scale at which this display filter is applied. IfMapView.getMapScale()
orViewpoint.getTargetScale()
is greater than or equal to this value, theDisplayFilter
will be applied. This value should be less thanminScale
. A value of 0 indicates that this display filter is applied without a lower limit.- Throws:
java.lang.IllegalArgumentException
- if name is null or emptyjava.lang.IllegalArgumentException
- if whereClause is null or emptyArcGISRuntimeException
- if the themaxScale
is greater than theminScale
- Since:
- 100.13.0
-
-
Method Detail
-
getMaxScale
public double getMaxScale()
Gets the maximum scale at which this display filter is applied.This display filter is only applied when zoomed further out than the maximum scale. Set this property to allow current scale of the map to determine when this display filter is applied. If
MapView.getMapScale()
orViewpoint.getTargetScale()
is greater than or equal to this value, theDisplayFilter
will be applied. This value should be less thangetMinScale()
. A value of 0 indicates this display filter is applied without an upper limit. The default value is 0.- Returns:
- the maximum scale at which this display filter is applied
- Since:
- 100.13.0
-
setMaxScale
public void setMaxScale(double maxScale)
Sets the maximum scale at which this display filter is applied.This display filter is only applied when zoomed further out than the maximum scale. Set this property to allow current scale of the map to determine when this display filter is applied. If
MapView.getMapScale()
orViewpoint.getTargetScale()
is greater than or equal to this value, theDisplayFilter
will be applied. This value should be less thangetMinScale()
. A value of 0 indicates this display filter is applied without an upper limit. The default value is 0.- Parameters:
maxScale
- the maximum scale at which this display filter is applied- Since:
- 100.13.0
-
getMinScale
public double getMinScale()
Gets the minimum scale at which this display filter is applied.This display filter is only applied when zoomed further in than the minimum scale. Set this property to allow current scale of the map to determine when this display filter is applied. If
MapView.getMapScale()
orViewpoint.getTargetScale()
is less than or equal to this value, theDisplayFilter
will be applied. This value should be greater thangetMaxScale()
. A value of 0 indicates this display filter is applied without a lower limit. The default value is 0.- Returns:
- the minimum scale at which this display filter is applied
- Since:
- 100.13.0
-
setMinScale
public void setMinScale(double minScale)
Sets the minimum scale at which this display filter is applied.This display filter is only applied when zoomed further in than the minimum scale. Set this property to allow current scale of the map to determine when this display filter is applied. If
MapView.getMapScale()
orViewpoint.getTargetScale()
is less than or equal to this value, theDisplayFilter
will be applied. This value should be greater thangetMaxScale()
. A value of 0 indicates this display filter is applied without a lower limit. The default value is 0.- Parameters:
minScale
- the minimum scale at which this display filter is applied- Since:
- 100.13.0
-
-