panels/stats-view
The graph, row, and tile markup every stats view shares, which a layout
draws in its own skin by passing the class names (GraphSkin, RowsSkin,
TilesSkin) and its status mark. What they draw is read by
stats-data.ts.
Interfaces
GraphSkin
Defined in: panels/stats-view.tsx:23
The class names a layout draws a graph in.
Properties
root
root: string;Defined in: panels/stats-view.tsx:24
head
head: string;Defined in: panels/stats-view.tsx:25
label
label: string;Defined in: panels/stats-view.tsx:26
values
values: string;Defined in: panels/stats-view.tsx:27
value?
value?: string;Defined in: panels/stats-view.tsx:28
number
number: string;Defined in: panels/stats-view.tsx:29
key
key: string;Defined in: panels/stats-view.tsx:31
The key beside a series' value where there are two; its color is the series'.
plot
plot: string;Defined in: panels/stats-view.tsx:32
grid?
grid?: string;Defined in: panels/stats-view.tsx:34
A line across the middle of the plot, where the skin has one.
area?
area?: string;Defined in: panels/stats-view.tsx:35
line?
line?: string;Defined in: panels/stats-view.tsx:36
cross?
cross?: string;Defined in: panels/stats-view.tsx:37
max
max: string;Defined in: panels/stats-view.tsx:38
RowsSkin
Defined in: panels/stats-view.tsx:114
The class names a layout draws the rows in.
Properties
root
root: string;Defined in: panels/stats-view.tsx:115
row
row: string;Defined in: panels/stats-view.tsx:117
A row; its status is added as a class of its own.
label
label: string;Defined in: panels/stats-view.tsx:118
body
body: string;Defined in: panels/stats-view.tsx:119
value
value: string;Defined in: panels/stats-view.tsx:120
detail
detail: string;Defined in: panels/stats-view.tsx:121
reason
reason: string;Defined in: panels/stats-view.tsx:122
TilesSkin
Defined in: panels/stats-view.tsx:148
The class names a layout draws the figure tiles in.
Properties
root
root: string;Defined in: panels/stats-view.tsx:149
tile
tile: string;Defined in: panels/stats-view.tsx:150
calm?
calm?: string;Defined in: panels/stats-view.tsx:152
Added to a tile whose figure did not fall short.
warn
warn: string;Defined in: panels/stats-view.tsx:154
Added to a tile whose figure fell short.
value
value: string;Defined in: panels/stats-view.tsx:155
detail
detail: string;Defined in: panels/stats-view.tsx:156
label
label: string;Defined in: panels/stats-view.tsx:157
Functions
Graph()
function Graph(__namedParameters): Element;Defined in: panels/stats-view.tsx:54
One graph: its name, the value under the pointer or else the newest, and up to two series against one axis. The plot's strokes are presentation attributes, which a skin's class names override.
Parameters
| Parameter | Type |
|---|---|
__namedParameters | GraphProps |
Returns
Element
Graphs()
function Graphs(__namedParameters): Element;Defined in: panels/stats-view.tsx:103
The three graphs, in order.
Parameters
| Parameter | Type |
|---|---|
__namedParameters | { skin: GraphSkin; graphs: Record<"fps" | "mbps" | "rtt", cn>; } |
__namedParameters.skin | GraphSkin |
__namedParameters.graphs | Record<"fps" | "mbps" | "rtt", cn> |
Returns
Element
StatRows()
function StatRows(__namedParameters): Element;Defined in: panels/stats-view.tsx:126
What the stream runs on, one row per stage: its mark, name, value, and what explains it.
Parameters
| Parameter | Type |
|---|---|
__namedParameters | { skin: RowsSkin; rows: any; Mark: StatusMarkComponent; children?: ReactNode; } |
__namedParameters.skin | RowsSkin |
__namedParameters.rows | any |
__namedParameters.Mark | StatusMarkComponent |
__namedParameters.children? | ReactNode |
Returns
Element
StatTiles()
function StatTiles(__namedParameters): Element;Defined in: panels/stats-view.tsx:161
The figures as tiles: value, its spread where it has one, and its name.
Parameters
| Parameter | Type |
|---|---|
__namedParameters | { skin: TilesSkin; tiles: any; Mark: StatusMarkComponent; } |
__namedParameters.skin | TilesSkin |
__namedParameters.tiles | any |
__namedParameters.Mark | StatusMarkComponent |
Returns
Element