OptionalautolockOptionalautoungrabifyWhether nodes should be ungrabified (not grabbable by user) by default (if true, overrides individual node state).
The default value is false.
OptionalautounselectifyWhether nodes should be unselectified (immutable selection state) by default (if true, overrides individual element state).
The default value is false.
OptionalboxWhether box selection (i.e. drag a box overlay around, and release it to select) is enabled. If enabled, the user must taphold to pan the graph.
The default value is false.
OptionalcontainerA HTML DOM element in which the graph should be rendered. This is optional if Cytoscape.js is run headlessly or if you initialise using jQuery (in which case your jQuery object already has an associated DOM element).
The default is undefined.
OptionaldataA plain object that contains graph-level data (i.e. data that does not belong to any particular node or edge).
OptionaldesktopA nonnegative integer that indicates the maximum allowable distance that a user may move during a tap gesture, on touch devices and desktop devices respectively.
This makes tapping easier for users. These values have sane defaults, so it is not advised to change these options unless you have very good reason for doing so. Larger values will almost certainly have undesirable consequences.
The default value is 4.
OptionalelementsAn array of [[Elements]] specified as plain objects. For convenience, this option can alternatively be specified as a promise that resolves to the elements JSON.
OptionalheadlessA convenience option that initialises the Core to run headlessly. You do not need to set this in environments that are implicitly headless (e.g. Node.js). However, it is handy to set headless: true if you want a headless Core in a browser.
The default value is false.
OptionalhideWhen set to true, the renderer does not render edges while the viewport is being manipulated. This makes panning, zooming, dragging, et cetera more responsive for large graphs.
The default value is false.
Optionalhidewhen set to true, the renderer does not render labels while the viewport is being manipulated. This makes panning, zooming, dragging, et cetera more responsive for large graphs.
The default value is false.
OptionallayoutA plain object that specifies layout options. Which layout is initially run is specified by the name field. Refer to a layout's documentation for the options it supports. If you want to specify your node positions yourself in your elements JSON, you can use the preset layout — by default it does not set any positions, leaving your nodes in their current positions (e.g. specified in options.elements at initialisation time)
OptionalmaxA maximum bound on the zoom level of the graph. The viewport can not be scaled larger than this zoom level.
The default value is 1e50.
OptionalminA minimum bound on the zoom level of the graph. The viewport can not be scaled smaller than this zoom level.
The default value is 1e-50.
OptionalmotionWhen set to true, the renderer will use a motion blur effect to make the transition between frames seem smoother. This can significantly increase the perceived performance for a large graphs.
The default value is false.
OptionalmotionWhen motionBlur: true, this value controls the opacity of motion blur frames. Higher values make the motion blur effect more pronounced.
The default value is 0.2.
OptionalpanThe initial panning position of the graph. Make sure to disable viewport manipulation options, such as fit, in your layout so that it is not overridden when the layout is applied.
OptionalpanningWhether panning the graph is enabled, both by user events and programmatically.
The default value is true.
OptionalpixelOverrides the screen pixel ratio with a manually set value (1.0 or 0.666 recommended, if set). This can be used to increase performance on high density displays by reducing the effective area that needs to be rendered. If you want to use the hardware's actual pixel ratio at the expense of performance, you can set pixelRatio: 'auto'.
The default value is 1.
OptionalselectionA string indicating the selection behaviour from user input. By default, this is set automatically for you based on the type of input device detected. On touch devices, 'additive' is default — a new selection made by the user adds to the set of currenly selected elements. On mouse-input devices, 'single' is default — a new selection made by the user becomes the entire set of currently selected elements (i.e. the previous elements are unselected).
The default value is (isTouchDevice ? 'additive' : 'single').
OptionalstyleThe [[Stylesheet]] used to style the graph. For convenience, this option can alternatively be specified as a promise that resolves to the stylesheet.
OptionalstyleA boolean that indicates whether styling should be used. For headless (i.e. outside the browser) environments, display is not necessary and so neither is styling necessary — thereby speeding up your code. You can manually enable styling in headless environments if you require it for a special case. Note that it does not make sense to disable style if you plan on rendering the graph.
The default value is true.
OptionaltextureWhen set to true, the renderer uses a texture (if supported) during panning and zooming instead of drawing the elements, making large graphs more responsive.
The default value is false.
OptionaltouchA nonnegative integer that indicates the maximum allowable distance that a user may move during a tap gesture, on touch devices and desktop devices respectively.
This makes tapping easier for users. These values have sane defaults, so it is not advised to change these options unless you have very good reason for doing so. Larger values will almost certainly have undesirable consequences.
The default value is is 8.
OptionaluserWhether user events (e.g. dragging the graph background) are allowed to pan the graph. Programmatic changes to pan are unaffected by this option.
The default value is true.
OptionaluserWhether user events (e.g. mouse wheel, pinch-to-zoom) are allowed to zoom the graph. Programmatic changes to zoom are unaffected by this option.
The default value is true.
OptionalwheelChanges the scroll wheel sensitivity when zooming. This is a multiplicative modifier. So, a value between 0 and 1 reduces the sensitivity (zooms slower), and a value greater than 1 increases the sensitivity (zooms faster).
The default value is 1.
OptionalzoomThe initial zoom level of the graph. Make sure to disable viewport manipulation options, such as fit, in your layout so that it is not overridden when the layout is applied. You can set options.minZoom and options.maxZoom to set restrictions on the zoom level.
The default value is 1.
OptionalzoomingWhether zooming the graph is enabled, both by user events and programmatically.
The default value is true.
Whether nodes should be locked (not draggable at all) by default (if true, overrides individual node state).
The default value is false.