![[attach.png]](../../../idldoc-resources/attach.png)
spedas/gui/objects/
spd_ui_zaxis_settings__define.pro
NAME: spd_ui_zaxis_settings__define PURPOSE: zaxis_settings is an object that holds all of the settings necessary for spectral data plots that are common to the entire panel CALLING SEQUENCE: zaxisSettings = Obj_New("SPD_UI_ZAXIS_SETTINGS") INPUT: none KEYWORDS: xAxisIndex flag to index x axis yAxisIndex flag to index y axis colorTable droplist value of color tables minRange minimum range value maxRange maximum range value fixed flag to use fixed min/max values tickNum the number of z-axis ticks minorTickNum the number of minor ticks between majors logMinorTickType full-interval,first-magnitude,last-magnitude,even-spacing annotationStyle droplist value for annotation style annotateTextObject a text object to indicate the size,color,font,format of the annotation text annotationOrientation flag indicating horizontal or vertical annotations 0=horizontal, 1=vertical annotateExponent Flag indicates whether to force annotations into an exponential format. 0: default behavior, 1: Always exponential, 2: Never exponential labelTextObject a text object to indicate the size,color,font,format of the label text - this is being treated as the z title subtitleTextObject a text object for the subtitle labelOrientation flag indicating horizontal/vertical text labelMargin in number of pts lazylabels flag indicating if underscores will be converted to carriage returns scaling 0=Linear, 1=Log10, 2= Natural Log placement droplist value of placement location margin number of points between plot & zaxis showFrequencies flag to show frequencies frequencyMin minimum value for showing frequencies frequencyMax maximum value for showing frequencies autoticks direct the draw object to make decisions about tick positioning automatically, and mutate axis object settings OUTPUT: spectra property object reference METHODS: SetProperty procedure to set keywords GetProperty procedure to get keywords GetAll returns the entire structure GetPlacements returns string array of placement options GetPlacement returns name of placement option given an index GetColorTables returns string array of color tables GetColorTable returns name of color table given an index NOTES: Methods: GetProperty,SetProperty,GetAll,SetAll are now managed automatically using the parent class spd_ui_getset. You can still call these methods when using objects of type spd_ui_zaxis_settings, and call them in the same way as before $LastChangedBy:pcruce $ $LastChangedDate:2009-09-10 09:15:19 -0700 (Thu, 10 Sep 2009) $ $LastChangedRevision:6707 $ $URL:svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/spedas/spd_ui/objects/spd_ui_zaxis_settings__define.pro $
Class description for SPD_UI_ZAXIS_SETTINGS
Inheritance
Properties
Properties in spd_ui_getset
- _extra set
- _ref_extra get
Properties in SPD_UI_ZAXIS_SETTINGS
- annotateExponent init
- annotateTextObject init
- annotationOrientation init
- annotationStyle init
- autoticks init
- colorTable init
- fixed init
- frequencyMax init
- frequencyMin init
- labelMargin init
- labelOrientation init
- labelTextObject init
- lazylabels init
- logMinorTickType init
- margin init
- maxRange init
- minRange init
- minorTickNum init
- nosave init
- placement init
- scaling init
- showFrequencies init
- subtitleTextObject init
- tickNum init
- xAxisIndex init
- yAxisIndex init
Fields
Fields in SPD_UI_READWRITE
- __DUMMY 0S
Fields in spd_ui_getset
- ___DUMMY 0S
Fields in SPD_UI_ZAXIS_SETTINGS
- ANNOTATEEXPONENT 0S
- ANNOTATETEXTOBJECT obj_new()
- ANNOTATIONORIENTATION 0S
- ANNOTATIONSTYLE 0S
- AUTOTICKS 0S
- COLORTABLE 0S
- FIXED 0S
- FREQUENCYMAX 0S
- FREQUENCYMIN 0S
- LABELMARGIN 0S
- LABELORIENTATION 0S
- LABELTEXTOBJECT obj_new()
- LAZYLABELS 0S
- LOGMINORTICKTYPE 0L
- MARGIN 0S
- MAXRANGE 0.0000000D
- MINORTICKNUM 0S
- MINRANGE 0.0000000D
- ORIGSETTINGS ptr_new()
- PLACEMENT 0S
- SCALING 0S
- SHOWFREQUENCIES 0S
- SUBTITLETEXTOBJECT obj_new()
- TICKNUM 0S
- TOUCHEDAUTOTICKS 0B
- TOUCHEDFIXED 0B
- TOUCHEDMAXRANGE 0B
- TOUCHEDMINORTICKNUM 0B
- TOUCHEDMINRANGE 0B
- TOUCHEDPLACEMENT 0B
- TOUCHEDSCALING 0B
- TOUCHEDTICKNUM 0B
- XAXISINDEX 0S
- YAXISINDEX 0S
Routines
Methods inherited from spd_ui_getset
spd_ui_getset::getProperty, _ref_extra=_ref_extraspd_ui_getset::setProperty, _extra=_extraspd_ui_getset::SetAll, strresult = spd_ui_getset::GetAll()spd_ui_getset::setTouchedresult = spd_ui_getset::init()result = spd_ui_getset::equalTolerance(val1, val2)
Methods inherited from SPD_UI_READWRITE
result = spd_ui_readwrite::GetDOMElement(parent_node)spd_ui_readwrite::write, lunspd_ui_readwrite::BuildFromDOMElement, dom_elementspd_ui_readwrite::read, lunresult = spd_ui_readwrite::getNodeArray(nodelist)result = SPD_UI_READWRITE::Init()spd_ui_readwrite::appendXMLNewline, parent
Routines from spd_ui_zaxis_settings__define.pro
result = SPD_UI_ZAXIS_SETTINGS::Copy()SPD_UI_ZAXIS_SETTINGS::SaveSPD_UI_ZAXIS_SETTINGS::Resetresult = SPD_UI_ZAXIS_SETTINGS::GetPlacements()result = SPD_UI_ZAXIS_SETTINGS::GetPlacement(index)result = SPD_UI_ZAXIS_SETTINGS::GetColorTables()result = SPD_UI_ZAXIS_SETTINGS::GetColorTableNumber(index)result = SPD_UI_ZAXIS_SETTINGS::GetColorTable(index)result = SPD_UI_ZAXIS_SETTINGS::GetAnnotations()result = SPD_UI_ZAXIS_SETTINGS::GetAnnotation(index)result = SPD_UI_ZAXIS_SETTINGS::Init(xAxisIndex=xAxisIndex, yAxisIndex=yAxisIndex, colorTable=colorTable, minRange=minRange, maxRange=maxRange, fixed=fixed, tickNum=tickNum, minorTickNum=minorTickNum, logMinorTickType=logMinorTickType, annotationStyle=annotationStyle, annotateTextObject=annotateTextObject, annotationOrientation=annotationOrientation, annotateExponent=annotateExponent, labelTextObject=labelTextObject, subtitleTextObject=subtitleTextObject, labelOrientation=labelOrientation, labelMargin=labelMargin, lazylabels=lazylabels, scaling=scaling, placement=placement, margin=margin, showFrequencies=showFrequencies, frequencyMin=frequencyMin, frequencyMax=frequencyMax, autoticks=autoticks, nosave=nosave)SPD_UI_ZAXIS_SETTINGS__DEFINE
Routine details
top source SPD_UI_ZAXIS_SETTINGS::GetPlacement
result = SPD_UI_ZAXIS_SETTINGS::GetPlacement(index)
Parameters
- index
top source SPD_UI_ZAXIS_SETTINGS::GetColorTableNumber
result = SPD_UI_ZAXIS_SETTINGS::GetColorTableNumber(index)
Parameters
- index
top source SPD_UI_ZAXIS_SETTINGS::GetColorTable
result = SPD_UI_ZAXIS_SETTINGS::GetColorTable(index)
Parameters
- index
top source SPD_UI_ZAXIS_SETTINGS::GetAnnotation
result = SPD_UI_ZAXIS_SETTINGS::GetAnnotation(index)
Parameters
- index
top source SPD_UI_ZAXIS_SETTINGS::Init
result = SPD_UI_ZAXIS_SETTINGS::Init(xAxisIndex=xAxisIndex, yAxisIndex=yAxisIndex, colorTable=colorTable, minRange=minRange, maxRange=maxRange, fixed=fixed, tickNum=tickNum, minorTickNum=minorTickNum, logMinorTickType=logMinorTickType, annotationStyle=annotationStyle, annotateTextObject=annotateTextObject, annotationOrientation=annotationOrientation, annotateExponent=annotateExponent, labelTextObject=labelTextObject, subtitleTextObject=subtitleTextObject, labelOrientation=labelOrientation, labelMargin=labelMargin, lazylabels=lazylabels, scaling=scaling, placement=placement, margin=margin, showFrequencies=showFrequencies, frequencyMin=frequencyMin, frequencyMax=frequencyMax, autoticks=autoticks, nosave=nosave)
Keywords
- xAxisIndex
- yAxisIndex
- colorTable
- minRange
- maxRange
- fixed
- tickNum
- minorTickNum
- logMinorTickType
- annotationStyle
- annotateTextObject
- annotationOrientation
- annotateExponent
- labelTextObject
- subtitleTextObject
- labelOrientation
- labelMargin
- lazylabels
- scaling
- placement
- margin
- showFrequencies
- frequencyMin
- frequencyMax
- autoticks
- nosave
File attributes
| Modification date: | Thu Feb 13 16:41:40 2014 |
| Lines: | 196 |