GRAPH2

External objects

Properties

Property Description
$3d If true, the graph has a 3d appearance
$3ddepth Specifies the 3d depth (-1=Default)
$angularcolor Color of the angular grid
$angulardegrees The start & end degrees [separated by a comma] of an angular meter
$angularlabelson If true labels will be shown on the angular axis
$angularpositionh The percentage position of the horizontal start of the angular meter
$angularpositionv The percentage position of the vertical start of the angular meter
$angularwidth Width of the angular grid
$axiswidth The width of the axis
$backgroundborder The border color of the background
$backgroundcolor The color of the background
$backgroundeffect The color effect used for the background kG2colorMetal kG2colorSolid
$backgroundraised The 3d effect of the background (0=None,Positive=Raised,Negative=Sunken)
$circulargrid If true the grid will be circular, polygon otherwise
$columnheadings A list or row containing the column headings of the list.
$datacombine The combine method of the data kG2dataOverlay kG2dataPercentage kG2dataSide kG2dataStack
$dataname The list containing the data for a graph
$depth The depth (-1 if default) (Pie graphs only)
$depthcolumn The depth column in the list (0 if normal depth) (Pie graphs only)
$deviceindependent Should report printing be device independent? (Set to kTrue for thin client)
$donutradius If positive, then this specifies the percentage radius of the donut (0 to 100) (Pie graphs only)
$drawclockwise The direction of rotation (Pie graphs only)
$feelercolor The feeler color (Pie graphs only)
$feelerwidth The feeler width (Pie graphs only)
$framecolor The color of the slice frame (Pie graphs only)
$frameon Enable border (Pie graphs only)
$hgridcolor Horizontal grid color
$imagesearchpath The image search path. If this is empty, the object sets the search path to the path of the icons folder in the Studio tree
$labelfont Specifies the font for the labels (must exist in FONTS folder)
$labelfontheight Specifies the height for the label font
$labelformat The label format (use empty string for default) (Pie graphs only)
$labelpos The position of the label (used if $labelposon is true) (Pie graphs only)
$labelposon If true, $labelpos is used (Pie graphs only)
$layereffect The effect for all layers kG2effectGlass kG2effectNone kG2effectSoftLight
$layereffectalign The alignment for the layer effect for all layers kG2alignBottom kG2alignCenter kG2alignLeft kG2alignRight kG2alignTop
$legendbackgroundcolor The color of the legends' background
$legendbackgroundeffect The color effect used for the legend kG2colorMetal kG2colorNotUsed kG2colorSolid
$legendfont Specifies the font for the legend (must exist in FONTS folder)
$legendfontheight Specifies the height for the legend font
$legendpos The position of the legend kG2legendBottom kG2legendLeft kG2legendManual kG2legendNone kG2legendRight kG2legendTop
$legendtextcolor The color of the legends' text
$legendvert If true, the manual positioned legend is vertical
$legendx Manual position of legend
$legendy Manual position of legend
$linearalignment The alignment of the linear meter kG2alignBottom kG2alignCenter kG2alignLeft kG2alignRight kG2alignTop
$maintitle The title of the graph
$majortickwidth The width of the major tick
$majortype The type of graph kG2meter kG2pie kG2polar kG2xy
$microtickwidth The width of the micro tick
$minormetertype The minor type of a meter graph. A value that further defines the appearance of a meter graph kG2meterAngular kG2meterLinear
$minorpolartype The minor type of a Polar graph. A value that further defines the appearance of a Polar graph kG2polarArea kG2polarLine kG2polarSplineArea kG2polarSplineLine
$minortickwidth The width of the minor tick
$minorxytype The minor type of an XY graph. A value that further defines the appearance of an XY graph kG2xyArea kG2xyBar kG2xyBoxWhisker kG2xyCandleStick kG2xyHLOC kG2xyLine kG2xyScatter kG2xyTrend
$offsetheight Specifies an additional height offset for the graph
$offsetheight Specifies an additional height offset for the graph
$offsetwidth Specifies an additional width offset for the graph
$offsetx Specifies an additional x offset for the graph
$offsety Specifies an additional y offset for the graph
$plotareacolorend The end gradient color for the plot area
$plotareacolorstart The start gradient color for the plot area
$pointercolor The color of the pointer
$radialcolor Color of the radial grid
$radialwidth Width of the radial grid
$rotate The pie rotation (in degrees) (Pie graphs only)
$roundedframe True if frame is rounded
$shadow If true, shadow is shown (Pie graphs only)
$showfeeler If true, feelers are shown (Pie graphs only)
$sidelayout If true, labels are to be displayed on the sides (Pie graphs only)
$subtitle The graph subtitle
$swapxy If true, X and Y are swapped (XY graphs only)
$tilt The degree of tilt to be applied to the pie (Pie graphs only)
$tilton If true, pie tilt is enabled (Pie graphs only)
$titlefont Specifies the font for the title (must exist in FONTS folder)
$titlefontheight Specifies the height for the title font
$vgridcolor Vertical grid color
$wallpaper The filename of the wallpaper
$xaxisfontangle Specifies the angle of rotation (-1=Default)
$xaxisontop If true, the X-Axis is on the top (XY graphs only)
$xaxistitle The X-Axis title
$xaxiswidth Width of X-Axis
$xlabelfontangle Specifies the angle of rotation (-1=Default)
$y2axisfontangle Specifies the angle of rotation (-1=Default)
$y2axistitle The Y2-Axis title
$yaxisfontangle Specifies the angle of rotation (-1=Default)
$yaxisonright If true, the Y-Axis is on the right (XY graphs only)
$yaxistitle The Y-Axis title
$yaxiswidth Width of Y-Axis

Methods

Method Description
$addarealayer $addarealayer(lList[,iCombineMethod]) Returns an object to a new area layer to the XY/Polar graph. lList contains the data representing the layer to add. iCombineMethod is of type kG2data
$addbarlayer $addbarlayer(lList[,iCombineMethod]) Returns an object to a new bar layer to the XY graph. lList contains the data representing the layer to add. iCombineMethod is of type kG2data
$addboxwhiskerlayer $addboxwhiskerlayer(lList) Returns an object to a new box whisker layer to the XY graph. lList contains the data representing the layer to add.
$addcandlesticklayer $addcandlesticklayer(lList) Returns an object to a new candlestick layer to the XY graph. lList contains the data representing the layer to add.
$addextrafield $addextrafield(List) Add extra fields
$addhloclayer $addhloclayer(lList) Returns an object to a new HLOC layer to the XY graph. lList contains the data representing the layer to add.
$addlinelayer $addlinelayer(lList[,iCombineMethod]) Returns an object to a new line layer to the XY/Polar graph. lList contains the data representing the layer to add. iCombineMethod is of type kG2data
$addmark $addmark(AxisID, Value, Color [,Text, Fontname, FontSize])
$addpointer $addpointer(Value,Color[,PointerType]) Adds a pointer to the meter
$addring $addring(StartRadius,EndRadius,FillColor) Adds a ring to the angular meter
$addscatterlayer $addscatterlayer(lList [,iSymbol=kG2symbolSquare, iSymbolSize=10]) Returns an object to a new scatter layer to the XY graph. lList contains the data representing the layer to add. iSymbol and iSymbolSize specify the symbol to use
$addsplinearealayer $addsplinearealayer(lList [,iSymbol=kG2symbolSquare, iSymbolSize=10]) Returns an object to a new spline area layer to the Polar graph. lList contains the data for layer. iSymbol and iSymbolSize specify the symbol to use
$addsplinelinelayer $addsplinelinelayer(lList [,iSymbol=kG2symbolSquare, iSymbolSize=10]) Returns an object to a new spline line layer to the Polar graph. lList contains the data for layer. iSymbol and iSymbolSize specify the symbol to use
$addtext $addtext(Text, x, y [,fontname, fontsize, color, alignment, angle, vertical]) Adds the specified text (must be done during layout)
$addtrendlayer $addtrendlayer(lList) Returns an object to a new trend layer to the XY graph. lList contains the data representing the layer to add.
$addzone $addzone(AxisID,LowLimit,UpLimit,color)
$convdate $convdate(DateTime) Converts datetime to a numeric for use in chart data
$dispose $dispose() Disposes the graph and rebuilds it
$findobject $findobject(iX, iY, &iSetNo, &iItemNo [,&cSetName, &cItemName]) Obtains the set&item information for the given X&Y position. Returns True if successful.
$formatvalue $formatvalue(Value,FormatString) Returns the value formatted using the specified string
$getcolors $getcolors([PaletteID]) returns a list of RGB colors used for the graph (or a palette)
$getmainlayer $getmainlayer() Returns main layer object
$getradialaxis $getradialaxis() Returns radial axis object
$getxaxis $getxaxis([SecondAxis]) Returns x-axis (or x-axis2) object (only available during pre-layout)
$getyaxis $getyaxis([SecondAxis]) Returns y-axis (or y-axis2) object (only available during pre-layout)
$makecolor $makecolor(iRGB,iColorEffect) Returns a color for use in $setcolors
$prelayout $prelayout() Called during construction of graph enabling layers to be added
$setcolors $setcolors(lPaletteList) sets the colors from the RGB list supplied
$setlinearscale $setlinearscale(AxisID, LowerLimit, UpperLimit [,MajorTick, MinorTick, LabelList]) Sets the linear scale for the specified axis (only available during pre-layout)
$setlogscale $setlogscale(AxisID, [Format|LowLimit, UpLimit, LabelList|MajorTick, MinorTick]) Sets the log scale (only available during pre-layout)
$slicemove $slicemove(iDistance,iSlice[,iSliceEnd]) iSlice & iSliceEnd moves the range of slices out of the Pie graph, by the specified distance. iSlice may be a comma seperated list
$snapshot $snapshot([iWidth,iHeight]) Returns a picture which is a snapshot of the present graph; if specified, the picture has the dimensions specified by iWidth and iHeight