Liking cljdoc? Tell your friends :D

knitty.traceviz

Provides functions for visualizing yarn execution traces.

Provides functions for visualizing yarn execution traces.
raw docstring

*options*clj

Default options for trace visualization.

  • :format - Output format (:auto, :raw, :edn, :dot, :xdot, :svg, :png, etc.)
  • :dpi - Rendering DPI.
  • :width - Maximum width (in characters) for printed node labels.
  • :lines - Maximum number of lines printed for each label.
  • :pp-max-len - Maximum number of items to print in sequences.
  • :pp-max-level - Maximum depth for pretty-printing nested collections.
  • :clusters - Boolean indicating whether to group nodes in clusters.
  • :concentrate - Boolean to merge/concentrate graph edges.
  • :hspace - Horizontal spacing for graph layout.
  • :vspace - Vertical spacing for graph layout.
  • :show-unused - Boolean indicating whether to show unused nodes.
Default options for trace visualization.

- :format       - Output format (:auto, :raw, :edn, :dot, :xdot, :svg, :png, etc.)
- :dpi          - Rendering DPI.
- :width        - Maximum width (in characters) for printed node labels.
- :lines        - Maximum number of lines printed for each label.
- :pp-max-len   - Maximum number of items to print in sequences.
- :pp-max-level - Maximum depth for pretty-printing nested collections.
- :clusters     - Boolean indicating whether to group nodes in clusters.
- :concentrate  - Boolean to merge/concentrate graph edges.
- :hspace       - Horizontal spacing for graph layout.
- :vspace       - Vertical spacing for graph layout.
- :show-unused  - Boolean indicating whether to show unused nodes.
sourceraw docstring

graphviz-availableclj

A delayed flag indicating whether Graphviz (dot) is available on the system.

A delayed flag indicating whether Graphviz (dot) is available on the system.
sourceraw docstring

p3-roundclj

(p3-round x)
source

render-traceclj

(render-trace yank-result-or-trace & {:as options})

Renders the provided trace data into a visual representation.

Supports multiple output formats based on the :format option in options:

  • :raw - the parsed trace data as is.
  • :edn - returns an EDN-formatted string of the parsed trace.
  • :dot - returns the trace graph in Graphviz dot format.
  • :xdot - returns the dot format with xdot-specific escapes fixed.
  • :svg, :png, etc. - returns an image rendered from the trace graph.

Additional options can be provided to override options.

Renders the provided trace data into a visual representation.

Supports multiple output formats based on the :format option in *options*:
- :raw   - the parsed trace data as is.
- :edn   - returns an EDN-formatted string of the parsed trace.
- :dot   - returns the trace graph in Graphviz dot format.
- :xdot  - returns the dot format with xdot-specific escapes fixed.
- :svg, :png, etc. - returns an image rendered from the trace graph.

Additional options can be provided to override *options*.
sourceraw docstring

view-traceclj

(view-trace yank-result-or-trace & {:as options})

Opens a visual representation of the trace data using an external viewer.

Based on the specified :format, the function works as follows:

  • If the format is :xdot (or :auto with xdot available), it renders the trace in xdot format and opens it using xdot.
  • If an image format (e.g. :svg, :png, etc.) is specified it renders the trace and opens it using the default browser.
  • If the format is :edn or :raw, it renders the trace in EDN format and opens it with the default viewer.
Opens a visual representation of the trace data using an external viewer.

Based on the specified :format, the function works as follows:
- If the format is :xdot (or :auto with xdot available), it renders the trace in xdot format and opens it using xdot.
- If an image format (e.g. :svg, :png, etc.) is specified it renders the trace and opens it using the default browser.
- If the format is :edn or :raw, it renders the trace in EDN format and opens it with the default viewer.
sourceraw docstring

xdot-availableclj

A delayed flag indicating whether xdot is available on the system.

A delayed flag indicating whether xdot is available on the system.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close