PoMultipleHistogram

java.lang.Object
- com.openinventor.inventor.Inventor
- - com.openinventor.inventor.misc.SoBase
  - - com.openinventor.inventor.fields.SoFieldContainer
    - - com.openinventor.inventor.nodes.SoNode
      - com.openinventor.inventor.nodekits.SoBaseKit
        
        com.openinventor.meshviz.graph.PoBase
        
        com.openinventor.meshviz.graph.PoGraphMaster
        
        com.openinventor.meshviz.graph.PoHistogram
        
        com.openinventor.meshviz.graph.PoMultipleHistogram

All Implemented Interfaces:: SafeDisposable, SoGetView

public class PoMultipleHistogram
extends PoHistogram

Class to build a multiple histogram. Class to build a multiple histogram in the plane XY. This histogram is based on multiple statistical data. Multiple statistical data is composed of a matrix of values associated to a list of column names and a list of row names.

The histogram bars are perpendicular to the X-axis or to the Y-axis (according to the field type). The statistic values correspond to the height (or width) of the bars.

There are three possible representations of multiple histograms:

The histogram values are juxtaposed.
The histogram values are accumulated.
The histogram values are percentages.

The bars of the histogram can be colored using the fields color and coloring. If the bars colors are defined by a list of colors (coloring = COLOR_LIST), according to the field histogPath, the list of colors is associated to the rows or to the columns and color.getNum() must be greater or equal to getNum(), otherwise all the bars get the same color which is the inherited color.

File format/default:

PoMultipleHistogram {

start	0 0
end	1
type	X
color	0 0 0
coloring	COLOR_LIST
valueVisibility	VISIBILITY_ON
valuePosition	POS_DEPEND
valuePath	PATH_DEPEND
valueFontSize	0.0
valueFontName	""
valueAddStringVisibility	false
valueAddString	""
nameVisibility	VISIBILITY_ON
namePosition	POS_DEPEND
namePath	PATH_DEPEND
nameFontSize	0.0
nameFontName	""
barSpaceType	REL_SPACE
barSpaceValue	0.25
representation	JUXTAPOSED
barHeight	1.0
numRows	1
numColumns	1
value	0
rowName	""
columnName	""
histogPath	ROW_COLUM
sumVisibility	VISIBILITY_ON
sumPosition	POS_DEPEND
sumPath	PATH_DEPEND
sumFontSize	0.0
sumFontName	""

}

<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> <html> <head> <link REL="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> <title></title> </head> <BODY> <h1></h1> <h4> <A NAME="Heading780">CATALOG PARTS</A></h4> <ul>PoMultipleHistogram {</ul> <ul><ul>Separator <tt>alternateRep</tt> (from PoBase) { </ul></ul> <ul><ul><ul>AppearanceKit <tt>appearance</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul>Specifies the appearance of all the kit. By default lightModel.model=BASE_COLOR.</ul></ul></ul> <ul><ul><ul>MatrixTransform <tt>domainTransform</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul>Corresponds to the domain transformation.</ul></ul></ul> <ul><ul><ul>MatrixTransform <tt>transform</tt> (from PoHistogram)</ul></ul></ul> <ul><ul><ul>Corresponds to the orientation of the histogram.</ul></ul></ul> <ul><ul><ul><ul></ul></ul></ul></ul> <ul><ul><ul>Separator <tt>barSep</tt> (from PoHistogram) {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw the bars of the histogram.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>barApp </tt>(from PoHistogram)</ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of the bars of the histogram. material.diffuseColor is set (only if bars are colored) when the kit is rebuilt.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>bar</tt> (from PoHistogram)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoFaceSet shape to draw the bars of the histogram.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>valueTextSep</tt> (from PoHistogram) {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw the text of values of the histogram.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>valueTexApp </tt>(from PoHistogram)</ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of the text of values of the histogram. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>valueText</tt> (from PoHistogram)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains a list of SoAnnoText3 shapes to draw the text of values of the histogram.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>nameTextSep</tt> (from PoHistogram) {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw the bars names text of the histogram.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>nameTexApp </tt>(from PoHistogram)</ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of the bars names text of the histogram. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>nameText</tt> (from PoHistogram)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains a list of SoAnnoText3 shape to draw the bars names text of the histogram.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>sumTextSep</tt> {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw the bars sums text of the histogram.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>sumTextApp</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of the bars sums text of the histogram. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>sumText</tt></ul></ul></ul></ul> <ul><ul><ul><ul>Contains a list of SoAnnoText3 shape to draw the bars sums text of the histogram.</ul></ul></ul></ul> <ul><ul><ul>}</ul></ul></ul> <ul><ul>}</ul></ul> <ul>}</ul> <ul><ul> </ul></ul> </body> </html>

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PoMultipleHistogram.HistogPaths`
`static class`	`PoMultipleHistogram.Representations` Type of presentation of multiple histogram.

Nested classes/interfaces inherited from class com.openinventor.meshviz.graph.PoHistogram
PoHistogram.BarSpaceTypes, PoHistogram.Colorings, PoHistogram.Positions, PoHistogram.TextPaths, PoHistogram.Types, PoHistogram.Visibilities

Nested classes/interfaces inherited from class com.openinventor.meshviz.graph.PoBase
PoBase.NodeWriteFormats, PoBase.TextTypes, PoBase.UpdateMethodTypes

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor
Inventor.ConstructorCommand

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACCUMULATED` Deprecated. Use `PoMultipleHistogram.Representations.ACCUMULATED` instead.
`SoSFFloat`	`barHeight` This field is used only for percentage histogram representation (representation = PERCENTAGE) and it corresponds to the height of the histogram (in this representation, all the bars have the same size).
`static int`	`COLUMN_ROW` Deprecated. Use `PoMultipleHistogram.HistogPaths.COLUMN_ROW` instead.
`SoMFString`	`columnName` List of numColumns names of the columns.
`SoSFEnum<PoMultipleHistogram.HistogPaths>`	`histogPath` Indicates that the histogram shows rows as a function of columns, or columns as a function of rows.
`static int`	`JUXTAPOSED` Deprecated. Use `PoMultipleHistogram.Representations.JUXTAPOSED` instead.
`SoSFUShort`	`numColumns` Number of columns of the matrix of values.
`SoSFUShort`	`numRows` Number of rows of the matrix of values.
`static int`	`PERCENTAGE` Deprecated. Use `PoMultipleHistogram.Representations.PERCENTAGE` instead.
`SoSFEnum<PoMultipleHistogram.Representations>`	`representation` Representation type of the multiple histogram.
`static int`	`ROW_COLUMN` Deprecated. Use `PoMultipleHistogram.HistogPaths.ROW_COLUMN` instead.
`SoMFString`	`rowName` List of numRows names of the rows.
`SoSFString`	`sumFontName` Font name of bars sums.
`SoSFFloat`	`sumFontSize` Font size of bars sums.
`SoSFEnum<PoHistogram.TextPaths>`	`sumPath` Writing path of bars sums.
`SoSFEnum<PoHistogram.Positions>`	`sumPosition` Position of sums in relation to bars.
`SoSFEnum<PoHistogram.Visibilities>`	`sumVisibility` Bars sums visibility.
`SoMFFloat`	`value` Matrix of values.

Fields inherited from class com.openinventor.meshviz.graph.PoHistogram
barSpaceType, barSpaceValue, color, COLOR_LIST, coloring, DATA_MAPPING, end, FIXED_SPACE, nameFontName, nameFontSize, namePath, namePosition, nameVisibility, PATH_DEPEND, PATH_DOWN, PATH_LEFT, PATH_RIGHT, PATH_UP, POS_BOTTOM_IN, POS_BOTTOM_OUT, POS_CENTER, POS_DEPEND, POS_LEFT_IN, POS_LEFT_OUT, POS_RIGHT_IN, POS_RIGHT_OUT, POS_TOP_IN, POS_TOP_OUT, REL_SPACE, start, type, valueAddString, valueAddStringVisibility, valueFontName, valueFontSize, valuePath, valuePosition, valueVisibility, VISIBILITY_OFF, VISIBILITY_ON, X, Y

Fields inherited from class com.openinventor.meshviz.graph.PoBase
FOLD_NODE_WRITE_FORMAT, SO_ANNO_TEXT3, SO_TEXT3, UNFOLD_NODE_WRITE_FORMAT, UPDATE_METHOD_IMMEDIATE, UPDATE_METHOD_ON_ACTION

Fields inherited from class com.openinventor.inventor.nodekits.SoBaseKit
boundingBoxIgnoring

Fields inherited from class com.openinventor.inventor.Inventor
VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors
Constructor and Description
`PoMultipleHistogram()` Default constructor.
`PoMultipleHistogram(SbVec2f _start, float _end, PoHistogram.Types _type, int _numRows, int _numColumns, float[] _value, java.lang.String[] _rowName, java.lang.String[] _columnName)` Constructor.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type Method and Description

static SoNodekitCatalog getClassNodekitCatalog()
Returns the SoNodekitCatalog for this class.
- Methods inherited from class com.openinventor.meshviz.graph.PoHistogram
  getDataMapping, getFormat, getMiscTextAttr, setDataMapping, setFormat, setMiscTextAttr
- Methods inherited from class com.openinventor.meshviz.graph.PoBase
  addPostRebuildCallback, addPreRebuildCallback, getDomain, getNodeWriteFormat, getTextType, getUpdateMethod, isBuilt, isModified, isVRML2Mode, rebuild, setDomain, setNodeWriteFormat, setTextType, setUpdateMethod, setVRML2Mode, touchKit
- Methods inherited from class com.openinventor.inventor.nodekits.SoBaseKit
  getNodekitCatalog, getPart, getPart, getPartString, getViewportIsEnabled, getViewportOrigin, getViewportSize, isSearchingChildren, set, set, setPart, setSearchingChildren
- Methods inherited from class com.openinventor.inventor.nodes.SoNode
  affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write
- Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer
  copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, setToDefaults
- Methods inherited from class com.openinventor.inventor.misc.SoBase
  dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable
- Methods inherited from class com.openinventor.inventor.Inventor
  getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads
- Methods inherited from class java.lang.Object
  equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static SoNodekitCatalog`	`getClassNodekitCatalog()` Returns the `SoNodekitCatalog` for this class.

- Field Detail
 - ROW_COLUMN
```
@Deprecated
public static final int ROW_COLUMN
```
 Deprecated. Use PoMultipleHistogram.HistogPaths.ROW_COLUMN instead.
 - COLUMN_ROW
```
@Deprecated
public static final int COLUMN_ROW
```
 Deprecated. Use PoMultipleHistogram.HistogPaths.COLUMN_ROW instead.
 - JUXTAPOSED
```
@Deprecated
public static final int JUXTAPOSED
```
 Deprecated. Use PoMultipleHistogram.Representations.JUXTAPOSED instead.
 - ACCUMULATED
```
@Deprecated
public static final int ACCUMULATED
```
 Deprecated. Use PoMultipleHistogram.Representations.ACCUMULATED instead.
 - PERCENTAGE
```
@Deprecated
public static final int PERCENTAGE
```
 Deprecated. Use PoMultipleHistogram.Representations.PERCENTAGE instead.
 - numRows
```
public final SoSFUShort numRows
```
 Number of rows of the matrix of values.
 - numColumns
```
public final SoSFUShort numColumns
```
 Number of columns of the matrix of values.
 - value
```
public final SoMFFloat value
```
 Matrix of values.
 - rowName
```
public final SoMFString rowName
```
 List of numRows names of the rows.
 - columnName
```
public final SoMFString columnName
```
 List of numColumns names of the columns.
 - representation
```
public final SoSFEnum<PoMultipleHistogram.Representations> representation
```
 Representation type of the multiple histogram.
 - barHeight
```
public final SoSFFloat barHeight
```
 This field is used only for percentage histogram representation (representation = PERCENTAGE) and it corresponds to the height of the histogram (in this representation, all the bars have the same size).
 - histogPath
```
public final SoSFEnum<PoMultipleHistogram.HistogPaths> histogPath
```
 Indicates that the histogram shows rows as a function of columns, or columns as a function of rows.
 - sumVisibility
```
public final SoSFEnum<PoHistogram.Visibilities> sumVisibility
```
 Bars sums visibility. .
 - sumPosition
```
public final SoSFEnum<PoHistogram.Positions> sumPosition
```
 Position of sums in relation to bars. .
 - sumPath
```
public final SoSFEnum<PoHistogram.TextPaths> sumPath
```
 Writing path of bars sums. .
 - sumFontSize
```
public final SoSFFloat sumFontSize
```
 Font size of bars sums. if this value is less or equal to 0, the font size is fixed at 0.04. This value is a percentage of the current domain (cf PoBase description).
 - sumFontName
```
public final SoSFString sumFontName
```
 Font name of bars sums. If the font is equal to its default value, the font used is the font of the current miscellaneous text attributes (cf PoHistogram description).
- Constructor Detail
 - PoMultipleHistogram
```
public PoMultipleHistogram()
```
 Default constructor.
 - PoMultipleHistogram
```
public PoMultipleHistogram(SbVec2f _start,
 float _end,
 PoHistogram.Types _type,
 int _numRows,
 int _numColumns,
 float[] _value,
 java.lang.String[] _rowName,
 java.lang.String[] _columnName)
```
 Constructor.
- Method Detail
 - getClassNodekitCatalog
```
public static SoNodekitCatalog getClassNodekitCatalog()
```
 Returns the SoNodekitCatalog for this class.

Class PoMultipleHistogram

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.meshviz.graph.PoHistogram

Nested classes/interfaces inherited from class com.openinventor.meshviz.graph.PoBase

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Field Summary

Fields inherited from class com.openinventor.meshviz.graph.PoHistogram

Fields inherited from class com.openinventor.meshviz.graph.PoBase

Fields inherited from class com.openinventor.inventor.nodekits.SoBaseKit

Fields inherited from class com.openinventor.inventor.Inventor

Constructor Summary

Method Summary

Methods inherited from class com.openinventor.meshviz.graph.PoHistogram

Methods inherited from class com.openinventor.meshviz.graph.PoBase

Methods inherited from class com.openinventor.inventor.nodekits.SoBaseKit

Methods inherited from class com.openinventor.inventor.nodes.SoNode

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

Methods inherited from class com.openinventor.inventor.misc.SoBase

Methods inherited from class com.openinventor.inventor.Inventor

Methods inherited from class java.lang.Object

Field Detail

ROW_COLUMN

COLUMN_ROW

JUXTAPOSED

ACCUMULATED

PERCENTAGE

numRows

numColumns

value

rowName

columnName

representation

barHeight

histogPath

sumVisibility

sumPosition

sumPath

sumFontSize

sumFontName

Constructor Detail

PoMultipleHistogram

PoMultipleHistogram

Method Detail

getClassNodekitCatalog