PictureMarkerSymbol

require(["esri/symbols/PictureMarkerSymbol"], function(PictureMarkerSymbol) { /* code goes here */ });
Class: esri/symbols/PictureMarkerSymbol
Inheritance: PictureMarkerSymbol MarkerSymbol Symbol Accessor
Since: ArcGIS API for JavaScript 4.0

PictureMarkerSymbol renders Point graphics in either a 2D MapView or 3D SceneView using an image. A url must point to a valid image. PictureMarkerSymbols may be applied to point features in a FeatureLayer or individual graphics. The image below depicts a FeatureLayer whose point features are styled with a PictureMarkerSymbol.

pms-sample

To avoid CORS issues with this symbol, do one of the following:

  • Use an image hosted on the same domain as the application.
  • If the image is on a different domain and that server is CORS enabled, add the domain to the corsEnabledServers array.
  • Install a proxy.

Autocasting support

As of version 4.5 of the ArcGIS API for JavaScript, autocasting is universally supported for all renderers, symbols, and symbol layers in the API. So there is no need to include this module in the require() and define() module loaders of your application unless you intend to use the static method(s) of this module.

See also:
Example:
var symbol = {
  type: "picture-marker",  // autocasts as new PictureMarkerSymbol()
  url: "https://webapps-cdn.esri.com/Apps/MegaMenu/img/logo.jpg",
  width: "8px",
  height: "8px"
};

Constructors

new PictureMarkerSymbol(properties)

Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
Number

The angle of the marker in degrees.

more details
more detailsMarkerSymbol
String

The name of the class.

more details
more detailsAccessor
Number

The height of the image in points.

more details
more detailsPictureMarkerSymbol
String

For PictureMarkerSymbol the type is always picture-marker.

more details
more detailsPictureMarkerSymbol
String

The URL to the image.

more details
more detailsPictureMarkerSymbol
Number

The width of the image in points.

more details
more detailsPictureMarkerSymbol
Number

The offset on the x-axis in points.

more details
more detailsMarkerSymbol
Number

The offset on the y-axis in points.

more details
more detailsMarkerSymbol

Property Details

The angle of the marker in degrees.

Known Limitations

This property is not supported in 3D SceneViews.

Default Value: 0

declaredClassStringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

The height of the image in points. This value may be autocast with a string expressing size in points or pixels (e.g. 12px).

Default Value: 12
Examples:
// height in points
symbol.height = 14;
// height in pixels
symbol.height = "20px";
// height in points
symbol.height = "14pt";

typeString

For PictureMarkerSymbol the type is always picture-marker.

The URL to the image. To avoid CORS issues with this symbol, do one of the following:

  • Use an image hosted on the same domain as the application.
  • If the image is on a different domain and that server is CORS enabled, add the domain to the corsEnabledServers array.
  • Install a proxy.

The width of the image in points. This value may be autocast with a string expressing size in points or pixels (e.g. 12px).

Default Value: 12
Examples:
// height in points
symbol.height = 14;
// height in pixels
symbol.height = "20px";
// height in points
symbol.height = "14pt";

The offset on the x-axis in points. This value may be autocast with a string expressing size in points or pixels (e.g. 12px).

Known Limitations

This property is not supported in 3D SceneViews.

Default Value: 0
Examples:
// xoffset in points
symbol.xoffset = 4;
// xoffset in pixels
symbol.xoffset = "2px";
// xoffset in points
symbol.xoffset = "4pt";

The offset on the y-axis in points. This value may be autocast with a string expressing size in points or pixels (e.g. 12px).

Known Limitations

This property is not supported in 3D SceneViews.

Default Value: 0
Examples:
// yoffset in points
symbol.yoffset = 4;
// yoffset in pixels
symbol.yoffset = "2px";
// yoffset in points
symbol.yoffset = "4pt";

Method Overview

NameReturn TypeSummaryClass
PictureMarkerSymbol

Creates a deep clone of the symbol.

more details
more detailsPictureMarkerSymbol
*

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform.

more details
more detailsSymbol
Object

Converts an instance of this class to its ArcGIS Portal JSON representation.

more details
more detailsSymbol

Method Details

Creates a deep clone of the symbol.

Returns:
TypeDescription
PictureMarkerSymbolA deep clone of the object that invoked this method.
Example:
// Creates a deep clone of the graphic's symbol
var symLyr = graphic.symbol.clone();

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:
TypeDescription
*Returns a new instance of this class.

toJSON(){Object}inherited

Converts an instance of this class to its ArcGIS Portal JSON representation. See the Using fromJSON() topic in the Guide for more information.

Returns:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.