Global parameter - EpsTk

# Global parameter

setup parameter of toolkit

EpsTk uses global variables of octave or Matlab® to get default values for the functions.

All global parameter are defined in the file ‘einit.m’.

Which global parameter are used by function you can see in the description of the function

Summary

Global parameter | setup parameter of toolkit
Handling |
Environment |
Page |
Window(Bounding box) |
Plot area |
Polar plot area |
Title obove plots |
Grid |
Polar grid |
Axes |
South axis |
North axis |
West axis |
East axis |
Polar radius axis |
Polar angle axis |
Plot line |
Plot legend |
Image |
Image legend |
Parameter |
Line |
Text |
Text box |
Contour line |
Table |

### Handling

- change defaults permanently: If you want to change any default values, edit the file ‘einit.m’. This file is called by function eopen everytime.
- change temporarily: you can change then global parameter termporarily if you have called ‘eglobpar’ in you programs before. If you need the default values again after modifications of the global parameter, you should use the command ‘esavpar’ and ‘erespar’. ‘esavpar’ saves all global parameters and ‘erespar’ restores the last backup.

### Environment

- ePath (path of epstk m-files)
- ePsdPath (path for psd-symbol files, default=ePath)
- eDocUrl (URL of documentation file)
- eFileName (standard output file,default=’epstkout.eps’ or temp. names with ‘tmpnam’ if exist)
- eGhostscript (ghostscript command)
- eGhostview (postscript viewer command)
- eBrowser (html-browser command)

### Page

- eUserUnit (default=’mm’; or ‘cm’ or ‘inch’ or ‘inch/72’)
- ePageWidth (default=210mm, A3=297 A4=210 A5=148 )
- ePageHeight (default=297mm, A3=420 A4=297 A5=210)
- ePageOrientation (default=0, 0=Portrait 1=Landscape 2=Upside-down 3=Seaside)
- ePageReflection (default=0, 1=on 0=off reflect page )
- eXScaleFac (default=1, 1=no resize 0.5=50% reduce 2=200% enlarge)
- eYScaleFac (default=1, 1=no resize 0.5=50% reduce 2=200% enlarge)

### Window(Bounding box)

- eWinWidth (default=180mm)
- eWinHeight (default=250mm)
- eWinFrameVisible (default=0, 1=on 0=off draw frame around window)
- eWinFrameLineWidth (default=0.3mm)
- eWinGridVisible (default=0, 1=on 0=off draw grid of window)
- eWinTimeStampVisible (default=0, 1=on 0=off print time stamp outside of frame)
- eWinTimeStampFont (default=1, font number 1=TimesRoman select font of time stamp)
- eWinTimeStampFontSize (default=1.5mm)

### Plot area

- ePlotAreaPos (default=[40 100], x y position of left bottom corner of plot area)
- ePlotAreaWidth (default=100mm)
- ePlotAreaHeight (default=100mm)
- ePlotAreaXValueStart (default=0, start value of x-axis)
- ePlotAreaXValueEnd (default=100, end value of x-axis)
- ePlotAreaYValueStart (default=0, start value of y-axis)
- ePlotAreaYValueEnd (default= 100, end value of y-axis)

### Polar plot area

- ePolarPlotAreaCenterPos (default=[90 160], x y position of Center of polar plot area)
- ePolarPlotAreaRadMin (default=10mm)
- ePolarPlotAreaRadMax (default=50mm)
- ePolarPlotAreaAngStart (default=0, deg, 0=east 90=north 180=west 270=south)
- ePolarPlotAreaAngEnd (default=360, deg, 0=east 90=north 180=west 270=south)
- ePolarPlotAreaValStart (default=0, start value of radius-axis)
- ePolarPlotAreaValEnd (default=100, end value of radius-axis)

### Title obove plots

- ePlotTitleDistance (default=20mm)
- ePlotTitleFontSize (default=6mm)
- ePlotTitleText (default=’’, text string )
- ePlotTitleTextFont (default=1, font number 1=TimesRoman)

### Grid

- eXGridLineWidth (default=0.1mm)
- eXGridColor (default=[0 0 0], [r g b] [0 0 0]=black [1 1 1]=white)
- eXGridDash (default=0.5mm, 0=solid line >0=dash length or dash=[space dashL1 dashL2 ...])
- eXGridVisible (default=0, )
- eYGridLineWidth (default=0.1mm)
- eYGridColor (default=[0 0 0], [r g b] [0 0 0]=black [1 1 1]=white)
- eYGridDash (default=0.5mm, 0=solid line >0=dash length or dash=[space dashL1 dashL2 ...])
- eYGridVisible (default=0, 0=off 1=on )

### Polar grid

- ePolarRadiusGridLineWidth (default=0.1mm)
- ePolarRadiusGridColor (default=[0 0 0], [r g b] [0 0 0]=black [1 1 1]=white)
- ePolarRadiusGridDash (default=1mm, 0=solid line >0=dash length or dash=[space dashL1 dashL2 ...])
- ePolarRadiusGridVisible (default=1, 0=off 1=on)
- ePolarAngleGridLineWidth (default=0.1mm)
- ePolarAngleGridColor (default=[0 0 0], [r g b] [0 0 0]=black [1 1 1]=white)
- ePolarAngleGridDash (default=2mm, 0=solid line >0=dash length or dash=[space dashL1 dashL2 ...])
- ePolarAngleGridVisible (default=1, 0=off 1=on )

### Axes

- eAxesColor (default=[0 0 0], [r g b] [0 0 0]=black [1 1 1]=white)
- eAxesLineWidth (default=0.3mm,)
- eAxesTicShortLength (default=1.5mm,)
- eAxesTicLongLength (default=3mm,)
- eAxesTicLongMaxN (default=9, max. number of long Tics)
- eAxesValueSpace (default=1mm)
- eAxesValueFontSize (default=4mm)
- eAxesLabelFontSize (default=4mm)
- eAxesLabelTextFont (default=5, font number 5=Helvetica)
- eAxesCrossOrigin (default=0, 0=off 1=on 2=on and with arrows)

#### Note: Scaling

You can scale the axes with scale vectors [start step end]

if start and end == 0 then autoranging is on

if step == 0 then autoscaling is on

### South axis

- eXAxisSouthScale (default=[0 0 0], [start step end])
- eXAxisSouthScaleType (default=0, 0=linear 1=classes 2=log10)
- eXAxisSouthValueFormat (default=-1, n digits after decimal point,-1=auto) or format string of printf
- eXAxisSouthTicsVisible (default=1, 0=off 1=on )
- eXAxisSouthValueVisible (default=1, 0=off 1=on )
- eXAxisSouthValuePos (default=[0 0], value positions after drawing of axis )
- eXAxisSouthLabelDistance (default=2mm, label distance from axis)
- eXAxisSouthLabelText (default=’’, )
- eXAxisSouthVisible (default=1, 0=off 1=on )

### North axis

- eXAxisNorthScale (default=[0 0 0], [start step end])
- eXAxisNorthScaleType (default=0, 0=linear 1=classes 2=log10)
- eXAxisNorthValueFormat (default=-1, n digits after decimal point,-1=auto) or format string of printf
- eXAxisNorthTicsVisible (default=1, 0=off 1=on )
- eXAxisNorthValueVisible (default=1, 0=off 1=on )
- eXAxisNorthValuePos (default=[0 0], value positions after drawing of axis )
- eXAxisNorthLabelDistance (default=2mm, label distance from axis)
- eXAxisNorthLabelText (default=’’, )
- eXAxisNorthVisible (default=1, 0=off 1=on )

### West axis

- eYAxisWestScale (default=[0 0 0], [start step end])
- eYAxisWestScaleType (default=0, 0=linear 1=classes 2=log10)
- eYAxisWestValueFormat (default=-1, n digits after decimal point,-1=auto) or format string of printf
- eYAxisWestTicsVisible (default=1, 0=off 1=on )
- eYAxisWestValueVisible (default=1, 0=off 1=on )
- eYAxisWestValuePos (default=[0 0], value positions after drawing of axis )
- eYAxisWestLabelDistance (default=6mm, label distance from axis)
- eYAxisWestLabelText (default=’’, )
- eYAxisWestVisible (default=1, 0=off 1=on )

### East axis

- eYAxisEastScale (default=[0 0 0], [start step end])
- eYAxisEastScaleType (default=0, 0=linear 1=classes 2=log10)
- eYAxisEastValueFormat (default=-1, n digits after decimal point,-1=auto) or format string of printf
- eYAxisEastTicsVisible (default=1, 0=off 1=on )
- eYAxisEastValueVisible (default=1, 0=off 1=on )
- eYAxisEastValuePos (default=[0 0], value positions after drawing of axis )
- eYAxisEastLabelDistance (default=6mm, label distance from axis)
- eYAxisEastLabelText (default=’’, )
- eYAxisEastVisible (default=1, 0=off 1=on )

### Polar radius axis

- ePolarAxisRadScale (default=[0 0 0], [start step end])
- ePolarAxisRadScaleType (default=0, 0=linear 1=classes 2=log10)
- ePolarAxisRadValueFormat (default=-1, n digits after decimal point,-1=auto) or format string of printf
- ePolarAxisRadValueVisible (default=3, 0=off,1=RadStart on,2=RadEnd on,3=Start+End on)
- ePolarAxisRadValuePos (default=[0 0], value positions after drawing of axis )
- ePolarAxisRadVisible (default=1, 0=off,1=RadStart on,2=RadEnd on,3=Start+End on)

### Polar angle axis

- ePolarAxisAngScale (default=[0 0 0], [start step end])
- ePolarAxisAngValueFormat (default=-1, n digits after decimal point,-1=auto) or format string of printf
- ePolarAxisAngValueVisible (default=1, 0=off 1=on )
- ePolarAxisAngValueAngle (default=0, angle positions of values after drawing of axis )
- ePolarAxisAngVisible (default=1, 0=off 1=on )

### Plot line

- ePlotLineColor (default=[0 0 0], [r g b] [0 0 0]=black [1 1 1]=white)
- ePlotLineDash (default=0mm, 0=solid line,>0=dash length,<0=fill or dash=[space dashL1 dashL2 ...])
- ePlotLineWidth (default=0.3mm)
- ePlotLineInterpolation (default=0, 0=off 1=on)

### Plot legend

- ePlotLegendPos (default=[-15 -20], position relativ to left bottom corner of plot area)
- ePlotLegendFontSize (default=4mm)
- ePlotLegendDistance (default=100, in percent, depend on ePlotLegendFontSize )
- ePlotLegendTextFont (default=1, font number 1=TimesRoman)

### Image

- eImageDefaultColorMap (default=0, number of default map of eColorMaps )
- eImageFrameVisible (default=0, 0=off 1=on)

### Image legend

- eImageLegendPos (default=[0 -25], position relativ to left bottom corner of plot area)
- eImageLegendWidth (default=0mm, 0=ePlotAreaWidth)
- eImageLegendHeight (default=5mm)
- eImageLegendScale (default=[0 0 0], [start step end])
- eImageLegendScale (default=[0 0 0], [start step end])
- eImageLegendScaleType (default=0, 0=linear 1=classes 2=log10)
- eImageLegendValueFormat (default=-1, n digits after decimal point,-1=auto) or format string of printf
- eImageLegendValueVisible (default=1, 0=off 1=on )
- eImageLegendValuePos (default=[0 0], value positions after drawing of axis )
- eImageLegendLabelDistance (default=2mm)
- eImageLegendLabelText (default=’’, )
- eImageLegendVisible (default=1, 0=off 1=on )

### Parameter

- eParamPos (default=[30 65], absolut position of window )
- eParamFontSize (default=4mm)
- eParamLineDistance (default=100, in percent, depend on eParamFontSize)
- eParamTextValueDistance (default=100, in percent, depend on eParamFontSize)
- eParamText (default=’’, )
- eParamTextFont (default=3, font number 1=TimesRoman)
- eParamValue (default=’’, )
- eParamValueFont (default=11, font number 9=Courier)

### Line

- eLineWidth (default=0.3mm)
- eLineColor (default=[0 0 0], [r g b] [0 0 0]=black [1 1 1]=white)
- eLineDash (default=0, 0=solid line >0=dash length or dash=[space dashL1 dashL2 ...])

### Text

- eTextFont (default=1, font number 1=TimesRoman)
- eTextFontSize (default=4mm)
- eTextPos (default=[30 eWinHeight-eTextFontSize], inital position is left top of window )
- eTextColor (default=[0 0 0], [r g b] [0 0 0]=black [1 1 1]=white)
- eTextAlignment (default=1, 1=right 0=center -1=left)
- eTextRotation (default=0, in deg)
- eTextLimitWord (default=’ ‘, character to limit words)
- eTextLimitPara (default=setstr(10), character to limit paragraphs, setstr(10)=linefeed)

### Text box

- eTextBoxFeedLine (default=0, 0=auto else fix linefeed)
- eTextBoxFeedPara (default=0mm, space between paragraphs )
- eTextBoxSpaceNorth (default=0mm, space between text and the north border of box )
- eTextBoxSpaceSouth (default=0mm, space between text and the south border of box)
- eTextBoxSpaceWest (default=0mm, space between text and the north border of box )
- eTextBoxSpaceEast (default=0mm, space between text and the south border of box)

### Contour line

- eContourLineWidth (default=0.2mm)
- eContourLineColor (default=[0 0 0], [r g b] [0 0 0]=black [1 1 1]=white)
- eContourLineDash (default=0, 0=solid line >0=dash length)
- eContourScale (default=[0 0 0], [start step end])
- eContourValueVisible (default=0, 0=off 1=on )
- eContourValueFormat (default=-1, n digits after decimal point,-1=auto)
- eContourValueFont (default=5, font number 5=Helvetica)
- eContourValueFontSize (default=2mm )
- eContourValueDistance (default=2+eContourLineWidth/2)
- eContourLevelsMaxN (default=10, max. number of isolevels if autoscaling on)

### Table

- eTabBackgroundColor (default=[-1 0 0], [r g b] if r<0 then transparent )
- eTabFrameVisible (default=1, 0=off 1=on )
- eTabFrameLineWidth (default=eLineWidth, mm)
- eTabFrameColor (default=[0 0 0], [r g b] [0 0 0]=black [1 1 1]=white)
- eTabFrameDash (default=0, 0=solid line >0=dash length)
- eTabXLineVisible (default=1, 0=off 1=on )
- eTabXLineWidth (default=eLineWidth)
- eTabXLineColor (default=[0 0 0], [r g b] [0 0 0]=black [1 1 1]=white)
- eTabXLineDash (default=0, 0=solid line >0=dash length)
- eTabYLineVisible (default=1, 0=off 1=on )
- eTabYLineWidth (default=eLineWidth)
- eTabYLineColor (default=[0 0 0], [r g b] [0 0 0]=black [1 1 1]=white)
- eTabYLineDash (default=0, 0=solid line >0=dash length)

open EPS-file, define size of page, size of window and call ‘einit’ to initialize the global parameter
Close