Current Graph Methods

See Graph Properties Index for methods that get and set property values. See IdentObj Methods Index for methods that return an object ID in the form IdentObj.

Return Value

Method

Description

int

getAltFmtFrameNumColors()

Gets the number of colors/sections to be used for alternate formatting of an axis.

See get/setAltFmtFrameNumColors().

double

getAltFmtFrameSeparator()

Gets the location on an axis where alternate formatting is applied.

See get/setAltFmtFrameSeparator().

int

getAutoSkip()

Gets label automatic skip mode.

int

getAxisAssignment()

Gets axis assignment.

boolean

getAxisDescending()

Gets axis descending.

int

getAxisOffset()

Gets axis offset value for Multi-Y graph.

int

getAxisSide()

Gets axis side.

int

getAxisSize()

Gets axis size value for Multi-Y graph.

String

getBorder()

Gets the border assigned to an object.

color

getBorderColor()

Gets the border color of an object.

int

getBorderType()

Gets the border type of an object.

Insets

getBorderWidth()

Gets the width of a border assigned to an object.

boolean

getChartFromFTP()

Gets a graph from an FTP server.

int

getCornerArcWidth/Height()

Gets the width/height of the corner arc of a border applied to an object.

int

getCurveFitPolynomialOrder()

Gets polynomial order for a curve fit line.

int

getCurveFitType()

Gets the curve fit type.

boolean

getCustomDataText()

Gets custom data text.

int

getCustomDataTextFormat()

Gets custom data text format.

String

getCustomDataTextFormatPattern()

Gets custom data text format pattern.

double

getDataAsDouble()

Gets data at row/col as double.

String

getDataAsString()

Gets data at row/col as a string.

String

getDataLabel()

Gets the data label at series/group.

int

getDataTextAngle()

Gets data text angle.

int

getDataTextRadius()

Gets data text radius.

double

getDataValue()

Gets data value assigned to the object identified by id.

boolean

getDisplay()

Gets the display mode of an object.

boolean

getDisplayOffScale()

Gets display offscale mode.

int

getDocumentHeightInPoints()

Gets document height in points.

int

getDocumentWidthInPoints()

Gets document width in points.

boolean

getDrawTicksPerpendicular()

Gets draw ticks perpendicular setting.

int

getEffectiveColorMode()

Returns the actual color mode used.

int

getEffectiveGroupOffset()

Gets the effective group offset.

int

getEffectiveSeriesOffset()

Gets the effective series offset.

int

getEffectiveViewableGroups()

Gets the effective number of viewable groups.

int

getEffectiveViewableSeries()

Gets the effective number of viewable series.

Hashtable

getExceptionalRisers()

Determines if there are any exceptional risers.

See Exceptional Risers.

boolean

getExcludeMaxLabel()

Determines if maximum label is imaged on an axis.

boolean

getExcludeMinLabel()

Determines if minimum label is imaged on an axis.

Color

getFillColor()

Gets fill color.

int

getFillType()

Gets fill type.

String

getFontName()

Gets the font name assigned to a text object.

int

getFontSize()

Gets the font size in destination coordinates.

boolean

getFontSizeAbsolute()

Gets font size absolute setting.

int

getFontSizeInPoints()

Gets font size in points.

int

getFontSizeVC()

Gets the font size in virtual coordinates.

int

getFontStyle()

Gets the font style of a text object.

Point

getFrameDepthOffset()

Gets frame depth offset.

Rectangle

getFrameRect()

Gets the size and location of the graph frame.

int

getGradientDirection()

Gets the gradient direction.

int

getGradientNumPins()

Gets the number of pins in a gradient.

Color

getGradientPinLeftColor()

Gets the left color used by the gradient pin.

double

getGradientPinPosition()

Gets the gradient pin position.

Color

getGradientPinRightColor()

Gets the right color used by the gradient pin.

int

getGridCount()

Gets grid count.

double

getGridStep()

Gets number of grid steps on an axis.

boolean

getGridStepAuto()

Determines if grid steps are automatically calculated.

int

getGridStyle()

Gets style of grid lines assigned to an axis.

String

getGroupLabel()

Gets a group label.

boolean

getIgnoreSeries()

Determines if a series is ignored.

Insets

getInsets()

Gets the insets of an object.

int

get...inset()

Gets the top/bottom and right/left insets of borders of a specified object.

boolean

getLabelStagger()

Determines if staggered labels are used.

int

getLegendMinWidth()

Gets the minimum legend width.

Rectangle

getLegendRect()

Gets the size and location of the legend area.

String

getLevelDateFormat()

Gets level date format for time scale axis.

Color

getLevelFillColor()

Gets level fill color for time scale axis.

int

getLevelHeight()

Gets level height for time scale axis.

int

getLevelInterval()

Gets level interval for time scale axis.

int

getLevelTextFormat()

Gets level test format for time scale axis.

int

getLineBasicStrokeType()

Gets a Java 2D basic stroke type of the line object.

int

getLineCap()

Gets a Java 2D cap style of the line object.

Vector

getLineDash()

Gets a Java 2D dash definition of the line object as a vector.

float[]

getLineDashFloat()

Gets a Java 2D dash definition of the line object as a floating point array.

float

getLineDashPhase()

Gets a Java 2D dash offset of the line object.

int

getLineJoin()

Gets a Java 2D join style of the line object.

float

getLineMiterLimit()

Gets a Java 2D line miter limit of the line object.

int

getLineWidth()

Gets the width of a line.

boolean

getLogScale()

Gets logarithmic/linear scaling assigned to an axis.

double

getLogScaleBase()

Gets logarithmic scale base.

int

getMarkerShape()

Gets marker shape.

int

getMarkerSize()

Gets marker size.

MarkerTemplate

getMarkerTemplate()

Gets a marker template.

int

getMaxNumAnnotations()

Gets the maximum number of annotations.

long

getMillisFromDate()

Returns the current date as a long.

Dimension

getMinimumSize()

Gets the minimum size of a graph.

int

getMinNumGroups()

Gets minimum # of groups for this graph type.

int

getMinNumSeries()

Gets minimum # of series for the graph type.

boolean

getNonZeroBaseline()

Gets the designated baseline.

double

getNonzeroBaselineValue()

Gets the designated non-zero baseline value.

int

getNumColumnsInGroup()

Gets the number of columns in a group for this graph type.

int

getNumGroups()

Gets the number of groups in the graph.

int

getNumNonIgnoredSeries()

Gets the number of the series in the graph that are not ignored.

int

getNumSeries()

Gets the number of series in the graph.

int

getNumTotalGroups()

Gets the total number of groups in the graph.

int

getNumTotalSeries()

Gets the total number of series in the graph.

boolean

getPieSliceDelete()

Determines if a pie slice is deleted.

int

getPieSliceDetach()

Determines if a pie slice is detached.

int

getPlaceAlign()

Gets alignment setting for automatic graph layout manager.

Rectangle

getPlaceMargin()

Gets graph margin used by automatic graph layout manager.

int

getPlaceMaxNumWordWrapLines()

Gets maximum number of word-wrap lines for automatic graph layout.

int

getPlaceMinFontSize()

Gets minimum font point size for automatic graph layout.

Rectangle

getRect()

Gets the bounding rectangle for a user-movable object in virtual coordinates (x, y, width, height).

Color

getSeriesBorderColor()

Gets the border color of a series.

boolean

getSeriesDataTextDisplay()

Gets series data text display.

Color

getSeriesFillColor()

Gets the fill color of a series.

String

getSeriesLabel()

Gets series label.

int

getSeriesType()

Gets series type.

Color

getShadowColor()

Gets the Shadow Color of an object.

boolean

getShadowDisplay()

Determines if a shadow has been applied to an object.

int

getShadowFillType()

Gets the fill type assigned to a Java 2D text object.

Color

getShadowGradientEndColor()

Gets the end color for setShadowFillType(FILL_COLOR).

Color

getShadowGradientStartColor()

Gets the start color for setShadowFillType(FILL_COLOR).

Image/String

getShadowTextureURL()

Gets the texture for setShadowFillType(FILL_TEXTURE).

int

getShadowXOffset()

Gets shadow X-Offset.

int

getShadowYOffset()

Gets shadow Y-Offset.

int

getSkipBegin()

Gets label skip beginning number.

int

getSkipCount()

Gets label skip count.

Color

getTextBackgroundColor()

Gets a Java 2D text object's background color.

String

getTextFormatPattern()

Gets text format pattern.

int

getTextFormatPreset()

Gets text format preset.

int

getTextJustHoriz()

Gets text horizontal justification.

int

getTextJustVert()

Gets text vertical justification.

int

getTextRotation()

Gets text rotation.

boolean

getTextStrikethrough()

Gets a Java 2D text object's strike-through mode.

String

getTextString()

Gets text string.

int

getTextUnderlineType()

Gets a Java 2D text object's underline type.

String

getTexture()

Gets texture.

Color

getTextureBGColor()

Gets texture background color.

int

getTextureDisplayMode()

Gets texture display mode assigned to object id.

int

getTextureFlipMode()

Gets texture flip mode.

boolean

getTextWrap()

Gets text wrap mode (on or off).

int

getTickCount()

Gets tick count.

int

getTickLength()

Gets tick length.

double

getTickStep()

Gets tick step.

boolean

getTickStepAuto()

Gets tick step auto setting.

int

getTickStyle()

Gets tick style.

int

getTickWidth()

Gets tick width.

boolean

getTransparentBorderColor()

Gets transparent border color.

boolean

getTransparentFillColor()

Gets transparent fill color.

boolean

getUseTextBackgroundColor()

Gets a Java 2D text object's use of background color.

int

getWaterfallGroupMode()

Gets Waterfall graph group mode.

double

getX1MajorGridStepAutoValue()

Gets automatically calculated major grid steps on the X-Axis.

double

getX1ScaleMaxAutoValue()

Gets automatically calculated maximum scale value on the X-Axis.

double

getX1ScaleMinAutoValue()

Gets automatically calculated minimum scale value on the X-Axis.

double

getY1MajorGridStepAutoValue()

Gets automatically calculated major grid steps on the Y1-Axis.

double

getY1ScaleMaxAutoValue()

Gets automatically calculated maximum scale value on the Y1-Axis.

double

getY1ScaleMinAutoValue()

Gets automatically calculated minimum scale value on the Y1-Axis.

double

getY2MajorGridStepAutoValue()

Gets automatically calculated major grid steps on the Y2-Axis.

double

getY2ScaleMaxAutoValue()

Gets automatically calculated maximum scale value on the Y2-Axis.

double

getY2ScaleMinAutoValue()

Gets automatically calculated minimum scale value on the Y2-Axis.

boolean

isChart3DType()

Determines whether or not the current graph is one of the 3D graphs.

See GraphType Methods.

boolean

isChartBiPolar()

Determines whether or not the current graph is bi-polar.

See GraphType Methods.

boolean

isChartBLAType()

Determines whether or not the current graph is a Bar, Line, or Area graph.

See GraphType Methods.

boolean

isChartDualY()

Determines whether or not the current graph is a dual-axes graph.

See GraphType Methods.

boolean

isChartOrientHorz()

Determines whether or not the current graph is horizontal (false=vertical graph).

See GraphType Methods.

boolean

isChartPieType()

Determines whether or not the current graph is one of the pie graphs.

See GraphType Methods.

boolean

isChartScatter()

Determines whether or not the current graph is a scatter graph.

See GraphType Methods.

boolean

isChartStockType()

Determines whether or not the current graph is one of the stock graphs.

See GraphType Methods.

boolean

isExceptionalAllowed()

Determines if exceptional risers are allowed.

See Exceptional Risers.

boolean

isGroupScrollerPresent()

Determines if the group data scroller bar is present.

boolean

isO1AxisPresent()

Determines if the O1 axis is present in the graph.

See Ordinal Axis Methods.

boolean

isO2AxisPresent()

Determines if the O2 axis is present in the graph.

See Ordinal Axis Methods.

boolean

isValidZoomIndex()

Determines if a particular data zooming index is valid.

See Data Zooming.

boolean

isX1AxisPresent()

Determines if the X1 axis is present in the graph.

See Numeric Axis Methods.

boolean

isY1AxisPresent()

Determines if the Y1 axis is present in the graph.

See Numeric Axis Methods.

boolean

isY2AxisPresent()

Determines if the Y2 axis is present in the graph.

See Numeric Axis Methods.

boolean

isZ1AxisPresent()

Determines if the Z1 axis is present in the graph.

See Numeric Axis Methods.

boolean

isZoomingArmed()

Determines if doZoomIn() or doZoomOut() has been called.

See Data Zooming.

boolean

optimizeData()

Asks the graph to optimize the data.

String

outputParamString()

Gets a list of graph parameters.

void

removeReferenceLineObject()

Removes a reference line object.

See APIs Related to Reference Lines.

void

restoreAllSlices()

Restores all deleted/detached slices from a pie.

void

restoreDefaults()

Restores all default values.

void

save()

Saves a graph to an output stream.

boolean

sendChartToFTP()

Sends a graph to an FTP server.

void

sendGIFToFile()

Sends a graph to a file as a .GIF image.

void

sendGIFToFileExc()

Sends a graph fo a file as a GIF image and throws the appropriate exceptions.

void

sendGIFToFTP()

Sends a graph to an FTP server as a GIF image.

void

sendGIFToStream()

Sends a graph to an output stream as a GIF image.

void

sendImageMapToStream()

Sends an image map to a stream.

void

sendJPEGToStream()

Sends a graph to an output stream as a JPEG image.

void

sendPNGToFile()

Sends a graph to a file as a PNG image.

void

sendPNGToFileExc()

Sends a graph to a file as a PNG image and throw the appropriate exceptions.

void

sendPNGToStream()

Sends a graph to an output stream as a PNG image.

void

sendPNGToStreamExc()

Sends a graph to an output stream as a PNG image and throw the appropriate exceptions.

void

setAltFmtFrameNumColors()

Sets the number of colors/sections to be used for alternate formatting of an axis.

void

setAltFmtFrameSeparator()

Sets the location on an axis where alternate formatting is applied.

void

setAutoColorLerpFactor()

Sets a factor for lightening or darkening groups of risers.

void

setAutoSkip()

Sets label skip mode.

void

setAxisAssignment()

Sets axis assignment.

void

setAxisDescending()

Sets axis ascending/descending.

void

setAxisOffset()

Sets Axis Offset in Multi-Y graphs.

void

setAxisSide()

Sets axis side.

void

setAxisSize()

Sets Axis Size in Multi-Y graphs.

void

setBorder()

Assigns a border to an object.

void

setBorderColor()

Sets border color.

void

setBorderType()

Sets the border type for the specified object.

void

setBorderWidth()

Sets the width of a border assigned to an object.

void

setCornerArc()

Sets the corner arc of an object.

void

setCornerArcWidth/Height()

Sets the width/height of the corner arc of a border applied to an object.

void

setCubeRotationMatrix()

Sets the rotation matrix of the 3D cube.

void

setCurveFitPolynomialOrder()

Sets polynomial order for a curve fit line.

void

setCurveFitType()

Sets the curve fit type.

void

setCustomDataText()

Sets custom data text.

void

setCustomDataTextFormat()

Sets custom data text format.

void

setCustomDataTextFormatPattern()

Sets custom data text format pattern.

void

setData()

Sets data in a graph.

void

setDataLabel()

Assigns a data label to a series/group.

void

setDataRange()

Sets the range of data to be imaged.

void

setDataRangeToExtent()

Sets the data range to the values set by setData().

void

setDataTextAngle()

Sets the angle of data text.

void

setDataTextRadius()

Sets data text radius.

void

setDataValue()

Assigns a data value to an object.

void

setDisplay()

Enables/disables display of an object.

void

setDisplayOffScale()

Sets display off scale.

void

setDrawTicksPerpendicular()

Sets draw ticks perpendicular to axis.

void

setEndDate()

Sets the end date in a graph.

See Time Scale Axis Graphs.

void

setExceptionalRiser()

Sets exceptional risers.

void

setExcludeMaxLabel()

Excludes/Includes maximum label on an axis.

void

setExcludeMinLabel()

Excludes/Includes minimum label on an axis.

void

setFillColor()

Sets the fill color of an object.

void

setFillType()

Sets fill type.

void

setFontName()

Sets font name.

void

setFontSize()

Sets font size in points (deprecated).

void

setFontSizeAbsolute()

FALSE = Use setFontSizeVC()

TRUE = Use setFontSizeInPoints()

void

setFontSizeVC()

Sets font size in virtual coordinates.

void

setFontSizeInPoints()

Sets font size in points.

void

setFontStyle()

Sets font style.

void

setGaugeAlphaChannel()

Sets the transparency of a gauge object.

See Gauge Graph Properties & Methods.

void

setGradientDirection()

Sets gradient direction.

void

setGradientNumPins()

Sets number of pins in a gradient.

void

setGradientPinLeftColor()

Sets gradient pin left color.

void

setGradientPinPosition()

Sets gradient pin position.

void

setGradientPinRightColor()

Sets gradient pin right color.

void

setGridCount()

Sets grid count.

void

setGridStep()

Sets number of grid steps.

void

setGridStepAuto()

Enables/disables automatic calculation of grid steps.

void

setGridStyle()

Sets the style of grid lines.

void

setGroupLabel()

Defines a group label.

void

setIgnoreSeries()

Includes/Excludes a series in a graph.

void

setInset()

Sets insets of an object.

void

set...Insets

Sets the top/bottom and right/left insets of borders of a specified object.

void

setLabelStagger()

Enables/disables staggered labels.

void

setLegendPosition()

Sets the legend position.

void

setLegendRect()

Sets the location and size of the legend area.

void

setLevelBorderColor()

Sets level border color for a time scale axis.

void

setLevelDateFormat()

Sets level date format for a time scale axis.

void

setLevelFillColor()

Sets level fill color for a time scale axis.

void

setLevelHeight()

Sets level height for a time scale axis.

void

setLevelInterval()

Sets level interval for a time scale axis.

void

setLevelTextColor()

Sets level text color for a time scale axis.

void

setLevelTextFormat()

Sets level text format for a time scale axis.

void

setLineBasicStrokeType()

Sets a Java 2D line object's basic stroke type.

void

setLineCap()

Sets a Java 2D line object's cap style.

void

setLineDash()

Sets a Java 2D line object's dash definition.

void

setLineDashPhase()

Sets a Java 2D line object's dash offset.

void

setLineJoin()

Sets a Java 2D line object's join style.

void

setLineMiterLimit()

Sets a Java 2D line object's line miter limit.

void

setLineWidth()

Sets line width.

void

setLineWidthAllSeries()

Sets the line width for all series in a graph.

void

setLogScale()

Sets logarithmic/linear scaling.

void

setLogScaleBase()

Sets logarithmic scale base.

void

setMarkerShape()

Sets the shape of a marker.

void

setMarkerSize()

Set marker size for the first item in the selection list.

void

setMaxNumAnnotations()

Sets the maximum number of annotations.

void

setNoExceptionalRiser()

Disallows exceptional risers.

void

setNonZeroBaseline()

Sets Non-Zero Base Line.

void

setNonZeroBaselineValue()

Sets Non-Zero Base Line Value.

void

setNoSelection()

De-select all items in the selection list.

void

setO1LabelCallback()

Sets a callback for O1-axis nested labels.

See Using Nested/Multi-Dimensional Labels.

void

setPieSliceDelete()

Sets/clear deleted pie slice.

void

setPieSliceDetach()

Sets distance a slice is detached from a pie graph.

void

setPlaceAlign()

Sets alignment mode for automatic graph layout.

void

setPlaceMargin()

Sets graph margin used by automatic graph layout manager.

void

setPlaceMaxNumWordWrapLines()

Sets maximum number of word wrap Lines for automatic graph layout.

void

setPlaceRect()

Sets bounding rectangle for automatic graph layout.

void

setPlaceResize()

Sets resize mode for automatic graph layout.

void

setPlaceSkip()

Sets skip mode for automatic graph layout.

void

setPlaceTruncateCount()

Sets truncate count for automatic graph layout.

void

setPlaceWordWrap()

Sets word wrap mode for automatic graph layout.

void

setQuadrantLineValueX()

Sets scale value at which to place vertical quadrant line.

void

setQuadrantLineValueY()

Sets scale value at which to place horizontal quadrant line.

void

setRect()

Sets the location and size of an object.

void

setReferenceLine()

Sets a reference line in a graph.

void

setReferenceLineValue()

Sets the value at which a reference line displays in a graph.

void

setScaleMax()

Assigns a maximum scale value.

void

setScaleMaxAuto()

Enables/disables automatic calculation of the maximum scale value.

void

setScaleMin()

Assigns a minimum scale value.

void

setScaleMinAuto()

Enables/disables automatic calculation of the minimum scale value.

void

setScaleMustIncludeZero()

Enables/disables zero on scale.

void

setSeriesAreRows()

Assigns a value to the SeriesAreRows property and enables/disables swapping of labels.

void

setSeriesBorderColor()

Assigns a border color to a series.

void

setSeriesDataTextDisplay()

Sets series data text display.

void

setSeriesFillColor()

Assigns a fill color to a series.

void

setSeriesLabel()

Assigns a series label.

void

setSeriesLooping()

Sets an index that defines the number of risers in a group for automatic lightening or darkening of riser colors.

void

setSeriesType()

Assigns a series type.

void

setShadowColor()

Assigns a shadow color to an object.

void

setShadowDisplay()

Enables/disables shadow display.

void

setShadowFillType()

Sets the fill type of a Java 2D text object.

void

setShadowGradientEndColor()

Sets the end color for setShadowFillType(FILL_COLOR).

void

setShadowGradientStartColor()

Sets the start color for setShadowFillType(FILL_COLOR).

void

setShadowTextureURL()

Sets the texture for setShadowFillType(FILL_TEXTURE).

void

setShadowXOffset()

Sets shadow X-offset.

void

setShadowYOffset()

Sets shadow Y-offset.

void

setSize()

Inherited by Perspective from Java Components.

void

setSkipBegin()

Assigns a label skip begin value.

void

setSkipCount()

Assigns a label skip interval.

void

setStartDate()

Sets the end date in a graph.

See Time Scale Axis Graphs.

void

setTextBackgroundColor()

Sets a Java 2D text object's background color.

void

setTextFormatPattern()

Assigns a standard Java text format pattern.

void

setTextFormatPreset()

Assigns a preset text format.

void

setTextJustHoriz()

Sets text horizontal justification.

void

setTextJustVert()

Sets text vertical justification.

void

setTextRotation()

Sets text rotation.

void

setTextStrikethrough()

Sets a Java 2D text object's strike-through mode.

void

setTextString()

Sets text string.

void

setTextUnderlineType()

Sets a Java 2D text object's underline type.

void

setTextureBGColor()

Sets texture background color.

void

setTextureDisplayMode()

Sets texture display mode.

void

setTextureFlipMode()

Sets texture flip mode.

void

setTextureResource()

Specifies a texture file as a resource instead of a file-system URL.

void

setTextureURL()

Loads a texture from a URL.

void

setTextWrap()

Sets text wrap mode.

void

setTickCount()

Sets tick count.

void

setTickLength()

Sets tick length.

void

setTickStep()

Sets tick step.

void

setTickStepAuto()

Enables/disables automatic calculation of tick steps.

void

setTickStyle()

Sets tick style.

void

setTickWidth()

Sets tick width.

void

setToolTipBackdropColor()

Sets Tooltip backdrop color.

void

setToolTipBackdropSize()

Sets Tooltip backdrop size.

void

setToolTipBackgroundColor()

Sets Tooltip background color.

void

setToolTipColor()

Sets Tooltip color.

void

setToolTipFontName()

Sets Tooltip font name as defined in java.awt.Font.

void

setToolTipFontSize()

Sets Tooltip font size as defined in java.awt.Font.

void

setToolTipFontStyle()

Set Tooltip font style as defined in java.awt.Font.

void

setToolTipOff()

Disables tool tip event generation.

void

setToolTipOn()

Enables tool tip event generation.

void

setTransparentBorderColor()

Sets transparent border color.

void

setTransparentFillColor()

Sets transparent fill color.

void

setURL()

Sets URL.

See URL Methods.

void

setURLTarget()

Sets the frame target for a URL.

See URL Methods.

void

setUserToolTip()

Sets user-mode custom tool tip string.

void

setUserToolTipDefault()

Selects default user-mode tool tips.

void

setUseTextBackgroundColor()

Enables/disables a Java 2D text object's background color.

void

setWaterfallGroupMode()

Sets Waterfall Group Mode in a waterfall graph.

void

setZoomIndex()

Sets the current zoom index in the zoom list.


WebFOCUS