Skip To Content ArcGIS for Developers Sign In Dashboard

LoadSettings Class

class Esri::ArcGISRuntime::LoadSettings

Contains properties which set the rendering behavior for the contents of a map or scene as they are loaded. More...

Header: #include <LoadSettings>
Since: Esri::ArcGISRuntime 100.2
Inherits: Esri::ArcGISRuntime::Object

This class was introduced in Esri::ArcGISRuntime 100.2.

Public Functions

LoadSettings(QObject *parent = nullptr)
virtual ~LoadSettings() override
Esri::ArcGISRuntime::FeatureRequestMode featureRequestMode() const
bool isUseAdvancedSymbology() const
Esri::ArcGISRuntime::FeatureRenderingMode preferredPointFeatureRenderingMode() const
Esri::ArcGISRuntime::FeatureRenderingMode preferredPolygonFeatureRenderingMode() const
Esri::ArcGISRuntime::FeatureRenderingMode preferredPolylineFeatureRenderingMode() const
void setFeatureRequestMode(Esri::ArcGISRuntime::FeatureRequestMode featureRequestMode)
void setPreferredPointFeatureRenderingMode(Esri::ArcGISRuntime::FeatureRenderingMode renderingMode)
void setPreferredPolygonFeatureRenderingMode(Esri::ArcGISRuntime::FeatureRenderingMode renderingMode)
void setPreferredPolylineFeatureRenderingMode(Esri::ArcGISRuntime::FeatureRenderingMode renderingMode)
void setUseAdvancedSymbology(bool useAdvancedSymbology)

Detailed Description

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(this);
loadSettings->setPreferredPointFeatureRenderingMode(FeatureRenderingMode::Dynamic);
loadSettings->setPreferredPolylineFeatureRenderingMode(FeatureRenderingMode::Dynamic);
loadSettings->setPreferredPolygonFeatureRenderingMode(FeatureRenderingMode::Dynamic);
Map* map1 = new Map(this);
Map* map2 = new Map(this);
map1->setLoadSettings(loadSettings);
map2->setLoadSettings(loadSettings);

The second is useful for modifying the default settings on a map or scene, for example:

Scene* scene = new Scene(this);
scene->loadSettings()->setPreferredPointFeatureRenderingMode(FeatureRenderingMode::Dynamic);

Member Function Documentation

LoadSettings::LoadSettings(QObject *parent = nullptr)

Constructs a new load settings instance with default values.

  • parent Parent object.

[override virtual] LoadSettings::~LoadSettings()

Destructor.

Esri::ArcGISRuntime::FeatureRequestMode LoadSettings::featureRequestMode() const

Returns the request mode to use for requesting features. Default is FeatureRequestMode::onInteractionCache.

This function was introduced in Esri::ArcGISRuntime 100.9.

See also setFeatureRequestMode().

bool LoadSettings::isUseAdvancedSymbology() const

Gets whether a web map should use advanced symbology.

This must be set prior to loading a web map and will use the simple or advanced symbol rest end point for the feature service.

The default return value is true.

Esri::ArcGISRuntime::FeatureRenderingMode LoadSettings::preferredPointFeatureRenderingMode() const

Gets the preferred rendering mode for point and multi-point based feature layers.

The default value is FeatureRenderingMode::Automatic.

See also setPreferredPointFeatureRenderingMode().

Esri::ArcGISRuntime::FeatureRenderingMode LoadSettings::preferredPolygonFeatureRenderingMode() const

Gets the preferred rendering mode for polygon based feature layers.

The default value is FeatureRenderingMode::Automatic.

See also setPreferredPolygonFeatureRenderingMode().

Esri::ArcGISRuntime::FeatureRenderingMode LoadSettings::preferredPolylineFeatureRenderingMode() const

Gets the preferred rendering mode for polyline based feature layers.

The default value is FeatureRenderingMode::Automatic.

See also setPreferredPolylineFeatureRenderingMode().

void LoadSettings::setFeatureRequestMode(Esri::ArcGISRuntime::FeatureRequestMode featureRequestMode)

Sets the featureRequestMode to featureRequestMode.

This function was introduced in Esri::ArcGISRuntime 100.9.

See also featureRequestMode.

void LoadSettings::setPreferredPointFeatureRenderingMode(Esri::ArcGISRuntime::FeatureRenderingMode renderingMode)

Sets the preferred rendering mode for point and multi-point based feature layers to renderingMode.

The layer will attempt to render in the specified mode if it is supported. If for example FeatureRenderingMode::Dynamic is not supported by a layer's Renderer, then it will fall back to rendering in FeatureRenderingMode::Static mode.

See also preferredPointFeatureRenderingMode().

void LoadSettings::setPreferredPolygonFeatureRenderingMode(Esri::ArcGISRuntime::FeatureRenderingMode renderingMode)

Sets the preferred rendering mode for polygon based feature layers to renderingMode.

The layer will attempt to render in the specified mode if it is supported. If for example FeatureRenderingMode::Dynamic is not supported by a layer's Renderer, then it will fall back to rendering in FeatureRenderingMode::Static mode.

See also preferredPolygonFeatureRenderingMode().

void LoadSettings::setPreferredPolylineFeatureRenderingMode(Esri::ArcGISRuntime::FeatureRenderingMode renderingMode)

Sets the preferred rendering mode for polyline based feature layers to renderingMode.

The layer will attempt to render in the specified mode if it is supported. If for example FeatureRenderingMode::Dynamic is not supported by a layer's Renderer, then it will fall back to rendering in FeatureRenderingMode::Static mode.

See also preferredPolylineFeatureRenderingMode().

void LoadSettings::setUseAdvancedSymbology(bool useAdvancedSymbology)

Sets whether a web map should use advanced symbology to useAdvancedSymbology.

This must be set prior to loading a web map and will use the simple or advanced symbol rest end point for the feature service.

See also isUseAdvancedSymbology().


Feedback on this topic?