Graph2D Object


Possible Containment

$$GraphSheet$Graph2D

Properties

Property Name: Description: Optional/Required: Default Value: Data Type: Allowable Values/Range:
AspectRatio Aspect Ratio Optional Auto character Auto, Fill Plot Area, Banking, Proportional Units, Ray From Origin, Ray From (0,0)
AxesBorderColor Color Optional Black character Black, Blue, Green, Cyan, Red, Magenta, Brown, Lt Gray, Dark Gray, Lt Blue, Lt Green, Lt Cyan, Lt Red, Lt Magenta, Yellow, Bright White, Transparent, User1, User2, User3, User4, User5, User6, User7, User8, User9, User10, User11, User12, User13, User14, User15, User16
AxesBorderStyle Style Optional None character None, Solid, Dots, Dot Dash, Short Dash, Long Dash, Dot Dot Dash, Alt Dash, Med Dash, Tiny Dash
AxesBorderWeight Weight Optional 1 character Hairline, 1/4, 1/3, 1/2, 1, 2, 3, 4, 5, 6, 8, 10, 12
AxesFillColor Fill Color Optional Transparent character Black, Blue, Green, Cyan, Red, Magenta, Brown, Lt Gray, Dark Gray, Lt Blue, Lt Green, Lt Cyan, Lt Red, Lt Magenta, Yellow, Bright White, Transparent, User1, User2, User3, User4, User5, User6, User7, User8, User9, User10, User11, User12, User13, User14, User15, User16
AxesFillPattern Fill Pattern Optional Empty character Empty, :::, / /, ///, \ \, \\\, X X, xxx, ___, ===, | |, |||, [], +++
AxesPatternColor Pattern Color Optional Lt Gray character Black, Blue, Green, Cyan, Red, Magenta, Brown, Lt Gray, Dark Gray, Lt Blue, Lt Green, Lt Cyan, Lt Red, Lt Magenta, Yellow, Bright White, Transparent, User1, User2, User3, User4, User5, User6, User7, User8, User9, User10, User11, User12, User13, User14, User15, User16
BankingRatio Ratio Value Optional Auto character Auto
ConditionColumns Column List Optional character
ConditionDataSetValues Optional character
ConditionDataSetValuesShdw Condition Data Optional character
ConditionGraph Condition Graph Optional F character
ConditioningVars Column List Synonym character
ConditionType Type Optional Auto character Auto, Discrete, Continuous
ConditionValues Optional character
ConditionValuesShdw Condition Data Optional character
CreatePlotDataArray Create Plot Data Array Optional F character
DisplayHeight Height Optional 8.1 numeric 0.5:99
DisplayWidth Width Optional 10.6 numeric 0.5:99
DrawStrip Draw Strip Optional T logical T, F
FractionOfSharedPoints Frac. Shared Pts. Optional 0 numeric
GraphBorderColor Color Optional Black character Black, Blue, Green, Cyan, Red, Magenta, Brown, Lt Gray, Dark Gray, Lt Blue, Lt Green, Lt Cyan, Lt Red, Lt Magenta, Yellow, Bright White, Transparent, User1, User2, User3, User4, User5, User6, User7, User8, User9, User10, User11, User12, User13, User14, User15, User16
GraphBorderStyle Style Optional None character None, Solid, Dots, Dot Dash, Short Dash, Long Dash, Dot Dot Dash, Alt Dash, Med Dash, Tiny Dash
GraphBorderWeight Weight Optional 1 character Hairline, 1/4, 1/3, 1/2, 1, 2, 3, 4, 5, 6, 8, 10, 12
GraphFillColor Fill Color Optional Transparent character Black, Blue, Green, Cyan, Red, Magenta, Brown, Lt Gray, Dark Gray, Lt Blue, Lt Green, Lt Cyan, Lt Red, Lt Magenta, Yellow, Bright White, Transparent, User1, User2, User3, User4, User5, User6, User7, User8, User9, User10, User11, User12, User13, User14, User15, User16
GraphFillPattern Fill Pattern Optional Empty character Empty, :::, / /, ///, \ \, \\\, X X, xxx, ___, ===, | |, |||, [], +++
GraphPatternColor Pattern Color Optional Lt Gray character Black, Blue, Green, Cyan, Red, Magenta, Brown, Lt Gray, Dark Gray, Lt Blue, Lt Green, Lt Cyan, Lt Red, Lt Magenta, Yellow, Bright White, Transparent, User1, User2, User3, User4, User5, User6, User7, User8, User9, User10, User11, User12, User13, User14, User15, User16
Height Height Optional Auto character Auto
Hide Hide Optional F logical T, F
HorizMarginValues Optional character
HorizMarginValuesShdw Condition Data Optional character
HorizontalMargin Horiz. Margin Optional Auto character Auto
HorizontalShift Horizontal Optional 0.2 numeric 0:99999
InteriorMarginX X Margin Optional Auto character Auto
InteriorMarginY Y Margin Optional Auto character Auto
IntervalType Interval Type Optional Equal Counts character Equal Counts, Equal Ranges, Columns of Ranges
LowerRangeColumn Lower Range Col. Optional character
LowerRangeValues Optional character
LowerRangeValuesShdw Condition Data Optional character
NewIndex Object Index Optional -1 character
NewName Name Optional character
NumberOfPages # of Pages Optional Auto character Auto
NumberOfPanelColumns # of Columns Optional Auto character Auto
NumberOfPanelRows # of Rows Optional Auto character Auto
NumberOfPanels # of Panels Optional 4 character
PanelBordersColor Color Optional Black character Black, Blue, Green, Cyan, Red, Magenta, Brown, Lt Gray, Dark Gray, Lt Blue, Lt Green, Lt Cyan, Lt Red, Lt Magenta, Yellow, Bright White, Transparent, User1, User2, User3, User4, User5, User6, User7, User8, User9, User10, User11, User12, User13, User14, User15, User16
PanelBordersStyle Style Optional Solid character None, Solid, Dots, Dot Dash, Short Dash, Long Dash, Dot Dot Dash, Alt Dash, Med Dash, Tiny Dash
PanelBordersWeight Weight Optional Hairline character Hairline, 1/4, 1/3, 1/2, 1, 2, 3, 4, 5, 6, 8, 10, 12
PanelFillsColor Fill Color Optional Transparent character Black, Blue, Green, Cyan, Red, Magenta, Brown, Lt Gray, Dark Gray, Lt Blue, Lt Green, Lt Cyan, Lt Red, Lt Magenta, Yellow, Bright White, Transparent, User1, User2, User3, User4, User5, User6, User7, User8, User9, User10, User11, User12, User13, User14, User15, User16
PanelFillsPattern Fill Pattern Optional Empty character Empty, :::, / /, ///, \ \, \\\, X X, xxx, ___, ===, | |, |||, [], +++
PanelHorizMarginColumn Horiz. Marg. Col. Optional character
PanelOrder Panel Order Optional Graph Order character Graph Order, Table Order
PanelOrderColumn Panel Order Col. Optional character
PanelOrderType Order Type Optional Data character Data, Alphabetical, Median of X, Median of Y, Median of Z, Median of W, Mean of X, Mean of Y, Mean of Z, Mean of W
PanelOrderValues Optional character
PanelOrderValuesShdw Condition Data Optional character
PanelPatternColor Pattern Color Optional Lt Gray character Black, Blue, Green, Cyan, Red, Magenta, Brown, Lt Gray, Dark Gray, Lt Blue, Lt Green, Lt Cyan, Lt Red, Lt Magenta, Yellow, Bright White, Transparent, User1, User2, User3, User4, User5, User6, User7, User8, User9, User10, User11, User12, User13, User14, User15, User16
PanelSkipColumn Skip Column Optional character
PanelType Panel Type Optional None character None, Condition, By Plot
PanelVertMarginColumn Vert. Marg. Col. Optional character
RayXValue X Value Optional 0 numeric
RayYValue Y Value Optional 0 numeric
Rotate3DAxes Rotate 3D Axes Optional F logical T, F
SkipValues Optional character
SkipValuesShdw Condition Data Optional character
TrellisConditionDS Data Set Optional character
UpperRangeColumn Upper Range Col. Optional character
UpperRangeValues Optional character
UpperRangeValuesShdw Condition Data Optional character
VerticalMargin Vertical Margin Optional Auto character Auto
VerticalShift Vertical Optional 0.2 numeric 0:99999
VertMarginValues Optional character
VertMarginValuesShdw Condition Data Optional character
Width Width Optional Auto character Auto
xPlotOrigin X Optional Auto character Auto
yPlotOrigin Y Optional Auto character Auto

Methods

Method Name: Description: Syntax:
BeginTransaction Starts remembering property set calls so changes can be applied on CommitTransaction.
Function BeginTransaction(  ) as Boolean
CancelTransaction Cancels remembering property set calls made after last call to BeginTransaction.
Function CancelTransaction(  ) as Boolean
ClassName Returns the class name (i.e. 'Arrow') of this object.
Function ClassName(  ) as Variant
CommitTransaction Commits all property changes made since last call to BeginTransaction.
Function CommitTransaction(  ) as Boolean
Containees Returns array of objects of class specified contained by this object.
Function Containees( ObjectClassToFind as Variant ) as Variant
Container Returns the container object of this object.
Function Container(  ) as Object
CreateObject Creates an object or a child object of a particular type.
Function CreateObject( ObjectClassName as Variant ) as Object
GetMethodArgumentNames Returns an array of argument names including the ReturnValue (if any) for a given method name for this object.
Function GetMethodArgumentNames( MethodName as Variant ) as Variant
GetMethodArgumentTypes Returns an array of argument types including the ReturnValue type (if any) for a given method name for this object. Specify the LanguageType (i.e. BASIC or C) so strings are appropriate for language.
Function GetMethodArgumentTypes( MethodName as Variant, LanguageType as Variant ) as Variant
GetMethodHelpString Returns the help string for a given method name for this object.
Function GetMethodHelpString( MethodName as Variant ) as Variant
GetObject Gets an object or a child object of the class name specified, identified by an object path name.
Function GetObject( ObjectClassName as Variant, ObjectPathName as Variant ) as Object
GetObjectPicture Returns array of byte values representing the metafile picture of the object. Returns empty variant if unsuccessful.
Function GetObjectPicture(  ) as Variant
GetObjectRectangle Returns rectangle that contains this object in client or screen coordinates depending on ReturnClientCoordsIfTrue. Returns empty variant if unsuccessful.
Function GetObjectRectangle( ReturnClientCoordsIfTrue as Boolean ) as Variant
GetPropertyAllowedValues Returns an array of allowable values for the specified property of this object.
Function GetPropertyAllowedValues( PropertyName as Variant ) as Variant
GetPropertyInformation Returns an array of property information including default value and allowable values for the specified property of this object.
Function GetPropertyInformation( PropertyName as Variant ) as Variant
GetSelectedObjects Returns array of objects which are selected of class specified contained by this object. StartIndex and EndIndex can be used to return subsets of selected objects.
Function GetSelectedObjects( ObjectClassToFind as String, StartIndex as Long, EndIndex as Long ) as Variant
GetSelectedText Returns the selected text as a string if any in this object. If this object has no selected text, an empty string is returned.
Function GetSelectedText(  ) as String
Methods Returns comma delimited list of methods which can be called on this object.
Function Methods(  ) as Variant
MethodsList Returns an array of method names which can be called on this object.
Function MethodsList(  ) as Variant
Objects If 'CONTAINEES', returns comma delimited list of objects which can be contained by this object. If 'CONTAINER', returns list of containers for this object.
Function Objects( ObjectHierarchyType as Variant ) as Variant
ObjectsList If 'CONTAINEES', returns an array of object names which can be contained by this object. If 'CONTAINER', returns an array of container object names for this object.
Function ObjectsList( ObjectHierarchyType as Variant ) as Variant
PathName Returns the path name in the S-PLUS project space (i.e. '$$GS1$Arrow1') of this object.
Function PathName(  ) as Variant
Properties Returns comma delimited list of properties for this object.
Function Properties(  ) as Variant
PropertiesList Returns an array of property names for this object.
Function PropertiesList(  ) as Variant
RemoveObject Removes a child object from this container object.
Function RemoveObject( Object as Object ) as Boolean
SelectObject Selects this object in all views. SelectionType is 'add', 'new', or 'remove' to control how object is selected. Returns TRUE if successful or FALSE if not.
Function SelectObject( SelectionType as String ) as Boolean
ShowDialog Displays object property dialog.
Function ShowDialog(  ) as Boolean
ShowDialogInParent Displays object property dialog using the HWND parameter passed as its parent.
Function ShowDialogInParent( ParentWindowHWND as Variant ) as Boolean
ShowDialogInParentModeless Displays object property dialog modelessly using the HWND parameter passed as its parent.
Function ShowDialogInParentModeless( ParentWindowHWND as Variant ) as Boolean

Containers

Possible parent objects:
GraphSheet

Children

Possible child objects:
Arc
AreaPlot
Arrow
Axis2dX
Axis2dY
AxisX
AxisY
AxisZ
BarPlot
Box
BoxPlot
Comment
CommentDate
CommentPlot
ContourPlot
DataSpec
DateStamp
Ellipse
ErrorBar
ErrorBarPlot
HiLowPlot
Histogram
Legend
Line
LinearCFPlot
LinePlot
MainTitle
NonlinearCFPlot
Overlay
PanelStrips
ParetoPlot
Plot
PPPlot
QQPlot
Radius
ReferenceLine
Subtitle
Symbol
VectorPlot