import { createRenderer } from "@arcgis/core/smartMapping/raster/renderers/vectorField.js";const { createRenderer } = await $arcgis.import("@arcgis/core/smartMapping/raster/renderers/vectorField.js");- 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
VectorFieldRenderer is only supported with ImageryTileLayer and
ImageryLayer where the
source type
is Vector-UV or Vector-MagDir.
VectorFieldRenderer is only supported in 2D MapView.
Type definitions
VectorFieldRendererParameters
- Supertypes
- RasterRendererParameters
flowRepresentation
- Type
- VectorFieldRenderer["flowRepresentation"] | undefined
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.
rotationType
- Type
- RotationType | undefined
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.
style
- Type
- VectorFieldRenderer["style"] | undefined
The predefined symbol styles used to represent the vector flow. See VectorFieldRenderer.style for more information.
VectorFieldRendererResult
The result object of the createRenderer() method. See the table below for details of each property.
renderer
- Type
- VectorFieldRenderer
The VectorFieldRenderer renderer to apply to the input layer.
Functions
| Name | Return Type | Object |
|---|---|---|
| | |
| | |
| |
createRenderer
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.
- Signature
-
createRenderer (parameters: VectorFieldRendererParameters): Promise<VectorFieldRendererResult>
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| parameters | Input parameters for generating a vector field visualization. | |
- Returns
- Promise<VectorFieldRendererResult>
Resolves to an object containing a VectorFieldRenderer that can be set on the input layer.