Difference between revisions of "CAGraphPivot"

Revision as of 00:21, 29 July 2017

ADE User Guide > ADE Server Class Reference >

CAGraphPivot provides information about the pivot state of a graph, and a method for changing the pivot. The pivot state is the set of role-filler assignments (see Graphing roles) for a graph, as well as the set of pivot options. A CAGraphPivot object instance is obtained from an associated with a single CATable instance.

To obtain a graph image from ADE, the following steps are typically involved.

Use CAObject::ResultTable to obtain the result to be graphed as a CATable
Use CATable::GraphPivot to get a CAGraphPivot object
Use the properties of CAGraphPivot to examine the current pivot, and use CAGraphPivot::PivotTo to change the current pivot.
Set CATable::GraphWidth and CATable::GraphHeight to the desired graph image size.
Obtain the graph image from CATable::GraphToStream or CATable::GraphToFile.

Creation

A CAGraphPivot instance is obtained from a call to CATable::GraphPivot().

Properties

@@ Line 28: / Line 28: @@
 ==== Update() ====
-==== [[CAFiller]] [[CAGraphPivot::RoleFiller|:RoleFiller]]( string role ) ====
+==== [[CAFiller]] [[CAGraphPivot::RoleFiller|RoleFiller]]( string role ) ====
-==== unsigned [[CAGraphPivot::NumPossibleFillers|:NumPossibleFillers]]( string role ) ====
+==== unsigned [[CAGraphPivot::NumPossibleFillers|NumPossibleFillers]]( string role ) ====
-==== [[CAFiller]] [[CAGraphPivot::PossibleRoleFiller|:PossibleRoleFiller]]( string role, unsigned i ) ====
+==== [[CAFiller]] [[CAGraphPivot::PossibleRoleFiller|PossibleRoleFiller]]( string role, unsigned i ) ====
-==== unsigned [[CAGraphPivot::NumSlicers|:NumSlicers]]( ) ====
+==== unsigned [[CAGraphPivot::NumSlicers|NumSlicers]]( ) ====
-==== [[CAIndex]] [[CAGraphPivot::NthSlicerIndex|:NthSlicerIndex]]( unsigned n ) ====
+==== [[CAIndex]] [[CAGraphPivot::NthSlicerIndex|NthSlicerIndex]]( unsigned n ) ====
-==== bool [[CAGraphPivot::PivotTo|:PivotTo]]( string role, CAFiller newFiller ) ====
+==== bool [[CAGraphPivot::PivotTo|PivotTo]]( string role, CAFiller newFiller ) ====
 == See Also ==

Difference between revisions of "CAGraphPivot"

Revision as of 00:21, 29 July 2017

Contents

Creation

Properties

{get,put} long :NthSlicerPosition(unsigned n)

Methods

Update()

CAFiller RoleFiller( string role )

unsigned NumPossibleFillers( string role )

CAFiller PossibleRoleFiller( string role, unsigned i )

unsigned NumSlicers( )

CAIndex NthSlicerIndex( unsigned n )

bool PivotTo( string role, CAFiller newFiller )

See Also