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: SimpleFillSymbol
[ AMD Module Require | Legacy Module Require ]
require(["esri/symbols/SimpleFillSymbol"], function(SimpleFillSymbol) { /* code goes here */ });
Description
(Added at v1.0)
Fill symbols are used to draw polygon features on the graphics layer. SimpleFillSymbol can be solid, transparent, or one of several cross hatch patterns. In addition, the symbol can have an optional outline, which is defined by a line symbol.
Explore the SimpleFillSymbol 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/SimpleFillSymbol
Constructors
| Name | Summary |
|---|---|
| new SimpleFillSymbol() | Creates a new empty SimpleFillSymbol object. |
| new SimpleFillSymbol(style, outline, color) | Creates a new SimpleFillSymbol object with parameters. |
| new SimpleFillSymbol(json) | Creates a new SimpleFillSymbol object using a JSON object. |
Constants
| Name | Description |
|---|---|
STYLE_BACKWARD_DIAGONAL | The fill is backward diagonal lines. |
STYLE_CROSS | The fill is a cross. |
STYLE_DIAGONAL_CROSS | The fill is a diagonal cross. |
STYLE_FORWARD_DIAGONAL | The fill is forward diagonal lines. |
STYLE_HORIZONTAL | The fill is horizontal lines. |
STYLE_NULL | The polygon has no fill. |
STYLE_SOLID | The fill is solid. |
STYLE_VERTICAL | The fill is vertical lines. |
Properties
| Name | Type | Summary |
|---|---|---|
| color | Color | Symbol color - only applies when SimpleFillSymbol.style = 'STYLE_SOLID'. |
| outline | SimpleLineSymbol | Outline of the polygon. |
| style | String | The fill style. |
| type | String | The type of symbol. |
Methods
| Name | Return type | Summary |
|---|---|---|
| setColor(color) | SimpleFillSymbol | Sets the symbol color - only applies when style is STYLE_SOLID. |
| setOutline(outline) | FillSymbol | Sets the outline of the fill symbol. |
| setStyle(style) | SimpleFillSymbol | Sets the fill symbol style. |
| toJson() | Object | Converts object to its ArcGIS Server JSON representation. |
Constructor Details
Creates a new empty SimpleFillSymbol object.
Sample:
require([
"esri/symbols/SimpleFillSymbol", ...
], function(SimpleFillSymbol, ... ) {
var sfs = new SimpleFillSymbol();
...
});
Creates a new SimpleFillSymbol object with parameters.
Parameters:
< |
Required | See Constants table for values. |
< |
Required | See SimpleLineSymbol. |
< |
Required | Symbol color. |
Sample:
require([
"esri/symbols/SimpleFillSymbol", "esri/symbols/SimpleLineSymbol", "esri/Color", ...
], function(SimpleFillSymbol, SimpleLineSymbol, Color, ... ) {
var sfs = new SimpleFillSymbol(SimpleFillSymbol.STYLE_SOLID,
new SimpleLineSymbol(SimpleLineSymbol.STYLE_DASHDOT,
new Color([255,0,0]), 2),new Color([255,255,0,0.25])
);
...
});
Creates a new SimpleFillSymbol object using a JSON object.
Parameters:
< |
Required | JSON object representing the SimpleFillSymbol. 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. |
Property Details
<Color
ColorSymbol color - only applies when
SimpleFillSymbol.style = 'STYLE_SOLID'.<SimpleLineSymbol
SimpleLineSymbolOutline of the polygon.
<String
StringThe fill style. See the Constants table for valid values. Color is valid only with STYLE_SOLID.
Default value:
STYLE_SOLID<String
StringThe type of symbol.
Known values:
simplemarkersymbol | picturemarkersymbol | simplelinesymbol | cartographiclinesymbol | simplefillsymbol | picturefillsymbol | textsymbolMethod Details
Sets the symbol color - only applies when style is STYLE_SOLID.
Return type:
SimpleFillSymbolParameters:
< |
Required | Symbol color. |
Sets 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 fill symbol style.
Return type:
SimpleFillSymbolParameters:
< |
Required | Fill style. See the Constants table for valid values. |