PictureFillSymbol | References | ArcGIS Maps SDK for JavaScript

import PictureFillSymbol from "@arcgis/core/symbols/PictureFillSymbol.js";

Inheritance:: PictureFillSymbol→FillSymbol→Symbol→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.0

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

Constructor

Parameters

Parameter	Type	Description	Required
properties	`PictureFillSymbolProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`color`	`Color \| null`
`declaredClass` readonly inherited	`string`	Accessor
`height`	`number`
`outline` inherited	`SimpleLineSymbol \| null \| undefined`	FillSymbol
`type` readonly	`"picture-fill"`
`url`	`string \| null \| undefined`
`width`	`number`
`xoffset`	`number`
`xscale`	`number`
`yoffset`	`number`
`yscale`	`number`

color

Property

Type: Color | null

PictureFillSymbols do not utilize color information; this property is ignored if set. The color property is present for consistency with other symbol types.

Examples

// CSS color string
symbol.color = "dodgerblue";

// HEX string
symbol.color = "#33cc33";

// array of RGBA values
symbol.color = [51, 204, 51, 0.3];

// object with rgba properties
symbol.color = {
  r: 51,
  g: 51,
  b: 204,
  a: 0.7
};

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

height

autocast Property

Type: number

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

autocast inherited Property

Type: SimpleLineSymbol | null | undefined

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

readonly Property

Type: "picture-fill"

The symbol type.

url

Property

Type: string | null | undefined

The URL to the image.

width

autocast Property

Type: number

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

autocast Property

Type: number

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

Type: number

The scale factor on the x axis of the symbol.

Default value: 1

yoffset

autocast Property

Type: number

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

Type: number

The scale factor on the y axis of the symbol.

Default value: 1

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone`	`clone(): PictureFillSymbol`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

clone

Method

Signature: clone (): PictureFillSymbol

Creates a deep clone of the symbol.

Returns: 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();

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.