![[attach.png]](../../../idldoc-resources/attach.png)
spedas/gui/objects/
spd_ui_axis_settings__define.pro
NAME: spd_ui_axis_settings__define PURPOSE: axis properties is an object that holds all of the settings necessary for plotting a axis as specified in the Trace Properties Line panel CALLING SEQUENCE: axisSettings = Obj_New("SPD_UI_AXIS_SETTINGS") INPUT: none ATTRIBUTES: rangeOption range options (auto, floating, fixed) touchedRangeOption has the user modified the rangeOption field scaling axis scaling (linear, log10, natural) touchedScaling has the user modified the scaling field equalXYScaling flag set if equal X & Y axis scaled isTimeAxis flag set if axis is time based touchedIsTimeAxis has the user modified the isTimeAxis field rangeMargin if auto - range margin boundScaling flag set if auto scaling is bound boundfloating flag set if bounded floating range is used minFixedRange min range value if fixed scaling touchedMinFixedRange has the user modified the minFixedRange maxFixedRange max range value if fixed scaling touchedMaxFixedRange has the user modified the maxFixedRange minFloatRange min range bound if floating range maxFloatRange max range bound if floating range minBoundRange min range bound if using bounded autoscaling maxBoundRange max range bound if using bounded autoscaling floatingSpan value of span if floating floatingCenter floating center options (mean, median, appr. mean/median) majorTickEvery display major ticks every minorTickEvery display major ticks every majorTickUnits major tick units (sec, hr, min, day, none) minorTickUnits major tick units (sec, hr, min, day, none) majorTickAuto set to automatically figure out major ticks minorTickAuto set to automatically figure out minor ticks firstTickAuto set to automatically figure out first tick numMajorTicks number of major ticks numMinorTicks number of major ticks firstTickAt value where first tick should be firstTickUnits first tick unit (sec, hr, min, day, none) tickStyle style (inside, outside, both) bottomPlacement flag set if ticks should be on bottom axis topPlacement flag set if ticks should be on top axis majorLength length of major tick minorLength length of minor tick logMinorTickType For Log minor ticks, log-full-interval,log-first-magnitude,log-last-magnitude,even-spacing lineAtZero flag set if line is drawn at zero showdate flag set if date strings are shown dateString1 string format of date for line 1 dateString2 string format of date for line 1 dateFormat1 format of date string for annotation - line 1 dateFormat2 format of date string for annotation - line 2 format options include 'Time', 'Date', 'Year', 'Mon', 'Day', 'Hours', 'Minutes', 'Seconds', 'Day of Year' respective commands are '%time', '%date', '%year', '%mon', '%day', '%hours', '%minutes', '%seconds', '%doy' annotateAxis flag set to annotate along axis placeAnnotation placement of annotation (bottom or top) annotateMajorTicks set flag if major ticks are annotated annotateEvery value where annotations occur annotateUnits units for annotation value (sec, min, hr, day,none) firstAnnotation value where annotation of first major tick occurs firstAnnotateUnits units for major tick value (sec, min, hr, day,none) annotateRangeMin set flag to annotate range min tick annotateRangeMax set flag to annotate range max tick annotateStyle format style of tick if IsTime ['date', 'date:doy' , 'date:doy:h:m', 'date:doy:h:m:s', 'date:doy:h:m:s.ms', $ 'h:m', 'h:m:s', 'h:m:s.ms', 'mo:day', 'mo:day:h:m', 'doy', 'doy:h:m', $ 'doy:h:m:s', 'doy:h:m:s.ms', 'year:doy', 'year:doy:h:m', 'year:doy:h:m:s', $ 'year:doy:h:m:s.ms'] otherwise ['d(1234)', 'f0(1234)' , 'f1(123.4)', 'f2(12.34)', 'f3(1.234)', 'f4(0.1234)', $ 'f5(0.01234)', 'f6(0.001234)', 'e0(123e4)', 'e1(12.3e4)', 'e2(1.23e4)', 'e2(0.123e4)', $ 'e2(0.0123e4)', 'e2(0.00123e4)', 'e2(0.000123e4)'] annotateOrientation The orientation of the annotations: 0(horizontal) & 1(vertical) annotateTextObject Text object that represents that textual style of annotations annotateExponent Flag indicates whether to force annotations into an exponential format. 0: default behavior, 1: Always exponential, 2: Never exponential majorGrid=majorgrid linestyle object of major grid minorGrid=minorgrid linestyle object of minor grid orientation orientation of labels 0=Horizontal, 1=Vertical margin number of points for label margins showLabels flag for whether or not labels are displayed labels A container object that stores the text objects which represent each label stackLabels A flag to determine whether labels should be stacked lazyLabels A flag to determine whether underscores will be converted to carriage returns (and stacking turned off) blackLabels A flag to determine whether label colors are all black autoticks direct the draw object to make decisions about tick positioning automatically, and mutate axis object settings titleobj text object that contains the title for the axis subtitleobj text object that contains the subtitle for the axis placeLabel placement of labels (left/bottom or right/top) placeTitle placement of title (left/bottom 0 or right/top 1) titleorientation orientation for title (0=horizontal, 1=vertical) titlemargin number of points for title margin showtitle flag for whether the title should be displayed (mainly to allow us to turn off titles if panels are locked and titles would overlap panels) lazytitles flag to determine whether underscores in titles should be converted to carriage returns OUTPUT: axis property object reference METHODS: SetProperty procedure to set keywords GetProperty procedure to get keywords GetAll returns the entire structure GetUnits returns string array of unit options GetUnit returns name of unit given an index GetOrientations returns string array of plot options GetOrientation returns name of plot option given an index GetPlacements returns string array of plot options GetPlacement returns name of plot option given an index GetRangeOptions returns string array of plot options GetRangeOption returns name of plot option given an index GetStyles returns string array of plot options GetStyle returns name of plot option given an index GetScalings returns string array of plot options GetScaling returns name of plot option given an index GetDateFormats returns string array of date format options GetDateFormat returns the name of the date format given an index GetDateCommands returns array of commands for date formats GetDateCommand returns a string with the date command GetDateString returns a string with the actual date formatted given an index. if a time object is provided it will format the time object, otherwise it will default to the current date. HISTORY: 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_axis_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_axis_settings__define.pro $
Class description for spd_ui_axis_settings
Inheritance
Properties
Properties in spd_ui_getset
- _extra set
- _ref_extra get
Properties in spd_ui_axis_settings
- AnnotateAxis init
- AnnotateMajorTicks init
- AnnotateRangeMin init
- AnnotateStyle init
- BottomPlacement init
- BoundFloating init
- BoundScaling init
- DateFormat1 init
- DateFormat2 init
- DateString1 init
- DateString2 init
- EqualXYScaling init
- FirstAnnotateUnits init
- FirstAnnotation init
- FirstTickAt init
- FirstTickAuto init
- FirstTickUnits init
- FloatingCenter init
- FloatingSpan init
- IsTimeAxis init
- LineAtZero init
- MajorLength init
- MajorTickAuto init
- MajorTickEvery init
- MajorTickUnits init
- Margin init
- MinorLength init
- MinorTickAuto init
- MinorTickEvery init
- MinorTickUnits init
- NumMajorTicks init
- NumMinorTicks init
- Orientation init
- PlaceAnnotation init
- RangeMargin init
- RangeOption init
- Scaling init
- TickStyle init
- TopPlacement init
- annotateEvery init
- annotateExponent init
- annotateOrientation init
- annotateRangeMax init
- annotateTextObject init
- annotateUnits init
- autoticks init
- blackLabels init
- labels init
- lazyLabels init
- logMinorTickType init
- majorGrid init
- maxBoundRange init
- maxFixedRange init
- maxFloatRange init
- minBoundRange init
- minFixedRange init
- minFloatRange init
- minorGrid init
- nosave init
- placeLabel init
- placeTitle init
- showLabels init
- showdate init
- showtitle init
- stackLabels init
- subtitleObj init
- titleObj init
- titlemargin init
- titleorientation init
- touchedIsTimeAxis init
- touchedMaxFixedRange init
- touchedMinFixedRange init
- touchedRangeOption init
- touchedScaling init
Fields
Fields in SPD_UI_READWRITE
- __DUMMY 0S
Fields in spd_ui_getset
- ___DUMMY 0S
Fields in spd_ui_axis_settings
- ANNOTATEAXIS 0S
- ANNOTATEEVERY 0.0000000D
- ANNOTATEEXPONENT 0S
- ANNOTATEMAJORTICKS 0S
- ANNOTATEORIENTATION 0S
- ANNOTATERANGEMAX 0S
- ANNOTATERANGEMIN 0S
- ANNOTATESTYLE 0S
- ANNOTATETEXTOBJECT obj_new()
- ANNOTATEUNITS 0S
- AUTOTICKS 0S
- BLACKLABELS 0S
- BOTTOMPLACEMENT 0S
- BOUNDFLOATING 0B
- BOUNDSCALING 0B
- DATEFORMAT1 0S
- DATEFORMAT2 0S
- DATESTRING1 ''
- DATESTRING2 ''
- EQUALXYSCALING 0B
- FIRSTANNOTATEUNITS 0S
- FIRSTANNOTATION 0.0000000D
- FIRSTTICKAT 0.0000000D
- FIRSTTICKAUTO 0S
- FIRSTTICKUNITS 0S
- FLOATINGCENTER 0S
- FLOATINGSPAN 0.0000000D
- ISTIMEAXIS 0S
- LABELS obj_new()
- LAZYLABELS 0S
- LAZYTITLES 0S
- LINEATZERO 0S
- LOGMINORTICKTYPE 0L
- MAJORGRID obj_new()
- MAJORLENGTH 0LL
- MAJORTICKAUTO 0S
- MAJORTICKEVERY 0.0000000D
- MAJORTICKUNITS 0S
- MARGIN 0L
- MAXBOUNDRANGE 0.0000000D
- MAXFIXEDRANGE 0.0000000D
- MAXFLOATRANGE 0.0000000D
- MINBOUNDRANGE 0.0000000D
- MINFIXEDRANGE 0.0000000D
- MINFLOATRANGE 0.0000000D
- MINORGRID obj_new()
- MINORLENGTH 0LL
- MINORTICKAUTO 0S
- MINORTICKEVERY 0.0000000D
- MINORTICKUNITS 0S
- NUMMAJORTICKS 0LL
- NUMMINORTICKS 0LL
- ORIENTATION 0S
- ORIGSETTINGS ptr_new()
- PLACEANNOTATION 0S
- PLACELABEL 0S
- PLACETITLE 0S
- RANGEMARGIN 0.0000000D
- RANGEOPTION 0S
- SCALING 0S
- SHOWDATE 0S
- SHOWLABELS 0B
- SHOWTITLE 0B
- STACKLABELS 0S
- SUBTITLEOBJ obj_new()
- TICKSTYLE 0S
- TITLEMARGIN 0S
- TITLEOBJ obj_new()
- TITLEORIENTATION 0S
- TOPPLACEMENT 0S
- TOUCHEDANNOTATERANGEMAX 0B
- TOUCHEDISTIMEAXIS 0B
- TOUCHEDLINEATZERO 0B
- TOUCHEDMAXBOUNDRANGE 0B
- TOUCHEDMAXFIXEDRANGE 0B
- TOUCHEDMINBOUNDRANGE 0B
- TOUCHEDMINFIXEDRANGE 0B
- TOUCHEDRANGEMARGIN 0B
- TOUCHEDRANGEOPTION 0B
- TOUCHEDSCALING 0B
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_axis_settings__define.pro
result = spd_ui_axis_settings::getTickSpacing()result = SPD_UI_AXIS_SETTINGS::Copy()result = SPD_UI_AXIS_SETTINGS::GetUnits()result = SPD_UI_AXIS_SETTINGS::GetUnit(index)result = SPD_UI_AXIS_SETTINGS::GetFloatingCenters()result = SPD_UI_AXIS_SETTINGS::GetFloatingCenter(index)result = SPD_UI_AXIS_SETTINGS::GetAnnotationFormats()result = SPD_UI_AXIS_SETTINGS::GetAnnotationFormat(index)result = SPD_UI_AXIS_SETTINGS::GetPlacements()result = SPD_UI_AXIS_SETTINGS::GetPlacement(index)result = SPD_UI_AXIS_SETTINGS::GetOrientations()result = SPD_UI_AXIS_SETTINGS::GetOrientation(index)result = SPD_UI_AXIS_SETTINGS::GetStyles()result = SPD_UI_AXIS_SETTINGS::GetStyle(index)result = SPD_UI_AXIS_SETTINGS::GetRangeOptions()result = SPD_UI_AXIS_SETTINGS::GetRangeOption(index)SPD_UI_AXIS_SETTINGS::UpdateRange, xRangeresult = spd_ui_axis_settings::getRange()result = SPD_UI_AXIS_SETTINGS::GetScalings()result = SPD_UI_AXIS_SETTINGS::GetScaling(index)result = SPD_UI_AXIS_SETTINGS::GetDateFormats()result = SPD_UI_AXIS_SETTINGS::GetDateFormat(index)result = SPD_UI_AXIS_SETTINGS::GetDateCommands()result = SPD_UI_AXIS_SETTINGS::GetDateCommand(index)result = SPD_UI_AXIS_SETTINGS::GetDateString(index, TimeObject=TimeObject)spd_ui_axis_settings::savespd_ui_axis_settings::resetSPD_UI_AXIS_SETTINGS::Cleanupresult = SPD_UI_AXIS_SETTINGS::Init(RangeOption=RangeOption, touchedRangeOption=touchedRangeOption, Scaling=Scaling, touchedScaling=touchedScaling, EqualXYScaling=EqualXYScaling, IsTimeAxis=IsTimeAxis, touchedIsTimeAxis=touchedIsTimeAxis, RangeMargin=RangeMargin, BoundScaling=BoundScaling, BoundFloating=BoundFloating, minFloatRange=minFloatRange, maxFloatRange=maxFloatRange, minBoundRange=minBoundRange, maxBoundRange=maxBoundRange, minFixedRange=minFixedRange, touchedMinFixedRange=touchedMinFixedRange, maxFixedRange=maxFixedRange, touchedMaxFixedRange=touchedMaxFixedRange, FloatingSpan=FloatingSpan, FloatingCenter=FloatingCenter, MajorTickEvery=MajorTickEvery, MinorTickEvery=MinorTickEvery, MajorTickUnits=MajorTickUnits, MinorTickUnits=MinorTickUnits, MajorTickAuto=MajorTickAuto, MinorTickAuto=MinorTickAuto, FirstTickAuto=FirstTickAuto, NumMajorTicks=NumMajorTicks, NumMinorTicks=NumMinorTicks, FirstTickAt=FirstTickAt, FirstTickUnits=FirstTickUnits, TickStyle=TickStyle, BottomPlacement=BottomPlacement, TopPlacement=TopPlacement, MajorLength=MajorLength, MinorLength=MinorLength, logMinorTickType=logMinorTickType, LineAtZero=LineAtZero, showdate=showdate, DateString1=DateString1, DateString2=DateString2, DateFormat1=DateFormat1, DateFormat2=DateFormat2, AnnotateAxis=AnnotateAxis, PlaceAnnotation=PlaceAnnotation, AnnotateMajorTicks=AnnotateMajorTicks, annotateEvery=annotateEvery, annotateUnits=annotateUnits, FirstAnnotation=FirstAnnotation, FirstAnnotateUnits=FirstAnnotateUnits, AnnotateRangeMin=AnnotateRangeMin, annotateRangeMax=annotateRangeMax, AnnotateStyle=AnnotateStyle, annotateOrientation=annotateOrientation, annotateTextObject=annotateTextObject, annotateExponent=annotateExponent, majorGrid=majorGrid, minorGrid=minorGrid, Orientation=Orientation, Margin=Margin, showLabels=showLabels, labels=labels, stackLabels=stackLabels, lazyLabels=lazyLabels, blackLabels=blackLabels, titleObj=titleObj, subtitleObj=subtitleObj, placeLabel=placeLabel, placeTitle=placeTitle, titleorientation=titleorientation, titlemargin=titlemargin, showtitle=showtitle, autoticks=autoticks, nosave=nosave)SPD_UI_AXIS_SETTINGS__DEFINE
Routine details
top source SPD_UI_AXIS_SETTINGS::GetUnit
result = SPD_UI_AXIS_SETTINGS::GetUnit(index)
Parameters
- index
top source SPD_UI_AXIS_SETTINGS::GetFloatingCenters
result = SPD_UI_AXIS_SETTINGS::GetFloatingCenters()
top source SPD_UI_AXIS_SETTINGS::GetFloatingCenter
result = SPD_UI_AXIS_SETTINGS::GetFloatingCenter(index)
Parameters
- index
top source SPD_UI_AXIS_SETTINGS::GetAnnotationFormats
result = SPD_UI_AXIS_SETTINGS::GetAnnotationFormats()
top source SPD_UI_AXIS_SETTINGS::GetAnnotationFormat
result = SPD_UI_AXIS_SETTINGS::GetAnnotationFormat(index)
Parameters
- index
top source SPD_UI_AXIS_SETTINGS::GetPlacement
result = SPD_UI_AXIS_SETTINGS::GetPlacement(index)
Parameters
- index
top source SPD_UI_AXIS_SETTINGS::GetOrientation
result = SPD_UI_AXIS_SETTINGS::GetOrientation(index)
Parameters
- index
top source SPD_UI_AXIS_SETTINGS::GetStyle
result = SPD_UI_AXIS_SETTINGS::GetStyle(index)
Parameters
- index
top source SPD_UI_AXIS_SETTINGS::GetRangeOption
result = SPD_UI_AXIS_SETTINGS::GetRangeOption(index)
Parameters
- index
top source SPD_UI_AXIS_SETTINGS::UpdateRange
SPD_UI_AXIS_SETTINGS::UpdateRange, xRange
Parameters
- xRange
top source SPD_UI_AXIS_SETTINGS::GetScaling
result = SPD_UI_AXIS_SETTINGS::GetScaling(index)
Parameters
- index
top source SPD_UI_AXIS_SETTINGS::GetDateFormat
result = SPD_UI_AXIS_SETTINGS::GetDateFormat(index)
Parameters
- index
top source SPD_UI_AXIS_SETTINGS::GetDateCommand
result = SPD_UI_AXIS_SETTINGS::GetDateCommand(index)
Parameters
- index
top source SPD_UI_AXIS_SETTINGS::GetDateString
result = SPD_UI_AXIS_SETTINGS::GetDateString(index, TimeObject=TimeObject)
Parameters
- index
Keywords
- TimeObject
top source SPD_UI_AXIS_SETTINGS::Init
result = SPD_UI_AXIS_SETTINGS::Init(RangeOption=RangeOption, touchedRangeOption=touchedRangeOption, Scaling=Scaling, touchedScaling=touchedScaling, EqualXYScaling=EqualXYScaling, IsTimeAxis=IsTimeAxis, touchedIsTimeAxis=touchedIsTimeAxis, RangeMargin=RangeMargin, BoundScaling=BoundScaling, BoundFloating=BoundFloating, minFloatRange=minFloatRange, maxFloatRange=maxFloatRange, minBoundRange=minBoundRange, maxBoundRange=maxBoundRange, minFixedRange=minFixedRange, touchedMinFixedRange=touchedMinFixedRange, maxFixedRange=maxFixedRange, touchedMaxFixedRange=touchedMaxFixedRange, FloatingSpan=FloatingSpan, FloatingCenter=FloatingCenter, MajorTickEvery=MajorTickEvery, MinorTickEvery=MinorTickEvery, MajorTickUnits=MajorTickUnits, MinorTickUnits=MinorTickUnits, MajorTickAuto=MajorTickAuto, MinorTickAuto=MinorTickAuto, FirstTickAuto=FirstTickAuto, NumMajorTicks=NumMajorTicks, NumMinorTicks=NumMinorTicks, FirstTickAt=FirstTickAt, FirstTickUnits=FirstTickUnits, TickStyle=TickStyle, BottomPlacement=BottomPlacement, TopPlacement=TopPlacement, MajorLength=MajorLength, MinorLength=MinorLength, logMinorTickType=logMinorTickType, LineAtZero=LineAtZero, showdate=showdate, DateString1=DateString1, DateString2=DateString2, DateFormat1=DateFormat1, DateFormat2=DateFormat2, AnnotateAxis=AnnotateAxis, PlaceAnnotation=PlaceAnnotation, AnnotateMajorTicks=AnnotateMajorTicks, annotateEvery=annotateEvery, annotateUnits=annotateUnits, FirstAnnotation=FirstAnnotation, FirstAnnotateUnits=FirstAnnotateUnits, AnnotateRangeMin=AnnotateRangeMin, annotateRangeMax=annotateRangeMax, AnnotateStyle=AnnotateStyle, annotateOrientation=annotateOrientation, annotateTextObject=annotateTextObject, annotateExponent=annotateExponent, majorGrid=majorGrid, minorGrid=minorGrid, Orientation=Orientation, Margin=Margin, showLabels=showLabels, labels=labels, stackLabels=stackLabels, lazyLabels=lazyLabels, blackLabels=blackLabels, titleObj=titleObj, subtitleObj=subtitleObj, placeLabel=placeLabel, placeTitle=placeTitle, titleorientation=titleorientation, titlemargin=titlemargin, showtitle=showtitle, autoticks=autoticks, nosave=nosave)
Keywords
- RangeOption
- touchedRangeOption
- Scaling
- touchedScaling
- EqualXYScaling
- IsTimeAxis
- touchedIsTimeAxis
- RangeMargin
- BoundScaling
- BoundFloating
- minFloatRange
- maxFloatRange
- minBoundRange
- maxBoundRange
- minFixedRange
- touchedMinFixedRange
- maxFixedRange
- touchedMaxFixedRange
- FloatingSpan
- FloatingCenter
- MajorTickEvery
- MinorTickEvery
- MajorTickUnits
- MinorTickUnits
- MajorTickAuto
- MinorTickAuto
- FirstTickAuto
- NumMajorTicks
- NumMinorTicks
- FirstTickAt
- FirstTickUnits
- TickStyle
- BottomPlacement
- TopPlacement
- MajorLength
- MinorLength
- logMinorTickType
- LineAtZero
- showdate
- DateString1
- DateString2
- DateFormat1
- DateFormat2
- AnnotateAxis
- PlaceAnnotation
- AnnotateMajorTicks
- annotateEvery
- annotateUnits
- FirstAnnotation
- FirstAnnotateUnits
- AnnotateRangeMin
- annotateRangeMax
- AnnotateStyle
- annotateOrientation
- annotateTextObject
- annotateExponent
- majorGrid
- minorGrid
- Orientation
- Margin
- showLabels
- labels
- stackLabels
- lazyLabels
- blackLabels
- titleObj
- subtitleObj
- placeLabel
- placeTitle
- titleorientation
- titlemargin
- showtitle
- autoticks
- nosave
File attributes
| Modification date: | Thu Feb 13 16:41:39 2014 |
| Lines: | 608 |