Package com.esri.arcgisruntime.mapping
Class LoadSettings
- java.lang.Object
-
- com.esri.arcgisruntime.mapping.LoadSettings
-
public final class LoadSettings extends java.lang.Object
Contains properties that set the rendering behavior for a map or scene as it loads. It allows you to specify preferences, or "hints", concerning how the map/scene should treat feature layers.There are two alternative work flows for using LoadSettings. The first is useful for setting the same settings on more that one map or scene, for example:
LoadSettings loadSettings = new LoadSettings(); loadSettings.setPreferredPointFeatureRenderingMode(FeatureLayer.RenderingMode.DYNAMIC); loadSettings.setPreferredPolylineFeatureRenderingMode(FeatureLayer.RenderingMode.DYNAMIC); loadSettings.setPreferredPolygonFeatureRenderingMode(FeatureLayer.RenderingMode.DYNAMIC); ArcGISMap map1 = new ArcGISMap(); ArcGISMap map2 = new ArcGISMap(); map1.setLoadSettings(loadSettings); map2.setLoadSettings(loadSettings);
The second is useful for modifying the default settings on one map or scene, for example:ArcGISScene scene = new ArcGISScene(); scene.getLoadSettings().setPreferredPointFeatureRenderingMode(FeatureLayer.RenderingMode.DYNAMIC);
- Since:
- 100.2.0
-
-
Constructor Summary
Constructors Constructor Description LoadSettings()
Creates a new load settings instance with default values.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ServiceFeatureTable.FeatureRequestMode
getFeatureRequestMode()
Gets the request mode to use for requesting features.FeatureServiceSessionType
getFeatureServiceSessionType()
Gets the session type to use for branch-versionedServiceGeodatabase
objects.FeatureTilingMode
getFeatureTilingMode()
Gets the feature tiling mode of each feature layer that is loaded.FeatureLayer.RenderingMode
getPreferredPointFeatureRenderingMode()
Gets the preferred rendering mode for point and multi-point based feature layers.FeatureLayer.RenderingMode
getPreferredPolygonFeatureRenderingMode()
Gets the preferred rendering mode for polygon based feature layers.FeatureLayer.RenderingMode
getPreferredPolylineFeatureRenderingMode()
Gets the preferred rendering mode for polyline based feature layers.boolean
isUseAdvancedSymbology()
Gets whether service feature tables will use advanced symbology.void
setFeatureRequestMode(ServiceFeatureTable.FeatureRequestMode featureRequestMode)
Sets the request mode to use for requesting features.void
setFeatureServiceSessionType(FeatureServiceSessionType featureServiceSessionType)
Sets the session type to use for branch-versionedServiceGeodatabase
objects.void
setFeatureTilingMode(FeatureTilingMode featureTilingMode)
Sets the feature tiling mode of each feature layer that is loaded.void
setPreferredPointFeatureRenderingMode(FeatureLayer.RenderingMode renderingMode)
Sets the preferred rendering mode for point and multi-point based feature layers.void
setPreferredPolygonFeatureRenderingMode(FeatureLayer.RenderingMode renderingMode)
Sets the preferred rendering mode for polygon based feature layers.void
setPreferredPolylineFeatureRenderingMode(FeatureLayer.RenderingMode renderingMode)
Sets the preferred rendering mode for polyline based feature layers.void
setUseAdvancedSymbology(boolean useAdvancedSymbology)
Sets whether service feature tables will use advanced symbology.
-
-
-
Method Detail
-
setPreferredPointFeatureRenderingMode
public void setPreferredPointFeatureRenderingMode(FeatureLayer.RenderingMode renderingMode)
Sets the preferred rendering mode for point and multi-point based feature layers. The layer will attempt to render in the specified mode if this is supported. If for exampleDYNAMIC
is not supported by a layer'srenderer
then it will fall back to rendering inSTATIC
mode.- Parameters:
renderingMode
- the preferred rendering mode- Throws:
java.lang.IllegalArgumentException
- if renderingMode is null- Since:
- 100.2.0
-
getPreferredPointFeatureRenderingMode
public FeatureLayer.RenderingMode getPreferredPointFeatureRenderingMode()
Gets the preferred rendering mode for point and multi-point based feature layers. The default value isAUTOMATIC
.- Returns:
- the preferred rendering mode for point and multi-point based feature layers
- Since:
- 100.2.0
-
setPreferredPolylineFeatureRenderingMode
public void setPreferredPolylineFeatureRenderingMode(FeatureLayer.RenderingMode renderingMode)
Sets the preferred rendering mode for polyline based feature layers. The layer will attempt to render in the specified mode if this is supported. If, for example,DYNAMIC
is not supported by a layer'srenderer
then it will fall back to rendering inSTATIC
mode.- Parameters:
renderingMode
- the preferred rendering mode- Throws:
java.lang.IllegalArgumentException
- if renderingMode is null- Since:
- 100.2.0
-
getPreferredPolylineFeatureRenderingMode
public FeatureLayer.RenderingMode getPreferredPolylineFeatureRenderingMode()
Gets the preferred rendering mode for polyline based feature layers. The default value isAUTOMATIC
.- Returns:
- the preferred rendering mode for polyline based feature layers
- Since:
- 100.2.0
-
setPreferredPolygonFeatureRenderingMode
public void setPreferredPolygonFeatureRenderingMode(FeatureLayer.RenderingMode renderingMode)
Sets the preferred rendering mode for polygon based feature layers. The layer will attempt to render in the specified mode if this is supported. If for exampleDYNAMIC
is not supported by a layer'srenderer
then it will fall back to rendering inSTATIC
mode.- Parameters:
renderingMode
- the preferred rendering mode- Throws:
java.lang.IllegalArgumentException
- if renderingMode is null- Since:
- 100.2.0
-
getPreferredPolygonFeatureRenderingMode
public FeatureLayer.RenderingMode getPreferredPolygonFeatureRenderingMode()
Gets the preferred rendering mode for polygon based feature layers. The default value isAUTOMATIC
.- Returns:
- the preferred rendering mode for polygon based feature layers
- Since:
- 100.2.0
-
isUseAdvancedSymbology
public boolean isUseAdvancedSymbology()
Gets whether service feature tables will use advanced symbology.- Returns:
- true if the tables will use advanced symbology, false otherwise
- Since:
- 100.2.0
-
setUseAdvancedSymbology
public void setUseAdvancedSymbology(boolean useAdvancedSymbology)
Sets whether service feature tables will use advanced symbology. If the tables are already loaded this setting will have no effect. The default is true.- Parameters:
useAdvancedSymbology
- true for tables to use advanced symbology, false for simple symbology- Since:
- 100.2.0
-
getFeatureRequestMode
public ServiceFeatureTable.FeatureRequestMode getFeatureRequestMode()
Gets the request mode to use for requesting features. Default isServiceFeatureTable.FeatureRequestMode.ON_INTERACTION_CACHE
.- Returns:
- the feature request mode
- Since:
- 100.9.0
-
setFeatureRequestMode
public void setFeatureRequestMode(ServiceFeatureTable.FeatureRequestMode featureRequestMode)
Sets the request mode to use for requesting features. Default isServiceFeatureTable.FeatureRequestMode.ON_INTERACTION_CACHE
.- Parameters:
featureRequestMode
- the feature request mode- Throws:
java.lang.IllegalArgumentException
- if featureRequestMode is null- Since:
- 100.9.0
-
getFeatureServiceSessionType
public FeatureServiceSessionType getFeatureServiceSessionType()
Gets the session type to use for branch-versionedServiceGeodatabase
objects. Default isFeatureServiceSessionType.TRANSIENT
.- Returns:
- the session type to use for branch-versioned geodatabases
- Since:
- 100.10.0
-
setFeatureServiceSessionType
public void setFeatureServiceSessionType(FeatureServiceSessionType featureServiceSessionType)
Sets the session type to use for branch-versionedServiceGeodatabase
objects.- Parameters:
featureServiceSessionType
- the session type to use for branch-versioned geodatabases- Throws:
java.lang.IllegalArgumentException
- if featureServiceSessionType is null- Since:
- 100.10.0
-
getFeatureTilingMode
public FeatureTilingMode getFeatureTilingMode()
Gets the feature tiling mode of each feature layer that is loaded. Default isFeatureTilingMode.ENABLED_WHEN_SUPPORTED
.Changes how feature tiling is handled by each feature layer. Individual feature layers can override these settings.
- Returns:
- determines whether or not feature tiling is used to render layers that support its use.
- Since:
- 100.10.0
- See Also:
FeatureTilingMode
-
setFeatureTilingMode
public void setFeatureTilingMode(FeatureTilingMode featureTilingMode)
Sets the feature tiling mode of each feature layer that is loaded.- Parameters:
featureTilingMode
- the feature tiling mode to use when rendering layers that support its use- Throws:
java.lang.IllegalArgumentException
- if featureTilingMode is null- Since:
- 100.10.0
-
-