StylePattern3D

AMD: require(["esri/symbols/patterns/StylePattern3D"], (StylePattern3D) => { /* code goes here */ });
ESM: import StylePattern3D from "@arcgis/core/symbols/patterns/StylePattern3D";
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.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

The fill style.

more detailsStylePattern3D
Stringmore details

The pattern type.

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:

Value Description
backward-diagonal sfs-backward-diagonal
cross sfs-cross
diagonal-cross sfs-diagonal-cross
forward-diagonal sfs-forward-diagonal
horizontal sfs-horizontal
none The polygon has no fill.
solid sfs-solid
vertical sfs-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

Name Return Type Summary Class
StylePattern3Dmore details

Creates a deep clone of the pattern.

more detailsStylePattern3D
*more details

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

more detailsStylePattern3D
Objectmore details

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

more detailsStylePattern3D

Method Details

clone(){StylePattern3D}

Creates a deep clone of the pattern.

Returns:
Type Description
StylePattern3D A 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 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.
toJSON(){Object}

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.