ESM: import PictureFillSymbol from "@arcgis/core/symbols/PictureFillSymbol.js";
CDN: const PictureFillSymbol = await $arcgis.import("@arcgis/core/symbols/PictureFillSymbol.js");
Class: @arcgis/core/symbols/PictureFillSymbol
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.
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
new PictureFillSymbol(properties)
Parameter
optionalSee the properties for a list of all the properties that may be passed into the constructor.
Show inherited properties Hide inherited properties
Property DetailsInherited
Property declaredClass Stringreadonly
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
.
The height of the image in points. This value may be autocast with a string expressing size in points or pixels (e.g. 12px
).
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"
}
};
The width of the image in points. This value may be autocast with a string expressing size in points or pixels (e.g. 12px
).
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
).
Examples
// xoffset in points
symbol.xoffset = 6;
// xoffset in pixels
symbol.xoffset = "8px";
// xoffset in points
symbol.xoffset = "6pt";
The scale factor on the x axis of the symbol.
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
).
Examples
// yoffset in points
symbol.yoffset = 6;
// yoffset in pixels
symbol.yoffset = "8px";
// yoffset in points
symbol.yoffset = "6pt";
The scale factor on the y axis of the symbol.
Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
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
Handles marked for removal once the object is destroyed.
groupKey *
optionalKey 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.
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();
Inherited
Method fromJSON(json){* |null |undefined}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.
Returns
Type Description * | null | undefined Returns a new instance of this class.Inherited
Method hasHandles(groupKey){Boolean}
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 *
optionalA group key.
Returns
Type Description Boolean Returnstrue
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");
}
Inherited
Method removeHandles(groupKey)
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 *
optionalA 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");
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4