Skip to main content
UICoreOptions
Base options for a renderer.
NameTypeDescription
canCollapseGroup?(group:Group, currentSize:Size) => boolean | ObjectDataReturns whether or not the given group can be collapsed
canExpandGroup?(group:Group, currentSize:Size) => boolean | ObjectDataReturns whether or not the given group can be expanded
defaultCollapsedGroupSize?SizeOptional default size for a collapsed group. Defaults to 200x150.
defaults?OOptional default settings
edges?UIEdgeOptionsDefault options for edges - these will apply to all edge types in the UI.
getCollapsedGroupSize?(group:Group, currentSize:Size) => SizeOptional function to determine the size of a collapsed group. This is given precedence over any default or per-type specification for a collapsed group's size.
grid?GridOptionsOptions for imposing a grid onto the elements in the UI
id?stringOptional ID for the UI. Allows you to retrieve this UI from a model's getRenderer(id) method.
layout?LayoutSpecDefines the layout to use.
logicalPorts?booleanDefaults to false. When true, the UI treats the vertex's element as the element for the port if it cannot find a specific element for the port.
plugins?Array<UIPluginSpec<any>>Optional list of plugins to attach to the UI.
relayoutOnEdgeConnect?booleanWhen true, the UI will run a refresh of the underlying layout whenever a new edge is established. This defaults to false, but you might want to set this to true if you're using the Hierarchical or Hierarchy layouts, because it has a bearing on the way they paint. However, if your users are able to drag vertices around, you may not wish for the layout to move things that they have placed, which is why this defaults to false.
relayoutOnResize?booleanWhether or not to relayout the UI when an element's size changes as a result of content changes in its element. Defaults to false.
relayoutOnVertexRemove?booleanWhether or not to relayout the UI when a vertex is removed. Defaults to false. For some layouts, like the Hierarchy layout, you may wish to switch this on.
router?(u:UICore<E>) => Router<E>Optional factory method to instantiate a router. This is only for certain advanced usages in which you wish to route all of the edges yourself. Most applications do not need to consider this.
useModelForPositions?booleanDefaults to true - we get positions for elements from our layout. In some use cases you may wish to use element positions retrieved from the DOM.
useModelForSizes?booleanDefaults to false. When true, newly created nodes are sized according to values in their backing data, using the modelWidthAttribute and modelHeightAttribute as keys. NOTE: when this flag is set, VisuallyJs will write the size onto each element as it is created. Depending on your app, you may not need it to do this - if you know your node sizes are set via css, for instance, or you know the template rendering your vertices writes out the size in an element's style or an SVG element's width/height. If that is the case, you can set writeSizeToElements to be false, and you'll get a performance boost.
writeSizeToElements?booleanWhen useModelForSizes is true, VisuallyJs will write out the model size onto each element rendered. But if you know your node sizes are set via css, or you know the template rendering your vertices writes out the size in an element's style or an SVG element's width/height, you can instruct VisuallyJs not to bother writing out the size to the element itself, by setting this flag to true (the default is false). This can provide a performance boost.
zoomToFit?booleanIf true, zoom the display so that the dataset is entirely visible after initialisation.
zoomToFitIfNecessary?booleanIf true, zoom the display so that the dataset is entirely visible after initialisation, but only adjust the zoom level if the dataset is not already visible at the default zoom level.