TableHistogram
Create a table histogram plot for 1D and 2D plot groups.
Syntax
model.result(<pgtag>).create(<ftag>,"TableHistogram");
model.result(<pgtag>).feature(<ftag>).set(property,<value>);
model.result(<pgtag>).feature(<ftag>).run();
Description
model.result(<pgtag>).create(<ftag>,"TableHistogram") creates a table histogram plot feature named <ftag> belonging to the plot group <pgtag>.
Table histograms are used to visualize the distribution of the range of data taken from a table or evaluation group. The result is a plot with the data range on the x-axis and the data length, area, or volume on the y-axis. Such histogram plots can be added to 1D plot groups. In 2D histograms, which you can add to 2D plot groups, the x-axis and y-axis represent the values of two quantities (as a number of bins or a range of values), and the color surface represents the count of the total element volume in each “bin”.
The following properties are available:
Table 7-168: Valid Properties for Table Histogram Plots.
name
Value
Default
Description
bottomcolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
black
The bottom color to use for a color gradient. Active when linecolor is cyclegradient.
colorcycle
default | long
default
The color cycle, when linecolor is set to cycle. With default, it contains 7 colors; with long, it contains 19 colors.
colortable
color table name
Rainbow
The color table to use when linecolor is set to cyclecolortable. See Color Tables for a list of color tables.
cumulative
boolean
false
Plot a cumulative histogram.
custombottomcolor
RGB-triplet
{1,0,0} or last used color
The uniform color to use. Active when bottomcolor is set to custom.
customlinecolor
RGB-triplet
{0,0,1} or last used edgecolor
The color to use for the lines. Active when linecolor is set to custom.
customtopcolor
RGB-triplet
{1,0,0} or last used color
The uniform color to use. Active when topcolor is set to custom.
cyclelength
auto | manual
auto
The length of color cycle when linecolor is cyclegradient.
descriptionintitle
on | off
on
Whether the title contribution should contain the description when titletype is custom.
expressionintitle
on | off
off
Whether the title contribution should contain the expression when titletype is custom.
evaluationgroup
Tag of evaluation group or none
none
The evaluation group to take the data from, when source is set to evaluationgroup.
function
continuous | discrete
continuous
Use a continuous function or a discrete function (that is, using a constant level in each bin) for the histogram.
limits
double array
0 1
The bin limits if method is limits.
linecolor
custom | cycle | cyclereset | cyclecolortable | cyclegradient | fromtheme | black | blue | cyan | gray | green | magenta | red | white | yellow
cycle
How to color the lines in the graph. Cycle indicates that the colors is different for each line. Use cyclereset to restart the cycling of colors from the first color. Use fromtheme to take the color from the selected color theme.
linewidth
double | preference
1
The line width.
linemarker
none | cycle | asterisk | circle | diamond | plus | point | square | star | triangle
none
The line markers, if any. Cycle indicates that the marker is different for each line.
linestyle
none | cycle | solid | dotted | dashed | dashdot
solid
The line style, if any. Cycle indicates that the line style is different for each line.
measure
auto | integral | count
auto
The measure for evaluation of the histogram data. Choose integral for volume-based data; choose count of element-based data. auto is count for Mesh datasets; integral otherwise.
method
limit | number
number
The method used to specify the bins in which the expression’s range is split
normalization
integralsum | integralscaled | none | peak
none
The normalization of the values plot on the y-axis.
number
nonnegative integer
10
The number of bins if method is number.
numberofcolors
integer
7
The number of colors in the color cycle when cyclelength is manual.
prefixintitle
String
Empty
Added prefix to contribution to title
rangecoloractive
on | off
off
Whether to use the manual color range specified in rangecolormin and rangecolormax. The color range specifies the minimum and maxim value in the plotted colors. Default is the minimum and maximum data values. This and other range settings are available for 2D Histogram plots.
reversecolortable
boolean
false
Whether to reverse the order of the colors in the color table. Active when linecolor is cyclecolortable.
source
table | evaluationgroup
table
The data source for the histogram: a table or an evaluation group.
suffixintitle
String
Empty
Added suffix to contribution to title
table
Tag of table or none
none
The table to take the data from, when source is set to table.
title
String
The auto-title.
The title to use when titletype is manual.
titletype
auto | custom | label | manual | none
auto
auto, if the title should be computed automatically. custom, if the title should be computed automatically, but customized. label, if the title should be the plot group’s label. manual, if the manual title should be used (the title property). none, if no title should be displayed.
topcolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
white
The bottom color to use for a color gradient. Active when linecolor is cyclegradient.
type
curve | solid
curve
Use a filled histogram (solid) or a histogram drawn using lines (curve). This property is only available when function is discrete.
typeintitle
on | off
on
Whether the title contribution should contain the type when titletype is custom.
unitintitle
on | off
on
Whether the title contribution should contain the unit when titletype is custom.
xaxisdata
Column integer
 
An integer representing the table column to use as the x-coordinate.
yaxisdata
Column integer
 
An integer representing the table column to use as the y-coordinate (2D only).
Attributes
Height, AberrationHeight, HistogramHeight, TableHeight (2D only); Transparency (if a height attribute is used)
See Also
Histogram, MatrixHistogram