uPlot Types

Configuration types for uPlot charts in viser.

For comprehensive documentation about uPlot options, see: https://github.com/leeoniya/uPlot/tree/1.6.32/docs

uPlot type definitions and enums.

class viser.uplot.Axis

TypedDict type for uPlot.

show: bool
scale: str
side: Literal[0, 1, 2, 3]
size: float | Never
gap: float
font: str
lineGap: float
stroke: str
label: str | Never
labelSize: float
labelGap: float
labelFont: str
space: float | Never
incrs: Tuple[float, ...] | Never
splits: Tuple[float, ...] | Never
filter: Never
rotate: float | Never
align: Literal[1, 2]
alignTo: Literal[1, 2]
grid: Axis_Grid
ticks: Axis_Ticks
border: Axis_Border
class viser.uplot.Axis_Border

TypedDict type for uPlot.

show: bool
stroke: str
width: float
dash: Tuple[float, ...]
cap: str
class viser.uplot.Axis_Grid

TypedDict type for uPlot.

show: bool
stroke: str
width: float
dash: Tuple[float, ...]
cap: str
filter: Never
class viser.uplot.Axis_Ticks

TypedDict type for uPlot.

show: bool
stroke: str
width: float
dash: Tuple[float, ...]
cap: str
filter: Never
size: float
class viser.uplot.Band

TypedDict type for uPlot.

series: Required[Tuple[float, float]]
fill: str
dir: Literal[1, -1]
class viser.uplot.Cursor

TypedDict type for uPlot.

show: bool
x: bool
y: bool
left: float
top: float
idx: float | None
dataIdx: Never
idxs: Tuple[float | None, ...]
move: Never
points: Cursor_Points
bind: Cursor_Bind
drag: Cursor_Drag
sync: Cursor_Sync
focus: Cursor_Focus
hover: Cursor_Hover
lock: bool
event: Never
class viser.uplot.Cursor_Bind

TypedDict type for uPlot.

mousedown: Never
mouseup: Never
click: Never
dblclick: Never
mousemove: Never
mouseleave: Never
mouseenter: Never
class viser.uplot.Cursor_Drag

TypedDict type for uPlot.

setScale: bool
x: bool
y: bool
dist: float
uni: float
click: Any
class viser.uplot.Cursor_Focus

TypedDict type for uPlot.

prox: Required[float]
bias: Literal[0, 1, -1]
dist: Any
class viser.uplot.Cursor_Hover

TypedDict type for uPlot.

prox: float | None | Any
bias: Literal[0, 1, -1]
skip: Tuple[Any, ...]
class viser.uplot.Cursor_Points

TypedDict type for uPlot.

show: bool | Never
one: bool
size: float | Never
bbox: Never
width: float | Never
stroke: str
fill: str
class viser.uplot.Cursor_Sync

TypedDict type for uPlot.

key: Required[str]
setSeries: bool
scales: Tuple[str | None, str | None]
match: Tuple[Never, Never, Any, Any, Never]
filters: Any
class viser.uplot.Focus

TypedDict type for uPlot.

alpha: float
class viser.uplot.Legend

TypedDict type for uPlot.

show: bool
live: bool
isolate: bool
markers: Legend_Markers
mount: Any
idx: float | None
idxs: Tuple[float | None, ...]
class viser.uplot.Legend_Markers

TypedDict type for uPlot.

show: bool
width: float | Never
stroke: str
fill: str
dash: str
class viser.uplot.Scale

TypedDict type for uPlot.

time: bool
auto: bool | Never
range: Tuple[float | None, float | None] | Never | Any
from: str
distr: Literal[1, 2, 3, 4, 100]
log: Literal[10, 2]
clamp: float | Never
asinh: float
fwd: Never
bwd: Never
min: float
max: float
dir: Literal[1, -1]
ori: Literal[0, 1]
key: str
class viser.uplot.Select

TypedDict type for uPlot.

left: Required[float]
top: Required[float]
width: Required[float]
height: Required[float]
show: bool
over: bool
class viser.uplot.Series

TypedDict type for uPlot.

show: bool
class: str
scale: str
auto: bool
sorted: Literal[0, 1, -1]
spanGaps: bool
gaps: Tuple[Tuple[float, float], ...] | Never
pxAlign: float | bool
label: str | Never
value: str | Never
paths: Never
points: Series_Points
facets: Tuple[Series_Facet, ...]
width: float
stroke: str
fill: str
fillTo: float | Never
dash: Tuple[float, ...]
cap: str
alpha: float
idxs: Tuple[float, float]
min: float
max: float
class viser.uplot.Series_Facet

TypedDict type for uPlot.

scale: Required[str]
auto: bool
sorted: Literal[0, 1, -1]
class viser.uplot.Series_Points

TypedDict type for uPlot.

show: bool | Never
paths: Never
filter: Tuple[float, ...] | None | Never
size: float
space: float
width: float
stroke: str
dash: Tuple[float, ...]
cap: str
fill: str