Skip to content
Open Garphield

Garphield workspace tour

The canvas sits between the visual controls and the workspace panes.

Garphield workspace with a network on the canvas
  1. Top strip
  2. Visual controls
  3. Canvas
  4. Selection toolbar
  5. Workspace panes
  6. Minimap
The Garphield workspace. Open the image for a full-size view.
  • File: Open data, load a sample, save a project, or export.
  • Undo and redo: Move through recent changes.
  • Table: Toggle the node and link tables.
  • Layout: Choose Force, Levels, or a detected coordinate layout. Geo uses a map when the fields look geographic; other coordinates use the normal canvas.
  • Labels: Toggle node labels.
  • Search: Find a node or press / to focus the field.

Levels arranges a graph in rows. Directed graphs follow edge direction where possible; cycles require some upward edges. Automatic mode compares layered placements for crossings, edges through nodes, and spacing after fitting the canvas.

Select one or more nodes, then click Levels to use them as roots. Every root starts on the top row. Rows follow shortest graph distance, ignoring edge direction; disconnected components get their own automatic roots. Clicking Levels with no selection returns to automatic layout.

Root IDs are saved in shared views and projects. Loading another dataset clears them. Changing selection does not rearrange the graph until you click Levels again. Levels appears directly, without the Force layout animation.

The command API also accepts explicit IDs:

window.garphield.run("layout.levels", { roots: '["a","b"]' });
const result = await window.garphield.run("layout.wait");
if (!result.ok) throw new Error(result.error.message);

Use { levelAttribute: "stage" } to choose a property, { selectionAsRoots: true } to use the current selection, or {} to return to automatic layout. Await layout.wait after each request before reading positions or exporting an image.

When both options are supplied, explicit property values take precedence over root distances. Larger graphs use a bounded layout to keep interaction responsive.

Coordinate layout is available only when the graph has a usable field pair. Garphield recognizes latitude/longitude names and formats, as well as original X/Y fields. Geographic evidence determines whether the layout uses a basemap; ambiguous X/Y pairs start on the plain canvas with a Use geographic map option.

A unique pair is selected automatically. If several pairs are compatible, choose the fields and click Apply. Nodes without usable coordinates are omitted from that layout along with their incident edges; the controls report how many nodes were placed. Imported coordinates remain available after running Force or Levels and when saving a project.

  • Viz: Add graph fields, algorithms, transforms, filters, and visual bindings.
  • Style: Set the base appearance of nodes, links, labels, and the canvas. Choose Flat for the original fill, Lumen for soft relief, Sphere for complete balls, Prism for facets, or Sketchy for a hand-drawn double contour.
  • Audit: Review graph statistics, layout measures, and accessibility checks.

Click Browser to find a source to drag, or click the pluses for any visual channel.

Pan by dragging, zoom with a scroll wheel or touchpad. Any nodes that are dragged are persisted in the app.

  • Pointer (V): Select and drag nodes.
  • Marquee (M): Drag a rectangular selection.
  • Lasso (L): Draw around nodes to select them.
  • Path target (T): Choose the other end of a path.
  • Fit: Fit the network to the canvas.
  • Grow: Add neighbouring nodes to the selection.
  • Shrink: Remove the selection boundary.
  • Invert: Select everything outside the selection.
  • Annotate: Add a note to the selected set.

The minimap shows the full network and the current camera area. Open Groups for a summary of communities or other computed groups.

Toggle the table using the button in the top right. There are tabs for nodes and links. Click the headers to sort. Node and link details can be changed inline.

Garphield workspace with the node table open
  1. Node and link tabs
  2. Sortable headers
The node table below the canvas.

Save a selection as a named set. Sets can be selected again, used as a filter, or assigned to a visual channel.

Audit collects graph summaries, drawing measures, and accessibility findings. Use it to check the network before you present or export it.

Story saves an ordered sequence of views. Each step can retain its camera, selection, annotations, and presentation state.

History records graph edits, visual changes, filters, sets, and story changes. Select an earlier entry to return to that state.

Garphield includes Light, Graphite, and Seafoam. Choose File → Theme to switch between them.

Seafoam takes its cue from industrial control rooms: a light mint-green canvas, solid green panels, and deep green lettering. Consistent outlines separate the controls, while full-width underlines identify active sidebar tabs and flat green fills mark selected tools. Search uses a lighter green field with dark text, and sidebar charts sit directly on their cards. Yellow warnings and red danger states keep their existing meanings. The documentation uses the same palette; use its theme button to cycle through the three themes.

The Garphield workspace in Light, Graphite, and Seafoam themes
Light, Graphite, and Seafoam use the same workspace controls.