json_canvas - v0.3.0

json_canvas/types

Types

Canvas

</> 
pub type Canvas {
  Canvas(nodes: List(Node), edges: List(Edge))
}

Constructors 

  • Canvas(nodes: List(Node), edges: List(Edge))

Color

</> 
pub type Color {
  Color(String)
}

Constructors 

  • Color(String)

Edge

</> 
pub type Edge {
  Edge(
    id: EdgeId,
    from_node: NodeId,
    from_side: Option(Side),
    from_end: EndpointShape,
    to_node: NodeId,
    to_side: Option(Side),
    to_end: EndpointShape,
    color: Option(Color),
    label: Option(EdgeLabel),
  )
}

Constructors 

  • Edge(
  id: EdgeId,
  from_node: NodeId,
  from_side: Option(Side),
  from_end: EndpointShape,
  to_node: NodeId,
  to_side: Option(Side),
  to_end: EndpointShape,
  color: Option(Color),
  label: Option(EdgeLabel),
)

EdgeId

</> 
pub type EdgeId {
  EdgeId(String)
}

Constructors 

  • EdgeId(String)

EdgeLabel

</> 
pub type EdgeLabel {
  EdgeLabel(String)
}

Constructors 

  • EdgeLabel(String)

EndpointShape

</> 
pub type EndpointShape {
  WithArrow
  WithoutArrow
}

Constructors 

  • WithArrow
  • WithoutArrow

FilePath

</> 
pub type FilePath {
  FilePath(String)
}

Constructors 

  • FilePath(String)

GroupBackground

</> 
pub type GroupBackground {
  GroupBackground(String)
}

Constructors 

  • GroupBackground(String)

GroupBackgroundStyle

</> 
pub type GroupBackgroundStyle {
  Cover
  Ratio
  Repeat
}

Constructors 

  • Cover
  • Ratio
  • Repeat

GroupLabel

</> 
pub type GroupLabel {
  GroupLabel(String)
}

Constructors 

  • GroupLabel(String)

Node

</> 
pub type Node {
  TextNode(
    id: NodeId,
    x: Int,
    y: Int,
    width: Int,
    height: Int,
    color: Option(Color),
    text: String,
  )
  FileNode(
    id: NodeId,
    x: Int,
    y: Int,
    width: Int,
    height: Int,
    color: Option(Color),
    path: FilePath,
    subpath: Option(Subpath),
  )
  LinkNode(
    id: NodeId,
    x: Int,
    y: Int,
    width: Int,
    height: Int,
    color: Option(Color),
    url: Url,
  )
  GroupNode(
    id: NodeId,
    x: Int,
    y: Int,
    width: Int,
    height: Int,
    color: Option(Color),
    label: Option(GroupLabel),
    background: Option(GroupBackground),
    background_style: Option(GroupBackgroundStyle),
  )
}

Constructors 

  • TextNode(
  id: NodeId,
  x: Int,
  y: Int,
  width: Int,
  height: Int,
  color: Option(Color),
  text: String,
)
  • FileNode(
  id: NodeId,
  x: Int,
  y: Int,
  width: Int,
  height: Int,
  color: Option(Color),
  path: FilePath,
  subpath: Option(Subpath),
)
  • LinkNode(
  id: NodeId,
  x: Int,
  y: Int,
  width: Int,
  height: Int,
  color: Option(Color),
  url: Url,
)
  • GroupNode(
  id: NodeId,
  x: Int,
  y: Int,
  width: Int,
  height: Int,
  color: Option(Color),
  label: Option(GroupLabel),
  background: Option(GroupBackground),
  background_style: Option(GroupBackgroundStyle),
)

NodeId

</> 
pub type NodeId {
  NodeId(String)
}

Constructors 

  • NodeId(String)

Side

</> 
pub type Side {
  Top
  Right
  Bottom
  Left
}

Constructors 

  • Top
  • Right
  • Bottom
  • Left

Subpath

</> 
pub type Subpath {
  Subpath(String)
}

Constructors 

  • Subpath(String)

Url

</> 
pub type Url {
  Url(String)
}

Constructors 

  • Url(String)
✨ Search Document