Milky2018/diago/engine_api

This version of the module is deprecated: Moved to moonbit-community/diago. Use moonbit-community/diago@0.4.0 or later and update import paths.

README
- ::newCompileOptions::new
- ::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_parse_optionsCompileOptions::with_parse_options
- ::with_route_pluginCompileOptions::with_route_plugin
- ::with_saltCompileOptions::with_salt
- ::with_scaleCompileOptions::with_scale
- ::with_target_specCompileOptions::with_target_spec
- ::with_theme_nameCompileOptions::with_theme_name
- ::with_theme_overridesCompileOptions::with_theme_overrides
T
CompletionItem
T
CompletionKind
T
LayoutEngine
- ::innerLayoutPlugin::inner
- ::newLayoutPlugin::new
- ::runLayoutPlugin::run
T
OutputMode
- ::newParseOptions::new
- ::with_base_pathParseOptions::with_base_path
- ::with_import_resolverParseOptions::with_import_resolver
- ::innerRoutePlugin::inner
- ::newRoutePlugin::new
- ::runRoutePlugin::run
V
compile
V
compile_diagram
V
compile_file
V
get_board_path_at_position
V
get_completion_items
V
get_ref_ranges
V
parse
V
parse_file

Milky2018/diago/engine_api does not have a README file

LayoutEngine

source

pub(open) trait LayoutEngine {
  layout(Self, @Milky2018/diago/graph.GraphInput
GraphInput, LayoutConfig, Direction) -> @Milky2018/diago/graph.LayoutPatch
LayoutPatch raise LayoutError
}

Layout engine interface.

Engines must not mutate their input graph. They return a patch that can be applied by the caller.

LayoutError

source

pub(all) suberror LayoutError {
  InvalidGraph(String)
  CycleDetected(String)
  Unsupported(String)
}

Layout error

impl Eq for LayoutError

impl Show for LayoutError

Direction

source

pub(all) enum Direction {
  Down
  Right
  Up
  Left
}

Layout direction

impl Eq for 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
}

Layout configuration

impl Show for LayoutConfig

LayoutConfig::new

source

fn LayoutConfig::new() -> LayoutConfig

LayoutConfig::with_spacing

source

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

cycle_detected

source

fn cycle_detected(message : String) -> LayoutError

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

api.mbt

Install

Download zip

A D2-compatible diagram toolkit for MoonBit with Dagre, ELK, and Railway layout engines, rendering SVG, ASCII, and Unicode outputs.

graph

Milky2018

Apache-2.0

github.com/moonbit-community/diago

Updated 7 months ago

43K downloads

Site source Report issue Packages Build queue Skills Statistics

#LayoutEngine

#LayoutError

#Direction

#LayoutConfig

#LayoutConfig::new

#LayoutConfig::with_spacing

#cycle_detected

#invalid_graph

#layout_with_engine

#unsupported

Source Files

LayoutEngine

LayoutError

Direction

LayoutConfig

LayoutConfig::new

LayoutConfig::with_spacing

cycle_detected

invalid_graph

layout_with_engine

unsupported