AMD: require(["esri/smartMapping/raster/renderers/vectorField"], (rasterVectorFieldCreator) => { /* code goes here */ });
ESM: import * as rasterVectorFieldCreator from "@arcgis/core/smartMapping/raster/renderers/vectorField.js";
Object: esri/smartMapping/raster/renderers/vectorField
Since: ArcGIS Maps SDK for JavaScript 4.20

This object contains helper methods for generating a VectorFieldRenderer for a Vector-UV or Vector-MagDir ImageryLayer or ImageryTileLayer.

The createRenderer method in this module generates a renderer that may be applied directly to the input layer.

Known Limitations

Method Overview

Name Return Type Summary Object

Generates a VectorFieldRenderer to display raster data with vector symbols.


Method Details



Generates a VectorFieldRenderer to display raster data with vector symbols. This renderer is often used for visualizing flow direction and magnitude information in meteorology and oceanography raster data.

params Object

Input parameters for generating a vector field visualization. See the table below for details of each parameter.


The input layer for which the renderer is generated.

renderingRule RasterFunction

Deprecated since 4.27. Use rasterFunction instead.

rasterFunction RasterFunction

Specifies the function for how the requested image should be processed. When rasterFunction is applied, the server returns updated service information that reflects custom processing as defined by the raster function. If not provided, the output renderer is created using the layer's rasterFunction.

flowRepresentation String

Defines the flow direction of the data. This can be modified to display meteorological (the direction it is flowing from) or oceanographic data (the direction it is flowing to). See VectorFieldRenderer.flowRepresentation for more information.

Possible Values:"flow-from"|"flow-to"

rotationType String

Defines the origin and direction of rotation depending on how the angle of rotation was measured. This property only applies to rotations around the heading axis. See VectorFieldRenderer.rotationType for more information.

Possible Values:"geographic"|"arithmetic"

style String

The predefined symbol styles used to represent the vector flow. See for more information.

Possible Values:"beaufort-ft"|"beaufort-km"|"beaufort-kn"|"beaufort-m"|"beaufort-mi"|"classified-arrow"|"ocean-current-kn"|"ocean-current-m"|"simple-scalar"|"single-arrow"|"wind-barb"

signal AbortSignal

Allows for cancelable requests. If canceled, the promise will be rejected with an error named AbortError. See also AbortController.

Type Description
Promise<VectorFieldRendererResult> Resolves to an object containing a VectorFieldRenderer that can be set on the input layer.

Type Definitions


Type Definition

The result object of the createRenderer() method. See the table below for details of each property.


The VectorFieldRenderer renderer to apply to the input layer.

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