nustack
ReferenceNu STDui

refs.chart

Chart Refs -- typed visualization sinks over series payloads.

Module nustd.ui.refs.chart.

Chart Refs -- typed visualization sinks over series payloads.

Same directionality as other output Refs (server pushes points via write / append; browser only renders). Grouped by shape rather than by semantics because the payload contract is chart-specific.

NameSortCallMeaning
AreaChartrefAreaChart(address, parent_ref=None, owner_shape=None)Display-only area chart. write (partial) and append (one row).
BarChartrefBarChart(address, parent_ref=None, owner_shape=None)Display-only chart ref. write (partial) and append (one bar).
LineChartrefLineChart(address, parent_ref=None, owner_shape=None)Display-only chart ref. write (partial) and append (one point or one series row).
PieChartrefPieChart(address, parent_ref=None, owner_shape=None)Display-only pie chart ref. write (partial) and append (one slice).
SparklinerefSparkline(address, parent_ref=None, owner_shape=None)Display-only inline trend line. write (partial) and append (one point).

AreaChart

Display-only area chart. write (partial) and append (one row).

AreaChart(address, parent_ref=None, owner_shape=None)

Path nustd.ui.AreaChart. Kind Ref, sort ref, cardinality scalar.

Methods

.set_points(points)

Builds Nu.

Arguments

NameTypeDefaultMeaning
pointsListArg[Any]

Undocumented: summary, example.

.set_series(names)

Builds Nu.

Arguments

NameTypeDefaultMeaning
namesListArg[Any]

Undocumented: summary, example.

.set_colors(colors)

Builds Nu.

Arguments

NameTypeDefaultMeaning
colorsListArg[Any]

Undocumented: summary, example.

.set_stacked(flag)

Builds Nu.

Arguments

NameTypeDefaultMeaning
flagBoolArg

Undocumented: summary, example.

.set_x_label(text)

Builds Nu.

Arguments

NameTypeDefaultMeaning
textStrArg

Undocumented: summary, example.

.set_y_label(text)

Builds Nu.

Arguments

NameTypeDefaultMeaning
textStrArg

Undocumented: summary, example.

.set_max_points(value)

Builds Nu.

Arguments

NameTypeDefaultMeaning
valueIntArg

Undocumented: summary, example.

.set_x_format(value)

Builds Nu.

Arguments

NameTypeDefaultMeaning
valueXFormat | StrArg

Undocumented: summary, example.

.clear()

Builds Nu.

Undocumented: summary, example.

.set(points=<UNSET>, series=<UNSET>, colors=<UNSET>, stacked=<UNSET>, x_label=<UNSET>, y_label=<UNSET>, max_points=<UNSET>, x_format=<UNSET>)

Builds Nu.

Arguments

NameTypeDefaultMeaning
pointsListArg[Any]<UNSET>
seriesListArg[Any]<UNSET>
colorsListArg[Any]<UNSET>
stackedBoolArg<UNSET>
x_labelStrArg<UNSET>
y_labelStrArg<UNSET>
max_pointsIntArg<UNSET>
x_formatXFormat | StrArg<UNSET>

Undocumented: summary, example.

.append(x)

Builds Nu.

Arguments

NameTypeDefaultMeaning
xFloatArg

Undocumented: summary, example.

Inherited methods

From nustd.ui.core.base.Ref:

CallBuildsMeaning
.erase()NuDrop this Ref's node on the client, and everything under it.

Undocumented: example.

BarChart

Display-only chart ref. write (partial) and append (one bar).

BarChart(address, parent_ref=None, owner_shape=None)

Path nustd.ui.BarChart. Kind Ref, sort ref, cardinality scalar.

Methods

.set_bars(bars)

Builds Nu.

Arguments

NameTypeDefaultMeaning
barsListArg[Any]

Undocumented: summary, example.

.set_x_label(text)

Builds Nu.

Arguments

NameTypeDefaultMeaning
textStrArg

Undocumented: summary, example.

.set_y_label(text)

Builds Nu.

Arguments

NameTypeDefaultMeaning
textStrArg

Undocumented: summary, example.

.set_color(value)

Builds Nu.

Arguments

NameTypeDefaultMeaning
valueStrArg

Undocumented: summary, example.

.set_orientation(value)

Builds Nu.

Arguments

NameTypeDefaultMeaning
valueOrientation | StrArg

Undocumented: summary, example.

.set_max_bars(value)

Builds Nu.

Arguments

NameTypeDefaultMeaning
valueIntArg

Undocumented: summary, example.

.clear()

Builds Nu.

Undocumented: summary, example.

.set(bars=<UNSET>, x_label=<UNSET>, y_label=<UNSET>, color=<UNSET>, orientation=<UNSET>, max_bars=<UNSET>)

Builds Nu.

Arguments

NameTypeDefaultMeaning
barsListArg[Any] | DictArg[Any, Any]<UNSET>
x_labelStrArg<UNSET>
y_labelStrArg<UNSET>
colorStrArg<UNSET>
orientationOrientation | StrArg<UNSET>
max_barsIntArg<UNSET>

Undocumented: summary, example.

.append(category, value)

Builds Nu.

Arguments

NameTypeDefaultMeaning
categoryStrArg
valueFloatArg

Undocumented: summary, example.

Inherited methods

From nustd.ui.core.base.Ref:

CallBuildsMeaning
.erase()NuDrop this Ref's node on the client, and everything under it.

Undocumented: example.

LineChart

Display-only chart ref. write (partial) and append (one point or one series row).

LineChart(address, parent_ref=None, owner_shape=None)

Path nustd.ui.LineChart. Kind Ref, sort ref, cardinality scalar.

Methods

.set_points(points)

Builds Nu.

Arguments

NameTypeDefaultMeaning
pointsListArg[Any]

Undocumented: summary, example.

.set_series(series_list)

Builds Nu.

Arguments

NameTypeDefaultMeaning
series_listListArg[Any]

Undocumented: summary, example.

.set_x_label(text)

Builds Nu.

Arguments

NameTypeDefaultMeaning
textStrArg

Undocumented: summary, example.

.set_y_label(text)

Builds Nu.

Arguments

NameTypeDefaultMeaning
textStrArg

Undocumented: summary, example.

.set_color(value)

Builds Nu.

Arguments

NameTypeDefaultMeaning
valueStrArg

Undocumented: summary, example.

.set_max_points(value)

Builds Nu.

Arguments

NameTypeDefaultMeaning
valueIntArg

Undocumented: summary, example.

.set_x_format(value)

Builds Nu.

Arguments

NameTypeDefaultMeaning
valueXFormat | StrArg

Undocumented: summary, example.

.set_show_legend(flag)

Builds Nu.

Arguments

NameTypeDefaultMeaning
flagBoolArg

Undocumented: summary, example.

.set_show_tooltip(flag)

Builds Nu.

Arguments

NameTypeDefaultMeaning
flagBoolArg

Undocumented: summary, example.

.set_palette(colors)

Builds Nu.

Arguments

NameTypeDefaultMeaning
colorsListArg[Any]

Undocumented: summary, example.

.clear()

Builds Nu.

Undocumented: summary, example.

.set(points=<UNSET>, series=<UNSET>, x_label=<UNSET>, y_label=<UNSET>, color=<UNSET>, max_points=<UNSET>, x_format=<UNSET>, show_legend=<UNSET>, show_tooltip=<UNSET>, palette=<UNSET>)

Builds Nu.

Arguments

NameTypeDefaultMeaning
pointsListArg[Any] | DictArg[Any, Any]<UNSET>
seriesListArg[Any]<UNSET>
x_labelStrArg<UNSET>
y_labelStrArg<UNSET>
colorStrArg<UNSET>
max_pointsIntArg<UNSET>
x_formatXFormat | StrArg<UNSET>
show_legendBoolArg<UNSET>
show_tooltipBoolArg<UNSET>
paletteListArg[Any]<UNSET>

Undocumented: summary, example.

.append(x, y)

Builds Nu.

Arguments

NameTypeDefaultMeaning
xFloatArg
yFloatArg

Undocumented: summary, example.

.append_series(name, x, y)

Builds Nu.

Arguments

NameTypeDefaultMeaning
nameStrArg
xFloatArg
yFloatArg

Undocumented: summary, example.

Inherited methods

From nustd.ui.core.base.Ref:

CallBuildsMeaning
.erase()NuDrop this Ref's node on the client, and everything under it.

Undocumented: example.

PieChart

Display-only pie chart ref. write (partial) and append (one slice).

PieChart(address, parent_ref=None, owner_shape=None)

Path nustd.ui.PieChart. Kind Ref, sort ref, cardinality scalar.

Methods

.set_slices(slices)

Builds Nu.

Arguments

NameTypeDefaultMeaning
slicesListArg[Any]

Undocumented: summary, example.

.set_colors(colors)

Builds Nu.

Arguments

NameTypeDefaultMeaning
colorsListArg[Any]

Undocumented: summary, example.

.set_inner_radius(value)

Builds Nu.

Arguments

NameTypeDefaultMeaning
valueFloatArg

Undocumented: summary, example.

.set_show_labels(value)

Builds Nu.

Arguments

NameTypeDefaultMeaning
valueBoolArg

Undocumented: summary, example.

.set_show_legend(value)

Builds Nu.

Arguments

NameTypeDefaultMeaning
valueBoolArg

Undocumented: summary, example.

.set_total_label(value)

Builds Nu.

Arguments

NameTypeDefaultMeaning
valueStrArg

Undocumented: summary, example.

.clear()

Builds Nu.

Undocumented: summary, example.

.set(slices=<UNSET>, colors=<UNSET>, inner_radius=<UNSET>, show_labels=<UNSET>, show_legend=<UNSET>, total_label=<UNSET>)

Builds Nu.

Arguments

NameTypeDefaultMeaning
slicesListArg[Any] | DictArg[Any, Any]<UNSET>
colorsListArg[Any]<UNSET>
inner_radiusFloatArg<UNSET>
show_labelsBoolArg<UNSET>
show_legendBoolArg<UNSET>
total_labelStrArg<UNSET>

Undocumented: summary, example.

.append(label, value)

Builds Nu.

Arguments

NameTypeDefaultMeaning
labelStrArg
valueFloatArg

Undocumented: summary, example.

Inherited methods

From nustd.ui.core.base.Ref:

CallBuildsMeaning
.erase()NuDrop this Ref's node on the client, and everything under it.

Undocumented: example.

Sparkline

Display-only inline trend line. write (partial) and append (one point).

Sparkline(address, parent_ref=None, owner_shape=None)

Path nustd.ui.Sparkline. Kind Ref, sort ref, cardinality scalar.

Methods

.set_points(points)

Builds Nu.

Arguments

NameTypeDefaultMeaning
pointsListArg[Any]

Undocumented: summary, example.

.set_color(value)

Builds Nu.

Arguments

NameTypeDefaultMeaning
valueStrArg

Undocumented: summary, example.

.set_height(value)

Builds Nu.

Arguments

NameTypeDefaultMeaning
valueIntArg

Undocumented: summary, example.

.set_max_points(value)

Builds Nu.

Arguments

NameTypeDefaultMeaning
valueIntArg

Undocumented: summary, example.

.clear()

Builds Nu.

Undocumented: summary, example.

.set(points=<UNSET>, color=<UNSET>, height=<UNSET>, max_points=<UNSET>)

Builds Nu.

Arguments

NameTypeDefaultMeaning
pointsListArg[Any] | DictArg[Any, Any]<UNSET>
colorStrArg<UNSET>
heightIntArg<UNSET>
max_pointsIntArg<UNSET>

Undocumented: summary, example.

.append(x, y)

Builds Nu.

Arguments

NameTypeDefaultMeaning
xFloatArg
yFloatArg

Undocumented: summary, example.

Inherited methods

From nustd.ui.core.base.Ref:

CallBuildsMeaning
.erase()NuDrop this Ref's node on the client, and everything under it.

Undocumented: example.

refs.output

Display / output Refs -- server-owned sinks that render into the body.

refs.input

Input Refs -- tab-owned; server reads via `read` + `notify` path.

On this page

AreaChart.set_points(points).set_series(names).set_colors(colors).set_stacked(flag).set_x_label(text).set_y_label(text).set_max_points(value).set_x_format(value).clear().set(points=<UNSET>, series=<UNSET>, colors=<UNSET>, stacked=<UNSET>, x_label=<UNSET>, y_label=<UNSET>, max_points=<UNSET>, x_format=<UNSET>).append(x)BarChart.set_bars(bars).set_x_label(text).set_y_label(text).set_color(value).set_orientation(value).set_max_bars(value).clear().set(bars=<UNSET>, x_label=<UNSET>, y_label=<UNSET>, color=<UNSET>, orientation=<UNSET>, max_bars=<UNSET>).append(category, value)LineChart.set_points(points).set_series(series_list).set_x_label(text).set_y_label(text).set_color(value).set_max_points(value).set_x_format(value).set_show_legend(flag).set_show_tooltip(flag).set_palette(colors).clear().set(points=<UNSET>, series=<UNSET>, x_label=<UNSET>, y_label=<UNSET>, color=<UNSET>, max_points=<UNSET>, x_format=<UNSET>, show_legend=<UNSET>, show_tooltip=<UNSET>, palette=<UNSET>).append(x, y).append_series(name, x, y)PieChart.set_slices(slices).set_colors(colors).set_inner_radius(value).set_show_labels(value).set_show_legend(value).set_total_label(value).clear().set(slices=<UNSET>, colors=<UNSET>, inner_radius=<UNSET>, show_labels=<UNSET>, show_legend=<UNSET>, total_label=<UNSET>).append(label, value)Sparkline.set_points(points).set_color(value).set_height(value).set_max_points(value).clear().set(points=<UNSET>, color=<UNSET>, height=<UNSET>, max_points=<UNSET>).append(x, y)