XY Plot

xCreateXYPlot

Creates an empty XYPlot for the given plot name.

bool xCreateXYPlot(String sPlotName)

return

Returns True, if successful.

sPlotName

Name of XYPlot to be created.

xDeleteXYPlot

Deletes the plot associated with sPlotName.

bool xDeleteXYPlot(String sPlotName)

return

Returns True, if successful.

sPlotName

Name of XYPlot, to be deleted. To delete all plots set sPlotName as empty String(“”).

xAddXYPlotPath

Adds a path which contains a list of IDs to the plot.

bool xAddXYPlotPath(String sPlotName, String sPathName, String sIDList)

return

Returns True, if successful. If the path name already exists, returns False.

sPlotName

Name of XYPlot, to which path is to be created and added.

sPathName

Name of the path, which contains a list of IDs.

sIDList

List of IDs as a String delimited by semicolan ;.

pxGetHotspotIDs

Gets list of IDs from current probe/hotspot labels.

List<int> pxGetHotspotIDs(const String sModelName, bool bVisibleOnly=True)

return

Returns an array of positive integers for IDs.

sModelName

CAE Model Name.

bVisibleOnly

This flag decides whether to include visible labels or all.

Visible labels will only be considered if True.

All labels will be considered if False.

xSetXYPlotData

Sets all data required and builds the plot.

bool xSetXYPlotData(String sPlotName, short iPlotType, String sModel, String sAxisX, String sDerivedAxisX, String sAxisY, String sDerivedAxisY, String sInstanceList, String sPathNameList)

return

Returns True, if successful.

sPlotName

Name of XYPlot, to which curve data is to be set.

iPlotType

Plot type index, varies between 0 to 4.

0 - "IDsPath"
1 - "Transient"
2 - "MinMax"
3 - "Force Deflection"
4 - "Phase Response"

sModel

Name of the CAE model selected.

sAxisX, sDerivedAxisX

Name of the CAE result or result attribute for X-axis invariant and name of the derived scalar result respectively.

sAxisY, sDerivedAxisY

Name of CAE result for Y-axis and name of the derived scalar result for Y-axis respectively.

sInstanceList

List of common instance names for the selected X and Y axis data.

sPathNameList

List of path names selected, as a String delimited by semicolan ;.

xSetXYPlotPath

Adds a path to the plot

bool xSetXYPlotPath(String sPlotName, String sPathName, String sIDList)

return

Returns True, if successful.

sPlotName

Name of XYPlot, to which path is to be set.

sPathName

Name of the Path to be set. If pathname exists then overwrites the path with new ID list.

sIDList

List of IDs, as a String delimited by semicolan ;.

xSetXYPlotPlacement

Sets, given XY plots position and dimension in pixels.

bool xSetXYPlotPlacement(String sPlotName, float fPosX, float fPosY, float fWidth, float fHeight)

return

Returns True, if successful.

sPlotName

Name of XYPlot.

fPosX, fPosY

Sets X and Y position (Left Bottom of XY plot) in the viewport.

fWidth, fHeight

Sets Width and Height of the plot.

xClearXYPlot

Clears all curves and data of the plot associated with the given name.

bool xClearXYPlot(String sPlotName)

return

Returns True, if successful.

sPlotName

Name of XYPlot, in which all curves are to be cleared.

xGetXYPlotList

Gets the list of all existing plot names.

String xGetXYPlotList()

return

Returns all existing plot names in a single String delimited by semicolan ;.

xMergeXYPlots

Merges a list of selected plots into a new plot with or without deleting old plots merged.

bool xMergeXYPlots(String sPlotsList, bool bDelete)

return

Returns True, if successful.

sPlotsList

List of plot names to be merged.

bDelete

If True, it deletes old plots after merging them into a new one.

If False, it merges all plots into a new one without deleting selected plots.

xImportXYPlots

Imports external XYPlot data.

int xImportXYPlots(const String fileNames)

return

Returns Number of XYPlot data files successfully imported.

fileNames

The file name that to be imported. To import multiple files add the full paths with a delimiter semicolon ;.

xExportXYPlots

Exports selected XYPlots into external file formats like .csv.

int xExportXYPlots(const String plotNames, String filePath, String fileExt)

return

Returns number of plots successfully exported into the external formats.

plotNames

List of the XYPlot names.

filePath

The file name with path.

fileExt

The file extension of external file format.

xIsXYPlotNameExists

Checks whether an XY plot exists associated with a given name.

bool xIsXYPlotNameExists(String sPlotName)

return

Returns True, if XYplot exists associated with the given name sPlotName.

Returns False, if there is no XYplot with sPlotName.

sPlotName

XYPlot Name.

xSetCurrentXYPlot

Sets plot associated with the given name as the currently selected plot.

The current plot will be highlighted and VCollab GUI for XY plot operations are applied to the current plot.

bool xSetCurrentXYPlot(String sPlotName)

return

Returns True, if successful.

sPlotName

Sets this plot name as the currently selected plot.

pxGetXYPlotPlacement

Gets the position and dimension of the XYPlot.

List<float> pxGetXYPlotPlacement(const String sPlotName)

return

Returns real value array of size 4, order: x, y, w, h.

retArray[0] = X coordinate of the position
retArray[1] = Y coordinate of the position
retArray[2] = Width of Plot
retArray[3] = Height of the Plot

sPlotName

Name of the XYPlot.

xGetXYPlotType

Gets XYPlot Type in Integer.

int xGetXYPlotType(const String sPlotName)

return

Returns a positive integer of range 0 to 4.

0 - Path Plot
1 - Transient Plot
2 - MinMax Plot
3 - Force Deflection Plot
4 - Angle Plot for complex data

sPlotName

Name of the XYPlot.

xDeleteXYPlotPath

Deletes the path associated with an XYplot.

bool xDeleteXYPlotPath(String sPlotName, String sPathName)

return

Returns True, if successfully path is deleted.

sPlotName

Name of XYPlot, in which path is to be deleted.

sPathName

Name of Path to be deleted.

pxGetXYPlotResults

Get XYPlot CAE result information. i.e., Model Name, X-axis result, and the scalar type and Y-axis result and scalar type.

List<String> pxGetXYPlotResults(const String sPlotName)

return

Returns array of names of size 5, order: sModel, sXResult, sXScalar, sYResult, sYScalar.

retArray[0] = Model Name
retArray[1] = X axis result name
retArray[2] = X axis derived result name
retArray[3] = Y axis result name
retArray[4] = Y axis derived result name

sPlotName

Name of the XYPlot.

pxGetXYPlotInstances

Gets the list of XYPlot result instance names.

List<String> pxGetXYPlotInstances(const String sPlotName)

return

Returns list of names of user-selected instances.

sPlotName

Name of the XYPlot.

pxGetXYPlotComplexComponents

Gets complex components of the XYPlot. i.e. any one component of Real, Imaginary, Magnitude, Phase and Angle.

List<String> pxGetXYPlotComplexComponents()

return

Returns array of names of size 2.

retArray[1] = complex component for the X-axis
retArray[2] = complex component for the Y-axis

xSetXYPlotComplexComponents

Sets Complex component to XYPlot axes results. i.e. any one component of Real, Imaginary, Magnitude, Phase and Angle.

bool xSetXYPlotComplexComponents(const String sXAxisComp, const String sYAxisComp)

return

Returns True, if components are set to axes successfully.

Returns False, if not.

sXAxisComp

Name of the complex component for X-axis.

sYAxisComp

Name of the complex component for Y-axis.

xSetXYPlotComplexEigenAngle

Sets complex eigen angle to the XYPlot axis result.

bool xSetXYPlotComplexEigenAngle(float fDegree)

return

Returns True, if successfully angle is set.

Returns False, if not.

fDegree

The angle in Degrees.

pxGetXYPlotTitle

Gets the list of Titles of Plot and Axes.

List<String> pxGetXYPlotTitle(const String sPlotName)

return

Returns list of names of size 3, order: PlotTitle, PlotXTitle, PlotYTitle

retArray[0] = Title of the XYPlot
retArray[1] = Title of X axis
retArray[2] = Title of Y axis

sPlotName

Name of the XYPlot.

pxGetXYPlotFormat

Gets XYPlot numerical formats for both axes. i.e., scientific and decimal precision.

List<int> pxGetXYPlotFormat(const String sPlotName)

return

Returns an array of positive integer values of size 4, order: iPrecisionX, bScientificX, iPrecisionY, bScientificY.

retArray[0] = precision of X axis
retArray[1] = flag for scientific format of X axis
retArray[2] = precision of Y axis
retArray[3] = flag for scientific format of Y axis

pxGetXYPlotGrid

Gets the number of grids in X and Y axes respectively of an XYPlot.

List<String> pxGetXYPlotGrid(String sPlotName)

return

Returns the number of grids of X and Y axes in an array.

retArray[0] = number of grids in X-axis
retArray[1] = the number of grids in Y-axis

sPlotName

XYPlot Name.

pxGetXYPlotRange

Gets Min and Max values of X and Y axes results.

List<float> pxGetXYPlotRange(const String sPlotName)

return

Returns real value array of size 4, order: fMinX, fMaxX, fMinY, fMaxY.

retArray[0] = minimum of X axis range
retArray[1] = maximum of X axis range
retArray[2] = minimum of Y axis range
retArray[3] = maximum of Y axis range

pxGetXYPlotUnits

Gets Major tick mark interval unit for both X and Y axes.

List<float> pxGetXYPlotUnits(const String sPlotName)

return

Returns value array of size 2, order: fXMajor, fYMajor.

retArray[0] = Major tick mark unit of the X-axis
retArray[1] = Major tick mark unity of the Y-axis

sPlotName

Name of the XYPlot.

pxGetXYPlotCurves

Gets visibility of XYPlot curves. i.e., Sum curve, Averages Curve, Max Curve, Min Curve, and Actual Curves.

List<bool> pxGetXYPlotCurves(const String sPlotName)

return

Returns an array of True or False flags for curve visibility. Array size 5, order: bSum, bAvg, bMax, bMin, bMainCurves.

retArray[1] = flag visibility of Sum curve
retArray[2] = flag visibility of Average curve
retArray[3] = flag visibility of Maximum curve
retArray[4] = flag visibility of Minimum curve
retArray[5] = flag visibility of Actual curves

xSetXYPlotTitle

Sets plot title, axes titles to the plot.

bool xSetXYPlotTitle(String sPlotName, String sPlotTitle, String sTitleAxisX, String sTitleAxisY)

return

Returns True, if successful.

sPlotName

Name of XYPlot, to which names are to be set.

sPlotTitle

Title of the XYGraph to be set.

sTitleAxisX

Title of the Plot X-Axis invariant, to be set.

sTitleAxisY

Title of the Plot Y-Axis variant, to be set.

xSetXYPlotFormat

bool xSetXYPlotFormat(String sPlotName, short iPrecisionX, short iPrecisionY, bool bScientificX, bool bScientificY)

return

Returns True, if successful.

sPlotName

Name of XYPlot.

iPrecisionX, iPrecisionY

Decimal precision value for X and Y axes respectively.

bScientificX, bScientificY

Set True to display in scientific format for X and Y axis respectively, else returns False.

xSetXYPlotGrid

Sets number of grids in X and Y axes respectively.

bool xSetXYPlotGrid(String sPlotName, int nX, int nY)

return

Returns True, if successful.

sPlotName

XY Plot name

nX

Number of grids to be set in the X-axis.

nY

Number of grids to be set in the Y-axis.

xSetXYPlotRange

Sets user-defined ranges of X and Y axes to the plot.

bool xSetXYPlotRange(String sPlotName, bool bEnableXrange, float fMinX, float fMaxX, bool bEnableYrange, float fMinY, float fMaxY)

return

Returns True, if successful.

sPlotName

Name of XYPlot.

bEnableXRange

Enable user range for X axis.

fMinX, fMaxX

User-defined or customized X-axis range.

bEnableYRange

Enable user range for Y-axis.

fMinY, fMaxY

User-defined or customized Y-axis range.

xSetXYPlotUnits

Sets X and Y axes unit values to the plot.

bool xSetXYPlotUnits(String sPlotName, bool bApplyXUnit, float fUnitX, bool bApplyYUnit, float fUnitY)

return

Returns True, if successful.

sPlotName

Name of XYPlot.

bApplyXUnit

Set True to modify X-axis unit value, else set False.

fUnitX

The unit value of X-axis, to be set.

bApplyYUnit

Set True to modify Y axis unit value, else set False.

fUnitY

The unit value of Y-axis, to be set.

xSetXYPlotCurves

Sets visibility flags to special curves sum, average, max, min, and actual curves.

bool xSetXYPlotCurves(String sPlotName, bool bSum, bool bAvg, bool bMax, bool bMin, bool bActual)

return

Returns True, if successful.

sPlotName

Name of XYPlot.

bSum

Set True to show the curve which represents the sum of all curves and False to hide.

bAvg

Set True to show the curve which represents the average of all curves and False to hide.

bMax

Set True to show the curve which represents the maximum of all curves and False to hide.

bMin

Set True to show the curve which represents a minimum of all curves and False to hide.

bActual

Set True to show actual curves and False to hide.

Sets X and Y axes decimal precision and scientific format flags.

pxGetXYPlotPathNames

Gets all path names for the specified XYPlot with name sPlotName

List<String> pxGetXYPlotPathNames(String sPlotName)

return

Returns XYPlot path name list

sPlotName

Name of the XYPlot

xSetXYPlotBackground

Sets background with given color to XYPlot with the given name.

bool xSetXYPlotBackground (String sPlotName, bool bBackground, float r, float g, float b)

return

Returns True, if successfully sets the background.

Returns False, if there is no XYPlot with the given name.

sPlotName

XYPlot Name

bBackground

Sets background, if True.

Removes background, if False. (Transparent)

r, g, b

RGB color values for background in range of [0,1].

pxGetXYPlotBackground

Gets background data of XYPlot with the given name.

List<float> pxGetXYPlotBackground(String sPlotName)

return

Returns background data in the float value array.

If it is successful return, then value array is of size 4.

retArray[0] = Background Boolean (0 - No Background, 1 - Backgound)
retArray[1], retArray[2], retArray[3] = RGB values of background color and in range [0,1]

sPlotName

XYPlot Name

xSetXYPlotCurveColor

Sets background data of XYPlot with a given name.

bool xSetXYPlotCurveColor(String sPlotName, int iIndex, float r, float g, float b)

return

Returns True, if plot and curve are found and the color is set.

Returns False, if plot or curve is not found.

sPlotName

XYPlot Name

iIndex

Curve Index

r, g, b

RGB color values of curve in range of [0,1].

pxGetXYPlotCurveColor

Gets color of a specific curve of XYPlot with the given name.

List<float> pxGetXYPlotCurveColor(String sPlotName, int iIndex)

return

Returns curve RGB values in an array.

If it is successful return, then color values array of size 3.

retArray[0], retArray[1], retArray[2] = RGB values of curve color and in range [0,1]

Returns an empty array if plot name or curve index is wrong.

sPlotName

XYPlot Name

xSetXYPlotFontName

Sets font face to xyplot texts.

bool xSetXYPlotFontName(String sFontName)

return

Returns True if successfully set.

sFontName

True type font name for the texts.

xGetXYPlotFontName

Gets xyplot font name.

String xGetXYPlotFontName()

return

Returns font face name.

xSetXYPlotFontSize

Sets font size to xyplot

bool xSetXYPlotFontSize(int iSize)

return

Returns True if successful.

iSize

Font size.

xGetXYPlotFontSize

int xGetXYPlotFontSize()

Gets font size of xyplot.

return

Returns font-size value.

xAddXYPlotDatumLine

Adds datum line to current XYPlot with value and color. It is applicable only for current XYPlot.

int xAddXYPlotDatumLine(bool bXDatum, float fV, float r, float g, float b)

return

Returns -1, if failed.

Returns index of the datum line list, if successful.

bXDatum

True for X-axis.

False for Y-axis.

fV

Datum value.

r, g, b

RGB color values for datum line in range of [0,1].

xDeleteXYPlotDatumLine

Deletes datum line corresponding to axis and value. It is applicable only for current XYPlot.

bool xDeleteXYPlotDatumLine (bool bXDatum, float fVal)

return

Returns True, if datum line is deleted successfully.

Returns False, if failed.

bXDatum

True for the X-axis.

False for Y-axis.

fVal

Datum value.

xDeleteAllXYPlotDatumLines

Deletes all datum lines corresponding to the axis. It is applicable only for current XYPlot.

bool xDeleteAllXYPlotDatumLines(bool bXDatum)

return

Returns True, if all datum lines are deleted successfully.

Returns False, if failed.

bXDatum

True for the X-axis.

False for Y-axis.

xSetXYPlotDatumColor

Sets the color to datum line associated with axis and value. It is applicable only for current XYPlot.

bool xSetXYPlotDatumColor(bool bXDatum, float fV, float r, float g, float b)

return

Returns False, if failed.

Returns True, if successful.

bXDatum

True for X-axis.

False for Y-axis.

fV

Datum value.

r, g, b

RGB color values for datum line in range of [0,1].

pxGetXYPlotDatumColor

Gets color of datum line associated with axis and value. It is applicable only for current XYPlot.

List<float> pxGetXYPlotDatumColor(bool bXDatum, float fV)

return

Returns float array of size of 3, if successful.

retArray [0] = red value component [0,1]
retArray [1] = blue value component [0,1]
retArray [2] = green value component [0,1]

Returns empty array, if failed.

bXDatum

True for X-axis.

False for Y-axis.

fV

Datum value.

pxGetXYPlotDatumLines

Sets background with given color to XYPlot with the given name. It is applicable only for current XYPlot.

List<float> pxGetXYPlotDatumLines(bool bXDatum)

return

Returns float array of size of 4n, where n is the number of datum lines.

In each of four components, first is for datum value and others for color.

component [0] = Datum value
component [1] = red value component [0,1]
component [1] = blue value component [0,1]
component [2] = green value component [0,1]

n = size of float array / 4

Returns empty array, if failed.

bXDatum

True for X axis.

False for Y axis.

xOpenBinoutFile

Opens binout file. It should be called first, before calling other binout calls.

bool xOpenBinoutFile(String sFilePath)

return

Returns True, if the file is successfully opened.

Returns False, if there is an error in opening the file.

sFilePath

File path / name of binout file.

xCloseBinoutFile

Closes binout file if it is open status. It should be called last, after calling other binout query calls.

bool xCloseBinoutFile()

return

Returns True, if the file is successfully closed.

pxGetBinoutMainBranches

Gets main branch name list from currently opened binout file.

List<String> pxGetBinoutMainBranches()

return

Returns array of main branch names.

Returns empty array if failed.

xHasBinoutSubBranches

Checks given main branch has sub-branches or not and returns True or False.

bool xHasBinoutSubBranches(String sMainBranch)

return

Returns True if given main branch has sub-branches.

Returns False if not.

sMainBranch

Main Branch name.

pxGetBinoutSubBranches

Gets all sub-branches for the given main branch.

List<String> pxGetBinoutSubBranches(String sMainBranch)

return

Returns sub-branch names array.

sMainBranch

Main Branch name.

pxGetBinoutEntityTypes

Gets all entity types for the given main branch.

List<String> pxGetBinoutEntityTypes(String sMainBranch)

return

Returns entity types array.

sMainBranch

Main Branch name.

pxGetBinoutEntityList

Gets all entity lists for the given main branch.

List<String> pxGetBinoutEntityList(String sMainBranch, String sSubBranch, String sEntityType)

return

Returns all entities in a String array.

sMainBranch

Main Branch name.

sSubBranch

Sub Branch name.

sEntityType

Entity type name.

pxGetBinoutComponents

Gets all components for given main branch, sub branch, and entity type.

List<String> pxGetBinoutComponents(String sMainBranch, String sSubBranch, String sEntityType)

return

Returns all components in a String array.

sMainBranch

Main Branch name.

sSubBranch

Sub Branch name.

sEntityType

Entity type name.

xBuildBinoutXYPlot

Builds XY Plot with given binout data.

bool xBuildBinoutXYPlot(String sMainBranch, String subBranch, String sEntityType, String entityStrList, String componentsList, String xyPlotname)

return

Returns True, if XYPlot is built with the given binout data.

sMainBranch

Main Branch name.

sSubBranch

Sub Branch name.

sEntityType

Entity type name.

pxGetXYPlotCurveNames

Gets the list of curves in a particular XYPlot.

List< String > pxGetXYPlotCurveNames(String sPlotName)

return

Returns empty String array if it fails.

Returns list of curve names if it succeeds.

sPlotName

Name of the XYPlot

xDeleteXYPlotCurve

Deletes the particular curve given by index in a specific XYPlot.

bool xDeleteXYPlotCurve(String sPlotName, int iCurveIndex)

return

Returns False if it fails.

Returns True if the curve is deleted successfully.

sPlotName

Name of the XYPlot

iCurveIndex

Index of the curve to be deleted.

xSetXYPlotLogScale

Enables or disables Log scaling to XYPlot axes.

bool xSetXYPlotLogScale(bool Enable, bool xAxis)

return

Returns True if successfully sets or removes log scaling to the concerned axis.

Returns False if failed.

Enable

True – enables log scaling

False – removes log scaling

xAxis

True – sets log scaling to x axis of current xyplot.

False – sets log scaling to y axis of current xyplot.

Note 1: This function works only for current XYPlot. User should set the required plot as current plot before using this function.

Note 2: Log scaling will not work if min/max of the range is negative. Log (<0) =>Infinity.

xIsXYPlotLogScaled

Gets information about XYPlot axes are scaled logarithmically.

bool xIsXYPlotLogScaled(bool xAxis)

return

Returns True if the given input axis is scaled logarithmically.

Returns False otherwise.

xAxis

True refers to X axis.

False refers to Y axis.

xSetXYPlotComponentSize

Helps to modify the dimension of xyplot components X axis area, Legend Area, Y axis area and Plot title area.

bool xSetXYPlotComponentSize(float fWidth, float fHeight, int iComponent, String sPlotName)

return

Returns True if successfully sets the dimension to the concerned zone.

Returns False otherwise.

fWidth, fHeight

Width and height of the component zone.

iComponent

Refers to zone/component of plot

0 – Full Plot
1 – X Axis Title area
2 – X Ticks area
3 – Y Axis Title area
4 – Y Ticks area.
5 – Plot Title area
6 – Plot Legend area

sPlotName

Name the XYPlot.

xGetXYPlotCurveName

Gets the plot curve name for the given plot name and curve index.

String xGetXYPlotCurveName(String sPlotName, int iIndex)

return

Returns the curve name.

sPlotName

XYPlot Name

iIndex

curve index

xSetXYPlotCurveName

Gets the plot curve name for the given plot name and curve index.

bool xSetXYPlotCurveName(String sPlotName, int iIndex, String sCurveName)

return

Returns True if successfully sets the curvename.

Returns Faise otherwise.

sPlotName

XYPlot Name.

iIndex

Curve index.

sCurveName

Curve new Name.

pxGetXYPlotCurveData

Gets x and y values of a given xyplot and curve index. It returns an array of values [x1,y1,x2,y2,…]

List<float> pxGetXYPlotCurveData(String sPlotName, int iCurveIndex)

return

Returns all x, y values into an array.

sPlotName

XYPlot Name

iCurveIndex

Index of the input curve.

pxGetXYPlotCurveAttrib

Gets xyplot curve attrib for the given input key like Time.

List<float> pxGetXYPlotCurveAttrib(String sPlotName, int iCurveIndex, String sKey)

return

Returns the attrib values of the given key if available.

sPlotName

XYPlot Name.

iCurveIndex

Index of the input curve.

sKey

Key word,

xShowXYPlot

Set plot visibility flag to the given XYPlot.

bool xShowXYPlot(String sPlotName, bool bShow)

return

Returns True if successfully sets the visibility flag

Returns False otherwise.

sPlotName

XYPlot Name.

bShow

Visibility boolean flag.

xIsXYPlotVisible

Gets the plot visibility information (True/False).

bool xIsXYPlotVisible(String sPlotName)

return

Returns True if plot is visible.

Returns False if not.

xShowXYPlotLegend

Displays or hides XYPlot legend and adjusts the internal graph width.

bool xShowXYPlotLegend(String sPlotName, bool bShow, bool bAdjust)

return

Returns True if succeeds.

Returns False otherwise.

sPlotName

XYPlot Name

bShow True - Displays the legend

False - Hides the legend

bAdjust

True - adjusts the internal graph width based on the bShow flag value.

False - do not modify the width of the internal graph area.

xGetXYPlotLegendVisibility

Gets the visibility flag of the given XYPlot.

bool xGetXYPlotLegendVisibility(String sPlotName)

return

Returns True if XYPlot Legend is displayed.

Returns False if XYPlot Legend is Not displayed.

sPlotName

XYPlot Name

xShowXYPlotDataPoints

Sets and displays data points in the given XYPlot.

bool xShowXYPlotDataPoints(String sPlotName, bool bShow);

return

Returns True if successfully sets the flag to the XYPlot.

sPlotName

XY Plot Name

bShow

True - shows the data points.

False - hides the data points.

xIsShowXYPlotDataPoints

Gets the info if datapoiints are displayed in the given XYPlot.

bool xIsShowXYPlotDataPoints(String sPlotName);

return

Returns True if the datapoints are shown.

Returns False otherwise.

sPlotName

XY Plot Name

xShowXYPlotGrid

Sets the major/minor grid flags for X Axis and Y Axis of the given XYPlot.

bool xShowXYPlotGrid(String sPlotName, bool bMajorGrid, bool bXAxis, bool bYAxis);

return

Returns True if the grid flags are set to X and Y axes of the given XYPlot.

sPlotName

XYPlot Name

bMajorGrid

True - Major Grid.

False - Minor Grid.

bXAxis

True - displays Major/Minor grid for the X Axis

False - hides Major/Minor grid for the X Axis

bYAxis

True - displays Major/Minor grid for the Y Axis

False - hides Major/Minor grid for the Y Axis

pxGetXYPlotGridFlags

Gets the major/minor grid flags of X and Y axes of the given XYPlot.

List<int> pxGetXYPlotGridFlags(String sPlotName, bool bMajorGrid);

return

Returns an array of size 2.

array[0] - X axis flag.

array[1] - Y axis flag.

sPlotName

XYPlot Name

bMajorGrid

True - Major Grid.

False - Minor Grid.

xGetXYPlotAttribute

Gets display attribute of a data point of the curve of given XYPlot.

String xGetXYPlotAttribute(int iDataPt, String sCurveName, String sPlotName)

return

Returns Attribute as a string if succeeds.

Returns empty string otherwise.

iDataPt

Data point index

sCurveName

XYPlot Curve Name

sPlotName

XYPlot Name

xGetXYPlotAttributeEx

Gets display attribute of a data point of the curve of given XYPlot.

String xGetXYPlotAttributeEx(int iDataPt, int iCurveIndex, String sPlotName)

return

Returns Attribute as a string if succeeds.

Returns empty string otherwise.

iDataPt

Data point index

iCurveIndex

XYPlot Curve index

sPlotName

XYPlot Name

xAppendXYPlotAttribute

Appends display attribute of a data point of the curve of given XYPlot.

bool xAppendXYPlotAttribute(String sAttribute, int iDataPt, String sCurveName, String sPlotName)

return

Returns True if succeeds.

Returns empty string otherwise.

iDataPt

Data point index

sCurveName

XYPlot Curve Name

sPlotName

XYPlot Name

xAppendXYPlotAttributeEx

Appends display attribute of a data point of the curve of given XYPlot.

bool xAppendXYPlotAttributeEx(String sAttribute, int iDataPt, int iCurveIndex, String sPlotName)

return

Returns True if succeeds.

Returns empty string otherwise.

iDataPt

Data point index

iCurveIndex

XYPlot Curve Index

sPlotName

XYPlot Name