require(["esri/smartMapping/raster/renderers/vectorField"], (rasterVectorFieldCreator) => { /* code goes here */ });
import * as rasterVectorFieldCreator from "@arcgis/core/smartMapping/raster/renderers/vectorField.js";
esri/smartMapping/raster/renderers/vectorField
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
- VectorFieldRenderer is only supported with ImageryTileLayer and
ImageryLayer where the
source type
is
Vector-UVorVector-MagDir. - VectorFieldRenderer is only supported in 2D MapView.
Method Overview
| Name | Return Type | Summary | Object |
|---|---|---|---|
| Promise<VectorFieldRendererResult> | Generates a VectorFieldRenderer to display raster data with vector symbols. more details | vectorField |
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.
ParametersSpecificationparams ObjectInput parameters for generating a vector field visualization. See the table below for details of each parameter.
Specificationlayer ImageryLayer|ImageryTileLayerThe input layer for which the renderer is generated.
renderingRule RasterFunctionoptionalDeprecated since 4.27. Use
rasterFunctioninstead.rasterFunction RasterFunctionoptionalSpecifies the function for how the requested image should be processed. When
rasterFunctionis 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'srasterFunction.flowRepresentation StringoptionalDefines 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 StringoptionalDefines the origin and direction of rotation depending on how the angle of rotation was measured. This property only applies to rotations around the
headingaxis. See VectorFieldRenderer.rotationType for more information.Possible Values:"geographic"|"arithmetic"
style StringoptionalThe 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 AbortSignaloptionalAllows for cancelable requests. If canceled, the promise will be rejected with an error named
AbortError. See also AbortController.ReturnsType 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
-
renderer VectorFieldRenderer
The VectorFieldRenderer renderer to apply to the input layer.