GRAPH2

External objects

Properties Methods 

Properties

$3dIf true,the graph has a 3d appearance
$3ddepthSpecifies the 3d depth (-1=Default)
$angularcolorColor of the angular grid
$angulardegreesThe start & end degrees [seperated by a comma] of an angular meter
$angularlabelsonIf true labels will be shown on the angular axis
$angularpositionhThe percentage position of the horizontal start of the angular meter
$angularpositionvThe percentage position of the vertical start of the angular meter
$angularwidthWidth of the angular grid
$axiswidthThe width of the axis
$backgroundborderThe border color of the background
$backgroundcolorThe color of the background
$backgroundeffectThe color effect used for the background
kG2colorMetal kG2colorSolid
$backgroundraisedThe 3d effect of the background (0=None,Positive=Raised,Negative=Sunken)
$circulargridIf true the grid will be circular, polygon otherwise
$columnheadingsA list or row containing the column headings of the list.
$datacombineThe combine method of the data
kG2dataOverlay kG2dataPercentage kG2dataSide kG2dataStack
$datanameThe list containing the data for a graph
$depthThe depth (-1 if default) (Pie graphs only)
$depthcolumnThe depth column in the list (0 if normal depth) (Pie graphs only)
$deviceindependentShould report printing be device independent? (Set to kTrue for webclient)
$disablehighresolutionIf true, the graph is always generated at the same resolution irrespective of the display.
$donutradiusIf positive then this specifies the percentage radius of the donut (0 to 100) (Pie graphs only)
$drawclockwiseThe direction of rotation (Pie graphs only)
$feelercolorThe feeler color (Pie graphs only)
$feelerwidthThe feeler width (Pie graphs only)
$framecolorThe color of the slice frame (Pie graphs only)
$frameonEnable border (Pie graphs only)
$hgridcolorHorizontal grid color
$imagesearchpathThe image search path. If this is empty,the object sets the search path to the path of the icons folder in the Studio tree
$labelfontSpecifies the font for the labels (must exist in FONTS folder)
$labelfontheightSpecifies the height for the label font
$labelformatThe label format (use empty string for default) (Pie graphs only)
$labelposThe position of the label (used if $labelposon is true) (Pie graphs only)
$labelposonIf true,$labelpos is used (Pie graphs only)
$layereffectThe effect for all layers
kG2effectGlass kG2effectNone kG2effectSoftLight
$layereffectalignThe alignment for the layer effect for all layers
kG2alignBottom kG2alignCenter kG2alignLeft kG2alignRight kG2alignTop
$legendbackgroundcolorThe color of the legends' background
$legendbackgroundeffectThe color effect used for the legend
kG2colorMetal kG2colorNotUsed kG2colorSolid
$legendfontSpecifies the font for the legend (must exist in FONTS folder)
$legendfontheightSpecifies the height for the legend font
$legendposThe position of the legend
kG2legendBottom kG2legendLeft kG2legendManual kG2legendNone kG2legendRight kG2legendTop
$legendtextcolorThe color of the legends' text
$legendvertIf true,the manual positioned legend is vertical
$legendxManual position of legend
$legendyManual position of legend
$linearalignmentThe alignment of the linear meter
kG2alignBottom kG2alignCenter kG2alignLeft kG2alignRight kG2alignTop
$maintitleThe title of the graph
$majortickwidthThe width of the major tick
$majortypeThe type of graph
kG2meter kG2pie kG2polar kG2xy
$microtickwidthThe width of the micro tick
$minormetertypeThe minor type of a meter graph. A value that further defines the appearance of a meter graph
kG2meterAngular kG2meterLinear
$minorpolartypeThe minor type of a Polar graph. A value that further defines the appearance of a Polar graph
kG2polarArea kG2polarLine kG2polarSplineArea kG2polarSplineLine
$minortickwidthThe width of the minor tick
$minorxytypeThe 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
$offsetheightSpecifies an additional height offset for the graph
$offsetheightSpecifies an additional height offset for the graph
$offsetwidthSpecifies an additional width offset for the graph
$offsetxSpecifies an additional x offset for the graph
$offsetySpecifies an additional y offset for the graph
$plotareacolorendThe end gradient color for the plot area
$plotareacolorstartThe start gradient color for the plot area
$pointercolorThe color of the pointer
$radialcolorColor of the radial grid
$radialwidthWidth of the radial grid
$rotateThe pie rotation (in degrees) (Pie graphs only)
$roundedframeTrue if frame is rounded
$shadowIf true,shadow is shown (Pie graphs only)
$showfeelerIf true,feelers are shown (Pie graphs only)
$sidelayoutIf true,labels are to be displayed on the sides (Pie graphs only)
$subtitleThe graph subtitle
$swapxyIf true,X and Y are swapped (XY graphs only)
$tiltThe degree of tilt to be applied to the pie (Pie graphs only)
$tiltonIf true,pie tilt is enabled (Pie graphs only)
$titlefontSpecifies the font for the title (must exist in FONTS folder)
$titlefontheightSpecifies the height for the title font
$vgridcolorVertical grid color
$wallpaperThe filename of the wallpaper
$xaxisfontangleSpecifies the angle of rotation (-1=Default)
$xaxisontopIf true,the X-Axis is on the top (XY graphs only)
$xaxistitleThe X-Axis title
$xaxiswidthWidth of xaxis
$xlabelfontangleSpecifies the angle of rotation (-1=Default)
$y2axisfontangleSpecifies the angle of rotation (-1=Default)
$y2axistitleThe Y2-Axis title
$yaxisfontangleSpecifies the angle of rotation (-1=Default)
$yaxisonrightIf true,the Y-Axis is on the right (XY graphs only)
$yaxistitleThe Y-Axis title
$yaxiswidthWidth of yaxis

Methods

$addarealayer$addarealayer(lList[,iCombineType]) Returns an object to a new area layer to the XY/Polar graph. lList contains the data representing the layer to add. iCombineType is a kG2data... constant
$addbarlayer$addbarlayer(lList[,iCombineType]) Returns an object to a new bar layer to the XY graph. lList contains the data representing the layer to add. iCombineType is a kG2data... constant
$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(lFieldlist) Adds 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[,iCombineType]) Returns an object to a new line layer to the XY/Polar graph. lList contains the data representing the layer to add. iCombineType is a kG2data... constant
$addmark$addmark(iAxisid,nValue,iColor[,cText,cFontname,iFontsize]) Adds a mark
$addpointer$addpointer(nValue,iColor[,iPointer]) Adds a pointer to the meter. iPointer is a kG2pointer... constant
$addring$addring(iStartradius,iEndradius,iFillcolor) 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(cText,iX,iY[,cFontname,iFontsize,iColor,iAlign,iAngle,bVertical]) 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(iAxisid,nLowerlimit,nUpperlimit,iFillcolor) Adds a zone
$convdate$convdate(dDatetime) Converts dDatetime 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(nValue,cFormatstring) Returns the value formatted using the specified string
$getcolors$getcolors([iPaletteid]) 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([bSecondaxis]) Returns x-axis (or x-axis2) object (only available during pre-layout)
$getyaxis$getyaxis([bSecondaxis]) Returns y-axis (or y-axis2) object (only available during pre-layout)
$makecolor$makecolor(iColor,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(iAxisid,nLowerlimit,nUpperlimit[,nMajortick,nMinortick,lLabellist]) Sets the linear scale for the specified axis (only available during pre-layout)
$setlogscale$setlogscale(iAxisid,[vFormatstringorlowerLimit,nUpperlimit,nMajortick,nMinortick,lLabellist]) 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