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.
- See also:
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
-
new PictureFillSymbol(properties)
-
Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | more details The name of the class. | more details | Accessor | |
Number | more details The height of the image in points. | more details | PictureFillSymbol | |
SimpleLineSymbol | more details The outline of the polygon. | more details | FillSymbol | |
String | more details The symbol type. | more details | PictureFillSymbol | |
String | more details The URL to the image. | more details | PictureFillSymbol | |
Number | more details The width of the image in points. | more details | PictureFillSymbol | |
Number | more details The offset on the x-axis in points. | more details | PictureFillSymbol | |
Number | more details The scale factor on the x axis of the symbol. | more details | PictureFillSymbol | |
Number | more details The offset on the y-axis in pixels or points. | more details | PictureFillSymbol | |
Number | more details The scale factor on the y axis of the symbol. | more details | PictureFillSymbol |
Property Details
-
Since: ArcGIS API for JavaScript 4.7
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
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";
-
-
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.
-
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";
-
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
-
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
Name | Return Type | Summary | Class | |
---|---|---|---|---|
PictureFillSymbol | more details Creates a deep clone of the symbol. | more details | PictureFillSymbol | |
* | more details Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | more details | Symbol | |
more details Adds one or more handles which are to be tied to the lifecycle of the object. | more details | Accessor | ||
Object | more details Converts an instance of this class to its ArcGIS portal JSON representation. | more details | Symbol |
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 ObjectA 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.
-
own(handleOrHandles)inheritedSince: ArcGIS API for JavaScript 4.24
-
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.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }); handle.remove(); // Assign a handle using own() this.own(reactiveUtils.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }));
Parameter:handleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
-
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.