Skip to content

Latest commit

 

History

History
283 lines (276 loc) · 16.3 KB

globaldefaults-doc.md

File metadata and controls

283 lines (276 loc) · 16.3 KB
Raw

Global defaults

This schema is to define the properties inside the global defaults config.

Type: object

path: #globalDefaultSchema

$id: globalDefaultSchema

Properties

  • graph

    • graph

    • graph in global defaults
    • Type: object
    • path: #globalDefaultsGraph
    • $id: globalDefaultsGraph
    • Properties
      • autoLayout
        • If set to true, dagre is used to automatically determine to positions of the nodes. Individually set positions will be overwritten see Node positioning for more information.
        • Type: boolean
        • path: #globalDefaultsGraph/properties/autoLayout
        • Default: false
      • orientation
        • The orientation of the graph. If you want to work from top to bottom or from bottom to top, set orientation to vertical
        • Type: string
        • path: #globalDefaultsGraph/properties/orientation
        • The value is restricted to the following:
          1. "vertical"
          2. "horizontal"
        • Default: "horizontal"
      • spacing
        • Set the spacing between nodes when autolayout, vgroups or hgroups are used.The default spacing for groups is the width/2 for hgroups or the height/2 for vgroups devided by 2. If you want that larger or smaller, you can set this key to any number. The spacing will be the default times the factor.When 'autolayout' is used, spacing has only effect on the vertical distance between nodes, when the orientation is set to 'vertical'. Vice versa for 'horizontal'.
        • Type: number
        • path: #globalDefaultsGraph/properties/spacing
        • Default: 1
  • node

    • node

    • node in global defaults
    • Type: object
    • path: #globalDefaultsNode
    • $id: globalDefaultsNode
    • Properties
      • height
        • The height of the node.
        • Type: number
        • path: #globalDefaultsNode/properties/height
        • Default: 50
      • width
        • The width of the node.
        • Type: number
        • path: #globalDefaultsNode/properties/width
        • Default: 50
      • fill
        • Color of the node.
        • Type: string
        • path: #globalDefaultsNode/properties/fill
        • Default: "white"
      • fontsize
        • Size of the text inside the nodes.
        • Type: number
        • path: #globalDefaultsNode/properties/fontsize
        • Default: 12
      • image
        • The image inside a node. This image takes up the entire width and height of the node.
        • Type: string
        • path: #globalDefaultsNode/properties/image
      • label
        • The text inside a node. If you want a newline in your text, you should manually put '\n' in your string. If the label does not fit the node in which it appears, fontsize will be made smaller so label fits its node (the minimum value to which fontsize will be reduced, is the defined fontsize divided by two).
        • Type: string
        • path: #globalDefaultsNode/properties/label
      • shape
        • The shape of the node.
        • Type: string
        • path: #globalDefaultsNode/properties/shape
        • The value is restricted to the following:
          1. "icon"
          2. "8-star"
          3. "big-star"
          4. "circle"
          5. "cylinder"
          6. "diamond"
          7. "ellipse"
          8. "hexagon"
          9. "note"
          10. "rectangle"
          11. "square"
          12. "star"
          13. "triangle"
          14. "comunica"
          15. "rmlio"
          16. "solid"
          17. "Details"
        • Default: "square"
      • iconName
        • When 'shape' is set to 'icon', you can set 'iconName' to anything you find in react-icons. Since this is a third-party library, not all styling will work. Only fill, strokeWidth, width and height will have effect.
        • Type: string
        • path: #globalDefaultsNode/properties/iconName
      • stroke
        • The color of the stroke of the node.
        • Type: string
        • path: #globalDefaultsNode/properties/stroke
        • Default: "black"
      • strokeDasharray
        • The dash pattern of the node. See MDN Web Docs for more information. The default value solid will fall back to the CSS value 0, dashed to 6 4, dottedto1 3, variedto5 2 1 2and dashed-wide-gaps will fall back to4 8`.
        • Types: number, string
        • path: #globalDefaultsNode/properties/strokeDasharray
        • Example values:
          1. "solid"
          2. "dashed"
          3. "dotted"
          4. "varied"
          5. "dashed-wide-gaps"
        • Default: "solid"
      • strokeWidth
        • The thickness of the stroke of the nodes.
        • Type: number
        • path: #globalDefaultsNode/properties/strokeWidth
        • Default: 1
      • title
        • The title of a node. E.g. useful to name a parentNode. Notice that this is not the same as an ID. If you give a node a title, that title will show up not in the middle of the node, but at the top. If the title does not fit the node in which it appears, fontsize will be made smaller to fit the node (the minimum value to which fontsize will be reduced, is the defined fontsize divided by two).
        • Type: string
        • path: #globalDefaultsNode/properties/title
      • topText
        • Set on top of the node.
        • Type: string
        • path: #globalDefaultsNode/properties/topText
      • zIndex
        • Controls the stacking order of the nodes.
        • Type: number
        • path: #globalDefaultsNode/properties/zIndex
        • Default: 0
      • hgroup
        • Align a group of nodes vertically.
        • Type: string
        • path: #globalDefaultsNode/properties/hgroup
      • vgroup
        • Align a group of nodes horizontally.
        • Type: string
        • path: #globalDefaultsNode/properties/vgroup
      • presets
        • Create node presets.
        • Type: object
        • path: #globalDefaultsNode/properties/presets
        • This schema accepts additional properties.
        • Properties
  • edge

    • edge

    • edge in global defaults
    • Type: object
    • path: #globalDefaultsEdge
    • $id: globalDefaultsEdge
    • Properties
      • animation
        • See MDN Web Docs for more information about animation. An example is e.g. dashdraw .2s linear infinite (has to start with 'dashdraw'). Note that you can just the value to default. The animation will then fall back to dashdraw .45s linear infinite. If the value is reverse, the fall back value will be dashdraw .45s linear infinite reverse. The strokeDashArray (if none is specified) will fall back to 6 4. When set to none, no animation will be shown.
        • Type: string
        • path: #globalDefaultsEdge/properties/animation
        • Example values:
          1. "default"
          2. "reverse"
          3. "none"
      • color
        • The color of the edge.
        • Type: string
        • path: #globalDefaultsEdge/properties/color
        • Default: "black"
      • label
        • Set the label of the edge.
        • Type: string
        • path: #globalDefaultsEdge/properties/label
      • thickness
        • The thickness of the edge.
        • Type: number
        • path: #globalDefaultsEdge/properties/thickness
        • Default: 1.2
      • strokeDasharray
        • The pattern of dashes of the edges. See MDN Web Docs for more information. The default value solid will fall back to the CSS value 0, dashed to 6 4, dottedto1 3, variedto5 2 1 2and dashed-wide-gaps will fall back to4 8`.
        • Types: number, string
        • path: #globalDefaultsEdge/properties/strokeDasharray
        • Example values:
          1. "solid"
          2. "dashed"
          3. "dotted"
          4. "varied"
          5. "dashed-wide-gaps"
        • Default: "solid"
      • source
        • ID of the source node.
        • Type: string
        • path: #globalDefaultsEdge/properties/source
      • target
        • ID of the target node.
        • Type: string
        • path: #globalDefaultsEdge/properties/target
      • sourceHandle
        • Set where the edge should attach to the source node.
        • Type: string
        • path: #globalDefaultsEdge/properties/sourceHandle
        • The value is restricted to the following:
          1. "left"
          2. "right"
          3. "top"
          4. "bottom"
      • targetHandle
        • Set where the edge should attach to the target node.
        • Type: string
        • path: #globalDefaultsEdge/properties/targetHandle
        • The value is restricted to the following:
          1. "left"
          2. "right"
          3. "top"
          4. "bottom"
      • type
        • Set how the edge should look like (straight line, curve ...). default = Bézier curve.
        • Type: string
        • path: #globalDefaultsEdge/properties/type
        • The value is restricted to the following:
          1. "default"
          2. "step"
          3. "smoothstep"
          4. "straight"
        • Default: "default"
      • zIndex
        • Controls the stacking order of the edge. For more information, go to the MDN Web Docs.
        • Type: number
        • path: #globalDefaultsEdge/properties/zIndex
      • markerStart
        • Arrowhead schema
        • Type: object
        • path: #globalDefaultsEdge/properties/markerStart
        • Properties
          • type
            • Set the type of the arrowhead.
            • Type: string
            • path: #globalDefaultsEdge/properties/markerStart/properties/type
            • The value is restricted to the following:
              1. "arrow"
              2. "arrowclosed"
          • orient
            • Set the orient of the arrowhead. See the MDN Web Docs for more information.
            • Types: string, number
            • path: #globalDefaultsEdge/properties/markerStart/properties/orient
          • color
            • Set the color of the arrowhead. If you do not specify a color, the color of the arrowhead will be the same as the color of the edge.
            • Type: string
            • path: #globalDefaultsEdge/properties/markerStart/properties/color
          • size
            • Set the size of the arrowhead.
            • Type: number
            • path: #globalDefaultsEdge/properties/markerStart/properties/size
      • markerEnd
        • Arrowhead schema
        • Type: object
        • path: #globalDefaultsEdge/properties/markerEnd
        • Properties
          • type
            • Set the type of the arrowhead.
            • Type: string
            • path: #globalDefaultsEdge/properties/markerEnd/properties/type
            • The value is restricted to the following:
              1. "arrow"
              2. "arrowclosed"
          • orient
            • Set the orient of the arrowhead. See the MDN Web Docs for more information.
            • Types: string, number
            • path: #globalDefaultsEdge/properties/markerEnd/properties/orient
          • color
            • Set the color of the arrowhead. If you do not specify a color, the color of the arrowhead will be the same as the color of the edge.
            • Type: string
            • path: #globalDefaultsEdge/properties/markerEnd/properties/color
          • size
            • Set the size of the arrowhead.
            • Type: number
            • path: #globalDefaultsEdge/properties/markerEnd/properties/size
      • presets
        • Create edge presets.
        • Type: object
        • path: #globalDefaultsEdge/properties/presets
        • This schema accepts additional properties.
        • Properties

Generated with json-schema-md-doc