Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: PictureFillSymbol
[ AMD Module Require | Legacy Module Require ]
require(["esri/symbols/PictureFillSymbol"], function(PictureFillSymbol) { /* code goes here */ });
Description
(Added at v1.0)
Fill symbols are used to draw polygon features on the graphics layer. PictureFillSymbol uses an image in a repeating pattern. In addition, the symbol can have an optional outline, which is defined by a line symbol.
Explore the PictureFillSymbol in the ArcGIS Symbol Playground. This is a place to explore and learn how to work with various properties and methods before implementing it into custom code. Try out new features, customize them, and copy the generated code into your own application. This sample provides a starting point so as to allow use of these features as quickly as possible.Samples
Search for samples that use this class.Class hierarchy
esri/symbols/Symbol |_esri/symbols/FillSymbol |_esri/symbols/PictureFillSymbol
Constructors
| Name | Summary |
|---|---|
| new PictureFillSymbol(url, outline, width, height) | Creates a new PictureFillSymbol object. |
| new PictureFillSymbol(json) | Creates a new PictureFillSymbol object using a JSON object. |
Properties
| Name | Type | Summary |
|---|---|---|
| color | Color | Symbol color. |
| height | Number | Height of the image in pixels. |
| outline | SimpleLineSymbol | Outline of the polygon. |
| type | String | The type of symbol. |
| url | String | URL of the image. |
| width | Number | Width of the image in pixels. |
| xoffset | Number | The offset on the x-axis in pixels. |
| xscale | Number | Scale factor in x direction. |
| yoffset | Number | The offset on the y-axis in pixels. |
| yscale | Number | Scale factor in y direction. |
Methods
| Name | Return type | Summary |
|---|---|---|
| setColor(color) | Symbol | Sets the symbol color. |
| setHeight(height) | PictureFillSymbol | Sets the height of the symbol. |
| setOffset(x, y) | PictureFillSymbol | Sets the symbol offset. |
| setOutline(outline) | FillSymbol | Sets the outline of the fill symbol. |
| setUrl(url) | PictureFillSymbol | Sets the URL to the location of the symbol. |
| setWidth(width) | PictureFillSymbol | Sets the width of the symbol. |
| setXScale(scale) | PictureFillSymbol | Sets the scale factor in x direction. of the symbol. |
| setYScale(scale) | PictureFillSymbol | Sets the scale factor in y direction. |
| toJson() | Object | Converts object to its ArcGIS Server JSON representation. |
Constructor Details
Creates a new PictureFillSymbol object.
Parameters:
< |
Required | URL of the image. |
< |
Required | Outline of the symbol. |
< |
Required | Width of the image in pixels. |
< |
Required | Height of the image in pixels. |
Sample:
require([
"esri/symbols/PictureFillSymbol", "esri/symbols/SimpleLineSymbol", "esri/Color", ...
], function(PictureFillSymbol, SimpleLineSymbol, Color, ... ) {
var pfs = new PictureFillSymbol('images/sand.png',
new SimpleLineSymbol(SimpleLineSymbol.STYLE_SOLID,
new Color('#000'), 1),
42, 42);
...
});
Creates a new PictureFillSymbol object using a JSON object.
Parameters:
< |
Required | JSON object representing the PictureFillSymbol. View the Symbol Objects (Common data types in ArcGIS) for details on creating a JSON symbol. Note that when specifying symbol width and height using JSON the values should be entered in points, the JavaScript API then converts the point values to pixels. |
Sample:
require([
"esri/symbols/PictureFillSymbol", ...
], function(PictureFillSymbol, ... ) {
var symbol = new PictureFillSymbol({
"url":"graphics/redArrow2.png",
"height":20,
"width":20,
"type":"esriPFS"
});
...
});
Property Details
<Color
ColorSymbol color.
<Number
NumberHeight of the image in pixels.
<SimpleLineSymbol
SimpleLineSymbolOutline of the polygon.
<String
StringThe type of symbol.
Known values:
simplemarkersymbol | picturemarkersymbol | simplelinesymbol | cartographiclinesymbol | simplefillsymbol | picturefillsymbol | textsymbol<String
StringURL of the image.
<Number
NumberWidth of the image in pixels.
Method Details
Sets the symbol color.
Return type:
SymbolParameters:
< |
Required | Symbol color. |
Sample:
require([
"esri/Color", ...
], function(Color, ... ) {
symbol.setColor(new Color([255,255,0,0.5]));
...
});
Sets the height of the symbol.
Return type:
PictureFillSymbolParameters:
< |
Required | Height in pixels. |
Sets the symbol offset.
Return type:
PictureFillSymbolSets the outline of the fill symbol.
Return type:
FillSymbolParameters:
< |
Required | Symbol used for outline. |
Sample:
require([
"esri/symbols/SimpleLineSymbol", "esri/Color", ...
], function(SimpleLineSymbol, Color, ... ) {
selSymbol.setOutline(new SimpleLineSymbol(esri.symbol.SimpleLineSymbol.STYLE_SOLID, new Color([255,0,0]), 2));
...
});
Sets the URL to the location of the symbol.
Return type:
PictureFillSymbolParameters:
< |
Required | URL string. |
Sets the width of the symbol.
Return type:
PictureFillSymbolParameters:
< |
Required | Width in pixels. |
Sets the scale factor in x direction.
of the symbol.
Return type:
PictureFillSymbolParameters:
< |
Required | Scale factor in x direction. |
Sets the scale factor in y direction.
Return type:
PictureFillSymbolParameters:
< |
Required | Scale factor in y direction. |