mooncakes.io

ascii
→
ast
→
cmd
→
compiler
→
diagram
→
engine_api
→
engine_dagre
→
engine_elk
→
engine_railway
→
exporter
→
font_subset
→
formatter
→
fs
→
graph
→
ir
→
layout_ascii
→
layout_core
→
layout_sequence
→
layout_svg
→
lexer
→
lib
→
parser
→
render_api
→
renderer_ascii
→
renderer_svg
→
renderer_unicode
→
scratch_metrics
→
sugiyama
→
svg
→
tests
→
tests_fs
→
text_metrics
→
themes
→
xml_emit
→
README
E
DiagoError
T
CompileOptions
- ::newCompileOptions::new
- ::with_centerCompileOptions::with_center
- ::with_dark_theme_idCompileOptions::with_dark_theme_id
- ::with_dark_theme_overridesCompileOptions::with_dark_theme_overrides
- ::with_directionCompileOptions::with_direction
- ::with_layout_engineCompileOptions::with_layout_engine
- ::with_layout_pluginCompileOptions::with_layout_plugin
- ::with_no_xml_tagCompileOptions::with_no_xml_tag
- ::with_omit_versionCompileOptions::with_omit_version
- ::with_output_modeCompileOptions::with_output_mode
- ::with_padCompileOptions::with_pad
- ::with_parse_optionsCompileOptions::with_parse_options
- ::with_route_pluginCompileOptions::with_route_plugin
- ::with_saltCompileOptions::with_salt
- ::with_scaleCompileOptions::with_scale
- ::with_sketchCompileOptions::with_sketch
- ::with_target_specCompileOptions::with_target_spec
- ::with_theme_nameCompileOptions::with_theme_name
- ::with_theme_overridesCompileOptions::with_theme_overrides
T
CompletionItem
T
CompletionKind
T
LayoutEngine
T
LayoutPlugin
- ::newLayoutPlugin::new
- ::runLayoutPlugin::run
T
OutputMode
T
ParseOptions
- ::newParseOptions::new
- ::with_import_resolverParseOptions::with_import_resolver
T
RoutePlugin
- ::newRoutePlugin::new
- ::runRoutePlugin::run
T
SyntaxToken
T
SyntaxTokenKind
V
compile
V
compile_diagram
V
get_board_path_at_position
V
get_completion_items
V
get_ref_ranges
V
get_syntax_tokens
V
parse

README

Milky2018/diago/engine_api does not have a README file

#
LayoutEngine

pub(open) trait LayoutEngine {
  fn layout(Self, @Milky2018/diago/graph.GraphInput
GraphInput, LayoutConfig, Direction) -> @Milky2018/diago/graph.LayoutPatch
LayoutPatch raise LayoutError
  fn engine_name(Self) -> String
  fn features(Self) -> Array[LayoutFeature]
}

Layout engine interface.

Engines receive a graph whose object and edge lookup fields use canonical absolute source syntax. They must not mutate the input graph and return a patch whose keys belong to that graph.

#
LayoutError

source

pub(all) suberror LayoutError {
  InvalidGraph(String)
  CycleDetected(String)
  Unsupported(String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Layout error

impl Show for LayoutError

#
Direction

source

pub(all) enum Direction {
  Down
  Right
  Up
  Left
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Layout direction

impl Show for Direction

#
LayoutConfig

source

pub struct LayoutConfig {
  horizontal_spacing : Double
  vertical_spacing : Double
  container_padding : Double
  default_width : Double
  default_height : Double
  edge_padding : Double
} derive(@moonbitlang/core/debug.Debug
Debug)

Layout configuration

#
LayoutConfig::new

source

fn LayoutConfig::new() -> LayoutConfig

#
LayoutConfig::with_spacing

source

fn LayoutConfig::with_spacing(horizontal : Double, vertical : Double) -> LayoutConfig

#
LayoutFeature

source

pub(all) enum LayoutFeature {
  NearObject
  ContainerDimensions
  TopLeft
  DescendantEdges
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Layout engine capability flags aligned with the reference's layout feature model.

#
cycle_detected

source

fn cycle_detected(message : String) -> LayoutError

#
estimate_nested_grid_layout_like_d2

source

fn estimate_nested_grid_layout_like_d2(parent : @Milky2018/diago/graph.ObjectInput
ObjectInput, child_ids : Array[String], child_size_by_id : Map[String, (Double, Double)], object_by_id : Map[String, @Milky2018/diago/graph.ObjectInput
ObjectInput]) -> (Double, Double, Map[String, @Milky2018/diago/graph.Box
Box])?

Estimate a real nested grid container, including D2's outside-label margins and container padding, from backend-produced child sizes.

#
estimate_root_grid_child_boxes

source

fn estimate_root_grid_child_boxes(parent : @Milky2018/diago/graph.ObjectInput
ObjectInput, child_ids : Array[String], child_size_by_id : Map[String, (Double, Double)]) -> Map[String, @Milky2018/diago/graph.Box
Box]?

#
invalid_graph

source

fn invalid_graph(message : String) -> LayoutError

Construct an engine_api.LayoutError from outside this package.

#
layout_with_engine

source

fn[Engine : LayoutEngine] layout_with_engine(engine : Engine, graph : @Milky2018/diago/graph.GraphInput
GraphInput, config : LayoutConfig, direction : Direction) -> @Milky2018/diago/graph.GraphInput
GraphInput raise LayoutError

Perform layout on a graph (including variants) with a specific engine.

Returns a new graph with layout applied.

#
unsupported

source

fn unsupported(message : String) -> LayoutError

Source Files

Site source Report issue Packages Build queue Skills Statistics

#LayoutEngine

#LayoutError

#Direction

#LayoutConfig

#LayoutConfig::new

#LayoutConfig::with_spacing

#LayoutFeature

#cycle_detected

#estimate_nested_grid_layout_like_d2

#estimate_root_grid_child_boxes

#invalid_graph

#layout_with_engine

#unsupported

Source Files

#
LayoutEngine

#
LayoutError

#
Direction

#
LayoutConfig

#
LayoutConfig::new

#
LayoutConfig::with_spacing

#
LayoutFeature

#
cycle_detected

#
estimate_nested_grid_layout_like_d2

#
estimate_root_grid_child_boxes

#
invalid_graph

#
layout_with_engine

#
unsupported