pythontikz.paths

This module implements the classes used to show plots.

class pythontikz.paths.TikzArc(start_ang, finish_ang, radius, force_far_direction=False)[source]

Bases: pylatex.base_classes.latex_object.LatexObject

A class to represent the tikz specification for arcs i.e. (ang1: ang2: rad)

start_ang: float or int
angle in degrees
radius: float or int
radius from orig
force_far_direction: bool
forces arc to go in the longer direction around circumference
classmethod from_str(arc)[source]

Build a TikzArc object from a string.

class pythontikz.paths.TikzDraw(path=None, options=None)[source]

Bases: pythontikz.paths.TikzPath

A draw command is just a path command with the draw option.

Parameters:
  • path (TikzPathList or List) – A list of the nodes, path types in the path
  • options (TikzOptions) – A list of options for the command
get_anchor_point(anchor_name)

Return an anchor point of the node, if it exists.

class pythontikz.paths.TikzPath(path=None, options=None)[source]

Bases: pythontikz.common.TikzObject

The TikZ path command.

Parameters:
  • path (TikzPathList or list) – A list of the nodes, path types in the path
  • options (TikzOptions) – A list of options for the command
get_anchor_point(anchor_name)

Return an anchor point of the node, if it exists.

class pythontikz.paths.TikzPathList(*args, additional_path_types=None)[source]

Bases: pylatex.base_classes.latex_object.LatexObject

Represents a path drawing.

Parameters:*args (list) – A list of path elements
class pythontikz.paths.TikzRadius(radius, ellipse_semi_minor_ax=None)[source]

Bases: pylatex.base_classes.latex_object.LatexObject

Class which represents specification of a radius or radii for use with the ‘circle’ path argument. Should not need to be used directly, should be able inference from context.

Initialise a Radius object for a circle or ellipse respectively

class pythontikz.paths.TikzUserPath(path_type, options=None)[source]

Bases: pylatex.base_classes.latex_object.LatexObject

Represents a possible TikZ path.

Parameters:
  • path_type (str) – Type of path used
  • options (Options) – List of options to add