LegendItem Object


Possible Containment

$$GraphSheet$Graph2D$Legend$LegendItem
$$GraphSheet$Graph3D$Legend$LegendItem
$$GraphSheet$GraphMatrix$Legend$LegendItem
$$GraphSheet$GraphPolar$Legend$LegendItem
$$GraphSheet$GraphSmith$Legend$LegendItem
$$GraphSheet$TextGraph$Legend$LegendItem

Properties

Property Name: Description: Optional/Required: Default Value: Data Type: Allowable Values/Range:
AutoUpdate Override auto legend item specs Optional F logical T, F
AutoUpdateFill Override auto legend item specs Optional F logical T, F
AutoUpdateSymbol Override auto legend item specs Optional F logical T, F
Bold Bold Optional F logical T, F
BorderColor 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
BorderStyle Style Optional None character None, Solid, Dots, Dot Dash, Short Dash, Long Dash, Dot Dot Dash, Alt Dash, Med Dash, Tiny Dash
BorderWeight Weight Optional 1/4 character Hairline, 1/4, 1/3, 1/2, 1, 2, 3, 4, 5, 6, 8, 10, 12
BreakAtSymbols Break at Symbols Optional T logical T, F
FillColor 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
FillPattern Fill Pattern Optional Empty character Empty, :::, / /, ///, \ \, \\\, X X, xxx, ___, ===, | |, |||, [], +++
Font Font Optional Arial character
FontColor 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
Hide Hide Optional F logical T, F
Italics Italics Optional F logical T, F
LineColor Color Optional Red 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
LineStyle Style Optional None character None, Solid, Dots, Dot Dash, Short Dash, Long Dash, Dot Dot Dash, Alt Dash, Med Dash, Tiny Dash
LineWeight Weight Optional 1 character Hairline, 1/4, 1/3, 1/2, 1, 2, 3, 4, 5, 6, 8, 10, 12
NewIndex Object Index Optional -1 character
NewName Name Optional character
PatternColor Pattern 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
SymbolBold Bold Optional F logical T, F
SymbolColor Color Optional Blue 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
SymbolFont Font Optional Arial character
SymbolHeight Height Optional 0.1 numeric
SymbolItalics Italics Optional F logical T, F
SymbolLineWeight Line Weight Optional 1/2 character Hairline, 1/4, 1/3, 1/2, 1, 2, 3, 4, 5, 6, 8, 10, 12
SymbolStyle Style Optional Box + character None, Circle, Solid, Circle, Empty, Box, Solid, Box, Empty, Triangle, Up, Solid, Triangle, Dn, Solid, Triangle, Up, Empty, Triangle, Dn, Empty, Diamond, Solid, Diamond, Empty, Plus, Cross, Ant, X, -, |, Box X, Plus X, Diamond X, Circle X, Box +, Diamond +, Circle +, Tri. Up Down, Tri. Up Box, Tri. Dn Box, Female, Male
SymbolText Symbol Text Optional character
SymbolUnderline Underline Optional F logical T, F
Text Text Optional @Auto character
Underline Underline Optional F logical T, F
UseTextAsSymbol Use Text As Symbol Optional F logical T, F

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:
Legend

Children