vectorField

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

This object contains helper methods for generating a VectorFieldRenderer for raster layers (i.e. ImageryLayer, ImageryTileLayer, or WCSLayer).

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

Method Overview

Name Return Type Summary Object
Promise<VectorFieldRendererResult>more details

Generates a VectorFieldRenderer to display raster data with vector symbols.

more detailsvectorField

Method Details

createRenderer(params){Promise<VectorFieldRendererResult>}

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.

Parameters:
Specification:
params Object

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

Specification:

The input layer for which the renderer is generated.

renderingRule RasterFunction
optional

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

flowRepresentation String
optional

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
optional

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
optional

The predefined symbol styles used to represent the vector flow. See VectorFieldRenderer.style 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
optional

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

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

Type Definitions

VectorFieldRendererResult

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

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.