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

Create a visualization of a job as a diagram.

If you are working in an interactive environment, such as Jupyter notebooks, you can use the display method to display the visualized job diagram directly in the notebook.

​
Parameters

​
job_or_id
Job | str

The job 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.

Was this page helpful?

JobClient.cancel