PyX Manual

Abstract

PyX is a Python package for the creation of PostScript, PDF, and SVG files. It combines an abstraction of the PostScript drawing model with a TeX/LaTeX interface. Complex tasks like 2d and 3d plots in publication-ready quality are built out of these primitives.

• Introduction
  • Organisation of the PyX package
• Basic graphics
  • Introduction
  • Path operations
  • Attributes: Styles and Decorations
• Module path
  • Class path — PostScript-like paths
    • path
      • path.append()
      • path.arclen()
      • path.arclentoparam()
      • path.at()
      • path.atbegin()
      • path.atend()
      • path.bbox()
      • path.begin()
      • path.end()
      • path.extend()
      • path.intersect()
      • path.joined()
      • path.normpath()
      • path.paramtoarclen()
      • path.reversed()
      • path.rotation()
      • path.split()
      • path.tangent()
      • path.trafo()
      • path.transformed()
  • Path elements
    • moveto
    • rmoveto
    • lineto
    • rlineto
    • arc
    • arcn
    • arct
    • curveto
    • rcurveto
    • closepath
    • multilineto_pt
    • multicurveto_pt
  • Class normpath
    • normpath
      • normpath.join()
      • normpath.reverse()
      • normpath.transform()
  • Class normsubpath
    • normsubpath
      • normsubpath.append()
      • normsubpath.extend()
      • normsubpath.close()
  • Predefined paths
    • line
    • curve
    • rect
    • circle
• Module metapost.path
  • Class path — MetaPost-like paths
    • path
  • Knots
    • beginknot
    • startknot
    • endknot
    • smoothknot
    • roughknot
    • knot
  • Links
    • line
    • tensioncurve
    • controlcurve
    • curve
• Module deformer: Path deformers
  • deformer
    • deformer.__call__()
    • deformer.deform()
  • cycloid
  • smoothed
  • parallel
• Module canvas
  • Class canvas
    • canvas
      • canvas.draw()
      • canvas.fill()
      • canvas.stroke()
      • canvas.insert()
      • canvas.text()
      • canvas.layer()
      • canvas.bbox()
      • canvas.settexrunner()
      • canvas.writeEPSfile()
      • canvas.writePSfile()
      • canvas.writePDFfile()
      • canvas.writeSVGfile()
      • canvas.writetofile()
      • canvas.pipeGS()
      • canvas.writeGSfile()
  • Class clip
• Module document
  • Class page
    • page
  • Class document
    • document
      • document.writeEPSfile()
      • document.writePSfile()
      • document.writePDFfile()
      • document.writeSVGfile()
      • document.writetofile()
  • Class paperformat
    • paperformat
• Text
  • Rationale
  • TeX interface
    • SingleEngine
      • SingleEngine.texmessages_start_default
      • SingleEngine.texmessages_end_default
      • SingleEngine.texmessages_preamble_default
      • SingleEngine.texmessages_run_default
      • SingleEngine.preamble()
      • SingleEngine.text_pt()
      • SingleEngine.text()
    • SingleTexEngine
    • SingleLatexEngine
      • SingleLatexEngine.texmessages_docclass_default
      • SingleLatexEngine.texmessages_begindoc_default
    • MultiEngine
      • MultiEngine.preamble()
      • MultiEngine.text_pt()
      • MultiEngine.text()
      • MultiEngine.reset()
    • TexEngine
    • LatexEngine
    • textextbox_pt
      • textextbox_pt.left
      • textextbox_pt.right
      • textextbox_pt.width
      • textextbox_pt.height
      • textextbox_pt.depth
      • textextbox_pt.marker()
  • Module level functionality
    • defaulttextengine
    • preamble
    • text_pt
    • text
    • reset
    • set()
    • escapestring()
  • TeX output parsers
    • errordetail
      • errordetail.none
      • errordetail.default
      • errordetail.full
    • TexResultError
    • texmessage
      • texmessage.start()
      • texmessage.no_file()
      • texmessage.no_aux()
      • texmessage.no_nav()
      • texmessage.end()
      • texmessage.load()
      • texmessage.load_def()
      • texmessage.load_graphics()
      • texmessage.ignore()
      • texmessage.warn()
      • texmessage.pattern()
      • texmessage.box_warning()
      • texmessage.font_warning()
      • texmessage.package_warning()
      • texmessage.rerun_warning()
      • texmessage.nobbl_warning()
  • TeX/LaTeX attributes
    • halign
      • halign.boxleft
      • halign.boxcenter
      • halign.boxright
      • halign.flushleft
      • halign.raggedright
      • halign.flushcenter
      • halign.raggedcenter
      • halign.flushright
      • halign.raggedleft
      • halign.left
      • halign.center
      • halign.right
    • valign
      • valign.top
      • valign.middle
      • valign.bottom
      • valign.baseline
    • parbox
    • vshift
      • vshift.bottomzero
      • vshift.middlezero
      • vshift.topzero
      • vshift.mathaxis
    • mathmode
    • size
      • size.tiny
      • size.scriptsize
      • size.footnotesize
      • size.small
      • size.normalsize
      • size.large
      • size.Large
      • size.LARGE
      • size.huge
      • size.Huge
    • phantom
  • Using the graphics-bundle with LaTeX
  • Configuration
    • TeX ipc mode
    • Debugging
      • pyxinfo()
    • Typesetting insecure text
  • UnicodeEngine
    • FontMetricType
      • FontMetricType.afm
      • FontMetricType.pfm
    • UnicodeEngine
    • Text
    • StackedText
• Graphs
  • Introduction
  • Component architecture
  • Module graph.graph: Graph geometry
    • graphxy
      • graphxy.axes
      • graphxy.plot()
      • graphxy.dolayout()
      • graphxy.dobackground()
      • graphxy.doaxes()
      • graphxy.doplotitem()
      • graphxy.doplot()
      • graphxy.dokeyitem()
      • graphxy.dokey()
      • graphxy.finish()
      • graphxy.pos()
      • graphxy.vpos()
      • graphxy.vgeodesic()
      • graphxy.vgeodesic_el()
      • graphxy.axistrafo()
      • graphxy.axisatv()
    • graphxyz
      • graphxyz.central
      • graphxyz.parallel
      • graphxyz.vzindex()
      • graphxyz.vangle()
    • central
    • parallel
  • Module graph.data: Graph data
    • file
      • file.defaultcommentpattern
      • file.defaultcolumnpattern
      • file.defaultstringpattern
    • function
    • paramfunction
    • values
    • points
    • data
    • conffile
    • cbdfile
    • splitatvalue()
  • Module graph.style: Graph styles
    • pos
    • range
    • symbol
      • symbol.cross
      • symbol.plus
      • symbol.square
      • symbol.triangle
      • symbol.circle
      • symbol.diamond
      • symbol.changecross
      • symbol.changeplus
      • symbol.changesquare
      • symbol.changetriangle
      • symbol.changecircle
      • symbol.changediamond
      • symbol.changesquaretwice
      • symbol.changetriangletwice
      • symbol.changecircletwice
      • symbol.changediamondtwice
      • symbol.changestrokedfilled
      • symbol.changefilledstroked
    • line
      • line.changelinestyle
    • impulses
    • errorbar
    • text
    • arrow
    • rect
    • histogram
    • barpos
    • stackedbarpos
    • bar
    • changebar
    • gridpos
    • grid
    • surface
  • Module graph.key: Graph keys
    • key
• Axes
  • Component architecture
  • Module graph.axis.axis: Axes
    • linear
    • lin
    • logarithmic
    • log
    • bar
    • nestedbar
    • split
    • anchoredaxis
      • anchoredaxis.basepath()
      • anchoredaxis.vbasepath()
      • anchoredaxis.gridpath()
      • anchoredaxis.vgridpath()
      • anchoredaxis.tickpoint()
      • anchoredaxis.vtickpoint()
      • anchoredaxis.tickdirection()
      • anchoredaxis.vtickdirection()
    • linkedaxis
      • linkedaxis.setlinkedaxis()
    • anchoredpathaxis
  • Module graph.axis.tick: Axes ticks
    • rational
    • tick
  • Module graph.axis.parter: Axes partitioners
    • linear
    • lin
    • autolinear
      • autolinear.defaultvariants
    • autolin
    • preexp
    • logarithmic
      • logarithmic.pre1exp5
      • logarithmic.pre1exp4
      • logarithmic.pre1exp3
      • logarithmic.pre1exp2
      • logarithmic.pre1exp
      • logarithmic.pre125exp
      • logarithmic.pre1to9exp
    • log
    • autologarithmic
      • autologarithmic.defaultvariants
    • autolog
  • Module graph.axis.texter: Axes texter
    • decimal
    • default
    • rational
  • Module graph.axis.painter: Axes painter
    • rotatetext
      • rotatetext.parallel
      • rotatetext.orthogonal
    • ticklength
    • regular
    • linked
    • bar
    • linkedbar
    • split
    • linkedsplit
  • Module graph.axis.rater: Axes rater
    • cube
    • distance
    • rater
    • linear
    • lin
    • logarithmic
    • log
  • Module graph.axis.positioner: Axes positioners
    • positioner
      • positioner.vbasepath()
      • positioner.vgridpath()
      • positioner.vtickpoint_pt()
      • positioner.vtickdirection()
• Module box: Convex box handling
  • Polygon
  • Functions working on a box list
  • Rectangular boxes
• Module connector
  • Class line
  • Class arc
  • Class curve
  • Class twolines
• Module epsfile: EPS file inclusion
• Module svgfile: SVG file inclusion
• Bitmaps
  • Introduction
  • Bitmap module: Bitmap support
    • image
    • jpegimage
    • bitmap
• Module bbox
  • bbox constructor
  • bbox methods
• Module color
  • Color models
  • Example
  • Color gradients
    • gradient
      • gradient.getcolor()
      • gradient.select()
    • functiongradient_cmyk
    • functiongradient_gray
    • functiongradient_hsb
    • functiongradient_rgb
    • lineargradient_cmyk()
    • lineargradient_gray()
    • lineargradient_hsb()
    • lineargradient_rgb()
  • Transparency
    • transparency
• Module pattern
  • Class pattern
• Module unit
  • set()
  • Class length
    • length
  • Predefined length instances
  • Conversion functions
• Module trafo: Linear transformations
  • Class trafo
    • trafo
    • apply()
    • inverse()
    • mirrored()
    • rotated()
    • scaled()
    • slanted()
    • translated()
  • Subclasses of trafo
    • mirror
    • rotate
    • scale
    • slant
    • translate
• Appendix: Named colors
• Appendix: Named gradients
• Appendix: path styles
• Appendix: Arrows in deco module