Skip to content

Where would you like to start?

↑ ↓ to move · Enter to open · Esc to close

JobClient.visualize

def JobClient.visualize(
  job: Job | UUID | str,
  direction: str = "down",
  layout: str = "dagre",
  sketchy: bool = True
) -> str

Create a visualization of a job as a diagram.

Parameters

Section titled “Parameters”
job Job | UUID | str

The job, job ID, or job ID string to visualize.

direction str

The direction for the diagram to flow. For more details, see the relevant section in the D2 documentation. Valid values are up, down, right, and left. The default value is down.

layout str

The layout engine for the diagram. For further information, refer to the D2 layout engines. Valid values are dagre and elk, with the default being dagre.

sketchy bool

Indicates whether to use a sketchy, hand-drawn style for the diagram. The default is True.

Returns

Section titled “Returns”

Rendered SVG markup for the job diagram.