ihb2032/MoonFrame/chart

README
U
CellParseLocation
U
ChartKind
U
ChartSpec
U
ClosedInterval
U
CsvReadOptions
U
CsvWriteOptions
U
DataError
U
DataFrame
U
DataType
U
Expr
U
Field
U
HtmlOptions
U
JoinOptions
U
JoinType
U
JsonReadOptions
U
KeepStrategy
U
LazyFrame
U
OnParseError
U
ParseErrorDetail
U
PivotAgg
U
QuantileInterpolation
U
RankMethod
U
Scalar
U
Schema
U
Series
U
TypeMismatchDetail
U
VegaType
V
col
V
cols
V
format_vega_lite
V
lit
V
lit_bool
V
lit_float
V
lit_int
V
lit_series
V
lit_str
V
map_many
V
read_csv
V
read_json
V
read_ndjson
V
scan_csv
V
scan_json
V
scan_ndjson
V
when
V
write_csv
V
write_json
V
write_ndjson
V
write_vega_lite

ihb2032/MoonFrame/chart does not have a README file

ChartKind

pub(all) enum ChartKind {
  Bar
  Line
  Point
  Area
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The mark type of a chart, mapped to a Vega-Lite top-level mark: Bar → "bar", Line → "line", Point → "point", Area → "area". pub(all) so callers can name the variants when building a ChartSpec (though the ChartSpec::bar / line / point / area constructors set the kind for you).

ChartKind::equal

source

fn ChartKind::equal(ChartKind, ChartKind) -> Bool

ChartKind::not_equal

source

fn ChartKind::not_equal(x : ChartKind, y : ChartKind) -> Bool

ChartKind::to_repr

source

fn ChartKind::to_repr(ChartKind) -> @moonbitlang/core/debug.Repr
Repr

ChartSpec

source

pub struct ChartSpec {
  kind : ChartKind
  x : String
  y : String
  color : String?
  title : String?
  color_type : VegaType?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A chart specification: the mark kind, the x / y encoding columns, an optional color grouping column, and an optional title. Fields are read-only outside the package — build a spec through one of the mark-named constructors (ChartSpec::bar(x, y) / line / point / area), naming color / color_type / title as needed:

ChartSpec::bar("region", "revenue", title="Revenue by region")

x / y / color are column names resolved against the frame at format_vega_lite time (a missing name raises ColumnNotFound); each column's dtype decides its Vega-Lite field type — the rule format_vega_lite's doc states (numeric → quantitative, Date / Timestamp → temporal, otherwise → nominal) — unless color_type overrides the color channel: e.g. a numeric grouping column (a cluster id) rendered as Nominal distinct colors rather than a continuous gradient (only color honours an override; x / y keep dtype inference).

ChartSpec::area

source

fn ChartSpec::area(x : String, y : String, color? : String, color_type? : VegaType, title? : String) -> ChartSpec

An area chart of y against x (Vega-Lite mark: "area").

The optional color / color_type / title parameters carry the ChartSpec doc's colour-encoding and title contract (only color honours a color_type override; x / y keep dtype inference).

ChartSpec::bar

source

fn ChartSpec::bar(x : String, y : String, color? : String, color_type? : VegaType, title? : String) -> ChartSpec

A bar chart of y against x (Vega-Lite mark: "bar").

The optional color / color_type / title parameters carry the ChartSpec doc's colour-encoding and title contract (only color honours a color_type override; x / y keep dtype inference).

ChartSpec::equal

source

fn ChartSpec::equal(ChartSpec, ChartSpec) -> Bool

ChartSpec::line

source

fn ChartSpec::line(x : String, y : String, color? : String, color_type? : VegaType, title? : String) -> ChartSpec

A line chart of y against x (Vega-Lite mark: "line").

The optional color / color_type / title parameters carry the ChartSpec doc's colour-encoding and title contract (only color honours a color_type override; x / y keep dtype inference).

ChartSpec::not_equal

source

fn ChartSpec::not_equal(x : ChartSpec, y : ChartSpec) -> Bool

ChartSpec::point

source

fn ChartSpec::point(x : String, y : String, color? : String, color_type? : VegaType, title? : String) -> ChartSpec

A scatter (point) chart of y against x (Vega-Lite mark: "point").

The optional color / color_type / title parameters carry the ChartSpec doc's colour-encoding and title contract (only color honours a color_type override; x / y keep dtype inference).

ChartSpec::to_repr

source

fn ChartSpec::to_repr(ChartSpec) -> @moonbitlang/core/debug.Repr
Repr

VegaType

source

pub(all) enum VegaType {
  Quantitative
  Nominal
  Ordinal
  Temporal
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A Vega-Lite field type, used to override the dtype-based inference for the color channel. pub(all) so callers can name the variants in a constructor's color_type. Quantitative is a continuous measure (a color gradient), Nominal an unordered category (distinct colors per value), Ordinal an ordered category, and Temporal a time field.

VegaType::equal

source

fn VegaType::equal(VegaType, VegaType) -> Bool

VegaType::not_equal

source

fn VegaType::not_equal(x : VegaType, y : VegaType) -> Bool

VegaType::to_repr

source

fn VegaType::to_repr(VegaType) -> @moonbitlang/core/debug.Repr
Repr

format_vega_lite

source

fn format_vega_lite(df : @ihb2032/MoonFrame/frame.DataFrame
DataFrame, spec : ChartSpec) -> String raise @ihb2032/MoonFrame/types.DataError
DataError

Render df and spec as a complete Vega-Lite v5 specification JSON string: $schema (pinned to the Vega-Lite v5 schema URL) + optional title + mark (from spec.kind) + encoding (x / y and, when set, color, each {field, type}) + data.values (the frame inlined as JSON records, sharing format_json's cell mapping — null and non-finite-float cells become JSON null). A frame with the encoded columns but zero rows yields "data":{"values":[]}.

Each encoding channel's field type follows its column's dtype — the single statement of the dtype→type rule: a numeric column (Int / Float / Decimal) is "quantitative", a Date / Timestamp column is "temporal" (its ISO cells — data.values' date units, via the JSON records' ISO mapping — sort chronologically, and a temporal axis orders by time rather than by first appearance), and every other dtype is "nominal" — unless the channel carries an explicit color_type override.

The spec's x / y / color columns are resolved left-to-right; the first name absent from df raises ColumnNotFound(name) — this is the one reason the function is not total (it accepts column names, and a name can be wrong). The emitted text is always valid JSON (it is built through @json and stringified), so it round-trips through any standards-compliant JSON / Vega-Lite reader.

write_vega_lite

source

fn write_vega_lite(path : String, df : @ihb2032/MoonFrame/frame.DataFrame
DataFrame, spec : ChartSpec) -> Unit raise @ihb2032/MoonFrame/types.DataError
DataError

Write a Vega-Lite v5 spec for df / spec to path. Mirrors write_json: a ColumnNotFound from format_vega_lite (a spec column absent from df) propagates unchanged, a filesystem failure surfaces as raise IoError(message), and content holding an unpaired UTF-16 surrogate is refused with raise InvalidOperation.