RenderSettings

Symbolica documentation for getting started, symbolic expressions, numerical evaluation, pattern matching, and APIs in Python and Rust.

RenderSettings

class RenderSettings

Immutable presentation settings for diagrams, subgraphs, and process schematics. None leaves an option to the renderer; it does not force a default override. Constructors and read-only properties expose options to help() and completion.

Examples

from symbolica.community.hepkit import RenderSettings
settings = RenderSettings(node_radius=5, show_particle=False)

Attributes

Name	Description
debug	Show both vertex and edge IDs; disabled by default.
edge_stroke	Edge paint, width, and dash pattern.
layout	Native graph layout options; omitted values retain renderer defaults.
momentum_arrows	Draw momentum arrows; None follows momenta or the supplied momentum basis.
node_fill	Vertex fill as a CSS color.
node_radius	Finite nonnegative vertex radius in drawing units.
node_stroke	Vertex outline paint, width, and dash pattern.
show_edge_index	Show native edge IDs; disabled by default.
show_momentum	Show momentum labels; None follows momenta or the supplied momentum basis.
show_node_index	Show native vertex IDs; disabled by default.
show_particle	Show particle labels; enabled by default.
split_initial_state	Open sewn initial-state connections in cross sections; enabled by default.
title	Plain-text title above the drawing.

debug

RenderSettings.debug: typing.Optional[builtins.bool]

Show both vertex and edge IDs; disabled by default.

Examples

from symbolica.community.hepkit import RenderSettings
value = RenderSettings().debug

edge_stroke

RenderSettings.edge_stroke: typing.Optional[StrokeStyle]

Edge paint, width, and dash pattern.

Examples

from symbolica.community.hepkit import RenderSettings
value = RenderSettings().edge_stroke

layout

RenderSettings.layout: typing.Optional[LayoutSettings]

Native graph layout options; omitted values retain renderer defaults.

Examples

from symbolica.community.hepkit import RenderSettings
value = RenderSettings().layout

momentum_arrows

RenderSettings.momentum_arrows: typing.Optional[builtins.bool]

Draw momentum arrows; None follows momenta or the supplied momentum basis.

Examples

from symbolica.community.hepkit import RenderSettings
value = RenderSettings().momentum_arrows

node_fill

RenderSettings.node_fill: typing.Optional[builtins.str]

Vertex fill as a CSS color.

Examples

from symbolica.community.hepkit import RenderSettings
value = RenderSettings().node_fill

node_radius

RenderSettings.node_radius: typing.Optional[builtins.float]

Finite nonnegative vertex radius in drawing units.

Examples

from symbolica.community.hepkit import RenderSettings
value = RenderSettings().node_radius

node_stroke

RenderSettings.node_stroke: typing.Optional[StrokeStyle]

Vertex outline paint, width, and dash pattern.

Examples

from symbolica.community.hepkit import RenderSettings
value = RenderSettings().node_stroke

show_edge_index

RenderSettings.show_edge_index: typing.Optional[builtins.bool]

Show native edge IDs; disabled by default.

Examples

from symbolica.community.hepkit import RenderSettings
value = RenderSettings().show_edge_index

show_momentum

RenderSettings.show_momentum: typing.Optional[builtins.bool]

Show momentum labels; None follows momenta or the supplied momentum basis.

Examples

from symbolica.community.hepkit import RenderSettings
value = RenderSettings().show_momentum

show_node_index

RenderSettings.show_node_index: typing.Optional[builtins.bool]

Show native vertex IDs; disabled by default.

Examples

from symbolica.community.hepkit import RenderSettings
value = RenderSettings().show_node_index

show_particle

RenderSettings.show_particle: typing.Optional[builtins.bool]

Show particle labels; enabled by default.

Examples

from symbolica.community.hepkit import RenderSettings
value = RenderSettings().show_particle

split_initial_state

RenderSettings.split_initial_state: typing.Optional[builtins.bool]

Open sewn initial-state connections in cross sections; enabled by default.

Examples

from symbolica.community.hepkit import RenderSettings
value = RenderSettings().split_initial_state

title

RenderSettings.title: typing.Optional[builtins.str]

Plain-text title above the drawing.

Examples

from symbolica.community.hepkit import RenderSettings
value = RenderSettings().title

Methods

Name	Description
__new__	Construct immutable overrides; None preserves the renderer’s defaults.
__repr__	Inspect the selected overrides without rendering a diagram.

__new__

RenderSettings.__new__(
    *,
    title: typing.Optional[builtins.str] = None,
    layout: typing.Optional[LayoutSettings] = None,
    node_radius: typing.Optional[builtins.float] = None,
    node_fill: typing.Optional[builtins.str] = None,
    node_stroke: typing.Optional[StrokeStyle] = None,
    edge_stroke: typing.Optional[StrokeStyle] = None,
    show_particle: typing.Optional[builtins.bool] = None,
    show_momentum: typing.Optional[builtins.bool] = None,
    show_edge_index: typing.Optional[builtins.bool] = None,
    show_node_index: typing.Optional[builtins.bool] = None,
    momentum_arrows: typing.Optional[builtins.bool] = None,
    split_initial_state: typing.Optional[builtins.bool] = None,
    debug: typing.Optional[builtins.bool] = None,
) -> RenderSettings

Related types: LayoutSettings, StrokeStyle

Construct immutable overrides; None preserves the renderer’s defaults.

Examples

from symbolica.community.hepkit import RenderSettings
settings = RenderSettings(node_radius=5, show_particle=False)

Parameters

• title (str or None, optional) Plain-text title above the drawing.
• layout (LayoutSettings or None, optional) Native graph layout options; omitted values retain renderer defaults.
• node_radius (float or None, optional) Finite nonnegative vertex radius in drawing units.
• node_fill (str or None, optional) Vertex fill as a CSS color.
• node_stroke (StrokeStyle or None, optional) Vertex outline paint, width, and dash pattern.
• edge_stroke (StrokeStyle or None, optional) Edge paint, width, and dash pattern.
• show_particle (bool or None, optional) Show particle labels; enabled by default.
• show_momentum (bool or None, optional) Show momentum labels; None follows momenta or the supplied momentum basis.
• show_edge_index (bool or None, optional) Show native edge IDs; disabled by default.
• show_node_index (bool or None, optional) Show native vertex IDs; disabled by default.
• momentum_arrows (bool or None, optional) Draw momentum arrows; None follows momenta or the supplied momentum basis.
• split_initial_state (bool or None, optional) Open sewn initial-state connections in cross sections; enabled by default.
• debug (bool or None, optional) Show both vertex and edge IDs; disabled by default.

__repr__

RenderSettings.__repr__() -> builtins.str

Inspect the selected overrides without rendering a diagram.

Examples

from symbolica.community.hepkit import RenderSettings
text = repr(RenderSettings(node_radius=5, show_particle=False))