Vector Field Plots : Parameters for vector-field plots: velocity / quiver / streamplot visualizations drawn over a 2D coordinate space (direction + magnitude per sample). Set scatterType to vectorfield on a Scatter2D, or mapVectorField to true on a Map (positions come from the lat / lng marker columns and velocity from vectorUBy / vectorVBy, defaulting to vx / vy). Based on plotthis VelocityPlot (plot_type raw / grid / stream) and matplotlib quiver / streamplot

# mapVectorField
Flag to draw a vector-field overlay (raw arrows / gridded quiver / integrated streamlines) on a Map. Positions are read from the lat / lng marker columns of data.x and the velocity components from vectorUBy / vectorVBy (defaulting to vx eastward / vy northward)
Type: boolean
Default: false
Used in: Map, Scatter2D

# streamlineColor
Fixed color for streamlines (stream mode). When unset (or "magnitude") streamlines are colored by velocity magnitude
Type: string
Default:
Used in: Map, Scatter2D

streamlineColor : "magnitude"

streamlineColor : "#377eb8"


# streamlineSeedStride
Seed a streamline every N grid cells (stream mode); larger values draw fewer streamlines
Type: integer
Default: 2
Used in: Map, Scatter2D

streamlineSeedStride : 1

streamlineSeedStride : 4


# streamlineStepSize
RK4 step size as a fraction of the grid cell size (stream mode)
Type: float
Default: 0.5
Used in: Map, Scatter2D

streamlineStepSize : 0.25

streamlineStepSize : 1


# streamlineSteps
Maximum RK4 integration steps per streamline (stream mode)
Type: integer
Default: 160
Used in: Map, Scatter2D

streamlineSteps : 15

streamlineSteps : 160


# vectorArrowSize
Length (pixels) of the arrowhead drawn at each vector tip / streamline midpoint
Type: float
Default: 7
Used in: Map, Scatter2D

vectorArrowSize : 4

vectorArrowSize : 10


# vectorColorByMagnitude
Flag to color raw arrows by velocity magnitude (gradient) instead of by the group annotation. Grid arrows and streamlines are always colored by magnitude unless streamlineColor is set
Type: boolean
Default: false
Used in: Map, Scatter2D

vectorColorByMagnitude : false

vectorColorByMagnitude : true


# vectorColorValueColor
Color for the Fixed arrow color used in raw mode when there is no group annotation and vectorColorByMagnitude is off
Type: color
Default: rgb(55,126,184)
Used in: Map, Scatter2D

vectorColorValueColor : "rgb(55,126,184)"

vectorColorValueColor : "rgb(228,26,28)"


# vectorDensity
Fraction (0..1) of samples to draw in raw mode (subsampling for dense embeddings). 1 draws every sample
Type: float
Default: 1
Used in: Map, Scatter2D

vectorDensity : 0.3

vectorDensity : 1


# vectorFieldMode
Vector-field rendering mode: raw draws one arrow per sample, grid averages the field onto a regular grid and draws one arrow per cell (quiver), stream draws integrated streamlines (streamplot)
Type: string
Default: raw
Options: raw, grid, stream
Used in: Map, Scatter2D

vectorFieldMode : "raw"

vectorFieldMode : "grid"

vectorFieldMode : "stream"


# vectorGridSize
Number of cells per axis when averaging the field onto a grid (grid mode) or sampling it for streamlines (stream mode)
Type: integer
Default: 20
Used in: Map, Scatter2D

vectorGridSize : 10

vectorGridSize : 25


# vectorGroupBy
Column (sample) name holding a group label used to color raw arrows
Type: string
Default:
Used in: Map, Scatter2D

vectorGroupBy : false

vectorGroupBy : "Cluster"


# vectorGroupPalette
Qualitative hex colors used to color raw arrows by group (one per group, cycled). Defaults to ColorBrewer Set1
Type: array
Default: []
Used in: Map, Scatter2D

vectorGroupPalette : ["#e41a1c", "#377eb8", "#4daf4a"]

vectorGroupPalette : ["#984ea3", "#ff7f00", "#a65628"]


# vectorLineWidth
Rendered width (pixels) of the arrow shafts and streamlines
Type: float
Default: 1
Used in: Map, Scatter2D

vectorLineWidth : 1

vectorLineWidth : 2.5


# vectorMinMagnitude
Velocity magnitude below which streamline integration stops (stream mode). Defaults to 1% of the maximum magnitude
Type: float
Default:
Used in: Map, Scatter2D

vectorMinMagnitude : 0

vectorMinMagnitude : 0.8


# vectorPalette
Ordered hex color stops (low to high magnitude) for the vector / streamline magnitude gradient. Defaults to a blue-white-red ramp
Type: array
Default: []
Used in: Map, Scatter2D

vectorPalette : ["#ffffcc", "#fd8d3c", "#800026"]

vectorPalette : ["#377eb8", "#e41a1c"]


# vectorScale
Multiplier applied to the auto arrow length (raw / grid modes). Larger values draw longer arrows
Type: float
Default: 1
Used in: Map, Scatter2D

vectorScale : 0.5

vectorScale : 2


# vectorShowLegend
Flag to show the vector-field legend (magnitude color ramp, or the group legend in raw mode)
Type: boolean
Default: true
Used in: Map, Scatter2D

vectorShowLegend : true

vectorShowLegend : false


# vectorUBy
Column (sample) name holding the x velocity component when the input is a standard Scatter2D matrix
Type: string
Default: vx
Used in: Map, Scatter2D

vectorUBy : "velocity_1"


# vectorVBy
Column (sample) name holding the y velocity component when the input is a standard Scatter2D matrix
Type: string
Default: vy
Used in: Map, Scatter2D

vectorVBy : "velocity_2"


# vectorXBy
Column (sample) name holding the x position when the input is a standard Scatter2D matrix
Type: string
Default: x
Used in: Map, Scatter2D

vectorXBy : "UMAP_1"


# vectorYBy
Column (sample) name holding the y position when the input is a standard Scatter2D matrix
Type: string
Default: y
Used in: Map, Scatter2D

vectorYBy : "UMAP_2"


⇧