SimpleFillSymbol

require(["esri/symbols/SimpleFillSymbol"], function(SimpleFillSymbol) { /* code goes here */ });
Class: esri/symbols/SimpleFillSymbol
Inheritance: SimpleFillSymbol FillSymbol Symbol Accessor
Since: ArcGIS API for JavaScript 4.0

SimpleFillSymbol is used for rendering 2D polygons in either a MapView or a SceneView. It can be filled with a solid color, or a pattern. In addition, the symbol can have an optional outline, which is defined by a SimpleLineSymbol.

SimpleFillSymbols may be applied to polygon features in a FeatureLayer or an individual Graphic.

Fill symbols may also be used to symbolize 2D polygon features in a 3D SceneView. However, it is recommended you use PolygonSymbol3D instead. The image below depicts a FeatureLayer whose graphics are styled with a SimpleFillSymbol.

sfs-sample

Autocasting support

As of version 4.5 of the ArcGIS API for JavaScript, autocasting is universally supported for all renderers, symbols, and symbol layers in the API. So there is no need to include this module in the require() and define() module loaders of your application unless you intend to use the static method(s) of this module.

See also:
Example:
var symbol = {
  type: "simple-fill",  // autocasts as new SimpleFillSymbol()
  color: [ 51,51, 204, 0.9 ],
  style: "solid",
  outline: {  // autocasts as new SimpleLineSymbol()
    color: "white",
    width: 1
  }
};

Constructors

new SimpleFillSymbol(properties)

Parameter:
properties Object
optional

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
Color

The color of the symbol.

more details
more detailsSimpleFillSymbol
String

The name of the class.

more details
more detailsAccessor
SimpleLineSymbol

The outline of the polygon.

more details
more detailsFillSymbol
String

The fill style.

more details
more detailsSimpleFillSymbol
String

For SimpleFillSymbol the type is always simple-fill.

more details
more detailsSimpleFillSymbol

Property Details

The color of the symbol. This can be autocast with a named string; hex string; array of rgb or rgba values; an object with r, g, b, and a properties; or a Color object.

Default Value: [0, 0, 0, 0.25] - black, semitransparent
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
};

declaredClassStringreadonly inherited

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

The outline of the polygon.

Example:
var sym = {
  type: "simple-fill",  // autocasts as new SimpleFillSymbol()
  color: "red",
  outline: {  // autocasts as new SimpleLineSymbol()
    color: [128, 128, 128, 0.5],
    width: "0.5px"
  }
};

styleString

The fill style. Valid values are listed in the table below:

ValueDescription
backward-diagonalsfs-backward-diagonal
crosssfs-cross
diagonal-crosssfs-diagonal-cross
forward-diagonalsfs-forward-diagonal
horizontalsfs-horizontal
noneThe polygon has no fill.
solidsfs-solid
verticalsfs-vertical

Known Limitations

This property is not supported in 3D SceneViews.

Default Value: solid

typeString

For SimpleFillSymbol the type is always simple-fill.

Method Overview

NameReturn TypeSummaryClass
SimpleFillSymbol

Creates a deep clone of the symbol.

more details
more detailsSimpleFillSymbol
*

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform.

more details
more detailsSymbol
Object

Converts an instance of this class to its ArcGIS Portal JSON representation.

more details
more detailsSymbol

Method Details

Creates a deep clone of the symbol.

Returns:
TypeDescription
SimpleFillSymbolA deep clone of the object that invoked this method.
Example:
// Creates a deep clone of the graphic's symbol
var symLyr = graphic.symbol.clone();

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. 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 Object

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:
TypeDescription
*Returns a new instance of this class.

toJSON(){Object}inherited

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

Returns:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.