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. Based on plotthis VelocityPlot (plot_type raw / grid / stream) and matplotlib quiver / streamplot
# streamlineColor
Fixed color for streamlines (stream mode). When unset (or "magnitude") streamlines are colored by velocity magnitude
Type:
string
Default:
Used in:
Scatter2D
# streamlineSeedStride
Seed a streamline every N grid cells (stream mode); larger values draw fewer streamlines
Type:
integer
Default:
2
Used in:
Scatter2D
# streamlineStepSize
RK4 step size as a fraction of the grid cell size (stream mode)
Type:
float
Default:
0.5
Used in:
Scatter2D
# streamlineSteps
Maximum RK4 integration steps per streamline (stream mode)
Type:
integer
Default:
160
Used in:
Scatter2D
# vectorArrowSize
Length (pixels) of the arrowhead drawn at each vector tip / streamline midpoint
Type:
float
Default:
7
Used in:
Scatter2D
# 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:
Scatter2D
# 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:
Scatter2D
# 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:
Scatter2D
# 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
Used in:
Scatter2D
# 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:
Scatter2D
# vectorGroupBy
Column (sample) name holding a group label used to color raw arrows
Type:
string
Default:
Used in:
Scatter2D
# vectorGroupPalette
Qualitative hex colors used to color raw arrows by group (one per group, cycled). Defaults to ColorBrewer Set1
Type:
array
Default:
[]
Used in:
Scatter2D
# vectorLineWidth
Rendered width (pixels) of the arrow shafts and streamlines
Type:
float
Default:
1
Used in:
Scatter2D
# vectorMinMagnitude
Velocity magnitude below which streamline integration stops (stream mode). Defaults to 1% of the maximum magnitude
Type:
float
Default:
Used in:
Scatter2D
# 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:
Scatter2D
# vectorScale
Multiplier applied to the auto arrow length (raw / grid modes). Larger values draw longer arrows
Type:
float
Default:
1
Used in:
Scatter2D
# vectorShowLegend
Flag to show the vector-field legend (magnitude color ramp, or the group legend in raw mode)
Type:
boolean
Default:
true
Used in:
Scatter2D
# vectorUBy
Column (sample) name holding the x velocity component when the input is a standard Scatter2D matrix
Type:
string
Default:
vx
Used in:
Scatter2D
# vectorVBy
Column (sample) name holding the y velocity component when the input is a standard Scatter2D matrix
Type:
string
Default:
vy
Used in:
Scatter2D
# vectorXBy
Column (sample) name holding the x position when the input is a standard Scatter2D matrix
Type:
string
Default:
x
Used in:
Scatter2D
# vectorYBy
Column (sample) name holding the y position when the input is a standard Scatter2D matrix
Type:
string
Default:
y
Used in:
Scatter2D
