sayoi7799/moon_vegalite/spec

sayoi7799/moon_vegalite/spec does not have a README file

SpecError

pub(all) suberror SpecError {
  SpecError(String)
}

SpecError::message

source

fn SpecError::message(self : SpecError) -> String

Message of a spec error.

AggregateOp

source

pub(all) struct AggregateOp {
  op : String
  field : String?
  out : String
}

ChannelDef

source

pub(all) struct ChannelDef {
  field : String?
  typ : String?
  aggregate : String?
  bin : Map[String, @sayoi7799/moon_vegalite/value.Value
Value]?
  binned : Bool
  time_unit : String?
  sort : @sayoi7799/moon_vegalite/value.Value
Value?
  scale : Map[String, @sayoi7799/moon_vegalite/value.Value
Value]?
  scale_off : Bool
  axis : Guide
  legend : Guide
  title : String??
  format : String?
  format_type : String?
  value : @sayoi7799/moon_vegalite/value.Value
Value?
  datum : @sayoi7799/moon_vegalite/value.Value
Value?
  stack : String?
  band : Double?
  band_position : Double?
}

A field / value definition of an encoding channel.

FilterSpec

source

pub(all) enum FilterSpec {
  Expr(String)
  Predicate(Predicate)
}

Guide

source

pub(all) enum Guide {
  Default
  Off
  Props(Map[String, @sayoi7799/moon_vegalite/value.Value
Value])
}

Mark

source

pub(all) struct Mark {
  typ : String
  props : Map[String, @sayoi7799/moon_vegalite/value.Value
Value]
}

Predicate

source

pub(all) enum Predicate {
  Equal(String, @sayoi7799/moon_vegalite/value.Value
Value, String?)
  Lt(String, @sayoi7799/moon_vegalite/value.Value
Value, String?)
  Lte(String, @sayoi7799/moon_vegalite/value.Value
Value, String?)
  Gt(String, @sayoi7799/moon_vegalite/value.Value
Value, String?)
  Gte(String, @sayoi7799/moon_vegalite/value.Value
Value, String?)
  Range(String, @sayoi7799/moon_vegalite/value.Value
Value, @sayoi7799/moon_vegalite/value.Value
Value, String?)
  OneOf(String, Array[@sayoi7799/moon_vegalite/value.Value
Value], String?)
  Valid(String)
  And(Array[Predicate])
  Or(Array[Predicate])
  Not(Predicate)
  Expr(String)
}

A field predicate, possibly combined with and / or / not.

Reader

source

pub struct Reader {
  path : String
  obj : Map[String, Json]
  used : Array[String]
}

A JSON object being consumed key by key.

Reader::boolean

source

fn Reader::boolean(self : Reader, key : String) -> Bool? raise SpecError

Reader::finish

source

fn Reader::finish(self : Reader, unsupported_keys? : Array[String]) -> Unit raise SpecError

Fail on any property that has not been consumed. Names in unsupported_keys are valid Vega-Lite properties that this library does not implement.

Reader::has

source

fn Reader::has(self : Reader, key : String) -> Bool

Reader::ignore

source

fn Reader::ignore(self : Reader, keys : Array[String]) -> Unit

Accept (and ignore) properties that do not affect rendering.

Reader::new

source

fn Reader::new(path : String, j : Json) -> Reader raise SpecError

Reader::number

source

fn Reader::number(self : Reader, key : String) -> Double? raise SpecError

Reader::path_of

source

fn Reader::path_of(self : Reader, key : String) -> String

Reader::string

source

fn Reader::string(self : Reader, key : String) -> String? raise SpecError

Reader::take

source

fn Reader::take(self : Reader, key : String) -> Json?

The raw value of a key, marking it consumed.

Reader::value

source

fn Reader::value(self : Reader, key : String) -> @sayoi7799/moon_vegalite/value.Value
Value?

A value of any JSON type converted to a Value.

Spec

source

pub(all) struct Spec {
  mark : Mark
  encoding : Array[(String, ChannelDef)]
  transform : Array[Transform]
  data : Array[Map[String, @sayoi7799/moon_vegalite/value.Value
Value]]?
  width : @sayoi7799/moon_vegalite/value.Value
Value?
  height : @sayoi7799/moon_vegalite/value.Value
Value?
  padding : @sayoi7799/moon_vegalite/value.Value
Value?
  background : String?
  title : String?
  description : String?
  config : Map[String, @sayoi7799/moon_vegalite/value.Value
Value]
}

Transform

source

pub(all) enum Transform {
  Filter(FilterSpec)
  Calculate(String, String)
  Aggregate(Array[AggregateOp], Array[String])
  Bin(String, Map[String, @sayoi7799/moon_vegalite/value.Value
Value], Array[String])
  TimeUnit(String, String, String)
  Fold(Array[String], Array[String])
}

One data transform, as written in the spec.

index_path

source

fn index_path(base : String, i : Int) -> String

invalid

source

fn invalid(path : String, msg : String) -> SpecError

join_path

source

fn join_path(base : String, key : String) -> String

parse_spec

source

fn parse_spec(j : Json) -> Spec raise SpecError

Parse a Vega-Lite specification from parsed JSON.

parse_spec_text

source

fn parse_spec_text(text : String) -> Spec raise SpecError

Parse a specification from JSON text.

unsupported

source

fn unsupported(path : String) -> SpecError

Source Files

Site source Report issue Packages Build queue Skills Statistics

#SpecError

#SpecError::message

#AggregateOp

#ChannelDef

#FilterSpec

#Guide

#Mark

#Predicate

#Reader

#Reader::boolean

#Reader::finish

#Reader::has

#Reader::ignore

#Reader::new

#Reader::number

#Reader::path_of

#Reader::string

#Reader::take

#Reader::value

#Spec

#Transform

#index_path

#invalid

#join_path

#parse_spec

#parse_spec_text

#unsupported

Source Files

SpecError

SpecError::message

AggregateOp

ChannelDef

FilterSpec

Guide

Mark

Predicate

Reader

Reader::boolean

Reader::finish

Reader::has

Reader::ignore

Reader::new

Reader::number

Reader::path_of

Reader::string

Reader::take

Reader::value

Spec

Transform

index_path

invalid

join_path

parse_spec

parse_spec_text

unsupported