PictureFillSymbol | API Reference | ArcGIS Maps SDK for JavaScript 4.30

PictureFillSymbol uses an image in a repeating pattern to symbolize polygon features in a 2D MapView. A url must point to a valid image. In addition, the symbol can have an optional outline, which is defined by a SimpleLineSymbol. PictureFillSymbols may be applied to polygon features in a FeatureLayer or an individual Graphic.

PictureFillSymbol is not supported in 3D SceneView. Only use it when working in a MapView.

The image below depicts a Graphic that is styled with a PictureFillSymbol.

pfs-sample

See also

Example

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"
  },
};

Constructors

PictureFillSymbol Constructor new PictureFillSymbol(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

Type	Summary	Class
String	The name of the class.	Accessor
Number	The height of the image in points.	PictureFillSymbol
SimpleLineSymbol	The outline of the polygon.	FillSymbol
String	The symbol type.	PictureFillSymbol
String	The URL to the image.	PictureFillSymbol
Number	The width of the image in points.	PictureFillSymbol
Number	The offset on the x-axis in points.	PictureFillSymbol
Number	The scale factor on the x axis of the symbol.	PictureFillSymbol
Number	The offset on the y-axis in pixels or points.	PictureFillSymbol
Number	The scale factor on the y axis of the symbol.	PictureFillSymbol

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

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

height Property 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 Inherited Property outline SimpleLineSymbolautocast Inherited from FillSymbol

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 Property type Stringreadonly

The symbol type.

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

url Property url String

The URL to the image.

width Property 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 Property 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 Property xscale Number

The scale factor on the x axis of the symbol.

Default Value:1

yoffset Property 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 Property yscale Number

The scale factor on the y axis of the symbol.

Default Value:1

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
PictureFillSymbol	Creates a deep clone of the symbol.	PictureFillSymbol
*	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	Symbol
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	Symbol

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 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 }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

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.

clone Method 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 Inherited Method 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 Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 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 Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 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 Inherited Method toJSON(){Object} Inherited from Symbol

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.