Skip to main content

Global Configuration

This guide explains how to configure maxGraph globally. This global configuration applies to all instances of Graph.

General​

The following objects can be used to configure maxGraph globally:

  • Client: this is the historical entry point for global configuration, coming from the mxGraph library.
  • EdgeHandlerConfig (since 0.14.0): for EdgeHandler (including subclasses).
  • GlobalConfig (since 0.11.0): for shared resources (logger).
  • HandleConfig (since 0.14.0): for shared handle configurations.
  • StencilShapeConfig (since 0.11.0): for stencil shapes.
  • StyleDefaultsConfig (since 0.14.0): for the default values of the Cell styles.
  • VertexHandlerConfig (since 0.12.0): for VertexHandler.

Some functions are provided to reset the global configuration to the default values. For example:

  • resetEdgeHandlerConfig (since 0.14.0)
  • resetHandleConfig (since 0.14.0)
  • resetStyleDefaultsConfig (since 0.14.0)
  • resetVertexHandlerConfig (since 0.14.0)
note

Notice that the new global configuration elements introduced as version 0.11.0 are experimental and are subject to change in future versions.

info

For former mxGraph users, the global configuration objects allow to set the default values previously defined in mxConstants and used everywhere in the code. Not all values are currently configurable yet, but the list is growing.

See also discussions in issue #192.

Styles​

maxGraph provides several global registries used to register style configurations.

  • CellRenderer: shapes
  • MarkerShape: edge markers (also known as startArrow and endArrow in CellStateStyle)
  • StyleRegistry: edge styles and perimeters
  • StencilShapeRegistry: stencil shapes

When instantiating a Graph object, the registries are filled with maxGraph default style configurations. There is no default stencil shapes registered by default.

Serialization​

CodecRegistry is used for serialization and deserialization of objects in XML object. By default, no codec is registered. Some functions are provided to register codecs for specific objects.