FillSymbol3DLayer

require(["esri/symbols/FillSymbol3DLayer"], function(FillSymbol3DLayer) { /* code goes here */ });
Class: esri/symbols/FillSymbol3DLayer
Inheritance: FillSymbol3DLayer Symbol3DLayer Accessor
Since: ArcGIS API 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 affect 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.

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: "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.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
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
more detailsFillSymbol3DLayer
Object

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

more details
more detailsFillSymbol3DLayer
String

For FillSymbol3DLayer the type is always fill.

more details
more detailsFillSymbol3DLayer

Property Details

declaredClassStringreadonly inherited

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

materialObject

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

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

colorMixMode String
optional

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

ValueDescription
tintApplies the material color to the desaturated geometry/texture color.
replaceRemoves the geometry/texture color and applies the material color.
multiplyMultiplies geometry/texture color value with the material color value. The result is a darker color. Multiplying with white keeps the geometry color the same.

Default value: 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
  }
};

outlineObject

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

Properties:
color Color

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

size Number

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

Example:
symbolLayer.outline = {
  color: "white",
  size: "1px"
};

typeString

For FillSymbol3DLayer the type is always fill.

Method Overview

NameReturn TypeSummaryClass
FillSymbol3DLayer

Creates a deep clone of the symbol layer.

more details
more detailsFillSymbol3DLayer
*

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 detailsSymbol3DLayer
Object

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

more details
more detailsSymbol3DLayer

Method Details

Creates a deep clone of the symbol layer.

Returns:
TypeDescription
FillSymbol3DLayerA deep clone of the object that invoked this method.
Example:
// Creates a deep clone of the graphic's first symbol layer
var 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 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.