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

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.

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.

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.