PictureFillSymbol

let symbol = {
  type: "picture-fill",  // autocasts as new PictureFillSymbol()
  url: "https://static.arcgis.com/images/Symbols/Shapes/BlackStarLargeB.png",
  width: "24px",
  height: "24px"
  outline: {
    style: "solid"
  },
};

Property Overview

Property Details

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.

height Numberautocast

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 = 16;

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

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

outline SimpleLineSymbolautocast inherited

The outline of the polygon.

Example:

let sym = {
  type: "simple-fill",  // autocasts as new SimpleFillSymbol()
  color: "red",
  outline: {  // autocasts as new SimpleLineSymbol()
    color: [128, 128, 128, 0.5],
    width: "0.5px"
  }
};

type Stringreadonly

The symbol type.

For PictureFillSymbol the type is always "picture-fill".

url String

The URL to the image.

width Numberautocast

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:

// width in points
symbol.width = 16;

// width in pixels
symbol.width = "12px";

// width in points
symbol.width = "16pt";

xoffset Numberautocast

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 = 6;

// xoffset in pixels
symbol.xoffset = "8px";

// xoffset in points
symbol.xoffset = "6pt";

xscale Number

The scale factor on the x axis of the symbol.

Default Value:1

yoffset Numberautocast

Autocasts from Number|String

The offset on the y-axis in pixels or 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 = 6;

// yoffset in pixels
symbol.yoffset = "8px";

// yoffset in points
symbol.yoffset = "6pt";

yscale Number

The scale factor on the y axis of the symbol.

Default Value:1

Method Overview

Method Details

clone(){PictureFillSymbol}

Creates a deep clone of the symbol.

Returns:

Type	Description
PictureFillSymbol	A deep clone of the object that invoked this method.

Example:

// Creates a deep clone of the graphic's symbol
let sym = 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.

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.