spedas/gui/objects/
spd_ui_line_settings__define.pro
NAME: spd_ui_line_settings__define PURPOSE: line properties is an object that holds all of the settings necessary for plotting a line as specified in the Trace Properties Line panel CALLING SEQUENCE: lineSettings = Obj_New("SPD_UI_LINE_SETTINGS") INPUT: none KEYWORDS: dataX string naming X component of line dataY string naming Y component of line mirrorLine flag to mirror line lineStyle line style object drawBetweenPts flag set if separation attributes should be used(ie NOT drawBetweenpts) separatedBy number of point separation separatedUnits 0=sec, 1=min, 2=hrs, 3=days symbol symbol object plotPoints, all,1st/Last,1st,Last,MajorTick,EveryN everyOther number for every N points positiveEndPt variable name for positive endPt negativeEndPt variable name for negative endPt positiveEndRel flag if relative to line negativeEndRel flag if relative to line barLine bar line style object MarkSymbol mark symbol object debug=debug set to debug OUTPUT: line property object reference METHODS: SetProperty procedure to set keywords GetProperty procedure to get keywords GetAll returns the entire structure GetPlotOptions returns string array of plot options GetPlotOption returns name of plot option given an index GetUnits returns string array of unit options GetUnit returns name of unit 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_line_settings, and call them in the same way as before HISTORY: $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_line_settings__define.pro $
Class description for SPD_UI_LINE_SETTINGS
Inheritance
Properties
Properties in spd_ui_getset
- _extra set
- _ref_extra get
Properties in SPD_UI_LINE_SETTINGS
- BarLine init
- Debug init
- DrawBetweenPts init
- EveryOther init
- LineStyle init
- MarkSymbol init
- MirrorLine init
- NegativeEndPt init
- NegativeEndRel init
- PlotPoints init
- PositiveEndPt init
- PositiveEndRel init
- SeparatedBy init
- SeparatedUnits init
- Symbol init
- dataX init
- dataY init
- nosave init
Fields
Fields in SPD_UI_READWRITE
- __DUMMY 0S
Fields in spd_ui_getset
- ___DUMMY 0S
Fields in SPD_UI_LINE_SETTINGS
- BARLINE obj_new()
- DATAX ''
- DATAY ''
- DRAWBETWEENPTS 0S
- EVERYOTHER 0S
- LINESTYLE obj_new()
- MARKSYMBOL obj_new()
- MIRRORLINE 0S
- NEGATIVEENDPT ''
- NEGATIVEENDREL 0S
- ORIGSETTINGS ptr_new()
- PLOTPOINTS 0S
- POSITIVEENDPT ''
- POSITIVEENDREL 0S
- SEPARATEDBY 0.0000000D
- SEPARATEDUNITS 0S
- SYMBOL obj_new()
Routines
Methods inherited from spd_ui_getset
spd_ui_getset::getProperty, _ref_extra=_ref_extra
spd_ui_getset::setProperty, _extra=_extra
spd_ui_getset::SetAll, str
result = spd_ui_getset::GetAll()
spd_ui_getset::setTouched
result = 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, lun
spd_ui_readwrite::BuildFromDOMElement, dom_element
spd_ui_readwrite::read, lun
result = spd_ui_readwrite::getNodeArray(nodelist)
result = SPD_UI_READWRITE::Init()
spd_ui_readwrite::appendXMLNewline, parent
Routines from spd_ui_line_settings__define.pro
result = SPD_UI_LINE_SETTINGS::Copy()
result = spd_ui_line_settings::getPtSpacing()
spd_ui_line_settings::updatedatareference, oldnames, newnames, changed=changed
result = SPD_UI_LINE_SETTINGS::GetUnits()
result = SPD_UI_LINE_SETTINGS::GetUnit(index)
result = SPD_UI_LINE_SETTINGS::GetPlotOptions()
result = SPD_UI_LINE_SETTINGS::GetPlotOption(index)
SPD_UI_LINE_SETTINGS::Save
SPD_UI_LINE_SETTINGS::Reset
result = SPD_UI_LINE_SETTINGS::Init(dataX=dataX, dataY=dataY, MirrorLine=MirrorLine, LineStyle=LineStyle, DrawBetweenPts=DrawBetweenPts, SeparatedBy=SeparatedBy, SeparatedUnits=SeparatedUnits, Symbol=Symbol, PlotPoints=PlotPoints, EveryOther=EveryOther, PositiveEndPt=PositiveEndPt, NegativeEndPt=NegativeEndPt, PositiveEndRel=PositiveEndRel, NegativeEndRel=NegativeEndRel, BarLine=BarLine, MarkSymbol=MarkSymbol, Debug=Debug, nosave=nosave)
SPD_UI_LINE_SETTINGS__DEFINE
Routine details
top source spd_ui_line_settings::updatedatareference
spd_ui_line_settings::updatedatareference, oldnames, newnames, changed=changed
Parameters
- oldnames
- newnames
Keywords
- changed
top source SPD_UI_LINE_SETTINGS::GetUnit
result = SPD_UI_LINE_SETTINGS::GetUnit(index)
Parameters
- index
top source SPD_UI_LINE_SETTINGS::GetPlotOption
result = SPD_UI_LINE_SETTINGS::GetPlotOption(index)
Parameters
- index
top source SPD_UI_LINE_SETTINGS::Init
result = SPD_UI_LINE_SETTINGS::Init(dataX=dataX, dataY=dataY, MirrorLine=MirrorLine, LineStyle=LineStyle, DrawBetweenPts=DrawBetweenPts, SeparatedBy=SeparatedBy, SeparatedUnits=SeparatedUnits, Symbol=Symbol, PlotPoints=PlotPoints, EveryOther=EveryOther, PositiveEndPt=PositiveEndPt, NegativeEndPt=NegativeEndPt, PositiveEndRel=PositiveEndRel, NegativeEndRel=NegativeEndRel, BarLine=BarLine, MarkSymbol=MarkSymbol, Debug=Debug, nosave=nosave)
Keywords
- dataX
- dataY
- MirrorLine
- LineStyle
- DrawBetweenPts
- SeparatedBy
- SeparatedUnits
- Symbol
- PlotPoints
- EveryOther
- PositiveEndPt
- NegativeEndPt
- PositiveEndRel
- NegativeEndRel
- BarLine
- MarkSymbol
- Debug
- nosave
File attributes
Modification date: | Thu Feb 13 16:41:39 2014 |
Lines: | 181 |