linnet_py Python API

linnet_py · version 0.1.0

Choose a public class, function, or constant below. Each symbol has its own page with a conventional signature-first layout, flat member sections, stable links, and source-backed details.

API inventory

The generated inventory distinguishes the supported module API from names that are merely reachable through the extension.

82supported exportsone page per supported class, function, or constant
0implementation-detail exportschecked for drift but intentionally omitted from the public reference

Ordered Python module exports

Exports registered by linnet-py.

ConstantAUTO

Exported constant of type `Auto`.

ClassAngle

A Typst angle in degrees or radians.

3 members
ClassAuto

Type of the `AUTO` sentinel, which requests automatic selection.

3 members
ClassColor

A safe Typst color value.

2 members
ClassCycle

A cycle in a particular graph revision.

3 members
ClassDash

A named or explicit Typst dash pattern.

2 members
ClassDebugLevel

Finite debug detail accepted by Linnest's drawing layer.

3 members
ClassDirectionBasis

Selects which notion of edge direction a directed algorithm follows.

2 members
ClassDotCodec

An explicit mapping between graph values and DOT-representable records.

2 members
ClassDrawOptions

Full typed option surface for `linnest.draw`.

1 member
ClassDrawingSelectors

Per-render Python callbacks returning typed drawing patches.

1 member
ClassFlow

The directed role of a half-edge within its edge.

2 members
ClassFraction

A Typst fractional track size such as `1fr`.

2 members
ClassGlobalData

DOT graph metadata kept separate from arbitrary Python element data.

6 members
ClassGraph

An owned topology with arbitrary element data and typed rendering configuration.

67 members
ClassGraphStyleOptions

Options applied by `linnest.graph.style` before layout measurement.

1 member
ClassInherit

Type of the `INHERIT` sentinel, which preserves a lower-precedence setting.

3 members
ClassInsets

Typed CeTZ/Typst inset values.

1 member
ClassLayoutFrame

A position snapshot from one continuous force-layout run.

5 members
ClassLayoutOptions

One or more ordered Linnest layout passes.

4 members
ClassLayoutStream

A synchronous iterator that advances the native force solver in batches.

5 members
ClassLength

A Typst length such as `2pt` or `1.2em`.

8 members
ClassMark

Typed CeTZ mark configuration.

3 members
ClassMathSymbol

Safe mathematical identifier content, optionally with scripts.

1 member
ClassNodeStore

Storage strategy used for graph nodes.

2 members
ClassOrientation

How an edge's declared endpoints determine its logical direction.

3 members
ClassOrientedCut

An oriented cut in a particular graph revision.

7 members
ClassPreparedRender

One Typst render whose virtual project and generated entrypoint share a lifetime.

3 members
ClassAnchor

A finite CeTZ box or content anchor.

9 members
ClassCompass

A finite DOT compass point.

10 members
ClassDashPattern

Built-in Typst stroke dash pattern.

10 members
ClassEdge

A live edge view whose data and drawing metadata update its graph.

8 members
ClassHalfEdge

A live half-edge view whose data and drawing metadata update its graph.

8 members
ClassLayoutDirection

Rank direction used by tree and layered layouts.

2 members
ClassLayoutNodes

Whether a pass lays out or preserves its selected nodes.

2 members
ClassMarkSymbol

Built-in arrowhead symbol used by CeTZ edge marks.

2 members
ClassNode

A live node view whose data and drawing metadata update its graph.

6 members
ClassPattern

Kurvst path decoration pattern.

5 members
ClassPlacement

Coordinate-constraint mode for an explicit placement.

2 members
ClassRankAlignment

Alignment within a layered-layout rank.

5 members
ClassRoutePoints

Whether layout-provided route points participate in edge routing.

2 members
ClassRouting

Route construction used for an anchored edge.

4 members
ClassStrokeCap

Endpoint shape for a Typst stroke.

3 members
ClassStrokeJoin

Join shape for a Typst stroke.

3 members
ClassTextStyle

Finite Typst text slant.

3 members
ClassRatio

A Typst ratio expressed in percent.

3 members
ClassRenderConfig

Complete typed rendering configuration.

10 members
ClassStroke

A typed Typst stroke dictionary.

1 member
ClassSubgraph

A graph-bound structural selection.

32 members
ClassTextLabel

Literal text content with optional typed text styling.

2 members
ClassTraversalTree

A graph-bound DFS or BFS traversal tree.

8 members
ClassTypstBind

A Typst function partially applied through its native `.with` method.

2 members
ClassTypstCall

A call to an explicitly imported Typst function.

1 member
ClassTypstModule

A local or package Typst module whose exports can be referenced safely.

6 members
ClassTypstRef

A typed export from a Typst module.

3 members
Functionedge

Describe an edge from one or two endpoint specs.

Functionnode

Describe a node while preserving its arbitrary Python data by identity.