FillSymbol3DLayer

AMD: require(["esri/symbols/FillSymbol3DLayer"], (FillSymbol3DLayer) => { /* code goes here */ });
ESM: import FillSymbol3DLayer from "@arcgis/core/symbols/FillSymbol3DLayer";
Class: esri/symbols/FillSymbol3DLayer
Inheritance: FillSymbol3DLayer Symbol3DLayer Accessor
Since: ArcGIS Maps SDK for JavaScript 4.0

FillSymbol3DLayer is used to render the surfaces of flat 2D Polygon geometries and 3D volumetric meshes in a SceneView. MapView does not support 3D symbols.

The color of the fill is set in the material property. Because of the nature of polygon and mesh geometries, size is not an option in this symbol layer. Colors can be data-driven by adding a color visual variable to any Renderer that uses this symbol layer.

A FillSymbol3DLayer must be added to the symbolLayers property of a PolygonSymbol3D or MeshSymbol3D. Multiple symbol layers may be used in a single symbol. The outline property does not have an effect when used with a MeshSymbol3D. The image below depicts a polygon FeatureLayer whose features are symbolized with a PolygonSymbol3D containing a FillSymbol3DLayer.

symbols-3d-fill

See Symbol3DLayer and Symbol3D to read more general information about 3D symbols, symbol layers and how they relate to one another.

See also
Example
const symbol = {
  type: "polygon-3d",  // autocasts as new PolygonSymbol3D()
  symbolLayers: [{
    type: "fill",  // autocasts as new FillSymbol3DLayer()
    material: { color: "red" }
  }]
};

Constructors

new FillSymbol3DLayer(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.
Show inherited properties Hide inherited properties
Name Type Summary Class
Boolean

Indicates whether the symbol layer geometry casts shadows in the scene.

more details
FillSymbol3DLayer
String

The name of the class.

more details
Accessor
Edges3D

Sets the contour edges on 3D Objects.

more details
FillSymbol3DLayer
Object

The material defines the final color of the graphic, by blending the color property set in the material with the feature's geometry color/texture information.

more details
FillSymbol3DLayer
Object

The outline used to draw a line around the filled geometry.

more details
FillSymbol3DLayer
StylePattern3D

The pattern used to render the polygon fill.

more details
FillSymbol3DLayer
String

The symbol type.

more details
FillSymbol3DLayer

Property Details

castShadows Boolean
Since: ArcGIS Maps SDK for JavaScript 4.11

Indicates whether the symbol layer geometry casts shadows in the scene. Setting this property to false will disable shadows for the symbol layer even if direct shadows are enabled in SceneView.environment.

This property applies only to MeshSymbol3D symbols.

Default Value:true
Example
// disables shadow casting
symbolLayer.castShadows = false;
declaredClass Stringreadonly inherited
Since: ArcGIS Maps SDK for JavaScript 4.7

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

Since: ArcGIS Maps SDK for JavaScript 4.7

Sets the contour edges on 3D Objects. This is only applicable for MeshSymbol3D.

symbol3D-edges-solid

Example
const symbol = {
  type: "mesh-3d", // autocasts as new MeshSymbol3D()
  symbolLayers: [{
    type: "fill", // autocasts as new FillSymbol3DLayer()
    material: {
      color: [244, 247, 134]
    },
    edges: {
      type: "solid", // autocasts as new SolidEdges3D()
      color: [50, 50, 50, 0.5]
    }
  }]
};
material Objectautocast

The material defines the final color of the graphic, by blending the color property set in the material with the feature's geometry color/texture information. colorMixMode defines how these colors are mixed together.

Properties
color Color
optional
Default Value:white
Autocasts from Object|Number[]|String

The color of the fill. 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.

colorMixMode String
optional
Default Value:multiply

Specifies how the material color is applied to the geometry color/texture information. This property applies only to MeshSymbol3D symbols.

Value Description
tint Applies the material color to the desaturated geometry/texture color.
replace Removes the geometry/texture color and applies the material color.
multiply Multiplies geometry/texture color value with the material color value. The result is a darker color. Multiplying with white keeps the geometry color the same.

Possible Values:"tint"|"replace"|"multiply"

See also
Examples
// CSS color string
symbolLayer.material = {
  color: "dodgerblue",
  colorMixMode: "tint"
};
// HEX string
symbolLayer.material = {
  color: "#33cc33"
}
// array of RGBA values
symbolLayer.material = {
  color: [51, 204, 51, 0.3]
}
// object with rgba properties
symbolLayer.material = {
  color: {
    r: 51,
    g: 51,
    b: 204,
    a: 0.7
  }
};
outline Objectautocast

The outline used to draw a line around the filled geometry. This property is not supported in MeshSymbol3D symbol layers.

Properties
color Color
optional
Default Value:black
Autocasts from Object|Number[]|String

The color of the outline. 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.

size Number
optional
Default Value:1px
Autocasts from Number|String

The width of the outline in points. This value may be autocast with a string expressing size in points or pixels (e.g. 12px).

optional

The stroke pattern used to render the outline. By default, the lines are shown as solid.

patternCap String
optional
Default Value:butt

The style applied to the tips of each pattern segment along the line.

Possible Values:"butt"|"round"|"square"

Example
symbolLayer.outline = {
  color: "white",
  size: "2px",
  pattern: {  // autocasts as new LineStylePattern3D()
    type: "style",
    style: "dash"
  },
  patternCap: "round"
};
pattern StylePattern3D
Since: ArcGIS Maps SDK for JavaScript 4.17

The pattern used to render the polygon fill. This property only applies to PolygonSymbol3D.

Example
const symbol = {
  type: "polygon-3d",  // autocasts as new PolygonSymbol3D()
  symbolLayers: [{
    type: "fill",  // autocasts as new FillSymbol3DLayer()
    material: { color: "red" },
    outline: { color: "red" },
    pattern: {
      type: "style",
      style: "cross"
    }
  }]
};
type Stringreadonly

The symbol type.

For FillSymbol3DLayer the type is always "fill".

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
FillSymbol3DLayer

Creates a deep clone of the symbol layer.

more details
FillSymbol3DLayer
*

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

more details
Symbol3DLayer
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Object

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

more details
Symbol3DLayer

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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 layer.

Returns
Type Description
FillSymbol3DLayer A deep clone of the object that invoked this method.
Example
// Creates a deep clone of the graphic's first symbol layer
let symLyr = graphic.symbol.symbolLayers.getItemAt(0).clone();
fromJSON(json){*}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.

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
Type Description
* Returns a new instance of this class.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true 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");
}
removeHandles(groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A 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");
toJSON(){Object}inherited

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

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.