Skip to content
  1. API
  2. Types

LegendOptions

Type: object

Properties

  • backgroundColor(optional) Color[="white"] Background color of the widgets.
  • borderColor(optional) Color[="black"] Border color of the widgets.
  • borderRadius(optional) number[=0] Border radius of the widgets.
  • borderWidth(optional) number[=1] Border width of the widgets, in pixels.
  • circleStrokeWidth(optional) number[=3] Stroke width of the circles used to indicate the size of the nodes.
  • fontColor(optional) Color[="black"] Font color used to display the widgets' content
  • fontFamily(optional) string[="Arial"] Font used to display the widgets
  • fontSize(optional) number[=10] Font size used to display the widgets' content
  • innerMargin(optional) number[=10] Blank space between a widget's border and its content, in pixels.
  • outerMargin(optional) number[=5] Blank space between two widgets, in pixels.
  • position(optional) "bottom"|"top"|"left"|"right"[="bottom"] Position of the legend on the canvas.
  • shapeColor(optional) Color[="grey"] Color used for displaying the widget indicating a node or edge shape
  • titleFontColor(optional) Color[="black"] Font color used to display the widgets' title
  • titleFontSize(optional) number[=12] Font size used to display the widgets' title
  • titleFunction(optional) function(propertyPath: Array<string>, styleProperty: PropertyPath): string Given a property path, must return the title of the widget which displays information on that property. By default keep the last part of the property path.
  • titleMaxLength(optional) number[=20] If a widget's title has more characters that this value, it will be truncated
  • titleTextAlign(optional) "left"|"center"[="left"] Alignment of the widgets' title
  • widgetWidth(optional) number[=130] Width of a widget, in pixels