moonrockz/diagrams-svg/data-tree-layout

README
- ::equalChannelStyle::equal
- ::hiddenChannelStyle::hidden
- ::newChannelStyle::new
- ::not_equalChannelStyle::not_equal
- ::to_reprChannelStyle::to_repr
- ::equalConnectorCommand::equal
- ::not_equalConnectorCommand::not_equal
- ::to_reprConnectorCommand::to_repr
- ::equalConnectorGeometry::equal
- ::not_equalConnectorGeometry::not_equal
- ::to_reprConnectorGeometry::to_repr
- ::equalConnectorLimits::equal
- ::newConnectorLimits::new
- ::not_equalConnectorLimits::not_equal
- ::to_reprConnectorLimits::to_repr
- ::equalConnectorObstacle::equal
- ::not_equalConnectorObstacle::not_equal
- ::to_reprConnectorObstacle::to_repr
- ::equalConnectorOptions::equal
- ::newConnectorOptions::new
- ::not_equalConnectorOptions::not_equal
- ::to_reprConnectorOptions::to_repr
- ::equalConnectorPath::equal
- ::newConnectorPath::new
- ::not_equalConnectorPath::not_equal
- ::parseConnectorPath::parse
- ::svgConnectorPath::svg
- ::to_reprConnectorPath::to_repr
- ::equalConnectorPoint::equal
- ::not_equalConnectorPoint::not_equal
- ::to_reprConnectorPoint::to_repr
- ::equalConnectorStyle::equal
- ::not_equalConnectorStyle::not_equal
- ::to_reprConnectorStyle::to_repr
- ::equalCrossingMode::equal
- ::not_equalCrossingMode::not_equal
- ::to_reprCrossingMode::to_repr
- ::equalMode::equal
- ::not_equalMode::not_equal
- ::to_reprMode::to_repr
T
NodeBinding
- ::equalNodeBindingKind::equal
- ::not_equalNodeBindingKind::not_equal
- ::to_reprNodeBindingKind::to_repr
T
PathBinding
- ::equalResolvedConnector::equal
- ::not_equalResolvedConnector::not_equal
- ::to_reprResolvedConnector::to_repr
T
Scene
T
SceneResult
- ::connector_geometrySvgRenderer::connector_geometry
- ::newSvgRenderer::new
- ::renderSvgRenderer::render
- ::render_tracedSvgRenderer::render_traced
- ::sceneSvgRenderer::scene
- ::equalTraceHighlight::equal
- ::newTraceHighlight::new
- ::not_equalTraceHighlight::not_equal
- ::to_reprTraceHighlight::to_repr
- ::refusedTracedRender::refused
- ::equalVariant::equal
- ::not_equalVariant::not_equal
- ::to_reprVariant::to_repr
V
bpmn_geometry_path
V
bpmn_path
V
check_connectors
V
flowchart_path
V
inspect_connectors
V
render_architecture
V
render_data_tree
V
render_ebnf
V
render_flowchart
V
render_regex
V
render_sequence
V
render_swimlane
V
swimlane_path

moonrockz/diagrams-svg/data-tree-layout does not have a README file

Box

pub struct Box {
  node : String
  kind : Kind
  box : Rect
  divider : Double?
  rows : ReadOnlyArray[Row]
  label : Label?
  highlighted : Bool
  depth : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

One box: a container with its rows, or a scalar root.

Box::equal

source

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

Box::not_equal

source

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

Box::to_repr

source

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

Connector

source

pub struct Connector {
  entry : String
  source : String
  target : String
  points : ReadOnlyArray[Point]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A drawn connector from a row to the box of its nested container. The points are the start, the end of the straight part, two curve controls and the end.

Connector::equal

source

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

Connector::not_equal

source

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

Connector::path

source

fn Connector::path(self : Connector) -> String

The SVG path data of the connector.

Connector::samples

source

fn Connector::samples(self : Connector, count? : Int) -> Array[Point]

Sample points along the connector, for checks.

Connector::to_repr

source

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

Finding

source

pub struct Finding {
  rule : Rule
  identities : ReadOnlyArray[String]
  message : String
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Finding::equal

source

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

Finding::not_equal

source

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

Finding::to_repr

source

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

Geometry

source

pub struct Geometry {
  tree : @moonrockz/diagrams/data-tree.DataTree
DataTree
  width : Int
  height : Int
  title : Label?
  boxes : ReadOnlyArray[Box]
  connectors : ReadOnlyArray[Connector]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The measured geometry of one data view.

Geometry::equal

source

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

Geometry::not_equal

source

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

Geometry::to_repr

source

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

Ink

source

pub(all) enum Ink {
  Key
  Index
  Text
  Number
  Boolean
  Null
  Container
  Title
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The ink of a label. Each scalar kind has its own ink.

Ink::color

source

fn Ink::color(self : Ink, palette : @moonrockz/diagrams-svg/theme.Palette
Palette) -> @moonrockz/diagrams-svg/theme.Color
Color

Ink::equal

source

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

Ink::not_equal

source

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

Ink::to_repr

source

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

Ink::token

source

fn Ink::token(self : Ink) -> String

The theme token of the ink: text, muted or a family ink.

Kind

source

pub(all) enum Kind {
  Object
  Array
  String
  Number
  Boolean
  Null
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The kind of a value, as written in the data-type attribute.

Kind::equal

source

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

Kind::name

source

fn Kind::name(self : Kind) -> String

Kind::not_equal

source

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

Kind::to_repr

source

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

Label

source

pub struct Label {
  lines : ReadOnlyArray[String]
  box : Rect
  size : Double
  weight : Int
  ink : Ink
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

One measured label. lines are the wrapped lines; with the line breaks that wrapping replaced, they give the complete text.

Label::equal

source

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

Label::not_equal

source

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

Label::to_repr

source

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

Limits

source

pub struct Limits {
  nodes : Int
  depth : Int
  work : Int
  width : Int
  output_units : Int
  minimum_approach : Double
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Explicit bounds for structured-data layout and painting.

Limits::equal

source

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

Limits::new

source

fn Limits::new(nodes? : Int, depth? : Int, work? : Int, width? : Int, output_units? : Int, minimum_approach? : Double) -> Limits

Limits::not_equal

source

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

Limits::to_repr

source

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

Limits::with_minimum_approach

source

fn Limits::with_minimum_approach(self : Limits, minimum_approach : Double) -> Limits

Point

source

pub(all) struct Point {
  x : Double
  y : Double
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Point::equal

source

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

Point::not_equal

source

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

Point::to_repr

source

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

Rect

source

pub(all) struct Rect {
  x : Double
  y : Double
  width : Double
  height : Double
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Rect::bottom

source

fn Rect::bottom(self : Rect) -> Double

Rect::contains

source

fn Rect::contains(self : Rect, other : Rect, tolerance? : Double) -> Bool

Rect::equal

source

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

Rect::not_equal

source

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

Rect::overlaps

source

fn Rect::overlaps(self : Rect, other : Rect) -> Bool

Rect::right

source

fn Rect::right(self : Rect) -> Double

Rect::to_repr

source

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

Result

source

pub struct Result {
  geometry : Geometry?
  diagnostics : ReadOnlyArray[@moonrockz/diagrams.Diagnostic
Diagnostic]
}

Row

source

pub struct Row {
  entry : String
  node : String
  kind : Kind
  box : Rect
  key : Label?
  value : Label?
  highlighted : Bool
  port : Point?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

One member row of a container box.

Row::equal

source

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

Row::not_equal

source

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

Row::to_repr

source

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

Rule

source

pub(all) enum Rule {
  Overlap
  Fit
  Size
  Contrast
  Containment
  Endpoint
  Limit
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The rule that a legibility finding breaks.

Rule::equal

source

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

Rule::not_equal

source

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

Rule::to_repr

source

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

check

source

fn check(geometry : Geometry, palette : @moonrockz/diagrams-svg/theme.Palette
Palette, work_limit? : Int) -> ReadOnlyArray[Finding]

Check measured data geometry independently of its painter: row bounds, label clearance and fit, overlaps, connector attachment and crossings, text size and the contrast of every label on its background, including highlighted rows. The check is bounded by work_limit.

display_text

source

fn display_text(value : @moonrockz/diagrams/data-tree.Value
Value) -> String

The visible text of a value. Text and number lexemes are exact. Booleans and null have a mark, so they do not look like text with the same letters. A row of a nested container shows {…} or […], or {} or [] when the container is empty.

highlight_background

source

fn highlight_background(palette : @moonrockz/diagrams-svg/theme.Palette
Palette) -> @moonrockz/diagrams-svg/theme.Color
Color

The background of a highlighted row: the cloud family fill over the box fill.

ink_of

source

fn ink_of(kind : Kind) -> Ink

The ink of a scalar or container value.

kind_of

source

fn kind_of(value : @moonrockz/diagrams/data-tree.Value
Value) -> Kind

label_clearance

source

let label_clearance : Double

The smallest space between a label and the edge of its row.

layout

source

fn layout(tree : @moonrockz/diagrams/data-tree.DataTree
DataTree, limits? : Limits) -> Result

Measured data geometry. Each container is a box with ordered rows; arrays show the position of each row. A nested container is a separate box in the next column, joined by a connector from its row. Inline scalars stay in their row, with no connector. Empty containers and a scalar root are visible boxes. Layout is iterative and every bound is explicit; exhaustion gives a diagnostic and no geometry.

palette

source

fn palette(p : @moonrockz/diagrams-svg/theme.Palette
Palette) -> @moonrockz/diagrams-svg/theme.Palette
Palette

The palette for data views. Each ink that a data label uses gets a shade with 4.5:1 contrast on the box fill and on the highlight background.

svg_number

source

fn svg_number(value : Double) -> String

Canonical coordinates have at most three fractional digits and never use exponent notation.

text_width

source

fn text_width(line : String, size? : Int, weight? : Int) -> Double

The measured width of one line of text.

Source Files

Site source Report issue Packages Build queue Skills Statistics

#Box

#Box::equal

#Box::not_equal

#Box::to_repr

#Connector

#Connector::equal

#Connector::not_equal

#Connector::path

#Connector::samples

#Connector::to_repr

#Finding

#Finding::equal

#Finding::not_equal

#Finding::to_repr

#Geometry

#Geometry::equal

#Geometry::not_equal

#Geometry::to_repr

#Ink

#Ink::color

#Ink::equal

#Ink::not_equal

#Ink::to_repr

#Ink::token

#Kind

#Kind::equal

#Kind::name

#Kind::not_equal

#Kind::to_repr

#Label

#Label::equal

#Label::not_equal

#Label::to_repr

#Limits

#Limits::equal

#Limits::new

#Limits::not_equal

#Limits::to_repr

#Limits::with_minimum_approach

#Point

#Point::equal

#Point::not_equal

#Point::to_repr

#Rect

#Rect::bottom

#Rect::contains

#Rect::equal

#Rect::not_equal

#Rect::overlaps

#Rect::right

#Rect::to_repr

#Result

#Row

#Row::equal

#Row::not_equal

#Row::to_repr

#Rule

#Rule::equal

#Rule::not_equal

#Rule::to_repr

#check

#display_text

#highlight_background

#ink_of

#kind_of

#label_clearance

#layout

#palette

#svg_number

#text_width

Source Files

Box

Box::equal

Box::not_equal

Box::to_repr

Connector

Connector::equal

Connector::not_equal

Connector::path

Connector::samples

Connector::to_repr

Finding

Finding::equal

Finding::not_equal

Finding::to_repr

Geometry

Geometry::equal

Geometry::not_equal

Geometry::to_repr

Ink

Ink::color

Ink::equal

Ink::not_equal

Ink::to_repr

Ink::token

Kind

Kind::equal

Kind::name

Kind::not_equal

Kind::to_repr

Label

Label::equal

Label::not_equal

Label::to_repr

Limits

Limits::equal

Limits::new

Limits::not_equal

Limits::to_repr

Limits::with_minimum_approach

Point

Point::equal

Point::not_equal

Point::to_repr

Rect

Rect::bottom

Rect::contains

Rect::equal

Rect::not_equal

Rect::overlaps

Rect::right

Rect::to_repr

Result

Row

Row::equal

Row::not_equal

Row::to_repr

Rule

Rule::equal

Rule::not_equal

Rule::to_repr

check

display_text

highlight_background

ink_of

kind_of

label_clearance

layout

palette

svg_number

text_width