This is the cytoscape-clj Reference Manual, version 0.2.18, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri Sep 15 04:49:24 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
cytoscape-cljA cytoscape widget for Common Lisp Jupyter.
Tarn W. Burton
MIT
0.2.18
common-lisp-jupyter (system).
src (module).
Modules are listed depth-first from the system components tree.
cytoscape-clj/srccytoscape-clj (system).
packages.lisp (file).
version.lisp (file).
common-slots.lisp (file).
context-menu.lisp (file).
graph-layout.lisp (file).
cytoscape.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cytoscape-clj/cytoscape-clj.asdcytoscape-clj/src/packages.lispcytoscape-clj/src/version.lispcytoscape-clj/src/common-slots.lispcytoscape-clj/src/context-menu.lispcytoscape-clj/src/graph-layout.lispcytoscape-clj/src/cytoscape.lispcytoscape-clj/src/version.lisppackages.lisp (file).
src (module).
+module-name+ (special variable).
+module-version+ (special variable).
cytoscape-clj/src/common-slots.lispversion.lisp (file).
src (module).
animate (reader method).
(setf animate) (writer method).
animation-duration (reader method).
(setf animation-duration) (writer method).
animation-easing (reader method).
(setf animation-easing) (writer method).
avoid-overlap (reader method).
(setf avoid-overlap) (writer method).
bounding-box (reader method).
(setf bounding-box) (writer method).
clockwise (reader method).
(setf clockwise) (writer method).
fit (reader method).
(setf fit) (writer method).
gravity (reader method).
(setf gravity) (writer method).
nesting-factor (reader method).
(setf nesting-factor) (writer method).
node-dimensions-include-labels (reader method).
(setf node-dimensions-include-labels) (writer method).
num-iter (reader method).
(setf num-iter) (writer method).
padding (reader method).
(setf padding) (writer method).
randomize (reader method).
(setf randomize) (writer method).
refresh (reader method).
(setf refresh) (writer method).
spacing-factor (reader method).
(setf spacing-factor) (writer method).
start-angle (reader method).
(setf start-angle) (writer method).
sweep (reader method).
(setf sweep) (writer method).
animation-slots (class).
avoid-overlap-slot (class).
bounding-box-slot (class).
common-slots (class).
gravity-slot (class).
nesting-factor-slot (class).
node-dimensions-include-labels-slot (class).
num-iter-slot (class).
radial-slots (class).
randomize-slot (class).
refresh-slot (class).
spacing-factor-slot (class).
cytoscape-clj/src/graph-layout.lispcontext-menu.lisp (file).
src (module).
%on-layout-stop (reader method).
(setf %on-layout-stop) (writer method).
add-unnecessary-bendpoints (reader method).
(setf add-unnecessary-bendpoints) (writer method).
alignment (reader method).
(setf alignment) (writer method).
all-const-iter (reader method).
(setf all-const-iter) (writer method).
aspect-ratio (reader method).
(setf aspect-ratio) (writer method).
avoid-overlap-padding (reader method).
(setf avoid-overlap-padding) (writer method).
border-spacing (reader method).
(setf border-spacing) (writer method).
breadth-first-layout (class).
circle (reader method).
(setf circle) (writer method).
circle-layout (class).
cola-layout (class).
cols (reader method).
(setf cols) (writer method).
compact-components (reader method).
(setf compact-components) (writer method).
component-spacing (reader method).
(setf component-spacing) (writer method).
concentric-layout (class).
condense (reader method).
(setf condense) (writer method).
convergence-threshold (reader method).
(setf convergence-threshold) (writer method).
cooling-factor (reader method).
(setf cooling-factor) (writer method).
cose-layout (class).
crossing-minimization (reader method).
(setf crossing-minimization) (writer method).
dagre-layout (class).
directed (reader method).
(setf directed) (writer method).
direction (reader method).
(setf direction) (writer method).
edge-elasticity (reader method).
edge-elasticity (reader method).
(setf edge-elasticity) (writer method).
(setf edge-elasticity) (writer method).
edge-jaccard-length (reader method).
(setf edge-jaccard-length) (writer method).
edge-length (reader method).
(setf edge-length) (writer method).
edge-routing (reader method).
(setf edge-routing) (writer method).
edge-sep (reader method).
(setf edge-sep) (writer method).
edge-spacing-factor (reader method).
(setf edge-spacing-factor) (writer method).
edge-sym-diff-length (reader method).
(setf edge-sym-diff-length) (writer method).
edge-weight (reader method).
(setf edge-weight) (writer method).
equidistant (reader method).
(setf equidistant) (writer method).
fcose-layout (class).
feedback-edges (reader method).
(setf feedback-edges) (writer method).
fixed-alignment (reader method).
(setf fixed-alignment) (writer method).
flow (reader method).
(setf flow) (writer method).
gap-inequalities (reader method).
(setf gap-inequalities) (writer method).
graph-layout (class).
gravity-compound (reader method).
(setf gravity-compound) (writer method).
gravity-range (reader method).
(setf gravity-range) (writer method).
gravity-range-compound (reader method).
(setf gravity-range-compound) (writer method).
grid (reader method).
(setf grid) (writer method).
grid-layout (class).
handle-disconnected (reader method).
(setf handle-disconnected) (writer method).
ideal-edge-length (reader method).
ideal-edge-length (reader method).
(setf ideal-edge-length) (writer method).
(setf ideal-edge-length) (writer method).
in-layer-spacing-factor (reader method).
(setf in-layer-spacing-factor) (writer method).
initial-energy-on-incremental (reader method).
(setf initial-energy-on-incremental) (writer method).
initial-temp (reader method).
(setf initial-temp) (writer method).
klay-layout (class).
layout-hierarchy (reader method).
(setf layout-hierarchy) (writer method).
linear-segments-deflection-dampening (reader method).
(setf linear-segments-deflection-dampening) (writer method).
make-breadth-first-layout (function).
make-circle-layout (function).
make-cola-layout (function).
make-concentric-layout (function).
make-cose-layout (function).
make-dagre-layout (function).
make-fcose-layout (function).
make-graph-layout (function).
make-grid-layout (function).
make-klay-layout (function).
make-null-layout (function).
make-preset-layout (function).
make-random-layout (function).
max-simulation-time (reader method).
(setf max-simulation-time) (writer method).
maximal (reader method).
(setf maximal) (writer method).
merge-edges (reader method).
(setf merge-edges) (writer method).
merge-hierarchy-crossing-edges (reader method).
(setf merge-hierarchy-crossing-edges) (writer method).
min-length (reader method).
(setf min-length) (writer method).
min-node-spacing (reader method).
(setf min-node-spacing) (writer method).
min-temp (reader method).
(setf min-temp) (writer method).
node-layering (reader method).
(setf node-layering) (writer method).
node-overlap (reader method).
(setf node-overlap) (writer method).
node-placement (reader method).
(setf node-placement) (writer method).
node-repulsion (reader method).
node-repulsion (reader method).
(setf node-repulsion) (writer method).
(setf node-repulsion) (writer method).
node-sep (reader method).
(setf node-sep) (writer method).
node-separation (reader method).
(setf node-separation) (writer method).
null-layout (class).
on-custom-message (method).
on-layout-stop (function).
pack-components (reader method).
(setf pack-components) (writer method).
pan (reader method).
(setf pan) (writer method).
pi-tol (reader method).
(setf pi-tol) (writer method).
preset-layout (class).
quality (reader method).
(setf quality) (writer method).
radius (reader method).
(setf radius) (writer method).
random-layout (class).
randomization-seed (reader method).
(setf randomization-seed) (writer method).
rank-dir (reader method).
(setf rank-dir) (writer method).
rank-sep (reader method).
(setf rank-sep) (writer method).
ranker (reader method).
(setf ranker) (writer method).
roots (reader method).
(setf roots) (writer method).
route-self-loop-inside (reader method).
(setf route-self-loop-inside) (writer method).
rows (reader method).
(setf rows) (writer method).
sample-size (reader method).
(setf sample-size) (writer method).
sampling-type (reader method).
(setf sampling-type) (writer method).
selector (reader method).
(setf selector) (writer method).
separate-connected-components (reader method).
(setf separate-connected-components) (writer method).
spacing (reader method).
(setf spacing) (writer method).
thoroughness (reader method).
(setf thoroughness) (writer method).
tile (reader method).
(setf tile) (writer method).
tile-padding-horizontal (reader method).
(setf tile-padding-horizontal) (writer method).
tile-padding-vertical (reader method).
(setf tile-padding-vertical) (writer method).
unconst-iter (reader method).
(setf unconst-iter) (writer method).
ungrabify-while-simulating (reader method).
(setf ungrabify-while-simulating) (writer method).
uniform-node-dimensions (reader method).
(setf uniform-node-dimensions) (writer method).
user-const-iter (reader method).
(setf user-const-iter) (writer method).
zoom (reader method).
(setf zoom) (writer method).
cycle-breakingcycle-breaking (reader method).
(setf cycle-breakingcycle-breaking) (writer method).
cytoscape-clj/src/cytoscape.lispgraph-layout.lisp (file).
src (module).
add-graph (generic function).
auto-ungrabify (reader method).
(setf auto-ungrabify) (writer method).
auto-unselectify (reader method).
(setf auto-unselectify) (writer method).
autolock (reader method).
(setf autolock) (writer method).
box-selection-enabled (reader method).
(setf box-selection-enabled) (writer method).
center (function).
classes (reader method).
(setf classes) (writer method).
context-menus (reader method).
(setf context-menus) (writer method).
cytoscape-widget (class).
data (reader method).
(setf data) (writer method).
desktop-tap-threshold (reader method).
(setf desktop-tap-threshold) (writer method).
element (class).
elements (reader method).
(setf elements) (writer method).
fit-elements (function).
grabbable (reader method).
(setf grabbable) (writer method).
grabbed (reader method).
(setf grabbed) (writer method).
graph-layouts (reader method).
(setf graph-layouts) (writer method).
graph-style (reader method).
(setf graph-style) (writer method).
group (reader method).
(setf group) (writer method).
headless (reader method).
(setf headless) (writer method).
hide-edges-on-viewport (reader method).
(setf hide-edges-on-viewport) (writer method).
layout (function).
locked (reader method).
(setf locked) (writer method).
make-cytoscape-widget (function).
make-element (function).
max-zoom (reader method).
(setf max-zoom) (writer method).
min-zoom (reader method).
(setf min-zoom) (writer method).
motion-blur (reader method).
(setf motion-blur) (writer method).
motion-blur-opacity (reader method).
(setf motion-blur-opacity) (writer method).
pan (reader method).
(setf pan) (writer method).
panning-enabled (reader method).
(setf panning-enabled) (writer method).
removed (reader method).
(setf removed) (writer method).
reset (function).
selectable (reader method).
(setf selectable) (writer method).
selected (reader method).
(setf selected) (writer method).
selection-type (reader method).
(setf selection-type) (writer method).
style-enabled (reader method).
(setf style-enabled) (writer method).
texture-on-viewport (reader method).
(setf texture-on-viewport) (writer method).
toggle-fullscreen (function).
touch-tap-threshold (reader method).
(setf touch-tap-threshold) (writer method).
user-panning-enabled (reader method).
(setf user-panning-enabled) (writer method).
user-zooming-enabled (reader method).
(setf user-zooming-enabled) (writer method).
wheel-sensitivity (reader method).
(setf wheel-sensitivity) (writer method).
zoom (reader method).
(setf zoom) (writer method).
zooming-enabled (reader method).
(setf zooming-enabled) (writer method).
%position (reader method).
(setf %position) (writer method).
Packages are listed by definition order.
cytoscapecommon-lisp.
%on-layout-stop (generic reader).
(setf %on-layout-stop) (generic writer).
active-fill-color (generic reader).
(setf active-fill-color) (generic writer).
active-padding (generic reader).
(setf active-padding) (generic writer).
add-graph (generic function).
add-unnecessary-bendpoints (generic reader).
(setf add-unnecessary-bendpoints) (generic writer).
alignment (generic reader).
(setf alignment) (generic writer).
all-const-iter (generic reader).
(setf all-const-iter) (generic writer).
animate (generic reader).
(setf animate) (generic writer).
animation-duration (generic reader).
(setf animation-duration) (generic writer).
animation-easing (generic reader).
(setf animation-easing) (generic writer).
aspect-ratio (generic reader).
(setf aspect-ratio) (generic writer).
at-mouse (generic reader).
(setf at-mouse) (generic writer).
auto-ungrabify (generic reader).
(setf auto-ungrabify) (generic writer).
auto-unselectify (generic reader).
(setf auto-unselectify) (generic writer).
autolock (generic reader).
(setf autolock) (generic writer).
avoid-overlap (generic reader).
(setf avoid-overlap) (generic writer).
avoid-overlap-padding (generic reader).
(setf avoid-overlap-padding) (generic writer).
border-spacing (generic reader).
(setf border-spacing) (generic writer).
bounding-box (generic reader).
(setf bounding-box) (generic writer).
box-selection-enabled (generic reader).
(setf box-selection-enabled) (generic writer).
breadth-first-layout (class).
center (function).
circle (generic reader).
(setf circle) (generic writer).
circle-layout (class).
classes (generic reader).
(setf classes) (generic writer).
clockwise (generic reader).
(setf clockwise) (generic writer).
cola-layout (class).
cols (generic reader).
(setf cols) (generic writer).
commands (generic reader).
(setf commands) (generic writer).
compact-components (generic reader).
(setf compact-components) (generic writer).
component-spacing (generic reader).
(setf component-spacing) (generic writer).
concentric-layout (class).
condense (generic reader).
(setf condense) (generic writer).
content (generic reader).
(setf content) (generic writer).
content-style (generic reader).
(setf content-style) (generic writer).
context-menu (class).
context-menus (generic reader).
(setf context-menus) (generic writer).
convergence-threshold (generic reader).
(setf convergence-threshold) (generic writer).
cooling-factor (generic reader).
(setf cooling-factor) (generic writer).
cose-layout (class).
crossing-minimization (generic reader).
(setf crossing-minimization) (generic writer).
cytoscape-widget (class).
dagre-layout (class).
data (generic reader).
(setf data) (generic writer).
desktop-tap-threshold (generic reader).
(setf desktop-tap-threshold) (generic writer).
directed (generic reader).
(setf directed) (generic writer).
direction (generic reader).
(setf direction) (generic writer).
edge-elasticity (generic reader).
(setf edge-elasticity) (generic writer).
edge-jaccard-length (generic reader).
(setf edge-jaccard-length) (generic writer).
edge-length (generic reader).
(setf edge-length) (generic writer).
edge-routing (generic reader).
(setf edge-routing) (generic writer).
edge-sep (generic reader).
(setf edge-sep) (generic writer).
edge-spacing-factor (generic reader).
(setf edge-spacing-factor) (generic writer).
edge-sym-diff-length (generic reader).
(setf edge-sym-diff-length) (generic writer).
edge-weight (generic reader).
(setf edge-weight) (generic writer).
element (class).
elements (generic reader).
(setf elements) (generic writer).
enabled (generic reader).
(setf enabled) (generic writer).
equidistant (generic reader).
(setf equidistant) (generic writer).
fcose-layout (class).
feedback-edges (generic reader).
(setf feedback-edges) (generic writer).
fill-color (generic reader).
(setf fill-color) (generic writer).
fit (generic reader).
(setf fit) (generic writer).
fit-elements (function).
fixed-alignment (generic reader).
(setf fixed-alignment) (generic writer).
flow (generic reader).
(setf flow) (generic writer).
gap-inequalities (generic reader).
(setf gap-inequalities) (generic writer).
grabbable (generic reader).
(setf grabbable) (generic writer).
grabbed (generic reader).
(setf grabbed) (generic writer).
graph-layout (class).
graph-layouts (generic reader).
(setf graph-layouts) (generic writer).
graph-style (generic reader).
(setf graph-style) (generic writer).
gravity (generic reader).
(setf gravity) (generic writer).
gravity-compound (generic reader).
(setf gravity-compound) (generic writer).
gravity-range (generic reader).
(setf gravity-range) (generic writer).
gravity-range-compound (generic reader).
(setf gravity-range-compound) (generic writer).
grid (generic reader).
(setf grid) (generic writer).
grid-layout (class).
group (generic reader).
(setf group) (generic writer).
handle-disconnected (generic reader).
(setf handle-disconnected) (generic writer).
headless (generic reader).
(setf headless) (generic writer).
hide-edges-on-viewport (generic reader).
(setf hide-edges-on-viewport) (generic writer).
ideal-edge-length (generic reader).
(setf ideal-edge-length) (generic writer).
in-layer-spacing-factor (generic reader).
(setf in-layer-spacing-factor) (generic writer).
indicator-size (generic reader).
(setf indicator-size) (generic writer).
initial-energy-on-incremental (generic reader).
(setf initial-energy-on-incremental) (generic writer).
initial-temp (generic reader).
(setf initial-temp) (generic writer).
item-color (generic reader).
(setf item-color) (generic writer).
item-text-shadow-color (generic reader).
(setf item-text-shadow-color) (generic writer).
klay-layout (class).
layout (function).
layout-hierarchy (generic reader).
(setf layout-hierarchy) (generic writer).
linear-segments-deflection-dampening (generic reader).
(setf linear-segments-deflection-dampening) (generic writer).
locked (generic reader).
(setf locked) (generic writer).
make-breadth-first-layout (function).
make-circle-layout (function).
make-cola-layout (function).
make-concentric-layout (function).
make-context-menu (function).
make-cose-layout (function).
make-cytoscape-widget (function).
make-dagre-layout (function).
make-element (function).
make-fcose-layout (function).
make-graph-layout (function).
make-grid-layout (function).
make-klay-layout (function).
make-menu-command (function).
make-null-layout (function).
make-preset-layout (function).
make-random-layout (function).
max-simulation-time (generic reader).
(setf max-simulation-time) (generic writer).
max-spotlight-radius (generic reader).
(setf max-spotlight-radius) (generic writer).
max-zoom (generic reader).
(setf max-zoom) (generic writer).
maximal (generic reader).
(setf maximal) (generic writer).
menu-command (class).
menu-radius (generic reader).
(setf menu-radius) (generic writer).
merge-edges (generic reader).
(setf merge-edges) (generic writer).
merge-hierarchy-crossing-edges (generic reader).
(setf merge-hierarchy-crossing-edges) (generic writer).
min-length (generic reader).
(setf min-length) (generic writer).
min-node-spacing (generic reader).
(setf min-node-spacing) (generic writer).
min-spotlight-radius (generic reader).
(setf min-spotlight-radius) (generic writer).
min-temp (generic reader).
(setf min-temp) (generic writer).
min-zoom (generic reader).
(setf min-zoom) (generic writer).
motion-blur (generic reader).
(setf motion-blur) (generic writer).
motion-blur-opacity (generic reader).
(setf motion-blur-opacity) (generic writer).
nesting-factor (generic reader).
(setf nesting-factor) (generic writer).
node-dimensions-include-labels (generic reader).
(setf node-dimensions-include-labels) (generic writer).
node-layering (generic reader).
(setf node-layering) (generic writer).
node-overlap (generic reader).
(setf node-overlap) (generic writer).
node-placement (generic reader).
(setf node-placement) (generic writer).
node-repulsion (generic reader).
(setf node-repulsion) (generic writer).
node-sep (generic reader).
(setf node-sep) (generic writer).
node-separation (generic reader).
(setf node-separation) (generic writer).
null-layout (class).
num-iter (generic reader).
(setf num-iter) (generic writer).
on-layout-stop (function).
on-menu-command-select (function).
pack-components (generic reader).
(setf pack-components) (generic writer).
padding (generic reader).
(setf padding) (generic writer).
pan (generic reader).
(setf pan) (generic writer).
panning-enabled (generic reader).
(setf panning-enabled) (generic writer).
pi-tol (generic reader).
(setf pi-tol) (generic writer).
preset-layout (class).
quality (generic reader).
(setf quality) (generic writer).
radius (generic reader).
(setf radius) (generic writer).
random-layout (class).
randomization-seed (generic reader).
(setf randomization-seed) (generic writer).
randomize (generic reader).
(setf randomize) (generic writer).
rank-dir (generic reader).
(setf rank-dir) (generic writer).
rank-sep (generic reader).
(setf rank-sep) (generic writer).
ranker (generic reader).
(setf ranker) (generic writer).
refresh (generic reader).
(setf refresh) (generic writer).
removed (generic reader).
(setf removed) (generic writer).
reset (function).
roots (generic reader).
(setf roots) (generic writer).
route-self-loop-inside (generic reader).
(setf route-self-loop-inside) (generic writer).
rows (generic reader).
(setf rows) (generic writer).
sample-size (generic reader).
(setf sample-size) (generic writer).
sampling-type (generic reader).
(setf sampling-type) (generic writer).
selectable (generic reader).
(setf selectable) (generic writer).
selected (generic reader).
(setf selected) (generic writer).
selection-type (generic reader).
(setf selection-type) (generic writer).
selector (generic reader).
(setf selector) (generic writer).
separate-connected-components (generic reader).
(setf separate-connected-components) (generic writer).
separator-width (generic reader).
(setf separator-width) (generic writer).
spacing (generic reader).
(setf spacing) (generic writer).
spacing-factor (generic reader).
(setf spacing-factor) (generic writer).
spotlight-padding (generic reader).
(setf spotlight-padding) (generic writer).
start-angle (generic reader).
(setf start-angle) (generic writer).
style-enabled (generic reader).
(setf style-enabled) (generic writer).
sweep (generic reader).
(setf sweep) (generic writer).
texture-on-viewport (generic reader).
(setf texture-on-viewport) (generic writer).
thoroughness (generic reader).
(setf thoroughness) (generic writer).
tile (generic reader).
(setf tile) (generic writer).
tile-padding-horizontal (generic reader).
(setf tile-padding-horizontal) (generic writer).
tile-padding-vertical (generic reader).
(setf tile-padding-vertical) (generic writer).
toggle-fullscreen (function).
touch-tap-threshold (generic reader).
(setf touch-tap-threshold) (generic writer).
unconst-iter (generic reader).
(setf unconst-iter) (generic writer).
ungrabify-while-simulating (generic reader).
(setf ungrabify-while-simulating) (generic writer).
uniform-node-dimensions (generic reader).
(setf uniform-node-dimensions) (generic writer).
user-const-iter (generic reader).
(setf user-const-iter) (generic writer).
user-panning-enabled (generic reader).
(setf user-panning-enabled) (generic writer).
user-zooming-enabled (generic reader).
(setf user-zooming-enabled) (generic writer).
wheel-sensitivity (generic reader).
(setf wheel-sensitivity) (generic writer).
z-index (generic reader).
(setf z-index) (generic writer).
zoom (generic reader).
(setf zoom) (generic writer).
zooming-enabled (generic reader).
(setf zooming-enabled) (generic writer).
%position (generic reader).
(setf %position) (generic writer).
+module-name+ (special variable).
+module-version+ (special variable).
animation-slots (class).
avoid-overlap-slot (class).
bounding-box-slot (class).
common-slots (class).
cycle-breakingcycle-breaking (generic reader).
(setf cycle-breakingcycle-breaking) (generic writer).
gravity-slot (class).
nesting-factor-slot (class).
node-dimensions-include-labels-slot (class).
num-iter-slot (class).
on-select (generic reader).
(setf on-select) (generic writer).
open-menu-events (generic reader).
(setf open-menu-events) (generic writer).
radial-slots (class).
randomize-slot (class).
refresh-slot (class).
spacing-factor-slot (class).
Definitions are sorted by export status, category, package, and then by lexicographic order.
graph-layout)) ¶automatically generated reader method
graph-layout)) ¶automatically generated writer method
context-menu)) ¶context-menu)) ¶the colour used to indicate the selected command
context-menu)) ¶context-menu)) ¶additional size in pixels for the active command
Add a graph to a cytoscape widget based on value type.
klay-layout)) ¶klay-layout)) ¶cola-layout)) ¶cola-layout)) ¶Relative alignment constraints on nodes. Can also be set per node via data.
cola-layout)) ¶cola-layout)) ¶Initial layout iterations with all constraints including non-overlap
common-slots)) ¶common-slots)) ¶Whether to animate changes to the layout
animation-slots)) ¶animation-slots)) ¶Duration of animation in ms, if enabled
animation-slots)) ¶animation-slots)) ¶Easing of animation, if enabled
klay-layout)) ¶klay-layout)) ¶context-menu)) ¶context-menu)) ¶draw menu at mouse position
cytoscape-widget)) ¶cytoscape-widget)) ¶Whether nodes should be ungrabified (not grabbable by user) by default (if true, overrides individual node state).
cytoscape-widget)) ¶cytoscape-widget)) ¶Whether nodes should be unselectified (immutable selection state) by default (if true, overrides individual element state).
cytoscape-widget)) ¶cytoscape-widget)) ¶Whether nodes should be locked (not draggable at all) by default (if true, overrides individual node state).
avoid-overlap-slot)) ¶avoid-overlap-slot)) ¶Prevents node overlap, may overflow boundingBox if not enough space
grid-layout)) ¶grid-layout)) ¶Extra spacing around nodes when avoidOverlap: true
klay-layout)) ¶klay-layout)) ¶bounding-box-slot)) ¶bounding-box-slot)) ¶constrain layout bounds; { x1, y1, x2, y2 } or { x1, y1, w, h }
cytoscape-widget)) ¶cytoscape-widget)) ¶Whether box selection (i.e. drag a box overlay around, and
release it to select) is enabled. If enabled while panning is also enabled,
the user must use a modifier key (shift, alt, control, or command) to use
box selection.
breadth-first-layout)) ¶breadth-first-layout)) ¶Put depths in concentric circles if true, put depths top down if false
radial-slots)) ¶radial-slots)) ¶Whether the layout should go clockwise (true) or counterclockwise/anticlockwise (false)
grid-layout)) ¶grid-layout)) ¶Force num of cols in the grid
cols.
context-menu)) ¶context-menu)) ¶an array of commands to list in the menu or a function that returns the array
klay-layout)) ¶klay-layout)) ¶cose-layout)) ¶cose-layout)) ¶Extra spacing between components in non-compound graphs
grid-layout)) ¶grid-layout)) ¶Uses all available space on false, uses minimal space on true
menu-command)) ¶menu-command)) ¶HTML/text content to be displayed in the menu.
menu-command)) ¶menu-command)) ¶css key:value pairs to set the command’s css in js if you want.
cola-layout)) ¶cola-layout)) ¶When the alpha value (system energy) falls below this value, the layout stops
cose-layout)) ¶cose-layout)) ¶Cooling factor (how the temperature is reduced between consecutive iterations
klay-layout)) ¶klay-layout)) ¶cytoscape-widget)) ¶cytoscape-widget)) ¶A non-negative integer that indicates the maximum allowable distance that a user may move during a tap gesture
breadth-first-layout)) ¶breadth-first-layout)) ¶Whether the tree is directed downwards (or edges can point in any direction if false)
klay-layout)) ¶klay-layout)) ¶UNDEFINED
fcose-layout)) ¶fcose-layout)) ¶Divisor to compute edge forces
cose-layout)) ¶cose-layout)) ¶Divisor to compute edge forces. Can also be set per edge via data.
cola-layout)) ¶cola-layout)) ¶Jaccard edge length in simulation. Can also be specified per edge via data.
cola-layout)) ¶cola-layout)) ¶Sets edge length directly in simulation. Can also be specified per edge via data.
klay-layout)) ¶klay-layout)) ¶dagre-layout)) ¶dagre-layout)) ¶the separation between adjacent edges in the same rank
klay-layout)) ¶klay-layout)) ¶cola-layout)) ¶cola-layout)) ¶Symmetric diff edge length in simulation. Can also be specified per edge via data.
dagre-layout)) ¶dagre-layout)) ¶Higher weight edges are generally made shorter and straighter than lower weight edges. Can also be set per edge via data.
cytoscape-widget)) ¶cytoscape-widget)) ¶The list of graph elements
menu-command)) ¶menu-command)) ¶Whether the command is selectable.
concentric-layout)) ¶concentric-layout)) ¶Whether levels have an equal radial distance betwen them, may cause bounding box overflow
klay-layout)) ¶klay-layout)) ¶context-menu)) ¶context-menu)) ¶the background colour of the menu
menu-command)) ¶menu-command)) ¶Custom background color for item.
common-slots)) ¶common-slots)) ¶Whether to fit the viewport to the graph
fit.
klay-layout)) ¶klay-layout)) ¶cola-layout)) ¶cola-layout)) ¶use DAG/tree flow layout if specified, e.g. { axis: ’y’, minSeparation: 30 }
flow.
cola-layout)) ¶cola-layout)) ¶list of inequality constraints for the gap between the nodes, e.g. [{"axis":"y", "left":node1, "right":node2, "gap":25}]
cytoscape-widget)) ¶cytoscape-widget)) ¶Layout algorithms
cytoscape-widget)) ¶cytoscape-widget)) ¶The stylesheet for the graph
gravity-slot)) ¶gravity-slot)) ¶Gravity force (constant)
fcose-layout)) ¶fcose-layout)) ¶Gravity force (constant) for compounds
fcose-layout)) ¶fcose-layout)) ¶Gravity range (constant)
fcose-layout)) ¶fcose-layout)) ¶Gravity range (constant) for compounds
breadth-first-layout)) ¶breadth-first-layout)) ¶Whether to create an even grid into which the DAG is placed (circle:false only)
grid.
cola-layout)) ¶cola-layout)) ¶if true, avoids disconnected components from overlapping
cytoscape-widget)) ¶cytoscape-widget)) ¶A convenience option that initialises the instance to run headlessly.
cytoscape-widget)) ¶cytoscape-widget)) ¶A rendering hint that when set to t makes the renderer
not render edges while the viewport is being manipulated. This makes panning,
zooming, dragging, et cetera more responsive for large graphs.
fcose-layout)) ¶fcose-layout)) ¶Ideal edge (non nested) length
cose-layout)) ¶cose-layout)) ¶Ideal edge (non nested) length. Can also be set per edge via data.
klay-layout)) ¶klay-layout)) ¶context-menu)) ¶context-menu)) ¶the size in pixels of the pointer to the active command
fcose-layout)) ¶fcose-layout)) ¶Initial cooling factor for incremental layout
cose-layout)) ¶cose-layout)) ¶Initial temperature (maximum node displacement)
context-menu)) ¶context-menu)) ¶the colour of text in the command’s content
context-menu)) ¶context-menu)) ¶the text shadow colour of the command’s content
klay-layout)) ¶klay-layout)) ¶klay-layout)) ¶klay-layout)) ¶cola-layout)) ¶cola-layout)) ¶max length in ms to run the layout
context-menu)) ¶context-menu)) ¶the maximum radius in pixels of the spotlight
cytoscape-widget)) ¶cytoscape-widget)) ¶A maximum bound on the zoom level of the graph. The viewport can not be scaled larger than this zoom level.
breadth-first-layout)) ¶breadth-first-layout)) ¶Whether to shift nodes down their natural BFS depths in order to avoid upwards edges (DAGS only)
klay-layout)) ¶klay-layout)) ¶klay-layout)) ¶klay-layout)) ¶dagre-layout)) ¶dagre-layout)) ¶Number of ranks to keep between the source and target of the edge. Can also be set per edge via data.
concentric-layout)) ¶concentric-layout)) ¶Min spacing between outside of nodes (used for radius adjustment)
context-menu)) ¶context-menu)) ¶the minimum radius in pixels of the spotlight
cose-layout)) ¶cose-layout)) ¶Lower temperature threshold (below this point the layout will end)
cytoscape-widget)) ¶cytoscape-widget)) ¶A minimum bound on the zoom level of the graph. The viewport can not be scaled smaller than this zoom level.
cytoscape-widget)) ¶cytoscape-widget)) ¶A rendering hint that when set to t makes the renderer
use a motion blur effect to make the transition between frames seem smoother.
cytoscape-widget)) ¶cytoscape-widget)) ¶When motionBlur: t, this value controls the opacity of motion blur frames.
nesting-factor-slot)) ¶nesting-factor-slot)) ¶Nesting factor (multiplier) to compute ideal edge length for nested edges
node-dimensions-include-labels-slot)) ¶node-dimensions-include-labels-slot)) ¶Includes the label when calculating node bounding boxes for the layout algorithm.
klay-layout)) ¶klay-layout)) ¶cose-layout)) ¶cose-layout)) ¶Node repulsion (overlapping) multiplier
klay-layout)) ¶klay-layout)) ¶fcose-layout)) ¶fcose-layout)) ¶Node repulsion (non overlapping) multiplier
cose-layout)) ¶cose-layout)) ¶Node repulsion (non overlapping) multiplier. Can also be set per node in data.
dagre-layout)) ¶dagre-layout)) ¶the separation between adjacent nodes in the same rank
fcose-layout)) ¶fcose-layout)) ¶Separation amount between nodes
num-iter-slot)) ¶num-iter-slot)) ¶Maximum number of iterations to perform
fcose-layout)) ¶fcose-layout)) ¶Whether to pack disconnected components - valid only if randomize: true
common-slots)) ¶common-slots)) ¶Padding to leave between graph and viewport
cytoscape-widget)) ¶cytoscape-widget)) ¶Pan location of the graph.
pan.
preset-layout)) ¶preset-layout)) ¶The pan level to set (prob want fit = false if set)
pan.
cytoscape-widget)) ¶cytoscape-widget)) ¶Whether panning the graph is enabled, both by user events sand programmatically.
fcose-layout)) ¶fcose-layout)) ¶Power iteration tolerance
fcose-layout)) ¶fcose-layout)) ¶Layout quality
circle-layout)) ¶circle-layout)) ¶The radius of the circle
klay-layout)) ¶klay-layout)) ¶randomize-slot)) ¶randomize-slot)) ¶Use random node positions at beginning of layout
dagre-layout)) ¶dagre-layout)) ¶’TB’ for top to bottom flow, ’LR’ for left to right,
dagre-layout)) ¶dagre-layout)) ¶the separation between each rank in the layout
dagre-layout)) ¶dagre-layout)) ¶Type of algorithm to assign a rank to each node in the input graph. Possible values: ’network-simplex’, ’tight-tree’ or ’longest-path’
refresh-slot)) ¶refresh-slot)) ¶Number of ticks per frame; higher is faster but more jerky
breadth-first-layout)) ¶breadth-first-layout)) ¶The roots of the trees
klay-layout)) ¶klay-layout)) ¶grid-layout)) ¶grid-layout)) ¶Force num of rows in the grid
rows.
fcose-layout)) ¶fcose-layout)) ¶Sample size to construct distance matrix
fcose-layout)) ¶fcose-layout)) ¶False for random, true for greedy sampling
cytoscape-widget)) ¶cytoscape-widget)) ¶A string indicating the selection behaviour from user input.
For ’additive’, a new selection made by the user adds to the set of
currently selected elements. For ’single’, a new selection made by the user
becomes the entire set of currently selected elements (i.e. the previous
elements are unselected).
graph-layout)) ¶graph-layout)) ¶Elements that the layout applies to.
context-menu)) ¶context-menu)) ¶Elements matching this Cytoscape.js selector will trigger this menu
klay-layout)) ¶klay-layout)) ¶context-menu)) ¶context-menu)) ¶the empty spacing in pixels between successive commands
klay-layout)) ¶klay-layout)) ¶spacing-factor-slot)) ¶spacing-factor-slot)) ¶Applies a multiplicative factor (>0) to expand or compress the overall area that the nodes take up
context-menu)) ¶context-menu)) ¶extra spacing in pixels between the element and the spotlight
radial-slots)) ¶radial-slots)) ¶Where nodes start in radians
cytoscape-widget)) ¶cytoscape-widget)) ¶A 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.
radial-slots)) ¶radial-slots)) ¶How many radians should be between the first and last node (defaults to full circle)
cytoscape-widget)) ¶cytoscape-widget)) ¶A rendering hint that when set to true makes the
renderer use a texture during panning and zooming instead of
drawing the elements, making large graphs more responsive.
klay-layout)) ¶klay-layout)) ¶fcose-layout)) ¶fcose-layout)) ¶For enabling tiling
tile.
fcose-layout)) ¶fcose-layout)) ¶Represents the amount of the horizontal space to put between the zero degree members during the tiling operation(can also be a function)
fcose-layout)) ¶fcose-layout)) ¶Represents the amount of the vertical space to put between the zero degree members during the tiling operation(can also be a function)
cytoscape-widget)) ¶cytoscape-widget)) ¶A non-negative integer that indicates the maximum allowable distance that a user may move during a tap gesture
cola-layout)) ¶cola-layout)) ¶unconstrained initial layout iterations
cola-layout)) ¶cola-layout)) ¶So you can’t drag nodes during layout
fcose-layout)) ¶fcose-layout)) ¶Whether or not simple nodes (non-compound nodes) are of uniform dimensions
cola-layout)) ¶cola-layout)) ¶initial layout iterations with user-specified constraints
cytoscape-widget)) ¶cytoscape-widget)) ¶Whether user events (e.g. dragging the graph background) are
allowed to pan the graph. Programmatic changes to pan are unaffected by
this option.
cytoscape-widget)) ¶cytoscape-widget)) ¶Whether user events (e.g. mouse wheel, pinch-to-zoom) are
allowed to zoom the graph. Programmatic changes to zoom are unaffected
by this option.
cytoscape-widget)) ¶cytoscape-widget)) ¶Changes 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).
context-menu)) ¶context-menu)) ¶the z-index of the ui div
cytoscape-widget)) ¶cytoscape-widget)) ¶Zoom level of the graph.
zoom.
preset-layout)) ¶preset-layout)) ¶The zoom level to set (prob want fit = false if set)
zoom.
cytoscape-widget)) ¶cytoscape-widget)) ¶Whether zooming the graph is enabled, both by user events and programmatically.
graph-layout) content buffers) ¶jupyter/widgets.
menu-command) content buffers) ¶jupyter/widgets.
Breadth first graph layout algorithm.
| Initarg | Value |
|---|---|
:%model-name | breadthfirstlayoutmodel |
:%view-name | breadthfirstlayoutview |
Put depths in concentric circles if true, put depths top down if false
:circle
Whether the tree is directed downwards (or edges can point in any direction if false)
:directed
Whether to create an even grid into which the DAG is placed (circle:false only)
:grid
grid.
Whether to shift nodes down their natural BFS depths in order to avoid upwards edges (DAGS only)
:maximal
The roots of the trees
:null
:roots
Circle graph layout algorithm.
| Initarg | Value |
|---|---|
:%model-name | circlelayoutmodel |
:%view-name | circlelayoutview |
The radius of the circle
:null
:radius
Cola graph layout algorithm.
(setf alignment).
alignment.
(setf all-const-iter).
all-const-iter.
(setf convergence-threshold).
convergence-threshold.
(setf edge-jaccard-length).
edge-jaccard-length.
(setf edge-length).
edge-length.
(setf edge-sym-diff-length).
edge-sym-diff-length.
(setf flow).
flow.
(setf gap-inequalities).
gap-inequalities.
(setf handle-disconnected).
handle-disconnected.
(setf max-simulation-time).
max-simulation-time.
(setf unconst-iter).
unconst-iter.
(setf ungrabify-while-simulating).
ungrabify-while-simulating.
(setf user-const-iter).
user-const-iter.
| Initarg | Value |
|---|---|
:%model-name | colalayoutmodel |
:%view-name | colalayoutview |
Relative alignment constraints on nodes. Can also be set per node via data.
:null
:alignment
Initial layout iterations with all constraints including non-overlap
:null
:all-const-iter
When the alpha value (system energy) falls below this value, the layout stops
0.01d0
:convergence-threshold
Jaccard edge length in simulation. Can also be specified per edge via data.
:null
:edge-jaccard-length
Sets edge length directly in simulation. Can also be specified per edge via data.
:null
:edge-length
Symmetric diff edge length in simulation. Can also be specified per edge via data.
:null
:edge-sym-diff-length
use DAG/tree flow layout if specified, e.g. { axis: ’y’, minSeparation: 30 }
:null
:flow
flow.
list of inequality constraints for the gap between the nodes, e.g. [{"axis":"y", "left":node1, "right":node2, "gap":25}]
:null
:gap-inequalities
if true, avoids disconnected components from overlapping
:handle-disconnected
max length in ms to run the layout
4000
:max-simulation-time
unconstrained initial layout iterations
:null
:unconst-iter
So you can’t drag nodes during layout
:ungrabify-while-simulating
initial layout iterations with user-specified constraints
:null
:user-const-iter
Concentric graph layout algorithm.
| Initarg | Value |
|---|---|
:%model-name | concentriclayoutmodel |
:%view-name | concentriclayoutview |
Whether levels have an equal radial distance betwen them, may cause bounding box overflow
:equidistant
Min spacing between outside of nodes (used for radius adjustment)
10
:min-node-spacing
Context menu for cytoscape.
widget.
(setf active-fill-color).
active-fill-color.
(setf active-padding).
active-padding.
(setf at-mouse).
at-mouse.
(setf commands).
commands.
(setf fill-color).
fill-color.
(setf indicator-size).
indicator-size.
(setf item-color).
item-color.
(setf item-text-shadow-color).
item-text-shadow-color.
(setf max-spotlight-radius).
max-spotlight-radius.
(setf menu-radius).
menu-radius.
(setf min-spotlight-radius).
min-spotlight-radius.
(setf open-menu-events).
open-menu-events.
(setf selector).
selector.
(setf separator-width).
separator-width.
(setf spotlight-padding).
spotlight-padding.
(setf z-index).
z-index.
| Initarg | Value |
|---|---|
:%model-name | contextmenumodel |
:%model-module | +module-name+ |
:%model-module-version | +module-version+ |
:%view-name | contextmenuview |
:%view-module | +module-name+ |
:%view-module-version | +module-version+ |
Elements matching this Cytoscape.js selector will trigger this menu
"node"
:selector
an array of commands to list in the menu or a function that returns the array
:commands
the background colour of the menu
"rgba(0, 0, 0, 0.75)"
:fill-color
the colour used to indicate the selected command
"rgba(1, 105, 217, 0.75)"
:active-fill-color
additional size in pixels for the active command
20
:active-padding
the size in pixels of the pointer to the active command
24
:indicator-size
the empty spacing in pixels between successive commands
3
:separator-width
extra spacing in pixels between the element and the spotlight
4
:spotlight-padding
the minimum radius in pixels of the spotlight
24
:min-spotlight-radius
the maximum radius in pixels of the spotlight
38
:max-spotlight-radius
space-separated cytoscape events that will open the menu; only ‘cxttapstart‘ and/or ‘taphold‘ work here
"cxttapstart taphold"
:open-menu-events
the colour of text in the command’s content
"white"
:item-color
the text shadow colour of the command’s content
"transparent"
:item-text-shadow-color
the z-index of the ui div
9999
:z-index
draw menu at mouse position
:at-mouse
Cose graph layout algorithm.
(setf component-spacing).
component-spacing.
(setf cooling-factor).
cooling-factor.
(setf edge-elasticity).
edge-elasticity.
(setf ideal-edge-length).
ideal-edge-length.
(setf initial-temp).
initial-temp.
(setf min-temp).
min-temp.
(setf node-overlap).
node-overlap.
(setf node-repulsion).
node-repulsion.
| Initarg | Value |
|---|---|
:%model-name | coselayoutmodel |
:%view-name | coselayoutview |
:refresh | 10 |
Extra spacing between components in non-compound graphs
40
:component-spacing
Cooling factor (how the temperature is reduced between consecutive iterations
0.99d0
:cooling-factor
Divisor to compute edge forces. Can also be set per edge via data.
32
:edge-elasticity
Ideal edge (non nested) length. Can also be set per edge via data.
32
:ideal-edge-length
Initial temperature (maximum node displacement)
1000.0d0
:initial-temp
Lower temperature threshold (below this point the layout will end)
1.0d0
:min-temp
Node repulsion (overlapping) multiplier
4
:node-overlap
Node repulsion (non overlapping) multiplier. Can also be set per node in data.
2048
:node-repulsion
Cytoscape graph widget.
dom-widget.
(setf auto-ungrabify).
auto-ungrabify.
(setf auto-unselectify).
auto-unselectify.
(setf autolock).
autolock.
(setf box-selection-enabled).
box-selection-enabled.
(setf context-menus).
context-menus.
(setf desktop-tap-threshold).
desktop-tap-threshold.
(setf elements).
elements.
(setf graph-layouts).
graph-layouts.
(setf graph-style).
graph-style.
(setf headless).
headless.
(setf hide-edges-on-viewport).
hide-edges-on-viewport.
(setf max-zoom).
max-zoom.
(setf min-zoom).
min-zoom.
(setf motion-blur).
motion-blur.
(setf motion-blur-opacity).
motion-blur-opacity.
(setf pan).
pan.
(setf panning-enabled).
panning-enabled.
(setf selection-type).
selection-type.
(setf style-enabled).
style-enabled.
(setf texture-on-viewport).
texture-on-viewport.
(setf touch-tap-threshold).
touch-tap-threshold.
(setf user-panning-enabled).
user-panning-enabled.
(setf user-zooming-enabled).
user-zooming-enabled.
(setf wheel-sensitivity).
wheel-sensitivity.
(setf zoom).
zoom.
(setf zooming-enabled).
zooming-enabled.
| Initarg | Value |
|---|---|
:%model-name | cytoscapemodel |
:%model-module | +module-name+ |
:%model-module-version | +module-version+ |
:%view-name | cytoscapeview |
:%view-module | +module-name+ |
:%view-module-version | +module-version+ |
A minimum bound on the zoom level of the graph. The viewport can not be scaled smaller than this zoom level.
1.0d-50
:min-zoom
A maximum bound on the zoom level of the graph. The viewport can not be scaled larger than this zoom level.
1.0d50
:max-zoom
Whether zooming the graph is enabled, both by user events and programmatically.
t
:zooming-enabled
Whether user events (e.g. mouse wheel, pinch-to-zoom) are
allowed to zoom the graph. Programmatic changes to zoom are unaffected
by this option.
t
:user-zooming-enabled
Whether panning the graph is enabled, both by user events sand programmatically.
t
:panning-enabled
Whether user events (e.g. dragging the graph background) are
allowed to pan the graph. Programmatic changes to pan are unaffected by
this option.
t
:user-panning-enabled
Whether box selection (i.e. drag a box overlay around, and
release it to select) is enabled. If enabled while panning is also enabled,
the user must use a modifier key (shift, alt, control, or command) to use
box selection.
t
:box-selection-enabled
A string indicating the selection behaviour from user input.
For ’additive’, a new selection made by the user adds to the set of
currently selected elements. For ’single’, a new selection made by the user
becomes the entire set of currently selected elements (i.e. the previous
elements are unselected).
"single"
:selection-type
A non-negative integer that indicates the maximum allowable distance that a user may move during a tap gesture
8
:touch-tap-threshold
A non-negative integer that indicates the maximum allowable distance that a user may move during a tap gesture
4
:desktop-tap-threshold
Whether nodes should be locked (not draggable at all) by default (if true, overrides individual node state).
:autolock
Whether nodes should be ungrabified (not grabbable by user) by default (if true, overrides individual node state).
:auto-ungrabify
Whether nodes should be unselectified (immutable selection state) by default (if true, overrides individual element state).
:auto-unselectify
A convenience option that initialises the instance to run headlessly.
:headless
A 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.
t
:style-enabled
A rendering hint that when set to t makes the renderer
not render edges while the viewport is being manipulated. This makes panning,
zooming, dragging, et cetera more responsive for large graphs.
:hide-edges-on-viewport
A rendering hint that when set to true makes the
renderer use a texture during panning and zooming instead of
drawing the elements, making large graphs more responsive.
:texture-on-viewport
A rendering hint that when set to t makes the renderer
use a motion blur effect to make the transition between frames seem smoother.
:motion-blur
When motionBlur: t, this value controls the opacity of motion blur frames.
0.2
:motion-blur-opacity
Changes 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).
1.0
:wheel-sensitivity
Layout algorithms
:graph-layouts
The stylesheet for the graph
:graph-style
Pan location of the graph.
(list (cons "x" 0) (cons "y" 0))
:pan
pan.
The list of graph elements
:elements
Dagre graph layout algorithm.
| Initarg | Value |
|---|---|
:%model-name | dagrelayoutmodel |
:%view-name | dagrelayoutview |
the separation between adjacent edges in the same rank
:null
:edge-sep
Higher weight edges are generally made shorter and straighter than lower weight edges. Can also be set per edge via data.
1
:edge-weight
Number of ranks to keep between the source and target of the edge. Can also be set per edge via data.
1
:min-length
the separation between adjacent nodes in the same rank
:null
:node-sep
’TB’ for top to bottom flow, ’LR’ for left to right,
:null
:rank-dir
Type of algorithm to assign a rank to each node in the input graph. Possible values: ’network-simplex’, ’tight-tree’ or ’longest-path’
:null
:ranker
the separation between each rank in the layout
:null
:rank-sep
A node or an edge in a graph.
widget.
| Initarg | Value |
|---|---|
:%model-name | elementmodel |
:%model-module | +module-name+ |
:%model-module-version | +module-version+ |
:%view-name | elementview |
:%view-module | +module-name+ |
:%view-module-version | +module-version+ |
Element type. Must be either nodes or edges.
"nodes"
:group
T if the element has been removed from the graph.
:removed
Whether the element is selected in the graph.
:selected
T if the element can be selected.
t
:selectable
T if the element will not be moved during a layout.
:locked
T if if the element is currently grabbed.
:grabbed
T if the element can be grabbed.
t
:grabbable
A list of CSS classes
:classes
The position of the element.
common-lisp.
:position
fCoSE graph layout algorithm.
(setf edge-elasticity).
edge-elasticity.
(setf gravity-compound).
gravity-compound.
(setf gravity-range).
gravity-range.
(setf gravity-range-compound).
gravity-range-compound.
(setf ideal-edge-length).
ideal-edge-length.
(setf initial-energy-on-incremental).
initial-energy-on-incremental.
(setf node-repulsion).
node-repulsion.
(setf node-separation).
node-separation.
(setf pack-components).
pack-components.
(setf pi-tol).
pi-tol.
(setf quality).
quality.
(setf sample-size).
sample-size.
(setf sampling-type).
sampling-type.
(setf tile).
tile.
(setf tile-padding-horizontal).
tile-padding-horizontal.
(setf tile-padding-vertical).
tile-padding-vertical.
(setf uniform-node-dimensions).
uniform-node-dimensions.
| Initarg | Value |
|---|---|
:%model-name | fcose_layoutmodel |
:%view-name | fcose_layoutview |
:nesting-factor | 0.1d0 |
:num-iter | 2500 |
:gravity | 0.25d0 |
:randomize | t |
Layout quality
"default"
:quality
Whether or not simple nodes (non-compound nodes) are of uniform dimensions
:uniform-node-dimensions
Whether to pack disconnected components - valid only if randomize: true
t
:pack-components
False for random, true for greedy sampling
t
:sampling-type
Sample size to construct distance matrix
25
:sample-size
Separation amount between nodes
75
:node-separation
Power iteration tolerance
1.0e-7
:pi-tol
Node repulsion (non overlapping) multiplier
4500
:node-repulsion
Ideal edge (non nested) length
50
:ideal-edge-length
Divisor to compute edge forces
0.45
:edge-elasticity
Represents the amount of the vertical space to put between the zero degree members during the tiling operation(can also be a function)
10
:tile-padding-vertical
Represents the amount of the horizontal space to put between the zero degree members during the tiling operation(can also be a function)
10
:tile-padding-horizontal
Gravity range (constant) for compounds
1.5d0
:gravity-range-compound
Gravity range (constant)
3.8d0
:gravity-range
Gravity force (constant) for compounds
1.0d0
:gravity-compound
Initial cooling factor for incremental layout
0.3d0
:initial-energy-on-incremental
Graph layout algorithm.
widget.
| Initarg | Value |
|---|---|
:%model-name | graphlayoutmodel |
:%model-module | +module-name+ |
:%model-module-version | +module-version+ |
:%view-name | graphlayoutview |
:%view-module | +module-name+ |
:%view-module-version | +module-version+ |
Elements that the layout applies to.
"*"
:selector
:on-layout-stop
Grid graph layout algorithm.
| Initarg | Value |
|---|---|
:%model-name | gridlayoutmodel |
:%view-name | gridlayoutview |
Extra spacing around nodes when avoidOverlap: true
10
:avoid-overlap-padding
Uses all available space on false, uses minimal space on true
:condense
Klay graph layout algorithm.
(setf add-unnecessary-bendpoints).
add-unnecessary-bendpoints.
(setf aspect-ratio).
aspect-ratio.
(setf border-spacing).
border-spacing.
(setf compact-components).
compact-components.
(setf crossing-minimization).
crossing-minimization.
(setf cycle-breakingcycle-breaking).
cycle-breakingcycle-breaking.
(setf direction).
direction.
(setf edge-routing).
edge-routing.
(setf edge-spacing-factor).
edge-spacing-factor.
(setf feedback-edges).
feedback-edges.
(setf fixed-alignment).
fixed-alignment.
(setf in-layer-spacing-factor).
in-layer-spacing-factor.
(setf layout-hierarchy).
layout-hierarchy.
(setf linear-segments-deflection-dampening).
linear-segments-deflection-dampening.
(setf merge-edges).
merge-edges.
(setf merge-hierarchy-crossing-edges).
merge-hierarchy-crossing-edges.
(setf node-layering).
node-layering.
(setf node-placement).
node-placement.
(setf randomization-seed).
randomization-seed.
(setf route-self-loop-inside).
route-self-loop-inside.
(setf separate-connected-components).
separate-connected-components.
(setf spacing).
spacing.
(setf thoroughness).
thoroughness.
| Initarg | Value |
|---|---|
:%model-name | klaylayoutmodel |
:%view-name | klaylayoutview |
:add-unnecessary-bendpoints
1.6
:aspect-ratio
20
:border-spacing
:compact-components
"layer_sweep"
:crossing-minimization
"greedy"
:cycle-breaking
UNDEFINED
20
:direction
"orthogonal"
:edge-routing
0.5
:edge-spacing-factor
:feedback-edges
"none"
:fixed-alignment
1.0
:in-layer-spacing-factor
:layout-hierarchy
0.3
:linear-segments-deflection-dampening
:merge-edges
t
:merge-hierarchy-crossing-edges
"network_simplex"
:node-layering
"brandes_koepf"
:node-placement
1
:randomization-seed
:route-self-loop-inside
t
:separate-connected-components
20
:spacing
7
:thoroughness
Menu commands and selection handlers for context menus.
widget.
| Initarg | Value |
|---|---|
:%model-name | menucommandmodel |
:%model-module | +module-name+ |
:%model-module-version | +module-version+ |
:%view-name | menucommandview |
:%view-module | +module-name+ |
:%view-module-version | +module-version+ |
Custom background color for item.
:fill-color
HTML/text content to be displayed in the menu.
""
:content
css key:value pairs to set the command’s css in js if you want.
:content-style
Whether the command is selectable.
t
:enabled
Selection handlers
:on-select
Null graph layout algorithm.
| Initarg | Value |
|---|---|
:%model-name | nulllayoutmodel |
:%view-name | nulllayoutview |
Preset graph layout algorithm.
(setf pan).
pan.
(setf zoom).
zoom.
| Initarg | Value |
|---|---|
:%model-name | presetlayoutmodel |
:%view-name | presetlayoutview |
The pan level to set (prob want fit = false if set)
:null
:pan
pan.
Random graph layout algorithm.
| Initarg | Value |
|---|---|
:%model-name | randomlayoutmodel |
:%view-name | randomlayoutview |
klay-layout)) ¶klay-layout)) ¶menu-command)) ¶menu-command)) ¶Selection handlers
Duration of animation in ms, if enabled
250
:animation-duration
Easing of animation, if enabled
:null
:animation-easing
Prevents node overlap, may overflow boundingBox if not enough space
t
:avoid-overlap
constrain layout bounds; { x1, y1, x2, y2 } or { x1, y1, w, h }
:null
:bounding-box
Whether to animate changes to the layout
t
:animate
Padding to leave between graph and viewport
30
:padding
Gravity force (constant)
1
:gravity
Nesting factor (multiplier) to compute ideal edge length for nested edges
1.2d0
:nesting-factor
Includes the label when calculating node bounding boxes for the layout algorithm.
:node-dimensions-include-labels
Maximum number of iterations to perform
1000
:num-iter
Whether the layout should go clockwise (true) or counterclockwise/anticlockwise (false)
t
:clockwise
Where nodes start in radians
(* 3/2 pi)
:start-angle
How many radians should be between the first and last node (defaults to full circle)
:null
:sweep
Use random node positions at beginning of layout
:randomize
Number of ticks per frame; higher is faster but more jerky
1
:refresh
Applies a multiplicative factor (>0) to expand or compress the overall area that the nodes take up
:null
:spacing-factor
| Jump to: | %
(
A B C D E F G H I L M N O P Q R S T U W Z |
|---|