StylePattern3D

require(["esri/symbols/patterns/StylePattern3D"], function(StylePattern3D) { /* code goes here */ });
Class: esri/symbols/patterns/StylePattern3D
Inheritance: StylePattern3D Accessor
Since: ArcGIS API for JavaScript 4.17

Renders polygons with predefined style pattern fills.

polygon-patterns

See also:
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"
    }
  }]
};

Constructors

new StylePattern3D(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
String

The fill style.

more details
more detailsStylePattern3D
String

The pattern type.

more details
more detailsStylePattern3D

Property Details

declaredClass Stringreadonly inherited

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

style String

The fill style. Possible 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

Possible Values:"backward-diagonal"|"cross"|"diagonal-cross"|"forward-diagonal"|"horizontal"|"none"|"solid"|"vertical"

Default Value:solid
type String

The pattern type.

For StylePattern3D the type is always "style".

Method Overview

NameReturn TypeSummaryClass
StylePattern3D

Creates a deep clone of the pattern.

more details
more detailsStylePattern3D
*

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

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

more details
more detailsStylePattern3D

Method Details

Creates a deep clone of the pattern.

Returns:
TypeDescription
StylePattern3DA deep clone of the object that invoked this method.
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}

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

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

API Reference search results

NameTypeModule
Loading...