Difference between revisions of "User Reference"

From LIBISIS
Jump to navigation Jump to search
m
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
This is a reference for the various properties that can be set. These can be set as [[Using Default Properties and Name Tags| name tags]] or given when plotting as optional arguments. They are usually used as [[General Behaviour#Property-Value Pairs| property value pairs]].
 +
 
==Valid Linestyles==
 
==Valid Linestyles==
  
Line 9: Line 11:
 
| Solid line (default)
 
| Solid line (default)
 
|-
 
|-
! | --
+
! | --
 
| Dashed line
 
| Dashed line
 
|-
 
|-
! | :
+
! | :
 
| Dotted line
 
| Dotted line
 
|-
 
|-
!| -.  
+
!| -.
 
|Dash-dot line
 
|Dash-dot line
 
|}
 
|}
Line 25: Line 27:
 
! {{Headcellstyle}} | Marker Type
 
! {{Headcellstyle}} | Marker Type
 
|-
 
|-
! | +
+
! | +
 
| Plus sign
 
| Plus sign
 
|-
 
|-
! | o
+
! | o
 
| Circle
 
| Circle
 
|-
 
|-
Line 34: Line 36:
 
| Asterisk
 
| Asterisk
 
|-
 
|-
! | .
+
! | .
 
| Point
 
| Point
 
|-
 
|-
Line 40: Line 42:
 
| Cross
 
| Cross
 
|-
 
|-
! | 'square' or s
+
! | 'square' or s
 
| Square
 
| Square
 
|-
 
|-
! | 'diamond' or d
+
! | 'diamond' or d
 
| Diamond
 
| Diamond
 
|-
 
|-
! | ^
+
! | ^
 
| Upward-pointing triangle
 
| Upward-pointing triangle
 
|-
 
|-
! | v
+
! | v
 
| Downward-pointing triangle
 
| Downward-pointing triangle
| -
+
|-
! | >
+
! | >
 
| Right-pointing triangle
 
| Right-pointing triangle
 
|-
 
|-
! | <
+
! | <
 
| Left-pointing triangle
 
| Left-pointing triangle
 
|-
 
|-
! | 'pentagram' or p
+
! | 'pentagram' or p
 
| Five-pointed star (pentagram)
 
| Five-pointed star (pentagram)
 
|-
 
|-
! | 'hexagram' or h
+
! | 'hexagram' or h
 
| Six-pointed star (hexagram)
 
| Six-pointed star (hexagram)
 
|}
 
|}
  
 
==Valid Colors==
 
==Valid Colors==
 +
 +
 +
{| {{Tablestyle}}
 +
|-
 +
! {{Headcellstyle}} | Short Name
 +
! {{Headcellstyle}} | Long Name
 +
|-
 +
| r
 +
| Red
 +
|-
 +
| g
 +
| Green
 +
|-
 +
| b
 +
| Blue
 +
|-
 +
| c
 +
| Cyan
 +
|-
 +
| m
 +
| Magenta
 +
|-
 +
| y
 +
| Yellow
 +
|-
 +
| k
 +
| Black
 +
|-
 +
| w
 +
| White
 +
|}
  
 
==Properties That Can Be Set in Plots==
 
==Properties That Can Be Set in Plots==
 +
 +
{| {{Tablestyle}}
 +
|-
 +
! {{Headcellstyle}} | Name
 +
! {{Headcellstyle}} | Description
 +
|-
 +
| '''PAPER'''
 +
|-
 +
| 'papersize'
 +
| Paper size
 +
|-
 +
| 'paperposition'
 +
| Position
 +
|-
 +
| 'paperunits'
 +
| Units
 +
|-
 +
| 'paperorientation'
 +
| Orientation
 +
|-
 +
| 'papertype'
 +
| Type
 +
|-
 +
| 'paperpositionmode'
 +
| Position mode
 +
|-
 +
| '''FIGURE'''
 +
|-
 +
| 'fcolor'
 +
| Figure color
 +
|-
 +
| 'funits'
 +
| Units
 +
|-
 +
| 'fposition'
 +
| Position
 +
|-
 +
| 'name'
 +
| Name
 +
|-
 +
| 'tag'
 +
| Tag
 +
|-
 +
| 'menubar'
 +
| Menubar
 +
|-
 +
| 'resize'
 +
| Resize
 +
|-
 +
| ‘closerequestfcn’
 +
| Function to run when figure closes
 +
|-
 +
| '''AXES '''
 +
|-
 +
| 'acolor'
 +
| Axes color
 +
|-
 +
| 'xgrid'
 +
| X grid
 +
|-
 +
| 'ygrid'
 +
| Y grid
 +
|-
 +
| ‘z grid’
 +
| Z grid
 +
|-
 +
| ‘grid’
 +
| Both x, y and z grid
 +
|-
 +
| 'aunits'
 +
| Units
 +
|-
 +
| 'aposition'
 +
| Position
 +
|-
 +
| 'title'
 +
| Title
 +
|-
 +
| 'xlabel'
 +
| X label
 +
|-
 +
| 'ylabel'
 +
| Y label
 +
|-
 +
| ‘zlabel’
 +
| Z label
 +
|-
 +
| ‘afontcolor’
 +
| Axes font color
 +
|-
 +
| 'afontname'
 +
| Font name
 +
|-
 +
| 'afontsize'
 +
| Size
 +
|-
 +
| 'afontangle'
 +
| Angle
 +
|-
 +
| 'afontweight'
 +
| Weight
 +
|-
 +
| 'afontunits'
 +
| Units
 +
|-
 +
| 'xlim'
 +
| X limits
 +
|-
 +
| 'ylim'
 +
| Y limits
 +
|-
 +
| ‘zlim’
 +
| Z limits
 +
|-
 +
| ‘clim’
 +
| C limits
 +
|-
 +
| 'xscale'
 +
| X scale
 +
|-
 +
| 'yscale'
 +
| Y scale
 +
|-
 +
| ‘zscale’
 +
| Z scale
 +
|-
 +
| 'gridlinestyle'
 +
| Grid line style
 +
|-
 +
| ‘drawmode'
 +
| ‘fast’ or ‘normal’
 +
|-
 +
| ‘colororder’
 +
| Array of colours defining the order colours are used in surface or area plots.
 +
|-
 +
| ‘projection’
 +
| Either Orthographic or Perspective
 +
|-
 +
| ‘aspect'
 +
| A 2 or 3 element vector defining the unit lengths along x axis, y axis and (if watned) z axis. i.e. [3.07, 2.9] means one unit in x should represent 3.07, 1 unit in y should represent 2.9, z is scaled such that it doesn’t change size. (for instance, the axes will be square if x is between 0 and 5.8  and y is between 0 and 6.14)
 +
|-
 +
| ‘dataaspectratio’
 +
| A 3 element vector defining the ratio between the axes, i.e. [1 2 1] means that for every 1 unit in x and z, y will have 2 units in the same space. (for instance, the axes will be square if x is between 0 and 3 and y is between 0 and 6).
 +
|-
 +
|'''TEXT'''
 +
|-
 +
|'tcolor'
 +
| Text color
 +
|-
 +
| 'tunits'
 +
| Units
 +
|-
 +
| 'tposition'
 +
| Position
 +
|-
 +
| 'tfontname'
 +
| Font name
 +
|-
 +
| 'tfontsize'
 +
| Size
 +
|-
 +
| 'tfontweight'
 +
| Weight
 +
|-
 +
| 'tfontangle'
 +
| Angle
 +
|-
 +
| 'tfontunits'
 +
| Units
 +
|-
 +
|'''PLOT'''
 +
|-
 +
| 'punits'
 +
| units
 +
|-
 +
| 'linestyle'
 +
| Line style
 +
|-
 +
| 'marker'
 +
| Marker
 +
|-
 +
| 'markersize'
 +
| Size
 +
|-
 +
| 'linewidth'
 +
| Line width
 +
|-
 +
| ‘shading’
 +
| Determines what shading to use (flat, faceted, interpreted)
 +
|}

Latest revision as of 09:06, 1 April 2008

This is a reference for the various properties that can be set. These can be set as name tags or given when plotting as optional arguments. They are usually used as property value pairs.

Valid Linestyles

Specifier Line Style
- Solid line (default)
-- Dashed line
: Dotted line
-. Dash-dot line

Valid Marker Styles

Specifier Marker Type
+ Plus sign
o Circle
* Asterisk
. Point
x Cross
'square' or s Square
'diamond' or d Diamond
^ Upward-pointing triangle
v Downward-pointing triangle
> Right-pointing triangle
< Left-pointing triangle
'pentagram' or p Five-pointed star (pentagram)
'hexagram' or h Six-pointed star (hexagram)

Valid Colors

Short Name Long Name
r Red
g Green
b Blue
c Cyan
m Magenta
y Yellow
k Black
w White

Properties That Can Be Set in Plots

Name Description
PAPER
'papersize' Paper size
'paperposition' Position
'paperunits' Units
'paperorientation' Orientation
'papertype' Type
'paperpositionmode' Position mode
FIGURE
'fcolor' Figure color
'funits' Units
'fposition' Position
'name' Name
'tag' Tag
'menubar' Menubar
'resize' Resize
‘closerequestfcn’ Function to run when figure closes
AXES
'acolor' Axes color
'xgrid' X grid
'ygrid' Y grid
‘z grid’ Z grid
‘grid’ Both x, y and z grid
'aunits' Units
'aposition' Position
'title' Title
'xlabel' X label
'ylabel' Y label
‘zlabel’ Z label
‘afontcolor’ Axes font color
'afontname' Font name
'afontsize' Size
'afontangle' Angle
'afontweight' Weight
'afontunits' Units
'xlim' X limits
'ylim' Y limits
‘zlim’ Z limits
‘clim’ C limits
'xscale' X scale
'yscale' Y scale
‘zscale’ Z scale
'gridlinestyle' Grid line style
‘drawmode' ‘fast’ or ‘normal’
‘colororder’ Array of colours defining the order colours are used in surface or area plots.
‘projection’ Either Orthographic or Perspective
‘aspect' A 2 or 3 element vector defining the unit lengths along x axis, y axis and (if watned) z axis. i.e. [3.07, 2.9] means one unit in x should represent 3.07, 1 unit in y should represent 2.9, z is scaled such that it doesn’t change size. (for instance, the axes will be square if x is between 0 and 5.8 and y is between 0 and 6.14)
‘dataaspectratio’ A 3 element vector defining the ratio between the axes, i.e. [1 2 1] means that for every 1 unit in x and z, y will have 2 units in the same space. (for instance, the axes will be square if x is between 0 and 3 and y is between 0 and 6).
TEXT
'tcolor' Text color
'tunits' Units
'tposition' Position
'tfontname' Font name
'tfontsize' Size
'tfontweight' Weight
'tfontangle' Angle
'tfontunits' Units
PLOT
'punits' units
'linestyle' Line style
'marker' Marker
'markersize' Size
'linewidth' Line width
‘shading’ Determines what shading to use (flat, faceted, interpreted)