My favorites | Sign in
Project Logo
                
Search
for
Updated Dec 07, 2008 by tw-pub...@gmx.de
Labels: Featured, Version1
Reference  
Home page for all documentation

(The following applies only to the 1.x branch of SVGFig. For version 2.x, see Version2Announcement.)

Tutorials


Alphabetized Index

Click here for an alphabetized list of all SVGFig reference pages. (Note that you can search their contents.)


Reference Table of Contents

Fundamentals

  • SVG: class representing an SVG image
    • canvas and canvas_outline: functions for explicitly laying out the SVG canvas; good for changing the aspect ratio
    • load and load_stream: functions for loading SVG files from files or XML streams
    • template: loads an SVG template, replacing all instances of "
      <replaceme>
      </replaceme>
      " with an SVG object
  • SVG graphics helpers
    • rgb: expresses an rgb triple as a hex string
    • make_symbol: makes a
      <symbol>
      </symbol>
      element from a template of standard shapes
    • make_marker: makes a
      <marker>
      </marker>
      element from a template
  • Fig: holds a set of transformable primitives and globally-positioned SVG objects, composes transformations when nested
  • Plot: a Fig with coordinate axes
  • Frame: a Fig in a coordinate frame
  • for making transformation functions
    • totrans: turns a string expression or complex function into an R2-to-R2 function
    • window: creates a transformation by mapping a rectangle of "inner" coordinates to a rectangle of "outer" coordinates
    • rotate: creates a simple rotation of the plane

Fig Primitives

  • Path: a transformable representation of an SVG path
    • pathtoPath: converts SVG
      <path>
      </path>
      objects into transformable Paths
  • Curve: draws a parametric function; implements the adaptive sampling algorithm
    • funcRtoR2: turns a string expression into a parametric function suitable for drawing with Curve
    • funcRtoC: turns a complex string expression into a parametric function
    • funcRtoR: turns a one-dimensional function into a parametric function
  • Poly: draws a line through a sequence of points; may be piecewise linear, Bézier, a velocity curve, or smooth
  • Dots: draws SVG symbols at a set of points
  • YErrorBars and XErrorBars: draw error bars (usually used with Dots), including multiple bars (e.g. for correlated and uncorrelated errors)
  • Line: draws a line between two points; if the coordinate transformation is non-linear, the line may be curved
  • LineGlobal: draws a straight line between two points, one or both of which are in global coordinates
  • VLine and HLine: draws vertical and horizontal lines (provided as a convenience)
  • Rect: draws a rectangle joining four points
  • Ellipse: draws an ellipse with semimajor axis and a semiminor length (does not need to be aligned with the X-Y axis)
  • Grid, HGrid, and VGrid: draws a set of horizontal and vertical lines
  • Text: places text at a local coordinate
  • TextGlobal: places text at a global coordinate

Coordinate Axes

  • Axes: draws an orthogonal coordinate axis in the local coordinate system
  • Ticks: superclass of everything with tick marks; implements the tick-guessing algorithm
  • CurveAxis: draws ticks along a parametric function
  • LineAxis: draws ticks along a line; useful for measuring the distance between points

Sign in to add a comment
Hosted by Google Code