Skip to content

XDSMjs configuration

Rémi Lafage edited this page Apr 24, 2020 · 5 revisions

XDSM diagram look can be configured through the configuration object given to the Xdsm instance. That object is as follows:

default_config = {
    labelizer: {
      ellipsis: 5,
      subSupScript: true,
      showLinkNbOnly: false,
    },
    layout: {
      origin: {x: 100, y: 20},
      cellsize: {w: 250, h: 75},
      padding: 20,
    },
    withDefaultDriver: true,
    withTitleTooltip: true,
};
  • config.labelizer:

    • showLinkNbOnly: if true display number of var computed from comma separated list of names, otherwise display the comma separated list of names
    • subSupScript: if true manage basic typesetting for nodes and edges names (_ for subscript, ^ for superscript)
    • ellipsis : max nb of variables to display, others are ellipsized (...)
  • config.layout:

    • origin.[x,y]: offset for the origin of the diagram
    • cellsize.[w, h]: control the spacing of the node and edges boxes
    • padding: control the spacing between text and boxes borders.
  • config.withDefaultDriver: When set to true, XDSMjs adds an invisible node with id=_U_ which can be used to define inputs and outputs of the whole multi-disciplibary analysis.

  • config.withTitleTooltip: When set to true, XDSMjs adds a tooltip to show all variable names within a connection.

Clone this wiki locally