NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::CAE::Xyplot::OverlayParameters Class Reference

Represents the parameters passed to overlay plot records on an existing plot graph. More...

Inheritance diagram for NXOpen::CAE::Xyplot::OverlayParameters:
NXOpen::CAE::Xyplot::BasePlotParameters NXOpen::TransientObject

Public Member Functions

void SetSubGraphInStack (int subGraphIndex)
 Sets the index of subgraph on a stacked plot, on which the records will be overlaied. More...
 
int SubGraphInStack ()
 Returns the index of subgraph on a stacked plot, on which the records will be overlaied. More...
 
- Public Member Functions inherited from NXOpen::CAE::Xyplot::BasePlotParameters
int DeviceIndex ()
 Returns the index of device on which plot graph will be shown. More...
 
std::vector
< NXOpen::CAE::FTK::BaseRecord * > 
GetRecords ()
 Gets the records to be plotted. More...
 
void SetDeviceIndex (int deviceIndex)
 Sets the index of device on which plot graph will be shown. More...
 
void SetRecords (const std::vector< NXOpen::CAE::FTK::BaseRecord * > &records)
 Sets the records to be plotted
Created in NX9.0.0. More...
 
void SetViewPortIndex (int viewIndex)
 Sets the index of a view port on main graphic window, on which plot graph will be shown. More...
 
int ViewPortIndex ()
 Returns the index of a view port on main graphic window, on which plot graph will be shown. More...
 
virtual ~BasePlotParameters ()
 Destroys the object
Created in NX9.0.0. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

Represents the parameters passed to overlay plot records on an existing plot graph.


To create a new instance of this class, use NXOpen::CAE::Xyplot::XYPlotManager::NewOverlayParameters

Created in NX9.0.0.

Member Function Documentation

void NXOpen::CAE::Xyplot::OverlayParameters::SetSubGraphInStack ( int  subGraphIndex)

Sets the index of subgraph on a stacked plot, on which the records will be overlaied.

The property is only available when overlaying records on a stacked plot. The index value is between 0 and the property value of CAE::Xyplot::Plot::SubGraphCountInStack .
Created in NX10.0.0.

License requirements : None

Parameters
subGraphIndexThe sub-graph index
int NXOpen::CAE::Xyplot::OverlayParameters::SubGraphInStack ( )

Returns the index of subgraph on a stacked plot, on which the records will be overlaied.

The property is only available when overlaying records on a stacked plot. The index value is between 0 and the property value of CAE::Xyplot::Plot::SubGraphCountInStack .
Created in NX10.0.0.

License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.