Skip to content

Latest commit

 

History

History
140 lines (135 loc) · 8.23 KB

edges-doc.md

File metadata and controls

140 lines (135 loc) · 8.23 KB
Raw

Array of edges

Type: array

path: #edgeSchema

$id: edgeSchema

  • Items

  • Edge

  • Type: object
  • path: #edgeSchema/items
  • 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: #edgeSchema/items/properties/animation
      • Example values:
        1. "default"
        2. "reverse"
        3. "none"
    • color
      • The color of the edge.
      • Type: string
      • path: #edgeSchema/items/properties/color
      • Default: "black"
    • label
      • Set the label of the edge.
      • Type: string
      • path: #edgeSchema/items/properties/label
    • preset
      • Refer to a preset defined in the config of the global defaults. If you haven't used a key in your config (but that key is used in your preset), the key from the preset is taken as a key in your individual config. You can refer to multiple presets: the first preset has priority on the second, the second on the third, ... In general, the priority of the keys is: local > first preset > second preset > ... > keys in global default.
      • Types: array, string
      • path: #edgeSchema/items/properties/preset
    • thickness
      • The thickness of the edge.
      • Type: number
      • path: #edgeSchema/items/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: #edgeSchema/items/properties/strokeDasharray
      • Example values:
        1. "solid"
        2. "dashed"
        3. "dotted"
        4. "varied"
        5. "dashed-wide-gaps"
      • Default: "solid"
    • source required
      • ID of the source node.
      • Type: string
      • path: #edgeSchema/items/properties/source
    • target required
      • ID of the target node.
      • Type: string
      • path: #edgeSchema/items/properties/target
    • sourceHandle
      • Set where the edge should attach to the source node.
      • Type: string
      • path: #edgeSchema/items/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: #edgeSchema/items/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: #edgeSchema/items/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: #edgeSchema/items/properties/zIndex
    • markerStart

      • Arrowhead schema

      • Type: object
      • path: #edgeSchema/items/properties/markerStart
      • Properties
        • type
          • Set the type of the arrowhead.
          • Type: string
          • path: #edgeSchema/items/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: #edgeSchema/items/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: #edgeSchema/items/properties/markerStart/properties/color
        • size
          • Set the size of the arrowhead.
          • Type: number
          • path: #edgeSchema/items/properties/markerStart/properties/size
    • markerEnd

      • Arrowhead schema

      • Type: object
      • path: #edgeSchema/items/properties/markerEnd
      • Properties
        • type
          • Set the type of the arrowhead.
          • Type: string
          • path: #edgeSchema/items/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: #edgeSchema/items/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: #edgeSchema/items/properties/markerEnd/properties/color
        • size
          • Set the size of the arrowhead.
          • Type: number
          • path: #edgeSchema/items/properties/markerEnd/properties/size

Generated with json-schema-md-doc