PictureMarkerSymbol

AMD: require(["esri/symbols/PictureMarkerSymbol"], (PictureMarkerSymbol) => { /* code goes here */ });
ESM: import PictureMarkerSymbol from "@arcgis/core/symbols/PictureMarkerSymbol";
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

Known Limitations:

  • SVG documents must include a definition for width and height to load properly in Firefox.
  • Animated GIF and PNG images are not supported in 3D SceneView.
  • The height and width of the symbol is restricted to no more than 200px.
  • Animated SVG images are currently not supported.

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

See also
Example
let symbol = {
  type: "picture-marker",  // autocasts as new PictureMarkerSymbol()
  url: "https://static.arcgis.com/images/Symbols/Shapes/BlackStarLargeB.png",
  width: "64px",
  height: "64px"
};

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.
Show inherited properties Hide inherited properties
Name Type Summary Class
Number

The angle of the marker relative to the screen in degrees.

more details
MarkerSymbol
String

The name of the class.

more details
Accessor
Number

The height of the image in points.

more details
PictureMarkerSymbol
String

The symbol type.

more details
PictureMarkerSymbol
String

The URL to an image or SVG document.

more details
PictureMarkerSymbol
Number

The width of the image in points.

more details
PictureMarkerSymbol
Number

The offset on the x-axis in points.

more details
MarkerSymbol
Number

The offset on the y-axis in points.

more details
MarkerSymbol

Property Details

The angle of the marker relative to the screen in degrees.

Known Limitations

This property is currently not supported in 3D SceneViews.

Default Value:0
declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

Autocasts from Number|String

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

The maximum allowed height of a picture marker symbol is 200px. If you set any value higher than 200px, then the image will be scaled down to a height of 200px while preserving the aspect ratio of the image.

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

The symbol type.

For PictureMarkerSymbol the type is always "picture-marker".

url String

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

Known Limitations

  • SVG documents must include a definition for width and height to load properly in Firefox.
  • Animated GIF and PNG images are not supported in SceneView. See the Custom WebGL layer view sample to learn how to accomplish this using WebGL.
  • Animated SVG images are currently not supported.
Examples
symbol.url = "cat-1-hurricane.png";
// render SVG document as a PictureMarkerSymbol
symbol.url = "logo.svg";
Autocasts from Number|String

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

The maximum allowed width of a picture marker symbol is 200px. If you set any value higher than 200px, then the image will be scaled down to a width of 200px while preserving the aspect ratio of the image.

Default Value:12
Examples
// height in points
symbol.height = 14;
// height in pixels
symbol.height = "20px";
// height in points
symbol.height = "14pt";
Autocasts from Number|String

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).

Default Value:0
Examples
// xoffset in points
symbol.xoffset = 4;
// xoffset in pixels
symbol.xoffset = "2px";
// xoffset in points
symbol.xoffset = "4pt";
Autocasts from Number|String

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).

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

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
PictureMarkerSymbol

Creates a deep clone of the symbol.

more details
PictureMarkerSymbol
*

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

more details
Symbol
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Object

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

more details
Symbol

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

Creates a deep clone of the symbol.

Returns
Type Description
PictureMarkerSymbol A deep clone of the object that invoked this method.
Example
// Creates a deep clone of the graphic's symbol
let 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 an ArcGIS product. 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
Type Description
* Returns a new instance of this class.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
removeHandles(groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
toJSON(){Object}inherited

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

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.