@kanunilabs/datagrid-react-enterprise
@kanunilabs/datagrid-react-enterprise / SparklineProps
Interface: SparklineProps
Extends
Properties
ariaLabel?
optionalariaLabel?:string
Screen-reader description. Falls back to the grid dictionary's summary.
Inherited from
color?
optionalcolor?:string
Series colour. Default: the theme's primary colour.
Inherited from
data
data:
unknown
The series. Non-numeric entries are holes: the line breaks there.
fillOpacity?
optionalfillOpacity?:number
Inherited from
highlight?
optionalhighlight?:object
Mark the first, lowest and/or highest reading too (see ColumnSparkline).
first?
optionalfirst?:boolean
max?
optionalmax?:boolean
min?
optionalmin?:boolean
Inherited from
labels?
optionallabels?:boolean
Each bar's value beside it (bar types).
Inherited from
lineDashed?
optionallineDashed?:boolean
Inherited from
lineWidth?
optionallineWidth?:number
Line thickness (1–6 px), dashed line and area opacity — see ColumnSparkline.
Inherited from
locale?
optionallocale?:string
Number formatting for the tooltip and the summary.
Inherited from
markers?
optionalmarkers?:boolean
A dot on every reading of a line or area.
Inherited from
max?
optionalmax?:number
Force the high end.
Inherited from
min?
optionalmin?:number
Force the low end of the scale — for comparing rows against each other.
Inherited from
negativeColor?
optionalnegativeColor?:string
Colour of bars below zero. Default: the theme's danger colour.
Inherited from
SparklineOptions.negativeColor
pointColor?
optionalpointColor?: (point) =>string|null|undefined
A colour per reading, or nothing for the default (see ColumnSparkline).
Parameters
point
SparklinePointInfo<any>
Returns
string | null | undefined
Inherited from
row?
optionalrow?:unknown
The row the sparkline is drawn in, handed to pointColor and tooltipText.
Inherited from
showBaseline?
optionalshowBaseline?:boolean
Draw the zero line when the series crosses it. Default true for bar.
Inherited from
showLast?
optionalshowLast?:boolean
Mark the last reading with a dot. Default true for line/area.
It is the point the reader is actually after — "where did it end up" — and a line without it makes them find the right edge themselves.
Inherited from
tooltip?
optionaltooltip?:boolean
Hover a reading to see its value (a native tooltip). Default off.
Inherited from
tooltipText?
optionaltooltipText?: (point) =>string
The tooltip's text per reading, with the row; turns tooltips on.
Parameters
point
SparklinePointInfo<any>
Returns
string
Inherited from
type?
optionaltype?:SparklineType
Inherited from
valueFormat?
optionalvalueFormat?:NumberFormatOptions
How values print: labels, tooltip, summary ({ style: 'percent' }…).
Inherited from
xKey?
optionalxKey?:string
When the readings are objects, the fields holding x and y (default 'x'
and 'y'). [x, y] pairs need no keys (§E.6 #82).
Inherited from
yKey?
optionalyKey?:string