# Interface VectorFieldRendererJson

A vector field renderer is a renderer that uses symbolizes a U-V or Magnitude-Direction data.

interface VectorFieldRendererJson {
attributeField: "Magnitude";
authoringInfo?: AuthoringInfoJson;
flowRepresentation: "flow_from" | "flow_to";
inputUnit?: MagnitudeUnitJsonType;
outputUnit?: MagnitudeUnitJsonType;
rotationExpression?: string;
rotationType?: RotationJsonType;
style:
| "beaufort_ft"
| "beaufort_km"
| "beaufort_kn"
| "beaufort_m"
| "beaufort_mi"
| "classified_arrow"
| "ocean_current_kn"
| "ocean_current_m"
| "simple_scalar"
| "single_arrow"
| "wind_speed";
symbolTileSize?: number;
type: "vectorField";
visualVariables?: VisualVariableJson[];
}

#### Hierarchy (view full)

- RendererJsonBase
  - VectorFieldRendererJson

#####
Index

### Properties

attributeField
authoringInfo?
flowRepresentation
inputUnit?
outputUnit?
rotationExpression?
rotationType?
style
symbolTileSize?
type
visualVariables?

##
Properties

### attributeField

attributeField

Name of the feature attribute field that contains the data value.

### `Optional` authoringInfo

authoringInfo?: AuthoringInfoJson

An object containing metadata about the authoring process for creating a renderer object. This allows the authoring clients to save specific overridable settings so that next time it is accessed via the UI, their selections are remembered. Non-authoring clients should ignore it.

Inherited from RendererJsonBase.authoringInfo

### flowRepresentation

flowRepresentation: "flow_from" | "flow_to"

Sets the flow direction of the data.

### `Optional` inputUnit

inputUnit?: MagnitudeUnitJsonType

Input unit for Magnitude.

### `Optional` outputUnit

outputUnit?: MagnitudeUnitJsonType

Output unit for Magnitude.

### `Optional` rotationExpression

rotationExpression?: string

A constant value or an expression that derives the angle of rotation based on a feature attribute value. When an attribute name is specified, it's enclosed in square brackets.

Inherited from RendererJsonBase.rotationExpression

### `Optional` rotationType

rotationType?: RotationJsonType

String value (either geographic or arithmetic) which controls the origin and direction of rotation on point features. If the rotationType is defined as 'arithmetic', the symbol is rotated from East in a counter-clockwise direction where East is the 0� axis. If the rotationType is defined as 'geographic', the symbol is rotated from North in a clockwise direction where North is the 0� axis.

Inherited from RendererJsonBase.rotationType

### style

style:
| "beaufort_ft"
| "beaufort_km"
| "beaufort_kn"
| "beaufort_m"
| "beaufort_mi"
| "classified_arrow"
| "ocean_current_kn"
| "ocean_current_m"
| "simple_scalar"
| "single_arrow"
| "wind_speed"

A predefined style.

### `Optional` symbolTileSize

symbolTileSize?: number

Determines the density of the symbols. Larger tile size, fewer symbols appear in the display. The VectorFieldRenderer draws one symbol within a defined tile size (in pixels). The default is 50 pixels.

### type

type

The type of renderer. See RendererJsonType.

Overrides RendererJsonBase.type

### `Optional` visualVariables

visualVariables?: VisualVariableJson[]

An array of visualVariable objects used for continuous color or size, simple, and unique values with feature opacity.

Inherited from RendererJsonBase.visualVariables