SimpleFillSymbol | References | ArcGIS Maps SDK for JavaScript

import SimpleFillSymbol from "@arcgis/core/symbols/SimpleFillSymbol.js";

Inheritance:: SimpleFillSymbol→FillSymbol→Symbol→Accessor

Since: ArcGIS Maps SDK 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.

See also

Example

let 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

Constructor

Parameters

Parameter	Type	Description	Required
properties	`SimpleFillSymbolProperties`

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`color`	`Color`
`declaredClass` readonly inherited	`string`	Accessor
`outline` inherited	`SimpleLineSymbol \| null \| undefined`	FillSymbol
`style`	`FillStyle`
`type` readonly	`"simple-fill"`

color

autocast Property

Type: Color

The color of the symbol. This can be autocast with an array of rgb(a) values, named string, hex string or an hsl(a) string, 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
};

// 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
};

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

outline

autocast inherited Property

Type: SimpleLineSymbol | null | undefined

Inherited from: FillSymbol

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"
  }
};

style

Property

Type: FillStyle

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

Value	Description
backward-diagonal
cross
diagonal-cross
forward-diagonal
horizontal
none	The polygon has no fill.
solid
vertical

Default value: "solid"

type

readonly Property

Type: "simple-fill"

The symbol type.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone`	`clone(): SimpleFillSymbol`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

clone

Method

Signature: clone (): SimpleFillSymbol

Creates a deep clone of the symbol.

Returns: SimpleFillSymbol
A deep clone of the object that invoked this method.

Example

// Creates a deep clone of the graphic's symbol
let symLyr = graphic.symbol.clone();

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.