vectorField | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Method Overview

Name	Return Type	Summary	Object
	Promise<VectorFieldRendererResult>	Generates a VectorFieldRenderer to display raster data with vector symbols.	vectorField

Method Details

createRenderer Method 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

layer ImageryLayer|ImageryTileLayer

The input layer for which the renderer is generated.

renderingRule RasterFunction

optional

Deprecated since 4.27. Use rasterFunction instead.

rasterFunction RasterFunction

optional

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

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.

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 Type Definition VectorFieldRendererResult

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

Property: renderer VectorFieldRenderer

The VectorFieldRenderer renderer to apply to the input layer.