![[attach.png]](../../../idldoc-resources/attach.png)
spedas/gui/objects/
spd_ui_legend__define.pro
Class description for SPD_UI_LEGEND
Inheritance
Properties
Properties in spd_ui_getset
- _extra set
- _ref_extra get
Properties in SPD_UI_LEGEND
- _extra set
- bValue init
- bgcolor init
- bordercolor init
- bottom init
- bunit set init
- color init
- enabled init
- font init
- format init
- framethickness init
- hValue init
- height init
- hunit set init
- lValue init
- left init
- lunit set init
- numFormat init
- size init
- timeFormat init
- traces set
- vspacing init
- wValue init
- width init
- wunit set init
- xAxisValEnabled init
- xAxisValue init
- xIsTime init
- yAxisValEnabled init
- yAxisValue init
- yIsTime init
- zIsTime init
Fields
Fields in SPD_UI_READWRITE
- __DUMMY 0S
Fields in spd_ui_getset
- ___DUMMY 0S
Fields in SPD_UI_LEGEND
- BGCOLOR [0S, 0S, 0S]
- BORDERCOLOR [0S, 0S, 0S]
- BOTTOM 0.00000
- BUNIT 0S
- BVALUE 0.0000000D
- COLOR [0S, 0S, 0S]
- CUSTOMTRACESSET 0S
- ENABLED 0S
- FONT 0S
- FORMAT 0S
- FRAMETHICKNESS 0S
- HEIGHT 0.00000
- HUNIT 0S
- HVALUE 0.0000000D
- LEFT 0.00000
- LUNIT 0S
- LVALUE 0.0000000D
- NOTATIONSET 0S
- NUMFORMAT 0S
- SIZE 0S
- TIMEFORMAT 0S
- TRACES ptr_new()
- VSPACING 0S
- WIDTH 0.00000
- WUNIT 0S
- WVALUE 0.0000000D
- XAXISVALENABLED 0S
- XAXISVALUE ''
- XISTIME 0S
- YAXISVALENABLED 0S
- YAXISVALUE ''
- YISTIME 0S
- ZISTIME 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_legend__define.pro
SPD_UI_LEGEND::CleanupNAME: spd_ui_legend__define PURPOSE: Basic legend settings object CALLING SEQUENCE: legend = Obj_New('SPD_UI_LEGEND') INPUT: none KEYWORDS: enabled: flag for disable/enabling the legend font: index of legend font type - font types are from the getFonts method in spd_ui_text size: size of legend text format: legend font formats ('bold', 'italic', etc..) color: color of legend text vspacing: vertical spacing between lines in legend bgcolor: background color of legend framethickness: thickness of frame around legend bordercolor: color of frame around legend bottom: flag indicating whether explicit positioning is used bValue: numerical value of the explicit position (bottom) bUnit: bottom units - 0=pt, 1=in, 2=cm, 3=mm, units of numerical value left: flag indicating whether explicit positioning is used lValue: numerical value of the explicit position (left) lUnit: 'left' units width: flag indicating whether explicit positioning is used wValue: numerical value of the explicit position (width) wUnit: 'width' units height: flag indicating whether explicit positioning is used hValue: numerical value of the explicit position (height) hUnit: 'height' units xAxisValue: X-axis value xAxisValEnabled: enable/disable showing x-axis value on legend yAxisValue: Y-axis value yAxisValEnabled: enable/disable showing y-axis value on legend traces: pointer to traces customTracesset: 0=no custom traces set for this panel, 1=custom traces are set xIsTime: flag indicating whether X-axis is time yIsTime: flag indicating whether Y-axis is time zIsTime: flag indicating whether Z-axis is time notationSet: 0 = auto-notation, 1=decimal notation, 2=scientific notation, 4=hexadecimal notation timeFormat: index of format for dates/times in legend, default is h:m:s.ms numformat: index of format for numerical values shown in legend$LastChangedBy: egrimes $$LastChangedDate: 2014-06-12 08:22:12 -0700 (Thu, 12 Jun 2014) $$LastChangedRevision: 15354 $$URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas/gui/objects/spd_ui_legend__define.pro $
SPD_UI_LEGEND::Disableresult = SPD_UI_LEGEND::Copy()SPD_UI_LEGEND::axisIsTime, axisSPD_UI_LEGEND::CopyContents, toLegendSettingsresult = SPD_UI_LEGEND::BackupSettings(origlegendSettings)result = SPD_UI_LEGEND::RestoreBackup(origlegendSettings)SPD_UI_LEGEND::setProperty, bunit=bunit, lunit=lunit, wunit=wunit, hunit=hunit, traces=traces, _extra=_extraSPD_UI_LEGEND::ResetPlacement, bunit=bunit, lunit=lunit, wunit=wunit, hunit=hunitSPD_UI_LEGEND::UpdateTraces, newStructresult = SPD_UI_LEGEND::GetUnitNames()result = SPD_UI_LEGEND::GetUnitName(index)result = SPD_UI_LEGEND::ConvertUnit(value, oldunit, newunit)result = SPD_UI_LEGEND::Init(enabled=enabled, font=font, size=size, format=format, color=color, vspacing=vspacing, bgcolor=bgcolor, framethickness=framethickness, bordercolor=bordercolor, bottom=bottom, left=left, width=width, height=height, bValue=bValue, lValue=lValue, wValue=wValue, hValue=hValue, bUnit=bUnit, lUnit=lUnit, wUnit=wUnit, hUnit=hUnit, xAxisValue=xAxisValue, xAxisValEnabled=xAxisValEnabled, yAxisValue=yAxisValue, yAxisValEnabled=yAxisValEnabled, xIsTime=xIsTime, yIsTime=yIsTime, zIsTime=zIsTime, timeFormat=timeFormat, numFormat=numFormat)SPD_UI_LEGEND__DEFINE
Routine details
top source SPD_UI_LEGEND::Cleanup
SPD_UI_LEGEND::Cleanup
NAME: spd_ui_legend__define PURPOSE: Basic legend settings object CALLING SEQUENCE: legend = Obj_New('SPD_UI_LEGEND') INPUT: none KEYWORDS: enabled: flag for disable/enabling the legend font: index of legend font type - font types are from the getFonts method in spd_ui_text size: size of legend text format: legend font formats ('bold', 'italic', etc..) color: color of legend text vspacing: vertical spacing between lines in legend bgcolor: background color of legend framethickness: thickness of frame around legend bordercolor: color of frame around legend bottom: flag indicating whether explicit positioning is used bValue: numerical value of the explicit position (bottom) bUnit: bottom units - 0=pt, 1=in, 2=cm, 3=mm, units of numerical value left: flag indicating whether explicit positioning is used lValue: numerical value of the explicit position (left) lUnit: 'left' units width: flag indicating whether explicit positioning is used wValue: numerical value of the explicit position (width) wUnit: 'width' units height: flag indicating whether explicit positioning is used hValue: numerical value of the explicit position (height) hUnit: 'height' units xAxisValue: X-axis value xAxisValEnabled: enable/disable showing x-axis value on legend yAxisValue: Y-axis value yAxisValEnabled: enable/disable showing y-axis value on legend traces: pointer to traces customTracesset: 0=no custom traces set for this panel, 1=custom traces are set xIsTime: flag indicating whether X-axis is time yIsTime: flag indicating whether Y-axis is time zIsTime: flag indicating whether Z-axis is time notationSet: 0 = auto-notation, 1=decimal notation, 2=scientific notation, 4=hexadecimal notation timeFormat: index of format for dates/times in legend, default is h:m:s.ms numformat: index of format for numerical values shown in legend $LastChangedBy: egrimes $ $LastChangedDate: 2014-06-12 08:22:12 -0700 (Thu, 12 Jun 2014) $ $LastChangedRevision: 15354 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas/gui/objects/spd_ui_legend__define.pro $
top source SPD_UI_LEGEND::CopyContents
SPD_UI_LEGEND::CopyContents, toLegendSettings
Parameters
- toLegendSettings
top source SPD_UI_LEGEND::BackupSettings
result = SPD_UI_LEGEND::BackupSettings(origlegendSettings)
Parameters
- origlegendSettings
top source SPD_UI_LEGEND::RestoreBackup
result = SPD_UI_LEGEND::RestoreBackup(origlegendSettings)
Parameters
- origlegendSettings
top source SPD_UI_LEGEND::setProperty
SPD_UI_LEGEND::setProperty, bunit=bunit, lunit=lunit, wunit=wunit, hunit=hunit, traces=traces, _extra=_extra
Keywords
- bunit
- lunit
- wunit
- hunit
- traces
- _extra
top source SPD_UI_LEGEND::ResetPlacement
SPD_UI_LEGEND::ResetPlacement, bunit=bunit, lunit=lunit, wunit=wunit, hunit=hunit
Keywords
- bunit
- lunit
- wunit
- hunit
top source SPD_UI_LEGEND::ConvertUnit
result = SPD_UI_LEGEND::ConvertUnit(value, oldunit, newunit)
Parameters
- value
- oldunit
- newunit
top source SPD_UI_LEGEND::Init
result = SPD_UI_LEGEND::Init(enabled=enabled, font=font, size=size, format=format, color=color, vspacing=vspacing, bgcolor=bgcolor, framethickness=framethickness, bordercolor=bordercolor, bottom=bottom, left=left, width=width, height=height, bValue=bValue, lValue=lValue, wValue=wValue, hValue=hValue, bUnit=bUnit, lUnit=lUnit, wUnit=wUnit, hUnit=hUnit, xAxisValue=xAxisValue, xAxisValEnabled=xAxisValEnabled, yAxisValue=yAxisValue, yAxisValEnabled=yAxisValEnabled, xIsTime=xIsTime, yIsTime=yIsTime, zIsTime=zIsTime, timeFormat=timeFormat, numFormat=numFormat)
Keywords
- enabled
- font
- size
- format
- color
- vspacing
- bgcolor
- framethickness
- bordercolor
- bottom
- left
- width
- height
- bValue
- lValue
- wValue
- hValue
- bUnit
- lUnit
- wUnit
- hUnit
- xAxisValue
- xAxisValEnabled
- yAxisValue
- yAxisValEnabled
- xIsTime
- yIsTime
- zIsTime
- timeFormat
- numFormat
File attributes
| Modification date: | Tue Oct 21 13:53:42 2014 |
| Lines: | 232 |