Skip To Content ArcGIS for Developers Sign In Dashboard

PictureMarkerSymbolLayer Class

(Esri::ArcGISRuntime::PictureMarkerSymbolLayer)

Represents a symbol layer used to place a picture marker on a point geometry. More...

Header: #include <PictureMarkerSymbolLayer>
Since: Esri::ArcGISRuntime 100.5
Inherits: MarkerSymbolLayer, Loadable, and RemoteResource

Public Functions

PictureMarkerSymbolLayer(const QImage &image, QObject *parent = nullptr)
PictureMarkerSymbolLayer(const QUrl &url, QObject *parent = nullptr)
PictureMarkerSymbolLayer(const QUrl &url, Credential *credential, QObject *parent = nullptr)
~PictureMarkerSymbolLayer()
QImage image() const
void setTintColor(const QColor &tintColor)
QColor tintColor() const

Reimplemented Public Functions

virtual void cancelLoad()
virtual Credential *credential() const
virtual void load()
virtual Error loadError() const
virtual LoadStatus loadStatus() const
virtual RequestConfiguration requestConfiguration() const
virtual void retryLoad()
virtual void setRequestConfiguration(const RequestConfiguration &requestConfiguration)
virtual QUrl url() const

Signals

void doneLoading(Esri::ArcGISRuntime::Error loadError)
void loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

Additional Inherited Members

  • 1 property inherited from QObject
  • 1 public slot inherited from QObject
  • 1 public variable inherited from QObject
  • 10 static public members inherited from QObject
  • 9 protected functions inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

Represents a symbol layer used to place a picture marker on a point geometry.

This symbol layer, in a MultilayerPointSymbol, places a picture marker at the location of the point feature. The class supports changing dimensions of the marker, specifying the image (or URL linking to the image) to use as the marker, as well as the general marker options provided by the MarkerSymbolLayer base class.

Example:

Create a PictureMarkerSymbolLayer and set its URL to an online PNG:

const QUrl pictureMarkerSymbolLayerUrl("http://static.arcgis.com/images/Symbols/Basic/YellowStickpin.png");
PictureMarkerSymbolLayer* pictureMarkerSymbolLayer = new PictureMarkerSymbolLayer(pictureMarkerSymbolLayerUrl, this);

Member Function Documentation

PictureMarkerSymbolLayer::PictureMarkerSymbolLayer(const QImage &image, QObject *parent = nullptr)

Constructor to initialize a picture marker symbol with the provided image and optional parent.

PictureMarkerSymbolLayer::PictureMarkerSymbolLayer(const QUrl &url, QObject *parent = nullptr)

Constructor to initialize a picture marker symbol with the provided url to an image and optional parent.

The URL can be provided as a path to a local file ( "file:/<path to file>"), path to a resource image ("qrc:/<path to resource image>"), or a path to an HTTP URL image ("http://path to image").

PictureMarkerSymbolLayer::PictureMarkerSymbolLayer(const QUrl &url, Credential *credential, QObject *parent = nullptr)

Constructor to initialize a picture marker symbol with the provided url to an image, a credential for the secured resource, and optional parent.

The URL can be provided as a path to a local file (file:/<path to file>), path to a resource image (qrc:/<path to resource image>), or a path to an HTTP URL image (http://path to image).

A credential is specified if the image needs authentication to gain access to it.

PictureMarkerSymbolLayer::~PictureMarkerSymbolLayer()

Destructor.

[virtual] void PictureMarkerSymbolLayer::cancelLoad()

Reimplemented from Loadable::cancelLoad().

See Loadable.

[virtual] Credential *PictureMarkerSymbolLayer::credential() const

Reimplemented from RemoteResource::credential().

Returns the credential to be used to access a secured image URL if provided.

[signal] void PictureMarkerSymbolLayer::doneLoading(Esri::ArcGISRuntime::Error loadError)

Signal emitted when this object is done loading.

  • loadError - Details about any error that may have occurred.

Note: If there is a load error it will also be emitted on the errorOccurred signal.

See also Loadable and Object.

QImage PictureMarkerSymbolLayer::image() const

Returns the picture marker symbol image once loaded.

If a URL was provided for the picture marker symbol, an attempt to load the symbol must occur and succeed, and then the image can be returned from this function. Prior to loading in this case, this will return a null QImage.

Returned images are in the QImage::Format_ARGB32_Premultiplied format.

[virtual] void PictureMarkerSymbolLayer::load()

Reimplemented from Loadable::load().

See Loadable.

[virtual] Error PictureMarkerSymbolLayer::loadError() const

Reimplemented from Loadable::loadError().

See Loadable.

[virtual] LoadStatus PictureMarkerSymbolLayer::loadStatus() const

Reimplemented from Loadable::loadStatus().

See Loadable.

[signal] void PictureMarkerSymbolLayer::loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

Signal emitted when the load status changes for this object.

See also Loadable.

[virtual] RequestConfiguration PictureMarkerSymbolLayer::requestConfiguration() const

Reimplemented from RemoteResource::requestConfiguration().

Returns the RequestConfiguration in use by this symbol.

See also setRequestConfiguration().

[virtual] void PictureMarkerSymbolLayer::retryLoad()

Reimplemented from Loadable::retryLoad().

See Loadable.

[virtual] void PictureMarkerSymbolLayer::setRequestConfiguration(const RequestConfiguration &requestConfiguration)

Reimplemented from RemoteResource::setRequestConfiguration().

Sets configuration parameters used for network requests sent by this symbol to requestConfiguration.

See also requestConfiguration().

void PictureMarkerSymbolLayer::setTintColor(const QColor &tintColor)

Sets the tint color of the picture marker symbol layer with the specified tintColor.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also tintColor().

QColor PictureMarkerSymbolLayer::tintColor() const

Returns the tint color of the picture marker symbol layer.

The tint color is applied to the entire image by multiplying each RGB color channel in the image by the corresponding color channel of the tint color. The default color is white with 100% opacity (RGBA (255,255,255,255)), which when applied leaves the image with its native colors and unchanged opacity. A white tint color with opacity less than 100% applies the reduced opacity without changing the image colors.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also setTintColor().

[virtual] QUrl PictureMarkerSymbolLayer::url() const

Reimplemented from RemoteResource::url().

Returns the URL path to the picture marker symbol image.

This could be a local file path, Qt resource path, or HTTP path to the image.


Feedback on this topic?