Milky2018/diago/diagram

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/diagram does not have a README file

Config

source

pub struct Config {
  sketch : Bool?
  theme_id : Int?
  dark_theme_id : Int?
  theme_overrides : Map[String, String]
  dark_theme_overrides : Map[String, String]
  pad : Double?
  center : Bool?
  layout_engine : String?
  scale : Double?
  no_xml_tag : Bool?
  salt : String?
  omit_version : Bool?
  data : Map[String, String]
}

Configuration extracted from source (vars/config).

Caller-provided options may override these values.

impl Show for Config

Config::from_parts

source

fn Config::from_parts(sketch : Bool?, theme_id : Int?, dark_theme_id : Int?, theme_overrides : Map[String, String], dark_theme_overrides : Map[String, String], pad : Double?, center : Bool?, layout_engine : String?, scale : Double?, no_xml_tag : Bool?, salt : String?, omit_version : Bool?, data : Map[String, String]) -> Config

Config::new

source

fn Config::new() -> Config

Connection

source

pub struct Connection {
  index : Int
  src_id : String
  dst_id : String
  src_arrow : Bool
  dst_arrow : Bool
  src_arrowhead : @Milky2018/diago/graph.ArrowheadType
ArrowheadType
  dst_arrowhead : @Milky2018/diago/graph.ArrowheadType
ArrowheadType
  src_arrowhead_label : String?
  dst_arrowhead_label : String?
  src_arrowhead_label_color : String?
  dst_arrowhead_label_color : String?
  src_anchor : String?
  dst_anchor : String?
  label : String
  style : @Milky2018/diago/graph.StyleInput
StyleInput
  route : Array[@Milky2018/diago/graph.Point
Point]
  bend_points : Array[@Milky2018/diago/graph.Point
Point]?
  is_curve : Bool
  z_index : Int
  reference_count : Int
  label_box : @Milky2018/diago/graph.Box
Box?
  src_column_index : Int?
  dst_column_index : Int?
}

Renderable connection.

This is derived from @graph.EdgeInput after layout has been applied.

impl Show for Connection

Diagram

source

pub struct Diagram {
  name : String
  config : Config?
  root : Shape
  shapes : Array[Shape]
  connections : Array[Connection]
  activation_boxes : Array[(String, @Milky2018/diago/graph.Box
Box)]
  sequence_notes : Array[(String, String, @Milky2018/diago/graph.Box
Box)]
  sequence_fragments : Array[@Milky2018/diago/graph.SequenceFragmentLayout
SequenceFragmentLayout]
  layers : Array[Diagram]
  scenarios : Array[Diagram]
  steps : Array[Diagram]
  legend : @Milky2018/diago/graph.LegendInput
LegendInput?
}

Render-ready diagram.

shapes does not include root.

impl Show for Diagram

Diagram::find_object

source

fn Diagram::find_object(self : Diagram, id : String) -> Shape?

Diagram::get_board

source

fn Diagram::get_board(self : Diagram, board_path : Array[String]) -> Diagram?

Get a board by path.

Supports both explicit and shorthand paths:

Explicit: ["layers", "x", "scenarios", "y"]
Shorthand: ["x", "y"]

Diagram::get_edges

source

fn Diagram::get_edges(self : Diagram) -> Array[Connection]

Diagram::get_objects

source

fn Diagram::get_objects(self : Diagram) -> Array[Shape]

Diagram::has_layers

source

fn Diagram::has_layers(self : Diagram) -> Bool

Diagram::has_legend

source

fn Diagram::has_legend(self : Diagram) -> Bool

Diagram::has_scenarios

source

fn Diagram::has_scenarios(self : Diagram) -> Bool

Diagram::has_steps

source

fn Diagram::has_steps(self : Diagram) -> Bool

Shape

source

pub struct Shape {
  id : String
  label : String
  shape_type : @Milky2018/diago/graph.ShapeType
ShapeType
  style : @Milky2018/diago/graph.StyleInput
StyleInput
  box : @Milky2018/diago/graph.Box
Box?
  label_box : @Milky2018/diago/graph.Box
Box?
  child_ids : Array[String]
  z_index : Int
  icon : String?
  tooltip : String?
  link : String?
  classes : Array[String]
  grid_rows : Int?
  grid_columns : Int?
  grid_gap : Double?
  horizontal_gap : Double?
  vertical_gap : Double?
  grid_column_span : Int?
  grid_row_span : Int?
  near : String?
}

Renderable shape.

This is derived from @graph.ObjectInput after layout has been applied.

impl Show for Shape

Shape::center

source

fn Shape::center(self : Shape) -> @Milky2018/diago/graph.Point
Point?

Shape::get_box

source

fn Shape::get_box(self : Shape) -> @Milky2018/diago/graph.Box
Box?

Shape::get_id

source

fn Shape::get_id(self : Shape) -> String

from_graph

source

fn from_graph(graph : @Milky2018/diago/graph.GraphInput
GraphInput, config : Config?) -> Diagram

Convert a laid-out graph to a render-ready diagram.

This is the only conversion renderers should need.

Source Files

diagram.mbt

Site source Report issue Packages Build queue Skills Statistics

#Config

#Config::from_parts

#Config::new

#Connection

#Diagram

#Diagram::find_object

#Diagram::get_board

#Diagram::get_edges

#Diagram::get_objects

#Diagram::has_layers

#Diagram::has_legend

#Diagram::has_scenarios

#Diagram::has_steps

#Shape

#Shape::center

#Shape::get_box

#Shape::get_id

#from_graph

Source Files

Config

Config::from_parts

Config::new

Connection

Diagram

Diagram::find_object

Diagram::get_board

Diagram::get_edges

Diagram::get_objects

Diagram::has_layers

Diagram::has_legend

Diagram::has_scenarios

Diagram::has_steps

Shape

Shape::center

Shape::get_box

Shape::get_id

from_graph