GraphSheet Object


Possible Containment

$$GraphSheet

Properties

Property Name: Description: Optional/Required: Default Value: Data Type: Allowable Values/Range:
AutoArrange Auto Arrange Optional Two Across character None, One Across, Two Across, Three Across, Four Across, Overlaid
AutoPageMode Page Creation Optional Auto character Auto, Off, Every Graph, Within Expression
AutoRedrawPlots Auto Redraw Plots Optional T logical T, F
BottomOffset Bottom Offset Optional 0.2 numeric 0:99999
CharacterSpacing Char. Spacing Optional 0 character 0:10
ColorTable User Colors Optional 0,0,0|0,192,192|192,0,192|0,192,0|192,128,0|0,128,192|192,192,0|255,0,0|198,255,255|255,195,255|200,255,200|255,209,143|169,226,255|255,255,195|255,140,138|110,110,100 character
CommandFont1 Font 1 Optional Arial character
CommandFont2 Font 2 Optional Times New Roman character
CommandFont3 Font 3 Optional Courier New character
CommandFont4 Font 4 Optional Tahoma character
CommandFont5 Font 5 Optional Modern character
CommandFont6 Font 6 Optional MS Sans Serif character
CommandFont7 Font 7 Optional Script character
CommandFont8 Font 8 Optional Symbol character
CommandMode Mode Optional Auto character Auto, Fast, Editable
CurrentPage Current Page Optional character
DisplayMargins Display Margins Optional F logical T, F
Font1 Font 1 Optional Symbol character
Font2 Font 2 Optional Times New Roman character
Font3 Font 3 Optional Century Schoolbook character
Font4 Font 4 Optional Wingdings character
GraphSheetColor Color Optional Bright White 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 Window Height Optional Auto character Auto
HeightMultiplier Ht. Multiplier Optional 0.75 numeric 0:4
Hide Hide Optional F character
HorizSpacing Horiz. Spacing Optional 0.2 numeric 0:9999
ImageColorTable Image Colors Optional 255,0,255|255,255,255|255,255,255|0,255,255|255,255,255|255,255,255|255,255,255|255,255,255|255,255,255|255,255,255|255,255,255|255,255,255|255,255,255|255,255,255|255,255,255|255,255,255 character
LastActivePage Last Active Page Optional character
Left Window Left Optional Auto character Auto
LeftOffset Left Offset Optional 0.2 numeric 0:99999
ModifiedFlag Modified Optional 0 character
NewIndex Object Index Optional -1 character
NewName Name Optional character
NumImageColors # of Colors Optional 4 numeric
NumImageShades # of Shades Optional 48,0,48 character
OLETypeName OLE Type Name Optional SPLUSGraphSheetFileType character
PageHeight Height Optional 8.5 character Printer
PageOrientation Orientation Optional Landscape character Portrait, Landscape
PageWidth Width Optional 11 character Printer
PrintBackground Print Background Optional F logical T, F
PrintBottomMargin Bottom Margin Optional 0 character Printer
PrintLeftMargin Left Margin Optional 0 character Printer
PrintRightMargin Right Margin Optional 0 character Printer
PrintTopMargin Top Margin Optional 0 character Printer
RightOffset Right Offset Optional 0.2 numeric 0:99999
SetRedraw Set Redraw Optional T character
ShiftMultiplier Shift Multiplier Optional 0.6 numeric 0:4
Show Show Window Optional Normal character Normal, Maximized, Minimized, FullScreen
Top Window Top Optional Auto character Auto
TopOffset Top Offset Optional 0.2 numeric 0:99999
Units Units Optional INCH character INCH, CM, MM, POINT,
VerticalSpacing Vertical Spacing Optional 0.2 numeric 0:9999
Width Window Width 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
ChooseGraphAndPlotType Displays a chooser dialog allowing selection of a graph type and plot type. Returns the strings selected from the lists.
Function ChooseGraphAndPlotType( GraphType as ByRef Variant, PlotType as ByRef Variant, hWndParent as Long ) 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
CreateConditionedPlots Create plots conditioned on data columns in the graphsheet.
Function CreateConditionedPlots( AxisType as String, PlotType as String, NumberOfConditioningVariables as Long, Data as Variant, DataColumnNames as Variant ) as Boolean
CreateConditionedPlotsGallery Create plots conditioned on data columns in the graphsheet which are selected from a gallery of plot types.
Function CreateConditionedPlotsGallery( NumberOfConditioningVariables as Long, hWndParent as Long, Data as Variant, DataColumnNames as Variant ) as Boolean
CreateConditionedPlotsSeparateData Create plots conditioned on data columns in the graphsheet.
Function CreateConditionedPlotsSeparateData( AxisType as String, PlotType as String, Data as Variant, ConditioningData as Variant, DataColumnNames as Variant, ConditioningDataColumnNames as Variant ) as Boolean
CreateConditionedPlotsSeparateDataGallery Create plots conditioned on data columns in the graphsheet.
Function CreateConditionedPlotsSeparateDataGallery( hWndParent as Long, Data as Variant, ConditioningData as Variant, DataColumnNames as Variant, ConditioningDataColumnNames as Variant ) as Boolean
CreateObject Creates an object or a child object of a particular type.
Function CreateObject( ObjectClassName as Variant ) as Object
CreatePlots Create plots on graphsheet.
Function CreatePlots( AxisType as String, PlotType as String, Data as Variant, DataColumnNames as Variant ) as Boolean
CreatePlotsGallery Create plots on graphsheet selected from a gallery of plot types.
Function CreatePlotsGallery( hWndParent as Long, Data as Variant, DataColumnNames as Variant ) as Boolean
ExecuteStringResult Executes valid S-PLUS syntax and returns result as string. Second parameter controls how result is formatted. Use '%GSNAME%' in syntax to get graphsheet name.
Function ExecuteStringResult( ExecuteResult as ByRef Variant, StringToExecute as String, UseOlderResultFormatting as Boolean ) as Boolean
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:
Application

Children

Possible child objects:
Arc
Arrow
Box
Comment
CommentDate
CompositeObject
DateStamp
Ellipse
ErrorBar
Graph
Graph2D
Graph3D
GraphMatrix
GraphPolar
GraphSheetPage
GraphSmith
Line
Overlay
Radius
Symbol
TextGraph