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

Property Overview

Property Details

angleNumber inherited

The angle of the marker in degrees.

Known Limitations

This property is currently not supported in 3D SceneViews.

Default Value:0

declaredClassStringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

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

heightNumberautocast

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

Default Value:12

Examples:

// height in points
symbol.height = 14;

// height in pixels
symbol.height = "20px";

// height in points
symbol.height = "14pt";

typeStringreadonly

For PictureMarkerSymbol the type is always picture-marker.

urlString

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

• Make certain that the image is hosted on a CORS enabled server.
• Use an image hosted on the same domain as the application.
• Install a proxy.

widthNumberautocast

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

Default Value:12

Examples:

// height in points
symbol.height = 14;

// height in pixels
symbol.height = "20px";

// height in points
symbol.height = "14pt";

xoffsetNumberautocast inherited

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

Known Limitations

This property is currently 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";

yoffsetNumberautocast inherited

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

Known Limitations

This property is currently 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

Method Details

clone(){PictureMarkerSymbol}

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
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:

Type	Description
*	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:

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