public class FacetChart extends DrawPane implements HasChartBackgroundDrawnHandlers, HasChartDrawnHandlers, HasDataLabelClickHandlers, HasDataLabelHoverHandlers, HasLegendClickHandlers, HasLegendHoverHandlers, HasValueClickHandlers, HasZoomChangedHandlers
Can be used directly, or specified as ListGrid.chartConstructor
or
CubeGrid.chartConstructor
.
NOTE: you must load the Drawing and Charts
Optional Modules
before you can use FacetChart. Also,
the Charts Module is available in Pro Edition or better, please see
smartclient.com/product for licensing
information.
To create a FacetChart, set facets
to an Array of Facet
objects describing the
chart dimensions and valueProperty
to value field
name. For example:
// Creating data Record sprRec = new Record(); sprRec.setAttribute("season", "Spring"); sprRec.setAttribute("temp", "79"); Record sumRec = new Record(); sumRec.setAttribute("season", "Summer"); sumRec.setAttribute("temp", "102"); Record autRec = new Record(); autRec.setAttribute("season", "Autumn"); autRec.setAttribute("temp", "81"); Record winRec = new Record(); winRec.setAttribute("season", "Winter"); winRec.setAttribute("temp", "59"); // Creating chart FacetChart chart = new FacetChart(); chart.setFacets(new Facet("season", "Season")); chart.setValueProperty("temp"); chart.setData(new Record[]{sprRec, sumRec, autRec, winRec}); chart.setTitle("Average temperature in Las Vegas");
The following SDK examples demonstrate charts with a single facet:
Having an "inlined facet" is another method to provide data to the chart. In this case each CellRecord
contains multiple data values; one facet definition is considered "inlined", meaning that
the facetValueIds from this facet appear as properties in each Record, and each such
property holds one data value. In this case the singular valueProperty
is ignored.
For example:
// Creating data CellRecord lvRec = new CellRecord(); lvRec.setAttribute("spring", "79"); lvRec.setAttribute("summer", "102"); lvRec.setAttribute("autumn", "81"); lvRec.setAttribute("winter", "59"); // Creating inlined facet Facet inlinedFacet = new Facet(); inlinedFacet.setInlinedValues(true); inlinedFacet.setValues( new FacetValue("spring", "Spring"), new FacetValue("summer", "Summer"), new FacetValue("autumn", "Autumn"), new FacetValue("winter", "Winter") ); // Creating chart FacetChart chart = new FacetChart(); chart.setFacets(inlinedFacet); chart.setData(new Record[]{lvRec}); chart.setTitle("Average temperature in Las Vegas");Example with two facets:
// Creating data CellRecord lvRec = new CellRecord(); lvRec.setAttribute("city", "Las Vegas"); lvRec.setAttribute("spring", "79"); lvRec.setAttribute("summer", "102"); lvRec.setAttribute("autumn", "81"); lvRec.setAttribute("winter", "59"); CellRecord nyRec = new CellRecord(); nyRec.setAttribute("city", "New York"); nyRec.setAttribute("spring", "60"); nyRec.setAttribute("summer", "83"); nyRec.setAttribute("autumn", "66"); nyRec.setAttribute("winter", "40"); // Creating inlined facet Facet inlinedFacet = new Facet(); inlinedFacet.setInlinedValues(true); inlinedFacet.setValues( new FacetValue("spring", "Spring"), new FacetValue("summer", "Summer"), new FacetValue("autumn", "Autumn"), new FacetValue("winter", "Winter") ); // Creating chart FacetChart chart = new FacetChart(); chart.setFacets(inlinedFacet, new Facet("city", "City")); chart.setData(new Record[]{lvRec, nyRec}); chart.setStacked(false); chart.setTitle("Average temperatures");
FacetChart supports drawing multiple vertical axes. This is commonly used to show values with different units (for example: sales in dollars, total units shipped) and/or very different ranges (for example: gross revenue, profit) on the same chart. Each set of values, referred to as a "metric", gets its own axis and gradation marks.
To use multiple axes, you add an additional facet called the "metric facet" that specifies
each axis to be plotted as a facetValueId. The metric facet is an inlined facet, so as with
inlined facets in general, each CellRecord has a value for each facetValueId of the metric
facet. You then set extraAxisMetrics
to the
list of
metrics that should be plotted as additional axes.
For example, if you were plotting revenue and profit for each month of the year, you would
have one facet named "metric" with facetValueIds "revenue" and "profit" and a second facet
"month". Each CellRecord would have the revenue and profit for one month, stored under the
properties "revenue" and "profit". Setting extraAxisMetrics
to ["profit"]
would cause profit to be plotted as the second axis. See the
Dual Axis SDK sample for
an example.
You can have multiple extra axes and the additional axes and gradation tics will be drawn at
increasing distances from the chart. By default, the first metric is drawn as a column chart
and subsequent metrics are drawn as lines; you can override this via
extraAxisSettings
. See the
3+ Axes SDK sample for
an example of multiple extra axes.
Multi-axis, multi-facet charts are also allowed. Extending the previous example, you might add a new facet "company", for a total of 3 facets. Each CellRecord would have "revenue" and "profit" for one combination of "company" and "month". The default appearance in this case would show revenue as clustered columns (one cluster per month, one column per company) and would show profit as multiple lines (one per company). See the Multi-Series SDK sample for an example of a multi-axis, multi-facet chart.
To achieve a mixed plot like this, define it as a multi-axis chart as explained above, but
set MetricSettings.showAxis
false to avoid a second
axis appearing, and set
MetricSettings.matchGradations
to cause the
same gradations to be used for both
plots.
See the Mixed Plots SDK example.
A "histogram" chart is similar to a stacked
"column"
chart, showing
multiple facet values vertically for each position along the x-axis /
data label facet
, but instead of each vertical
facet
value being defined only by a length, a "histogram" chart defines a segment for each,
represented by both a start point (the "value
property"
) and
an end point (the "endValue metric"
).
Segments may overlap, with the last segment drawn receiving the highest z-ordering. To
override this default behavior, values may be provided using an additional metric -
zIndexMetric
- whose value must be a non-negative
integer no greater than
maxDataZIndex
.
Scatter charts differ from other chart types in that both axes represent continuous numeric
data rather than a discrete set of facet values (like months of the year). For this reason
Scatter charts use the same concept of a "metric" facet as is used by Dual-Axis charts,
where the metric facet is expected to have exactly two metrics: the
xAxisMetric
and yAxisMetric
.
Unlike all other chart types, a scatter plot may be specified with only the metric facet. However one additional facet can be defined, which allows multiple sets of x,y points to be drawn in different colors, analogous to the different colors of a multi-series line chart.
See the Scatter Plot SDK example.
Date values on the X axis
FacetChart also supports scatter charts where the x-axis represents date- or time-valued
data and the y-axis represents numeric data, as normal. To enable this mode all records in
the data must have values for the facetValueId of the
xAxisMetric
that are true Date objects, not Strings
or
null
s. For these charts, vertical lines are drawn to represent a sequence of
significant datetime values on the x-axis, such as the first day of the month or week. The
mechanism used to select these Dates and format them into the x-axis labels is the same
mechanism used by charts with labelCollapseMode
set to
"time".
A "bubble" chart is a type of scatter chart where the size of each rendered data
point represents an additional metric value, allowing 3 continuous data values to be
visualized together. When using chartType:"Bubble"
, the additional metric
is configured via pointSizeMetric
.
Points will be sized between the minDataPointSize
and
maxDataPointSize
, optionally with
logarithmic scaling
. A legend will be
included showing
how point size represents data values, and a multi-facet Bubble chart can optionally use a
different shape for each facetValue
via
useMultiplePointShapes
.
Variable-size points can also be used with other, non-scatter chart types (such as "Line"
or "Radar") when showDataPoints
is enabled, by
setting
pointSizeMetric
to the FacetValue.id
of a facetValue
of the metric facet. In this case, a legend for point sizes is not shown by default, but can
be enabled via showPointSizeLegend
.
Whenever drawing variable size data points, by default, the largest data points are drawn
first so that smaller data points are less likely to be completely occluded by larger data
points, but this can be disabled by setting
autoSortBubblePoints
to false
.
Visual
appearance of data points can be further customized by setting the
bubbleProperties
.
See the Bubble Chart SDK example.
FacetChart supports rendering an additional metric value as the color of each data
point. This feature requires that showDataPoints
be
enabled and is configured via colorScaleMetric
.
Instead
of data points being drawn using a separate color for each facetValue
of the
legend facet, the data points will be drawn using a color interpolated between the
scaleStartColor
and
scaleEndColor
, optionally with
logarithmic scaling
. A legend is included by
default
via showColorScaleLegend
that shows how the
data
values are mapped to a color via a gradient over the range of colors used in the chart.
Visual appearance of data points in color scale charts can be further customized by setting
the bubbleProperties
, just as with bubble
charts.
Note that when color is being used to show values of the colorScaleMetric
then
color cannot be used to distinguish between different facetValues
. Therefore
color scale charts cannot have a (non-metric) legend facet.
See the Color Scale Chart SDK example.
FacetCharts support printing on all supported desktop browsers. When using Pro Edition or
better with the Smart GWT Server Framework installed, charts can also be exported to PDF
via RPCManager.exportContent()
or to images via RPCManager.exportImage()
.
DrawPane.InvalidDrawingTypeException
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName
Constructor and Description |
---|
FacetChart() |
FacetChart(com.google.gwt.core.client.JavaScriptObject jsObj) |
Modifier and Type | Method and Description |
---|---|
com.google.gwt.event.shared.HandlerRegistration |
addChartBackgroundDrawnHandler(ChartBackgroundDrawnHandler handler)
Add a chartBackgroundDrawn handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addChartDrawnHandler(ChartDrawnHandler handler)
Add a chartDrawn handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDataLabelClickHandler(DataLabelClickHandler handler)
Add a dataLabelClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDataLabelHoverHandler(DataLabelHoverHandler handler)
Add a dataLabelHover handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addLegendClickHandler(LegendClickHandler handler)
Add a legendClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addLegendHoverHandler(LegendHoverHandler handler)
Add a legendHover handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addValueClickHandler(ValueClickHandler handler)
Add a valueClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addZoomChangedHandler(ZoomChangedHandler handler)
Add a zoomChanged handler.
|
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
Changes the defaults for Canvas AutoChildren named
autoChildName . |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
Changes the defaults for FormItem AutoChildren named
autoChildName . |
protected com.google.gwt.core.client.JavaScriptObject |
create() |
java.lang.Boolean |
drawnValueContainsPoint(DrawnValue drawnValue)
Returns whether a given
DrawnValue contains a point. |
java.lang.Boolean |
drawnValueContainsPoint(DrawnValue drawnValue,
java.lang.Integer x) |
java.lang.Boolean |
drawnValueContainsPoint(DrawnValue drawnValue,
java.lang.Integer x,
java.lang.Integer y)
Returns whether a given
DrawnValue contains a point. |
java.lang.String |
formatFacetValueId(java.lang.Object value,
Facet facet)
Return the text string to display for facet value labels that appear in chart legends or as labels for
chartType s that have circumference or non-axis labels, such
as for example "Pie" or "Radar" charts. |
java.lang.String |
formatSegmentLabel(java.lang.Object startValue,
java.lang.Object endValue)
Defines the format of the label for a segment in a histogram chart.
|
boolean |
getAllowBubbleGradients()
Setting this flag to
false prevents the chart from drawing fill gradients into the bubbles of each data
point. |
ChartType[] |
getAllowedChartTypes()
Other
chart types that the end user will be allowed to switch to, using the
built-in context menu. |
java.lang.Boolean |
getAutoRotateLabels()
Deprecated.
As of Smart GWT 9.0 this property is replaced by the property
rotateLabels . Setting rotateLabels to "auto" is
equivalent to setting autoRotateLabels to true . Setting rotateLabels to "never" is equivalent to setting
autoRotateLabels to false . |
boolean |
getAutoScrollContent()
|
boolean |
getAutoScrollData()
For some
chart-types , should the chart body be
automatically expanded and scrollbars introduced according to data? |
AutoScrollDataApproach |
getAutoScrollDataApproach()
If set, overrides the default behavior of
autoScrollData , potentially limiting what factors drive the automatic expansion of the chart. |
boolean |
getAutoSortBubblePoints()
Whether to draw data points in order of descending
point size so that small values are less likely to be
completely occluded by larger values. |
java.lang.Double |
getAxisEndValue()
End value for the primary axis of the chart.
|
java.lang.Double |
getAxisStartValue()
Start value for the primary axis of the chart.
|
DrawRect |
getBackgroundBandProperties()
Properties for background band
|
java.lang.Boolean |
getBandedBackground()
Whether to show alternating color bands in the background of chart.
|
java.lang.Boolean |
getBandedStandardDeviations()
Whether to show color bands between the
standard deviation lines. |
int |
getBarMargin()
Distance between bars.
|
DrawRect |
getBarProperties()
Properties for bar
|
java.lang.Boolean |
getBrightenAllOnHover()
When hovering over a bar chart block, should the whole bar chart area be brightened Default behaviour is to just
brighten the line color around the bar chart area
|
int |
getBubbleHoverMaxDistance()
Maximum distance from the *outer radius* of the nearest bubble when hover will be shown.
|
DrawItem |
getBubbleProperties()
Properties for the shapes displayed around the data points (for example, in a bubble chart).
|
java.lang.Boolean |
getCanMoveAxes()
Whether the positions of value axes can be changed.
|
java.lang.Boolean |
getCanZoom()
Enables "zooming" on the X axis, specifically, only a portion of the overall dataset is shown in the main chart, and a
second smaller chart appears with slider controls
allowing a range to be selected for display in the main chart. |
java.lang.Boolean |
getCenterLegend()
Whether to place the
chart legend with respect to the
full, scrollable width of the chart when autoScrollData is active. |
java.lang.Boolean |
getCenterTitle()
Whether to place the
chart title with respect to the
full, scrollable width of the chart when autoScrollData is active. |
Point |
getChartCenter()
Returns the centerpoint for radar charts and pie charts.
|
float |
getChartHeight(boolean recalc)
Deprecated.
|
double |
getChartHeightAsDouble(boolean recalc)
Get the height the central chart area, where data elements appear.
|
float |
getChartLeft()
Deprecated.
|
double |
getChartLeftAsDouble()
Get the left margin of the central chart area, where data elements appear.
|
float |
getChartRadius()
Deprecated.
|
double |
getChartRadiusAsDouble()
Returns the radius for radar charts and pie charts.
|
int |
getChartRectMargin()
Margin around the main chart rect: between title and chart, between chart and axis labels, and chart rect and right edge
of chart.
|
DrawRect |
getChartRectProperties()
Properties for chart rect.
|
float |
getChartTop()
Deprecated.
|
double |
getChartTopAsDouble()
Get the top coordinate of the central chart area, where data elements appear.
|
ChartType |
getChartType()
See
ChartType for a list of known types - Column, Bar, Line, Pie, Doughnut, Area,
Radar, and Histogram charts are supported. |
float |
getChartWidth(boolean recalc)
Deprecated.
|
double |
getChartWidthAsDouble(boolean recalc)
Get the width of the central chart area, where data elements appear.
|
float |
getClusterMarginRatio()
For clustered charts, ratio between margins between individual bars and margins between clusters.
|
java.lang.Float |
getColorMutePercent()
Should be set to a number between -100 and 100.
|
java.lang.String |
getColorScaleMetric()
For charts where
showDataPoints is enabled, this
property specifies an additional metric (i.e. |
RecordList |
getDataAsRecordList() |
DrawLabel |
getDataAxisLabelProperties()
Properties for labels of data axis.
|
java.lang.String |
getDataColor(int index)
|
java.lang.String |
getDataColor(int index,
java.util.Date facetValueId,
java.lang.String purpose)
|
java.lang.String |
getDataColor(int index,
java.lang.Double facetValueId,
java.lang.String purpose)
|
java.lang.String |
getDataColor(int index,
java.lang.Integer facetValueId,
java.lang.String purpose)
|
java.lang.String |
getDataColor(int index,
java.lang.String facetValueId,
java.lang.String purpose)
Get a color from the
dataColors Array. |
java.lang.String[] |
getDataColors()
An array of colors to use for a series of visual elements representing data (eg columns, bars, pie slices), any of which
may be adjacent to any other.
|
Facet |
getDataLabelFacet()
|
java.lang.String |
getDataLabelHoverHTML(FacetValue facetValue)
Called when the mouse hovers over a data label, that is, a text label showing values from the first facet.
|
DrawLabel |
getDataLabelProperties()
Properties for data label
|
DrawLine |
getDataLineProperties()
Properties for lines that show data (as opposed to gradations or borders around the data area).
|
DataLineType |
getDataLineType()
How to draw lines between adjacent data points in Line and Scatter charts.
|
int |
getDataMargin()
For rectangular charts (bar, column, line), margin around the inside of the main chart area, so that data elements are
not flush to edge.
|
DrawItem |
getDataOutlineProperties()
Properties for lines that outline a data shape (in filled charts such as area or radar charts).
|
DrawItem |
getDataPointProperties()
Common properties to apply for all data points (see
showDataPoints ). |
int |
getDataPointSize()
Size in pixels for data points drawn for line, area, radar and other chart types.
|
DrawPath |
getDataShapeProperties()
Properties for data shapes (filled areas in area or radar charts).
|
int |
getDecimalPrecision()
Default precision used when formatting float numbers for axis labels
|
java.lang.Boolean |
getDiscontinuousLines()
Whether to treat non-numeric values in the dataset as indicating a break in the data line.
|
DrawOval |
getDoughnutHoleProperties()
Properties for doughnut hole
|
float |
getDoughnutRatio()
If showing a doughnut hole (see
showDoughnut ),
ratio of the size of the doughnut hole to the size of the overall pie chart, as a number between 0 to 1. |
java.lang.Boolean |
getDrawLegendBoundary()
Whether a boundary should be drawn above the Legend area for circumstances where the chart area already has an outer
border.
|
DrawnValue |
getDrawnValue(FacetValueMap facetValues)
Returns rendering information for the data value specified by the passed facet values.
|
DrawnValue |
getDrawnValueAtPoint()
Returns a
DrawnValue object for the data value that is shown nearest to the
passed coordinates only if it's under the given coordinates, or under the current mouse event coordinates if no
coordinates are passed. |
DrawnValue |
getDrawnValueAtPoint(java.lang.Integer x) |
DrawnValue |
getDrawnValueAtPoint(java.lang.Integer x,
java.lang.Integer y) |
DrawnValue |
getDrawnValueAtPoint(java.lang.Integer x,
java.lang.Integer y,
java.lang.String metric)
Returns a
DrawnValue object for the data value that is shown nearest to the
passed coordinates only if it's under the given coordinates, or under the current mouse event coordinates if no
coordinates are passed. |
DrawnValue[] |
getDrawnValues()
Returns rendering information for the data values specified by the passed facet values.
|
DrawnValue[] |
getDrawnValues(FacetValueMap facetValues)
Returns rendering information for the data values specified by the passed facet values.
|
DrawnValue[] |
getDrawnValuesAtPoint()
Returns an array of
DrawnValue objects for the data values of each metric that
are shown nearest to the passed coordinates, but only if they're under the given coordinates, or under the current mouse
event coordinates if no coordinates are passed. |
DrawnValue[] |
getDrawnValuesAtPoint(java.lang.Integer x) |
DrawnValue[] |
getDrawnValuesAtPoint(java.lang.Integer x,
java.lang.Integer y)
Returns an array of
DrawnValue objects for the data values of each metric that
are shown nearest to the passed coordinates, but only if they're under the given coordinates, or under the current mouse
event coordinates if no coordinates are passed. |
java.lang.Boolean |
getDrawTitleBackground()
should a background color be set behind the Title.
|
java.lang.Boolean |
getDrawTitleBoundary()
Whether a boundary should be drawn below the title area for circumstances where the chart area already has an outer
border.
|
java.lang.String |
getEditProxyConstructor()
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode . |
java.lang.String |
getEndValueMetric()
Specifies the attribute in the metric facet that will define the end point of segments in a histogram chart.
|
float |
getErrorBarColorMutePercent()
This property helps specify the color of the error bars and its value must be a number between -100 and 100.
|
int |
getErrorBarWidth()
Width of the horizontal line of the "T"-shape portion of the error bar).
|
DrawLine |
getErrorLineProperties()
Properties of the lines used to draw error bars (short, horizontal lines at the low and high metric values, and a
vertical connecting line).
|
DrawItem |
getExpectedValueLineProperties()
Properties for the
line drawn at the mean
value . |
Alignment |
getExtraAxisLabelAlign()
Horizontal alignment of labels shown in extra y-axes, shown to the right of the chart.
|
java.lang.String[] |
getExtraAxisMetrics()
Defines the set of metrics that will be plotted as additional vertical axes.
|
MetricSettings[] |
getExtraAxisSettings()
For charts will multiple vertical axes, optionally provides settings for how each
extra axis metric is plotted. |
Facet |
getFacet(java.lang.String facetId)
Get a facet definition by facetId.
|
Facet[] |
getFacets()
An Array of facets, exactly analogous to
CubeGrid.facets ,
except that: the "inlinedValues" property can be set on a facet to change data representation as described
under Chart.data. |
Facet |
getFacetsAsFacet()
An Array of facets, exactly analogous to
CubeGrid.facets ,
except that: the "inlinedValues" property can be set on a facet to change data representation as described
under Chart.data. |
FacetValue |
getFacetValue(java.lang.String facetId,
java.lang.String facetValueId)
Get facet value definition by facetId and facetValueId.
|
java.lang.Boolean |
getFilled()
Whether shapes are filled, for example, whether a multi-series line chart appears as a stack of filled regions as
opposed to just multiple lines.
|
java.lang.Boolean |
getFormatStringFacetValueIds()
Whether to call
setXAxisValueFormatter() or
formatFacetValueId() on a facet value id when
the id is a string. |
float[] |
getGradationGaps()
Candidate gradation gaps to evaluate when trying to determine what gradations should be displayed on the primary axis,
which is typically the y (vertical) axis except for Bar charts.
|
int |
getGradationLabelPadding()
Padding from edge of Y the Axis Label.
|
DrawLabel |
getGradationLabelProperties()
Properties for gradation labels
|
DrawLine |
getGradationLineProperties()
Properties for gradation lines
|
float[] |
getGradations()
Return an array of the gradation values used in the current chart.
|
java.lang.Integer |
getGradationTickMarkLength()
Deprecated.
use
tickLength instead |
DrawLine |
getGradationZeroLineProperties()
Properties for the gradation line drawn for zero (slightly thicker by default).
|
java.lang.String |
getHighErrorMetric()
See
lowErrorMetric . |
int |
getHoverLabelPadding()
An extra amount of padding to show around the
hoverLabel when showValueOnHover is enabled. |
DrawLabel |
getHoverLabelProperties()
Properties for text in a floating label that represents the data value shown whenever the mouse moves withing the main
chart area when
showValueOnHover is enabled. |
DrawRect |
getHoverRectProperties()
Properties for rectangle that draws behind of a floating hover label that represents the data value.
|
LabelCollapseMode |
getLabelCollapseMode()
What to do when there are too many data points to be able to show labels for every data point at the current chart size
- see
LabelCollapseMode . |
LegendAlign |
getLegendAlign()
Horizontal alignment of the chart's
legend widget . |
DrawLine |
getLegendBoundaryProperties()
Properties for top boundary of the legend are, when there is already an outer container around the whole chart.
|
Facet |
getLegendFacet()
|
java.lang.String |
getLegendHoverHTML(FacetValue facetValue,
FacetValue metricFacetValue)
Called when the mouse hovers over a color swatch or its label in the legend area of the chart.
|
int |
getLegendItemPadding()
Padding between each swatch and label pair.
|
DrawLabel |
getLegendLabelProperties()
Properties for labels shown next to legend color swatches.
|
int |
getLegendMargin()
Space between the legend and the chart rect or axis labels (whatever the legend is adjacent to.
|
int |
getLegendPadding()
Padding around the legend as a whole.
|
int |
getLegendRectHeight()
If drawing a border around the legend, the height of the drawn Rectangle.
|
DrawRect |
getLegendRectProperties()
Properties for rectangle around the legend as a whole.
|
DrawRect |
getLegendSwatchProperties()
Properties for the swatches of color shown in the legend.
|
int |
getLegendSwatchSize()
Size of individual color swatches in legend.
|
int |
getLegendTextPadding()
Padding between color swatch and its label.
|
int |
getLogBase()
When
useLogGradations , base value for
logarithmic gradation lines. |
float[] |
getLogGradations()
When
useLogGradations is set, gradation lines
to show in between powers,
expressed as a series of integer or float values between 1 and logBase . |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
getLogicalStructure()
Getter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
java.lang.Boolean |
getLogScale()
Whether to use logarithmic scaling for values.
|
boolean |
getLogScalePointColor()
Whether to use logarithmic scaling for the
color
scale of the data points. |
boolean |
getLogScalePointSize()
Whether to use logarithmic scaling for the
data
point sizes . |
java.lang.String |
getLowErrorMetric()
lowErrorMetric and highErrorMetric
can be used to cause error bars to appear above and below the main data point. |
float[] |
getMajorTickGradations()
List of tick marks that should be drawn as major ticks, expressed as a series of numbers between 1 and 10, representing
boundaries within a given order of magnitude (power of 10).
|
java.lang.String[] |
getMajorTickTimeIntervals()
When ticks are being
shown on the X axis for a
Scatter plot where the X axis uses time/date values, controls the intervals which are shown as major ticks. |
java.lang.Boolean |
getMatchBarChartDataLineColor()
Setting to define whether the border around the bar chart area should be the same color as the main chart area.
|
java.lang.Float |
getMax(FacetValueMap criteria)
Calculate the maximum of the data from a single metric.
|
java.lang.Float |
getMax(java.lang.String criteria)
Calculate the maximum of the data from a single metric.
|
int |
getMaxBarThickness()
Bars will not be drawn over this thickness, instead, margins will be increased.
|
double |
getMaxDataPointSize()
The maximum allowed data point size when controlled by
pointSizeMetric . |
java.lang.Integer |
getMaxDataZIndex()
Maximum allowed zIndex that can be specified through
zIndexMetric in a histogram chart. |
java.lang.Float |
getMean(FacetValueMap criteria)
Calculate the mean, or expected value, of the data over a single metric.
|
java.lang.Float |
getMean(java.lang.String criteria)
Calculate the mean, or expected value, of the data over a single metric.
|
java.lang.Float |
getMedian(FacetValueMap criteria)
Calculate the median of the data over a single metric.
|
java.lang.Float |
getMedian(java.lang.String criteria)
Calculate the median of the data over a single metric.
|
java.lang.String |
getMetricFacetId()
Specifies the "id" of the default metric facet value.
|
java.lang.Float |
getMin(FacetValueMap criteria)
Calculate the minimum of the data from a single metric.
|
java.lang.Float |
getMin(java.lang.String criteria)
Calculate the minimum of the data from a single metric.
|
int |
getMinBarThickness()
If bars would be smaller than this size, margins are reduced until bars overlap.
|
java.lang.Integer |
getMinChartHeight()
Minimum height for this chart instance.
|
java.lang.Integer |
getMinChartWidth()
Minimum width for this chart instance.
|
int |
getMinContentHeight()
When
autoScrollContent is true, limits the
minimum height of the chart-content, including data, labels, title and legends. |
int |
getMinContentWidth()
When
autoScrollContent is true, limits the
minimum width of the chart-content, including data, labels, titles and legends. |
double |
getMinDataPointSize()
The minimum allowed data point size when controlled by
pointSizeMetric . |
int |
getMinDataSpreadPercent()
If all data values would be spread across less than
minDataSpreadPercent of the axis, the start values
of axes will be automatically adjusted to make better use of space. |
java.lang.Integer |
getMinLabelGap()
Minimum gap between labels on the X axis before some labels are omitted or larger time granularity is shown (eg show
days instead of hours) based on the
labelCollapseMode . |
int |
getMinorTickLength()
Length of minor ticks marks shown along axis, if
minor tick marks are enabled. |
int |
getMinXDataSpreadPercent()
For scatter charts only, if all data points would be spread across less than
minXDataSpreadPercent of the x-axis, the start
value of x-axis will be automatically adjusted to make better use of space. |
DrawnValue |
getNearestDrawnValue()
Returns rendering information for the data value that is shown nearest to the passed coordinates, as a
DrawnValue object. |
DrawnValue |
getNearestDrawnValue(java.lang.Integer x) |
DrawnValue |
getNearestDrawnValue(java.lang.Integer x,
java.lang.Integer y) |
DrawnValue |
getNearestDrawnValue(java.lang.Integer x,
java.lang.Integer y,
java.lang.String metric)
Returns rendering information for the data value that is shown nearest to the passed coordinates, as a
DrawnValue object. |
DrawnValue[] |
getNearestDrawnValues()
Returns an array of
DrawnValue objects containing rendering information for
the data values having each metric that are shown nearest to the passed coordinates. |
DrawnValue[] |
getNearestDrawnValues(java.lang.Integer x) |
DrawnValue[] |
getNearestDrawnValues(java.lang.Integer x,
java.lang.Integer y)
Returns an array of
DrawnValue objects containing rendering information for
the data values having each metric that are shown nearest to the passed coordinates. |
java.lang.Integer |
getNumDataPoints()
Count the number of data points.
|
java.lang.Integer |
getNumDataPoints(FacetValueMap criteria)
Count the number of data points.
|
static FacetChart |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
float[] |
getOtherAxisGradationGaps()
Like
gradationGaps , except allows control of
gradations for the X (horizontal) axis, for Scatter charts only. |
java.lang.String[] |
getOtherAxisGradationTimes()
For charts that have a date/time-valued X-axis, gradations can instead be specified as
Strings, consisting of a number and trailing letter code, where the letter code indicates
the unit of time.
|
java.lang.Integer |
getOtherAxisPixelsPerGradation()
Ideal number of pixels to leave between each gradation on the x (horizontal axis), for Scatter plots only.
|
boolean |
getPadChartRectByCornerRadius()
If
showChartRect is enabled and if chartRectProperties specifies a nonzero rounding , whether the padding around the inside of the chart
rect. |
java.lang.Float |
getPercentile(FacetValueMap criteria,
float percentile)
Calculate a percentile of the data over a single metric.
|
java.lang.Float |
getPercentile(java.lang.String criteria,
float percentile)
Calculate a percentile of the data over a single metric.
|
DrawOval |
getPieBorderProperties()
Properties for the border around a pie chart.
|
int |
getPieLabelAngleStart()
Angle where first label is placed in a Pie chart in stacked mode, in degrees.
|
int |
getPieLabelLineExtent()
How far label lines stick out of the pie radius in a Pie chart in stacked mode.
|
DrawLine |
getPieLabelLineProperties()
Properties for pie label line
|
DrawOval |
getPieRingBorderProperties()
Properties for pie ring border
|
DrawSector |
getPieSliceProperties()
Properties for pie slices
|
java.lang.Integer |
getPieStartAngle()
Default angle in degrees where pie charts start drawing sectors to represent data values.
|
int |
getPixelsPerGradation()
Ideal number of pixels to leave between each gradation on the primary axis, which is typically the y (vertical) axis
except for Bar charts.
|
java.lang.Integer |
getPointColorLogBase()
When
logScalePointColor is true ,
this property specifies the base value for logarithmic color scale metric values. |
PointShape[] |
getPointShapes()
For charts where
showDataPoints is enabled, this
property specifies an array of geometric shapes to draw for the data points of each series. |
java.lang.Integer |
getPointSizeGradations()
When a
point size legend is shown, this
property controls the number of gradations of the pointSizeMetric that the chart tries to display. |
java.lang.Integer |
getPointSizeLogBase()
When
logScalePointSize is true, base value for
logarithmic point size metric values. |
float[] |
getPointSizeLogGradations()
When
usePointSizeLogGradations is set,
this property specifies the pointSizeMetric
value gradations to show in the point size
legend in between powers, expressed as a series of integer or float values between 1 and pointSizeLogBase . |
java.lang.String |
getPointSizeMetric()
For charts where
showDataPoints is enabled, this
property specifies an additional metric (i.e. |
void |
getPolynomialRegressionFunction()
For scatter plots only, get a Function from the specified independent variable X to the specified dependent variable Y
that defines the polynomial that best fits the data.
|
void |
getPolynomialRegressionFunction(java.lang.Integer degree) |
void |
getPolynomialRegressionFunction(java.lang.Integer degree,
java.lang.String xMetric) |
void |
getPolynomialRegressionFunction(java.lang.Integer degree,
java.lang.String xMetric,
java.lang.String yMetric)
For scatter plots only, get a Function from the specified independent variable X to the specified dependent variable Y
that defines the polynomial that best fits the data.
|
java.lang.String |
getPrintHTML(PrintProperties printProperties,
PrintHTMLCallback callback)
Retrieves printable HTML for this component and all printable subcomponents.
|
boolean |
getPrintZoomChart()
Should the
zoom chart be printed with this
FacetChart ? If true , then the SVG string returned by DrawPane.getSvgString() will include the zoom chart's SVG as
well. |
java.lang.String |
getProbabilityMetric()
The "id" of the metric facet value that assigns a probability to each combination of facets and their values.
|
java.lang.Boolean |
getProportional()
For multi-facet charts, render data values as a proportion of the sum of all data values that have the same label.
|
java.lang.String |
getProportionalAxisLabel()
Default title for the value axis label when the chart is in
proportional rendering mode . |
DrawOval |
getRadarBackgroundProperties()
Properties for radar background
|
LabelRotationMode |
getRadarRotateLabels()
This property controls whether to rotate the labels on the
data label facet of radar or stacked pie charts so that each label is parallel to its radial
gradation (these are the labels that appear around the perimeter). |
java.lang.Integer |
getRadialLabelOffset()
Distance in pixels that radial labels are offset from the outside of the circle.
|
java.lang.Float |
getRange(FacetValueMap criteria)
Calculate the range of the data from a single metric.
|
java.lang.Float |
getRange(java.lang.String criteria)
Calculate the range of the data from a single metric.
|
Record[] |
getRecords() |
DrawLine |
getRegressionLineProperties()
Properties for the
regression line . |
RegressionLineType |
getRegressionLineType()
Regression algorithm used for the
regression
line . |
int |
getRegressionPolynomialDegree()
For scatter plots only, specify the degree of polynomial to use for any polynomial regression that is calculated.
|
LabelRotationMode |
getRotateDataValues()
This property controls whether to rotate the labels shown for data-values in
Column-type charts . |
LabelRotationMode |
getRotateLabels()
This property controls whether to rotate the labels on the X-axis.
|
java.lang.String |
getScaleEndColor()
The ending color of the color scale when the data points are colored according to a
color scale metric . |
java.lang.String |
getScaleStartColor()
The starting color of the color scale when the data points are colored according to a
color scale metric . |
DrawOval |
getShadowProperties()
Properties for shadows.
|
boolean |
getShowBubbleLegendPerShape()
Whether to draw multiple bubble legends horizontally stacked to the right of the chart, one per shape type.
|
java.lang.Boolean |
getShowChartRect()
Whether to show a rectangular shape around the area of the chart where data is plotted.
|
java.lang.Boolean |
getShowColorScaleLegend()
Whether to show an additional legend underneath the chart to indicate color values.
|
java.lang.Boolean |
getShowDataAxisLabel()
Whether to show a label for the data axis as a whole (the data axis is where labels for each data point appear).
|
boolean |
getShowDataLabels()
If set to
false , data labels for values are entirely omitted. |
java.lang.Boolean |
getShowDataPoints()
For Line, Area, Radar, Scatter or Bubble charts, whether to show data points for each individual data value.
|
boolean |
getShowDataValues()
Deprecated.
in favor of
showDataValuesMode , a compound
setting that supports showing data-values in the chart and in hovers in various combinations. The equivalent to
showDataValues:true is ShowDataValuesMode.inChartOnly or
ShowDataValuesMode.inChartOrHover if showValueOnHover was also set to true. |
ShowDataValuesMode |
getShowDataValuesMode()
Strategy for determining whether and when to show data-values - either in the chart, near the shape representing a value
(above columns of a column chart for example, or adjacent to points in a line chart), in hovers, or some combination of
both, including
automatic rotation where
supported. |
java.lang.Boolean |
getShowDoughnut()
Whether to show a "doughnut hole" in the middle of pie charts.
|
java.lang.Boolean |
getShowExpectedValueLine()
Display a line at the
mean value . |
java.lang.Boolean |
getShowGradationsOverData()
If set, gradation lines are drawn on top of data rather than underneath.
|
java.lang.Boolean |
getShowInlineLabels()
Causes labels for the X axis to be shown above the axis and to the right of the gradation line they label, making for a
vertically more compact chart at the risk of gradation labels being partially obscured by data values.
|
java.lang.Boolean |
getShowLegend()
The legend is automatically shown for charts that need it (generally, multi-series charts) but can be forced off by
setting showLegend to false.
|
boolean |
getShowMinorTicks()
If
ticks are being shown, controls whether a
distinction is made between major and minor tick marks. |
java.lang.Boolean |
getShowPointSizeLegend()
Whether to show an additional legend to the right of the chart to indicate
point size . |
java.lang.Boolean |
getShowRadarGradationLabels()
Whether to show gradation labels in radar charts.
|
java.lang.Boolean |
getShowRegressionLine()
For scatter plots only, whether to display a regression curve that best fits the data of the two metric facet values.
|
java.lang.Boolean |
getShowScatterLines()
Whether to draw lines between adjacent data points in "Scatter" plots.
|
java.lang.Boolean |
getShowShadows()
Whether to automatically show shadows for various charts.
|
java.lang.Boolean |
getShowStandardDeviationLines()
Display multiple
standard deviations away from the mean
as lines. |
java.lang.Boolean |
getShowStatisticsOverData()
If set, the
mean line , standard deviation lines , standard deviation bands , and regression curves are drawn on top of the data
rather than underneath. |
java.lang.Boolean |
getShowTitle()
Whether to show a title.
|
java.lang.Boolean |
getShowValueAxisLabel()
Whether to show the
valueTitle (or, in the case of
proportional rendering mode , the proportionalAxisLabel ) as a label on the value
axis. |
java.lang.Boolean |
getShowValueOnHover()
Deprecated.
in favor of
showDataValuesMode , a compound
setting that supports showing data-values in the chart and in hovers in various combinations. The equivalent to
showValueOnHover:true is ShowDataValuesMode.inHoverOnly. |
boolean |
getShowXTicks()
When set, ticks are shown for the X (horizontal) axis for Scatter plots or Bar charts.
|
boolean |
getShowYTicks()
When set, ticks are shown for the Y (vertical) axis if it's a value axis.
|
void |
getSimpleLinearRegressionFunction()
For scatter plots only, get a Function from the specified independent variable X to the specified dependent variable Y
that defines the line that best fits the data.
|
void |
getSimpleLinearRegressionFunction(java.lang.String xMetric) |
void |
getSimpleLinearRegressionFunction(java.lang.String xMetric,
java.lang.String yMetric)
For scatter plots only, get a Function from the specified independent variable X to the specified dependent variable Y
that defines the line that best fits the data.
|
java.lang.Boolean |
getStacked()
Whether to use stacking for charts where this makes sense (column, area, pie, line and radar charts).
|
DrawItem |
getStandardDeviationLineProperties()
Properties for the
standard deviation
lines . |
float[] |
getStandardDeviations()
When
showStandardDeviationLines is
set, the number of standard deviation lines drawn
and their respective standard deviation away from the mean are specified by this property. |
java.lang.Float |
getStdDev(FacetValueMap criteria,
boolean population)
Calculate the standard deviation of the data from a single metric.
|
java.lang.Float |
getStdDev(java.lang.String criteria,
boolean population)
Calculate the standard deviation of the data from a single metric.
|
java.lang.String |
getStyleName()
Default styleName for the chart.
|
int |
getTickLength()
Length of the tick marks used when either
showXTicks
or showYTicks is enabled, or when extra value axes are in use. |
int |
getTickMarkToValueAxisMargin()
Margin between the tick marks and the labels of the
extra value axes . |
java.lang.String |
getTitle()
Title for the chart as a whole.
|
TitleAlign |
getTitleAlign()
Horizontal alignment of the chart's
title . |
DrawLabel |
getTitleBackgroundProperties()
Properties for title background (if being drawn).
|
DrawLine |
getTitleBoundaryProperties()
Properties for bottom boundary of the title area, when there is already an outer container around the whole chart.
|
int |
getTitlePadding()
if aligning the title left or right, the amount of space before (for left aligned) or after (for right aligned) to pad
the title from the border edge
|
DrawLabel |
getTitleProperties()
Properties for title label.
|
int |
getTitleRectHeight()
The height of the bordered rect around the title - defaults to 0 (assuming no border)
|
java.lang.Boolean |
getUseAutoGradients()
Causes the chart to use the colors specified in
dataColors but specify chart-specific gradients based on the primary data color per chart type. |
java.lang.Boolean |
getUseLogGradations()
Whether to use classic logarithmic gradations, where each order of magnitude is shown as a gradation as well as a few
intervening lines.
|
java.lang.Boolean |
getUseMultiplePointShapes()
Whether the chart should use multiple shapes to show data points.
|
java.lang.Boolean |
getUsePointSizeLogGradations()
Whether to use classic logarithmic gradations, where each order of magnitude is shown as a gradation as well as a few
intervening values, for the
pointSizeMetric
values displayed in the point size legend . |
java.lang.Boolean |
getUseSymmetricStandardDeviations()
Whether to display both the positive and negative of the
standard deviations . |
DrawLabel |
getValueAxisLabelProperties()
Properties for labels of value axis.
|
int |
getValueAxisMargin()
Margin between
multiple value axes . |
DrawLine |
getValueLineProperties()
Properties for a "value line" - a line shows where a particular discrete value is placed, eg, vertical lines connecting
points of a line chart to the X axis, or radial lines in a Radar chart.
|
java.lang.String |
getValueProperty()
Property in each record that holds a data value.
|
java.lang.String |
getValueTitle()
A label for the data values, such as "Sales in Thousands", typically used as the label for the value axis.
|
java.lang.Float |
getVariance(FacetValueMap criteria,
boolean population)
Calculate the variance of the data from a single metric.
|
java.lang.Float |
getVariance(java.lang.String criteria,
boolean population)
Calculate the variance of the data from a single metric.
|
java.lang.Double |
getXAxisEndValue()
For Bubble and Scatter charts only, the end value for the x-axis.
|
java.util.Date |
getXAxisEndValueAsDate()
For Bubble and Scatter charts only, the end value for the x-axis.
|
java.lang.String |
getXAxisMetric()
For scatter charts only, the "id" of the metric facet value to use for the x-axis.
|
java.lang.Double |
getXAxisStartValue()
For Bubble and Scatter charts only, the start value for the x-axis.
|
java.util.Date |
getXAxisStartValueAsDate()
For Bubble and Scatter charts only, the start value for the x-axis.
|
float |
getXCoord(double value)
Returns the X coordinate where the passed data value either was or would be drawn.
|
float |
getXCoord(FacetValueMap value)
Returns the X coordinate where the passed data value either was or would be drawn.
|
Alignment |
getYAxisLabelAlign()
Horizontal alignment of y-axis labels, shown to the left of the chart.
|
int |
getYAxisLabelPadding()
Padding between each swatch and label pair.
|
java.lang.String |
getYAxisMetric()
For scatter charts only, the "id" of the metric facet value to use for the y-axis.
|
float |
getYCoord(double value)
Returns the Y coordinate where the passed data value either was or would be drawn.
|
float |
getYCoord(FacetValueMap value)
Returns the Y coordinate where the passed data value either was or would be drawn.
|
java.lang.String |
getZIndexMetric()
Specifies the attribute in the metric facet that will define the z-ordering of the segments in a histogram chart.
|
FacetChart |
getZoomChart()
Mini-chart created to allow zooming when
canZoom is
enabled. |
double |
getZoomChartHeight()
Height of the
zoomChart . |
FacetChart |
getZoomChartProperties()
Properties to further configure the
zoomChart . |
RangeSlider |
getZoomChartSlider()
Slider controls shown on the mini-chart which is created when
canZoom is enabled. |
java.lang.Object |
getZoomEndValue()
For a
zoomed chart , end value of the data range shown in
the main chart. |
java.lang.Boolean |
getZoomLogScale()
|
float |
getZoomMutePercent()
colorMutePercent to use for the zoomChart . |
FacetChart |
getZoomSelectionChart()
Mini-chart created when
canZoom is enabled. |
FacetChart |
getZoomSelectionChartProperties()
Properties to further configure the
zoomSelectionChart . |
java.lang.Boolean |
getZoomShowSelection()
Whether the selected range should be shown in a different style, which can be configured via
zoomSelectionChartProperties . |
ZoomStartPosition |
getZoomStartPosition()
For a
zoomed chart , determines what portion of the
overall dataset should be initially shown in the main chart. |
java.lang.Object |
getZoomStartValue()
For a
zoomed chart , start value of the data range shown
in the main chart. |
FacetChart |
setAllowBubbleGradients(boolean allowBubbleGradients)
Setting this flag to
false prevents the chart from drawing fill gradients into the bubbles of each data
point. |
FacetChart |
setAllowedChartTypes(ChartType... allowedChartTypes)
Other
chart types that the end user will be allowed to switch to, using the
built-in context menu. |
FacetChart |
setAutoRotateLabels(java.lang.Boolean autoRotateLabels)
Deprecated.
As of Smart GWT 9.0 this property is replaced by the property
rotateLabels . Setting rotateLabels to "auto" is
equivalent to setting autoRotateLabels to true . Setting rotateLabels to "never" is equivalent to setting
autoRotateLabels to false . |
FacetChart |
setAutoScrollContent(boolean autoScrollContent)
|
FacetChart |
setAutoScrollData(boolean autoScrollData)
For some
chart-types , should the chart body be
automatically expanded and scrollbars introduced according to data? |
FacetChart |
setAutoScrollDataApproach(AutoScrollDataApproach autoScrollDataApproach)
If set, overrides the default behavior of
autoScrollData , potentially limiting what factors drive the automatic expansion of the chart. |
FacetChart |
setAutoSortBubblePoints(boolean autoSortBubblePoints)
Whether to draw data points in order of descending
point size so that small values are less likely to be
completely occluded by larger values. |
FacetChart |
setAxisEndValue(java.lang.Double axisEndValue)
End value for the primary axis of the chart.
|
FacetChart |
setAxisStartValue(java.lang.Double axisStartValue)
Start value for the primary axis of the chart.
|
void |
setAxisValueFormatter(ValueFormatter formatter)
Formatter to apply to values displayed in the gradation labels.
|
FacetChart |
setBackgroundBandProperties(DrawRect backgroundBandProperties)
Properties for background band
|
FacetChart |
setBandedBackground(java.lang.Boolean bandedBackground)
Whether to show alternating color bands in the background of chart.
|
FacetChart |
setBandedStandardDeviations(java.lang.Boolean bandedStandardDeviations)
Whether to show color bands between the
standard deviation lines. |
FacetChart |
setBarMargin(int barMargin)
Distance between bars.
|
FacetChart |
setBarProperties(DrawRect barProperties)
Properties for bar
|
FacetChart |
setBrightenAllOnHover(java.lang.Boolean brightenAllOnHover)
When hovering over a bar chart block, should the whole bar chart area be brightened Default behaviour is to just
brighten the line color around the bar chart area
|
FacetChart |
setBubbleHoverMaxDistance(int bubbleHoverMaxDistance)
Maximum distance from the *outer radius* of the nearest bubble when hover will be shown.
|
FacetChart |
setBubbleProperties(DrawItem bubbleProperties)
Properties for the shapes displayed around the data points (for example, in a bubble chart).
|
FacetChart |
setCanMoveAxes(java.lang.Boolean canMoveAxes)
Whether the positions of value axes can be changed.
|
FacetChart |
setCanZoom(java.lang.Boolean canZoom)
Enables "zooming" on the X axis, specifically, only a portion of the overall dataset is shown in the main chart, and a
second smaller chart appears with slider controls
allowing a range to be selected for display in the main chart. |
FacetChart |
setCenterLegend(java.lang.Boolean centerLegend)
Whether to place the
chart legend with respect to the
full, scrollable width of the chart when autoScrollData is active. |
FacetChart |
setCenterTitle(java.lang.Boolean centerTitle)
Whether to place the
chart title with respect to the
full, scrollable width of the chart when autoScrollData is active. |
FacetChart |
setChartRectMargin(int chartRectMargin)
Margin around the main chart rect: between title and chart, between chart and axis labels, and chart rect and right edge
of chart.
|
FacetChart |
setChartRectProperties(DrawRect chartRectProperties)
Properties for chart rect.
|
FacetChart |
setChartType(ChartType chartType)
See
ChartType for a list of known types - Column, Bar, Line, Pie, Doughnut, Area,
Radar, and Histogram charts are supported. |
FacetChart |
setClusterMarginRatio(float clusterMarginRatio)
For clustered charts, ratio between margins between individual bars and margins between clusters.
|
FacetChart |
setColorMutePercent(java.lang.Float colorMutePercent)
Should be set to a number between -100 and 100.
|
FacetChart |
setColorScaleMetric(java.lang.String colorScaleMetric)
For charts where
showDataPoints is enabled, this
property specifies an additional metric (i.e. |
void |
setData(Record[] records)
Dataset for this chart.
|
void |
setData(RecordList records) |
FacetChart |
setDataAxisLabelProperties(DrawLabel dataAxisLabelProperties)
Properties for labels of data axis.
|
void |
setDataColorMapper(ColorMapper colorMapper)
Sets a customizer to redefine what colors are used when rendering the chart data.
|
FacetChart |
setDataColors(java.lang.String... dataColors)
An array of colors to use for a series of visual elements representing data (eg columns, bars, pie slices), any of which
may be adjacent to any other.
|
void |
setDataGradientMapper(GradientMapper gradientMapper)
Sets a customizer to redefine what gradients are used when rendering the chart data.
|
void |
setDataLabelHoverHTMLCustomizer(DataLabelHoverCustomizer dataLabelHoverHTMLCustomizer)
Called when the mouse hovers over a data label, that is, a text label showing values from
the first facet.
|
FacetChart |
setDataLabelProperties(DrawLabel dataLabelProperties)
Properties for data label
|
void |
setDataLineColorMapper(ColorMapper colorMapper)
Sets a customizer to redefine what colors are used when rendering lines for the chart
data.
|
FacetChart |
setDataLineProperties(DrawLine dataLineProperties)
Properties for lines that show data (as opposed to gradations or borders around the data area).
|
FacetChart |
setDataLineType(DataLineType dataLineType)
How to draw lines between adjacent data points in Line and Scatter charts.
|
void |
setDataLineWidthMapper(LineWidthMapper lineWidthMapper)
Sets a customizer to define what widths to use for data lines in the chart.
|
FacetChart |
setDataMargin(int dataMargin)
For rectangular charts (bar, column, line), margin around the inside of the main chart area, so that data elements are
not flush to edge.
|
FacetChart |
setDataOutlineProperties(DrawItem dataOutlineProperties)
Properties for lines that outline a data shape (in filled charts such as area or radar charts).
|
FacetChart |
setDataPointProperties(DrawItem dataPointProperties)
Common properties to apply for all data points (see
showDataPoints ). |
FacetChart |
setDataPointSize(int dataPointSize)
Size in pixels for data points drawn for line, area, radar and other chart types.
|
FacetChart |
setDataShapeProperties(DrawPath dataShapeProperties)
Properties for data shapes (filled areas in area or radar charts).
|
void |
setDataValueFormatter(ValueFormatter formatter)
Formatter to apply to values displayed in the hover labels and other value labels
|
FacetChart |
setDecimalPrecision(int decimalPrecision)
Default precision used when formatting float numbers for axis labels
|
static void |
setDefaultProperties(FacetChart facetChartProperties)
Class level method to set the default properties of this class.
|
FacetChart |
setDiscontinuousLines(java.lang.Boolean discontinuousLines)
Whether to treat non-numeric values in the dataset as indicating a break in the data line.
|
FacetChart |
setDoughnutHoleProperties(DrawOval doughnutHoleProperties)
Properties for doughnut hole
|
FacetChart |
setDoughnutRatio(float doughnutRatio)
If showing a doughnut hole (see
showDoughnut ),
ratio of the size of the doughnut hole to the size of the overall pie chart, as a number between 0 to 1. |
FacetChart |
setDrawLegendBoundary(java.lang.Boolean drawLegendBoundary)
Whether a boundary should be drawn above the Legend area for circumstances where the chart area already has an outer
border.
|
FacetChart |
setDrawTitleBackground(java.lang.Boolean drawTitleBackground)
should a background color be set behind the Title.
|
FacetChart |
setDrawTitleBoundary(java.lang.Boolean drawTitleBoundary)
Whether a boundary should be drawn below the title area for circumstances where the chart area already has an outer
border.
|
FacetChart |
setEditProxyConstructor(java.lang.String editProxyConstructor)
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode . |
FacetChart |
setEndValueMetric(java.lang.String endValueMetric)
Specifies the attribute in the metric facet that will define the end point of segments in a histogram chart.
|
FacetChart |
setErrorBarColorMutePercent(float errorBarColorMutePercent)
This property helps specify the color of the error bars and its value must be a number between -100 and 100.
|
FacetChart |
setErrorBarWidth(int errorBarWidth)
Width of the horizontal line of the "T"-shape portion of the error bar).
|
FacetChart |
setErrorLineProperties(DrawLine errorLineProperties)
Properties of the lines used to draw error bars (short, horizontal lines at the low and high metric values, and a
vertical connecting line).
|
FacetChart |
setExpectedValueLineProperties(DrawItem expectedValueLineProperties)
Properties for the
line drawn at the mean
value . |
FacetChart |
setExtraAxisLabelAlign(Alignment extraAxisLabelAlign)
Horizontal alignment of labels shown in extra y-axes, shown to the right of the chart.
|
FacetChart |
setExtraAxisMetrics(java.lang.String... extraAxisMetrics)
Defines the set of metrics that will be plotted as additional vertical axes.
|
FacetChart |
setExtraAxisSettings(MetricSettings... extraAxisSettings)
For charts will multiple vertical axes, optionally provides settings for how each
extra axis metric is plotted. |
FacetChart |
setFacets(Facet... facets)
An Array of facets, exactly analogous to
CubeGrid.facets ,
except that: the "inlinedValues" property can be set on a facet to change data representation as described
under Chart.data. |
FacetChart |
setFacets(Facet facets)
An Array of facets, exactly analogous to
CubeGrid.facets ,
except that: the "inlinedValues" property can be set on a facet to change data representation as described
under Chart.data. |
FacetChart |
setFilled(java.lang.Boolean filled)
Whether shapes are filled, for example, whether a multi-series line chart appears as a stack of filled regions as
opposed to just multiple lines.
|
FacetChart |
setFormatStringFacetValueIds(java.lang.Boolean formatStringFacetValueIds)
Whether to call
setXAxisValueFormatter() or
formatFacetValueId() on a facet value id when
the id is a string. |
FacetChart |
setGradationGaps(float... gradationGaps)
Candidate gradation gaps to evaluate when trying to determine what gradations should be displayed on the primary axis,
which is typically the y (vertical) axis except for Bar charts.
|
FacetChart |
setGradationLabelPadding(int gradationLabelPadding)
Padding from edge of Y the Axis Label.
|
FacetChart |
setGradationLabelProperties(DrawLabel gradationLabelProperties)
Properties for gradation labels
|
FacetChart |
setGradationLineProperties(DrawLine gradationLineProperties)
Properties for gradation lines
|
FacetChart |
setGradationTickMarkLength(java.lang.Integer gradationTickMarkLength)
Deprecated.
use
tickLength instead |
FacetChart |
setGradationZeroLineProperties(DrawLine gradationZeroLineProperties)
Properties for the gradation line drawn for zero (slightly thicker by default).
|
FacetChart |
setHighErrorMetric(java.lang.String highErrorMetric)
See
lowErrorMetric . |
FacetChart |
setHoverLabelPadding(int hoverLabelPadding)
An extra amount of padding to show around the
hoverLabel when showValueOnHover is enabled. |
FacetChart |
setHoverLabelProperties(DrawLabel hoverLabelProperties)
Properties for text in a floating label that represents the data value shown whenever the mouse moves withing the main
chart area when
showValueOnHover is enabled. |
FacetChart |
setHoverRectProperties(DrawRect hoverRectProperties)
Properties for rectangle that draws behind of a floating hover label that represents the data value.
|
FacetChart |
setLabelCollapseMode(LabelCollapseMode labelCollapseMode)
What to do when there are too many data points to be able to show labels for every data point at the current chart size
- see
LabelCollapseMode . |
FacetChart |
setLegendAlign(LegendAlign legendAlign)
Horizontal alignment of the chart's
legend widget . |
FacetChart |
setLegendBoundaryProperties(DrawLine legendBoundaryProperties)
Properties for top boundary of the legend are, when there is already an outer container around the whole chart.
|
void |
setLegendHoverCustomizer(LegendHoverCustomizer legendHoverHTMLCustomizer)
Called when the mouse hovers over a color swatch or its label in the legend area of the
chart.
|
FacetChart |
setLegendItemPadding(int legendItemPadding)
Padding between each swatch and label pair.
|
FacetChart |
setLegendLabelProperties(DrawLabel legendLabelProperties)
Properties for labels shown next to legend color swatches.
|
FacetChart |
setLegendMargin(int legendMargin)
Space between the legend and the chart rect or axis labels (whatever the legend is adjacent to.
|
FacetChart |
setLegendPadding(int legendPadding)
Padding around the legend as a whole.
|
FacetChart |
setLegendRectHeight(int legendRectHeight)
If drawing a border around the legend, the height of the drawn Rectangle.
|
FacetChart |
setLegendRectProperties(DrawRect legendRectProperties)
Properties for rectangle around the legend as a whole.
|
FacetChart |
setLegendSwatchProperties(DrawRect legendSwatchProperties)
Properties for the swatches of color shown in the legend.
|
FacetChart |
setLegendSwatchSize(int legendSwatchSize)
Size of individual color swatches in legend.
|
FacetChart |
setLegendTextPadding(int legendTextPadding)
Padding between color swatch and its label.
|
FacetChart |
setLogBase(int logBase)
When
useLogGradations , base value for
logarithmic gradation lines. |
FacetChart |
setLogGradations(float... logGradations)
When
useLogGradations is set, gradation lines
to show in between powers,
expressed as a series of integer or float values between 1 and logBase . |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
setLogicalStructure(com.smartgwt.logicalstructure.widgets.chart.FacetChartLogicalStructure s)
Setter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
FacetChart |
setLogScale(java.lang.Boolean logScale)
Whether to use logarithmic scaling for values.
|
FacetChart |
setLogScalePointColor(boolean logScalePointColor)
Whether to use logarithmic scaling for the
color
scale of the data points. |
FacetChart |
setLogScalePointSize(boolean logScalePointSize)
Whether to use logarithmic scaling for the
data
point sizes . |
FacetChart |
setLowErrorMetric(java.lang.String lowErrorMetric)
lowErrorMetric and highErrorMetric
can be used to cause error bars to appear above and below the main data point. |
FacetChart |
setMajorTickGradations(float... majorTickGradations)
List of tick marks that should be drawn as major ticks, expressed as a series of numbers between 1 and 10, representing
boundaries within a given order of magnitude (power of 10).
|
FacetChart |
setMajorTickTimeIntervals(java.lang.String... majorTickTimeIntervals)
When ticks are being
shown on the X axis for a
Scatter plot where the X axis uses time/date values, controls the intervals which are shown as major ticks. |
FacetChart |
setMatchBarChartDataLineColor(java.lang.Boolean matchBarChartDataLineColor)
Setting to define whether the border around the bar chart area should be the same color as the main chart area.
|
FacetChart |
setMaxBarThickness(int maxBarThickness)
Bars will not be drawn over this thickness, instead, margins will be increased.
|
FacetChart |
setMaxDataPointSize(double maxDataPointSize)
The maximum allowed data point size when controlled by
pointSizeMetric . |
FacetChart |
setMaxDataZIndex(java.lang.Integer maxDataZIndex)
Maximum allowed zIndex that can be specified through
zIndexMetric in a histogram chart. |
FacetChart |
setMetricFacetId(java.lang.String metricFacetId)
Specifies the "id" of the default metric facet value.
|
FacetChart |
setMinBarThickness(int minBarThickness)
If bars would be smaller than this size, margins are reduced until bars overlap.
|
FacetChart |
setMinChartHeight(java.lang.Integer minChartHeight)
Minimum height for this chart instance.
|
FacetChart |
setMinChartWidth(java.lang.Integer minChartWidth)
Minimum width for this chart instance.
|
void |
setMinClusterSizeMapper(ClusterSizeMapper clusterSizeMapper)
Sets a customizer to define the minimum cluster size (for clustered charts), or minimum
bar thickness (for histogram or stacked charts) for the specified
data label facet
value. |
FacetChart |
setMinContentHeight(int minContentHeight)
When
autoScrollContent is true, limits the
minimum height of the chart-content, including data, labels, title and legends. |
FacetChart |
setMinContentWidth(int minContentWidth)
When
autoScrollContent is true, limits the
minimum width of the chart-content, including data, labels, titles and legends. |
FacetChart |
setMinDataPointSize(double minDataPointSize)
The minimum allowed data point size when controlled by
pointSizeMetric . |
FacetChart |
setMinDataSpreadPercent(int minDataSpreadPercent)
If all data values would be spread across less than
minDataSpreadPercent of the axis, the start values
of axes will be automatically adjusted to make better use of space. |
FacetChart |
setMinLabelGap(java.lang.Integer minLabelGap)
Minimum gap between labels on the X axis before some labels are omitted or larger time granularity is shown (eg show
days instead of hours) based on the
labelCollapseMode . |
FacetChart |
setMinorTickLength(int minorTickLength)
Length of minor ticks marks shown along axis, if
minor tick marks are enabled. |
FacetChart |
setMinXDataSpreadPercent(int minXDataSpreadPercent)
For scatter charts only, if all data points would be spread across less than
minXDataSpreadPercent of the x-axis, the start
value of x-axis will be automatically adjusted to make better use of space. |
FacetChart |
setOtherAxisGradationGaps(float... otherAxisGradationGaps)
Like
gradationGaps , except allows control of
gradations for the X (horizontal) axis, for Scatter charts only. |
FacetChart |
setOtherAxisGradationTimes(java.lang.String... otherAxisGradationTimes)
For charts that have a date/time-valued X-axis, gradations can instead be specified as
Strings, consisting of a number and trailing letter code, where the letter code indicates
the unit of time.
|
FacetChart |
setOtherAxisPixelsPerGradation(java.lang.Integer otherAxisPixelsPerGradation)
Ideal number of pixels to leave between each gradation on the x (horizontal axis), for Scatter plots only.
|
FacetChart |
setPadChartRectByCornerRadius(boolean padChartRectByCornerRadius)
If
showChartRect is enabled and if chartRectProperties specifies a nonzero rounding , whether the padding around the inside of the chart
rect. |
FacetChart |
setPieBorderProperties(DrawOval pieBorderProperties)
Properties for the border around a pie chart.
|
FacetChart |
setPieLabelAngleStart(int pieLabelAngleStart)
Angle where first label is placed in a Pie chart in stacked mode, in degrees.
|
FacetChart |
setPieLabelLineExtent(int pieLabelLineExtent)
How far label lines stick out of the pie radius in a Pie chart in stacked mode.
|
FacetChart |
setPieLabelLineProperties(DrawLine pieLabelLineProperties)
Properties for pie label line
|
FacetChart |
setPieRingBorderProperties(DrawOval pieRingBorderProperties)
Properties for pie ring border
|
FacetChart |
setPieSliceProperties(DrawSector pieSliceProperties)
Properties for pie slices
|
FacetChart |
setPieStartAngle(java.lang.Integer pieStartAngle)
Default angle in degrees where pie charts start drawing sectors to represent data values.
|
FacetChart |
setPixelsPerGradation(int pixelsPerGradation)
Ideal number of pixels to leave between each gradation on the primary axis, which is typically the y (vertical) axis
except for Bar charts.
|
void |
setPointClickHandler(ChartPointClickHandler handler)
Apply a handler to fire when
showDataPoints is true,
and the user clicks on a point. |
FacetChart |
setPointColorLogBase(java.lang.Integer pointColorLogBase)
When
logScalePointColor is true ,
this property specifies the base value for logarithmic color scale metric values. |
void |
setPointHoverCustomizer(ChartPointHoverCustomizer hoverCustomizer)
Display custom HTML when
showDataPoints is true and the mouse hovers
over a point. |
FacetChart |
setPointShapes(PointShape... pointShapes)
For charts where
showDataPoints is enabled, this
property specifies an array of geometric shapes to draw for the data points of each series. |
FacetChart |
setPointSizeGradations(java.lang.Integer pointSizeGradations)
When a
point size legend is shown, this
property controls the number of gradations of the pointSizeMetric that the chart tries to display. |
FacetChart |
setPointSizeLogBase(java.lang.Integer pointSizeLogBase)
When
logScalePointSize is true, base value for
logarithmic point size metric values. |
FacetChart |
setPointSizeLogGradations(float... pointSizeLogGradations)
When
usePointSizeLogGradations is set,
this property specifies the pointSizeMetric
value gradations to show in the point size
legend in between powers, expressed as a series of integer or float values between 1 and pointSizeLogBase . |
FacetChart |
setPointSizeMetric(java.lang.String pointSizeMetric)
For charts where
showDataPoints is enabled, this
property specifies an additional metric (i.e. |
FacetChart |
setPrintZoomChart(boolean printZoomChart)
Should the
zoom chart be printed with this
FacetChart ? If true , then the SVG string returned by DrawPane.getSvgString() will include the zoom chart's SVG as
well. |
FacetChart |
setProbabilityMetric(java.lang.String probabilityMetric)
The "id" of the metric facet value that assigns a probability to each combination of facets and their values.
|
FacetChart |
setProportional(java.lang.Boolean proportional)
For multi-facet charts, render data values as a proportion of the sum of all data values that have the same label.
|
FacetChart |
setProportionalAxisLabel(java.lang.String proportionalAxisLabel)
Default title for the value axis label when the chart is in
proportional rendering mode . |
FacetChart |
setRadarBackgroundProperties(DrawOval radarBackgroundProperties)
Properties for radar background
|
FacetChart |
setRadarRotateLabels(LabelRotationMode radarRotateLabels)
This property controls whether to rotate the labels on the
data label facet of radar or stacked pie charts so that each label is parallel to its radial
gradation (these are the labels that appear around the perimeter). |
FacetChart |
setRadialLabelOffset(java.lang.Integer radialLabelOffset)
Distance in pixels that radial labels are offset from the outside of the circle.
|
FacetChart |
setRegressionLineProperties(DrawLine regressionLineProperties)
Properties for the
regression line . |
FacetChart |
setRegressionLineType(RegressionLineType regressionLineType)
Regression algorithm used for the
regression
line . |
FacetChart |
setRegressionPolynomialDegree(int regressionPolynomialDegree)
For scatter plots only, specify the degree of polynomial to use for any polynomial regression that is calculated.
|
FacetChart |
setRotateDataValues(LabelRotationMode rotateDataValues)
This property controls whether to rotate the labels shown for data-values in
Column-type charts . |
FacetChart |
setRotateLabels(LabelRotationMode rotateLabels)
This property controls whether to rotate the labels on the X-axis.
|
FacetChart |
setScaleEndColor(java.lang.String scaleEndColor)
The ending color of the color scale when the data points are colored according to a
color scale metric . |
FacetChart |
setScaleStartColor(java.lang.String scaleStartColor)
The starting color of the color scale when the data points are colored according to a
color scale metric . |
FacetChart |
setShadowProperties(DrawOval shadowProperties)
Properties for shadows.
|
FacetChart |
setShowBubbleLegendPerShape(boolean showBubbleLegendPerShape)
Whether to draw multiple bubble legends horizontally stacked to the right of the chart, one per shape type.
|
FacetChart |
setShowChartRect(java.lang.Boolean showChartRect)
Whether to show a rectangular shape around the area of the chart where data is plotted.
|
FacetChart |
setShowColorScaleLegend(java.lang.Boolean showColorScaleLegend)
Whether to show an additional legend underneath the chart to indicate color values.
|
FacetChart |
setShowDataAxisLabel(java.lang.Boolean showDataAxisLabel)
Whether to show a label for the data axis as a whole (the data axis is where labels for each data point appear).
|
FacetChart |
setShowDataLabels(boolean showDataLabels)
If set to
false , data labels for values are entirely omitted. |
FacetChart |
setShowDataPoints(java.lang.Boolean showDataPoints)
For Line, Area, Radar, Scatter or Bubble charts, whether to show data points for each individual data value.
|
FacetChart |
setShowDataValues(boolean showDataValues)
Deprecated.
in favor of
showDataValuesMode , a compound
setting that supports showing data-values in the chart and in hovers in various combinations. The equivalent to
showDataValues:true is ShowDataValuesMode.inChartOnly or
ShowDataValuesMode.inChartOrHover if showValueOnHover was also set to true. |
FacetChart |
setShowDataValuesMode(ShowDataValuesMode showDataValuesMode)
Strategy for determining whether and when to show data-values - either in the chart, near the shape representing a value
(above columns of a column chart for example, or adjacent to points in a line chart), in hovers, or some combination of
both, including
automatic rotation where
supported. |
FacetChart |
setShowDoughnut(java.lang.Boolean showDoughnut)
Whether to show a "doughnut hole" in the middle of pie charts.
|
FacetChart |
setShowExpectedValueLine(java.lang.Boolean showExpectedValueLine)
Display a line at the
mean value . |
FacetChart |
setShowGradationsOverData(java.lang.Boolean showGradationsOverData)
If set, gradation lines are drawn on top of data rather than underneath.
|
FacetChart |
setShowInlineLabels(java.lang.Boolean showInlineLabels)
Causes labels for the X axis to be shown above the axis and to the right of the gradation line they label, making for a
vertically more compact chart at the risk of gradation labels being partially obscured by data values.
|
FacetChart |
setShowLegend(java.lang.Boolean showLegend)
The legend is automatically shown for charts that need it (generally, multi-series charts) but can be forced off by
setting showLegend to false.
|
FacetChart |
setShowMinorTicks(boolean showMinorTicks)
If
ticks are being shown, controls whether a
distinction is made between major and minor tick marks. |
FacetChart |
setShowPointSizeLegend(java.lang.Boolean showPointSizeLegend)
Whether to show an additional legend to the right of the chart to indicate
point size . |
FacetChart |
setShowRadarGradationLabels(java.lang.Boolean showRadarGradationLabels)
Whether to show gradation labels in radar charts.
|
FacetChart |
setShowRegressionLine(java.lang.Boolean showRegressionLine)
For scatter plots only, whether to display a regression curve that best fits the data of the two metric facet values.
|
FacetChart |
setShowScatterLines(java.lang.Boolean showScatterLines)
Whether to draw lines between adjacent data points in "Scatter" plots.
|
FacetChart |
setShowShadows(java.lang.Boolean showShadows)
Whether to automatically show shadows for various charts.
|
FacetChart |
setShowStandardDeviationLines(java.lang.Boolean showStandardDeviationLines)
Display multiple
standard deviations away from the mean
as lines. |
FacetChart |
setShowStatisticsOverData(java.lang.Boolean showStatisticsOverData)
If set, the
mean line , standard deviation lines , standard deviation bands , and regression curves are drawn on top of the data
rather than underneath. |
FacetChart |
setShowTitle(java.lang.Boolean showTitle)
Whether to show a title.
|
FacetChart |
setShowValueAxisLabel(java.lang.Boolean showValueAxisLabel)
Whether to show the
valueTitle (or, in the case of
proportional rendering mode , the proportionalAxisLabel ) as a label on the value
axis. |
FacetChart |
setShowValueOnHover(java.lang.Boolean showValueOnHover)
Deprecated.
in favor of
showDataValuesMode , a compound
setting that supports showing data-values in the chart and in hovers in various combinations. The equivalent to
showValueOnHover:true is ShowDataValuesMode.inHoverOnly. |
FacetChart |
setShowXTicks(boolean showXTicks)
When set, ticks are shown for the X (horizontal) axis for Scatter plots or Bar charts.
|
FacetChart |
setShowYTicks(boolean showYTicks)
When set, ticks are shown for the Y (vertical) axis if it's a value axis.
|
FacetChart |
setStacked(java.lang.Boolean stacked)
Whether to use stacking for charts where this makes sense (column, area, pie, line and radar charts).
|
FacetChart |
setStandardDeviationBandProperties(DrawItem... standardDeviationBandProperties)
An Array of DrawRect properties to specify the bands between the
standard deviation lines . |
FacetChart |
setStandardDeviationLineProperties(DrawItem standardDeviationLineProperties)
Properties for the
standard deviation
lines . |
FacetChart |
setStandardDeviations(float... standardDeviations)
When
showStandardDeviationLines is
set, the number of standard deviation lines drawn
and their respective standard deviation away from the mean are specified by this property. |
void |
setStyleName(java.lang.String styleName)
Default styleName for the chart.
|
FacetChart |
setTickLength(int tickLength)
Length of the tick marks used when either
showXTicks
or showYTicks is enabled, or when extra value axes are in use. |
FacetChart |
setTickMarkToValueAxisMargin(int tickMarkToValueAxisMargin)
Margin between the tick marks and the labels of the
extra value axes . |
void |
setTitle(java.lang.String title)
Title for the chart as a whole.
|
FacetChart |
setTitleAlign(TitleAlign titleAlign)
Horizontal alignment of the chart's
title . |
FacetChart |
setTitleBackgroundProperties(DrawLabel titleBackgroundProperties)
Properties for title background (if being drawn).
|
FacetChart |
setTitleBoundaryProperties(DrawLine titleBoundaryProperties)
Properties for bottom boundary of the title area, when there is already an outer container around the whole chart.
|
FacetChart |
setTitlePadding(int titlePadding)
if aligning the title left or right, the amount of space before (for left aligned) or after (for right aligned) to pad
the title from the border edge
|
FacetChart |
setTitleProperties(DrawLabel titleProperties)
Properties for title label.
|
FacetChart |
setTitleRectHeight(int titleRectHeight)
The height of the bordered rect around the title - defaults to 0 (assuming no border)
|
FacetChart |
setUseAutoGradients(java.lang.Boolean useAutoGradients)
Causes the chart to use the colors specified in
dataColors but specify chart-specific gradients based on the primary data color per chart type. |
FacetChart |
setUseLogGradations(java.lang.Boolean useLogGradations)
Whether to use classic logarithmic gradations, where each order of magnitude is shown as a gradation as well as a few
intervening lines.
|
FacetChart |
setUseMultiplePointShapes(java.lang.Boolean useMultiplePointShapes)
Whether the chart should use multiple shapes to show data points.
|
FacetChart |
setUsePointSizeLogGradations(java.lang.Boolean usePointSizeLogGradations)
Whether to use classic logarithmic gradations, where each order of magnitude is shown as a gradation as well as a few
intervening values, for the
pointSizeMetric
values displayed in the point size legend . |
FacetChart |
setUseSymmetricStandardDeviations(java.lang.Boolean useSymmetricStandardDeviations)
Whether to display both the positive and negative of the
standard deviations . |
FacetChart |
setValueAxisLabelProperties(DrawLabel valueAxisLabelProperties)
Properties for labels of value axis.
|
FacetChart |
setValueAxisMargin(int valueAxisMargin)
Margin between
multiple value axes . |
FacetChart |
setValueLineProperties(DrawLine valueLineProperties)
Properties for a "value line" - a line shows where a particular discrete value is placed, eg, vertical lines connecting
points of a line chart to the X axis, or radial lines in a Radar chart.
|
FacetChart |
setValueProperty(java.lang.String valueProperty)
Property in each record that holds a data value.
|
FacetChart |
setValueTitle(java.lang.String valueTitle)
A label for the data values, such as "Sales in Thousands", typically used as the label for the value axis.
|
FacetChart |
setXAxisEndValue(java.util.Date xAxisEndValue)
For Bubble and Scatter charts only, the end value for the x-axis.
|
FacetChart |
setXAxisEndValue(java.lang.Double xAxisEndValue)
For Bubble and Scatter charts only, the end value for the x-axis.
|
FacetChart |
setXAxisMetric(java.lang.String xAxisMetric)
For scatter charts only, the "id" of the metric facet value to use for the x-axis.
|
FacetChart |
setXAxisStartValue(java.util.Date xAxisStartValue)
For Bubble and Scatter charts only, the start value for the x-axis.
|
FacetChart |
setXAxisStartValue(java.lang.Double xAxisStartValue)
For Bubble and Scatter charts only, the start value for the x-axis.
|
void |
setXAxisValueFormatter(ValueFormatter formatter)
Formatter to apply to values displayed in the gradation labels on the x-axis.
|
FacetChart |
setYAxisLabelAlign(Alignment yAxisLabelAlign)
Horizontal alignment of y-axis labels, shown to the left of the chart.
|
FacetChart |
setYAxisLabelPadding(int yAxisLabelPadding)
Padding between each swatch and label pair.
|
FacetChart |
setYAxisMetric(java.lang.String yAxisMetric)
For scatter charts only, the "id" of the metric facet value to use for the y-axis.
|
void |
setYAxisValueFormatter(ValueFormatter formatter)
Formatter to apply to values displayed in the gradation labels on the y-axis.
|
FacetChart |
setZIndexMetric(java.lang.String zIndexMetric)
Specifies the attribute in the metric facet that will define the z-ordering of the segments in a histogram chart.
|
FacetChart |
setZoomChartHeight(double zoomChartHeight)
Height of the
zoomChart . |
FacetChart |
setZoomChartProperties(FacetChart zoomChartProperties)
Properties to further configure the
zoomChart . |
void |
setZoomEndValue(java.lang.Object zoomEndValue)
For a
zoomed chart , end value of the data range shown in
the main chart. |
FacetChart |
setZoomLogScale(java.lang.Boolean zoomLogScale)
|
FacetChart |
setZoomMutePercent(float zoomMutePercent)
colorMutePercent to use for the zoomChart . |
FacetChart |
setZoomSelectionChartProperties(FacetChart zoomSelectionChartProperties)
Properties to further configure the
zoomSelectionChart . |
FacetChart |
setZoomShowSelection(java.lang.Boolean zoomShowSelection)
Whether the selected range should be shown in a different style, which can be configured via
zoomSelectionChartProperties . |
FacetChart |
setZoomStartPosition(ZoomStartPosition zoomStartPosition)
For a
zoomed chart , determines what portion of the
overall dataset should be initially shown in the main chart. |
void |
setZoomStartValue(java.lang.Object zoomStartValue)
For a
zoomed chart , start value of the data range shown
in the main chart. |
void |
zoomTo(java.lang.Object startValue,
java.lang.Object endValue)
|
addDrawEndHandler, addDrawItem, addDrawStartHandler, addGradient, bezier, bezierExtrema, createLinearGradient, createRadialGradient, createSimpleGradient, destroyItems, erase, getBezierBoundingBox, getCanDragScroll, getDataURL, getDataURL, getDataURL, getDrawingHeight, getDrawingPoint, getDrawingType, getDrawingWidth, getDrawingX, getDrawingY, getDrawItems, getGradient, getGradients, getPolygonPoints, getRegularPolygonPoints, getRotation, getRotationAsDouble, getSvgString, getTranslate, getUnderlyingGWTCanvas, getZoomLevel, getZoomLevelAsDouble, refreshNow, removeGradient, rotate, scaleAndCenter, scaleAndCenterBezier, setAutoChildProperties, setCanDragScroll, setDefaultProperties, setDrawingHeight, setDrawingType, setDrawingWidth, setDrawItems, setGradients, setLogicalStructure, setRotation, setRotation, setTranslate, setZoomLevel, setZoomLevel, zoom, zoom
addChild, addChild, addChild, addChild, addChild, addClearHandler, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsEventTarget, containsFocus, containsPoint, containsPoint, deparent, depeer, disable, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysManageFocusNavigation, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaHandleID, getAriaRole, getAutoMaskComponents, getAutoParent, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragReposition, getCanDragResize, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getChildTabPosition, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCorrectZoomOverflow, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintStyleName, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getReceiveScrollbarEvents, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowColor, getShadowDepth, getShadowHOffset, getShadowImage, getShadowOffset, getShadowSoftness, getShadowSpread, getShadowVOffset, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapGridLineProperties, getSnapGridStyle, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getTabIndex, getTestInstance, getTooltip, getTop, getTopAsString, getTopElement, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, onInit, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, print, print, print, print, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeRuleContext, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeFonts, resizeFonts, resizeFonts, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, revealChild, revealChild, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAlign, setAllowExternalFilters, setAlwaysManageFocusNavigation, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeLayoutMode, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeavePageSpace, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrintStyleName, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setReceiveScrollbarEvents, setRect, setRect, setRedrawOnResize, setRelativeTabPosition, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowColor, setShadowDepth, setShadowHOffset, setShadowImage, setShadowOffset, setShadowSoftness, setShadowSpread, setShadowVOffset, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapGridLineProperties, setSnapGridStyle, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setTabIndex, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDrop
addDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent
public FacetChart()
public FacetChart(com.google.gwt.core.client.JavaScriptObject jsObj)
public static FacetChart getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public static void changeAutoChildDefaults(java.lang.String autoChildName, Canvas defaults)
autoChildName
.autoChildName
- name of an AutoChild to customize the defaults for.defaults
- Canvas defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties
.AutoChildUsage
public static void changeAutoChildDefaults(java.lang.String autoChildName, FormItem defaults)
autoChildName
.autoChildName
- name of an AutoChild to customize the defaults for.defaults
- FormItem defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties
.AutoChildUsage
protected com.google.gwt.core.client.JavaScriptObject create()
public FacetChart setAllowBubbleGradients(boolean allowBubbleGradients) throws java.lang.IllegalStateException
false
prevents the chart from drawing fill gradients into the bubbles of each data
point. This flag is required to be set for IE8 and earlier in order to draw bubble charts displaying high volumes of
data.allowBubbleGradients
- New allowBubbleGradients value. Default value is !(isc.Browser.isIE && isc.Browser.version <= 8)FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic boolean getAllowBubbleGradients()
false
prevents the chart from drawing fill gradients into the bubbles of each data
point. This flag is required to be set for IE8 and earlier in order to draw bubble charts displaying high volumes of
data.public FacetChart setAllowedChartTypes(ChartType... allowedChartTypes)
chart types
that the end user will be allowed to switch to, using the
built-in context menu. The actual list of ChartTypes displayed in the context menu may be a subset of
allowedChartTypes
, since the FacetChart will automatically disallow certain modes that are clearly invalid,
for example, not allowing switching to Pie mode if either canZoom
is enabled, or if the chart is multi-axis
.
allowedChartTypes
- New allowedChartTypes value. Default value is nullFacetChart
instance, for chaining setter callspublic ChartType[] getAllowedChartTypes()
chart types
that the end user will be allowed to switch to, using the
built-in context menu. The actual list of ChartTypes displayed in the context menu may be a subset of
allowedChartTypes
, since the FacetChart will automatically disallow certain modes that are clearly invalid,
for example, not allowing switching to Pie mode if either canZoom
is enabled, or if the chart is multi-axis
.
public FacetChart setAutoRotateLabels(java.lang.Boolean autoRotateLabels) throws java.lang.IllegalStateException
rotateLabels
. Setting rotateLabels to "auto" is
equivalent to setting autoRotateLabels to true
. Setting rotateLabels to "never" is equivalent to setting
autoRotateLabels to false
.autoRotateLabels
- New autoRotateLabels value. Default value is trueFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getAutoRotateLabels()
rotateLabels
. Setting rotateLabels to "auto" is
equivalent to setting autoRotateLabels to true
. Setting rotateLabels to "never" is equivalent to setting
autoRotateLabels to false
.public FacetChart setAutoScrollContent(boolean autoScrollContent)
width
or height
. These minimum sizes limit all chart-content,
including data and labels, titles and legends. See autoScrollData
for a means to introduce scrolling
according to the data being displayed.
If this method is called after the component has been drawn/initialized:
Sets autoScrollContent
and updates the chart.
autoScrollContent
- whether the chart should automatically show scrollbars when it's size is smaller than the minimum content
width
or height
. Default value is falseFacetChart
instance, for chaining setter callspublic boolean getAutoScrollContent()
width
or height
. These minimum sizes limit all chart-content,
including data and labels, titles and legends. See autoScrollData
for a means to introduce scrolling
according to the data being displayed.
public FacetChart setAutoScrollData(boolean autoScrollData)
chart-types
, should the chart body be
automatically expanded and scrollbars introduced according to data? When true for a column, histogram, line, or
area chart that has facet values displayed along
the x-axis
, the chart expands horizontally, showing a scroll bar, if that's needed to make room for the facet value
labels or, for column and histogram charts, to make space for the minimum configured bar \n thicknesses
or the margins
between them.
When true for a Bar chart, expansion and scrollbar are vertical, and also make space for the minimum configured bar thicknesses
or the margins
between them.
Note that this feature is incompatible with the following properties:
LabelCollapseMode
(other than the default of "none") rotateLabels
(in "auto" mode) canDragScroll
canZoom
rotateLabels
is set to "auto" it will be treated as
"never" if autoScrollData
has been set. If any of the other properties have non-default values, a warning
will be logged and autoScrollData
will be disabled. The factors used to drive expansion can be limited by
setting AutoScrollDataApproach
. You can also enforce a minimum size for the
chart-content, and scrollbars will be introduced if this widget shrinks below that size. See autoScrollContent
, along with minContentWidth
and minContentHeight
.
autoScrollData
and updates the chart.autoScrollData
- whether chart should automatically expand and show scrollbars to accommodate content. Default value is falseFacetChart
instance, for chaining setter callssetCanZoom(java.lang.Boolean)
,
setRotateLabels(com.smartgwt.client.types.LabelRotationMode)
,
LabelCollapseMode
,
com.smartgwt.client.widgets.chart.FacetChart#getMinClusterSize
,
DrawPane.setCanDragScroll(boolean)
public boolean getAutoScrollData()
chart-types
, should the chart body be
automatically expanded and scrollbars introduced according to data? When true for a column, histogram, line, or
area chart that has facet values displayed along
the x-axis
, the chart expands horizontally, showing a scroll bar, if that's needed to make room for the facet value
labels or, for column and histogram charts, to make space for the minimum configured bar \n thicknesses
or the margins
between them.
When true for a Bar chart, expansion and scrollbar are vertical, and also make space for the minimum configured bar thicknesses
or the margins
between them.
Note that this feature is incompatible with the following properties:
LabelCollapseMode
(other than the default of "none") rotateLabels
(in "auto" mode) canDragScroll
canZoom
rotateLabels
is set to "auto" it will be treated as
"never" if autoScrollData
has been set. If any of the other properties have non-default values, a warning
will be logged and autoScrollData
will be disabled. The factors used to drive expansion can be limited by
setting AutoScrollDataApproach
. You can also enforce a minimum size for the
chart-content, and scrollbars will be introduced if this widget shrinks below that size. See autoScrollContent
, along with minContentWidth
and minContentHeight
.getCanZoom()
,
getRotateLabels()
,
LabelCollapseMode
,
com.smartgwt.client.widgets.chart.FacetChart#getMinClusterSize
,
DrawPane.getCanDragScroll()
public FacetChart setAutoScrollDataApproach(AutoScrollDataApproach autoScrollDataApproach)
autoScrollData
, potentially limiting what factors drive the automatic expansion of the chart. (The "both" setting is
no different than the default of null.) When labels are on the x-axis, and if you're sizing bars very tightly to
labels by defining getMinClusterSize()
, you may
not want label-driven expansion, as the default separation assigned between them is very generous, and is based on the
widest labels. (You may also set minLabelGap
to
gain more control over the separation.)
If this method is called after the component has been drawn/initialized:
Sets AutoScrollDataApproach
and updates the chart.
autoScrollDataApproach
- what should drive horizontal expansion of the chart?. Default value is nullFacetChart
instance, for chaining setter callssetAutoScrollData(boolean)
public AutoScrollDataApproach getAutoScrollDataApproach()
autoScrollData
, potentially limiting what factors drive the automatic expansion of the chart. (The "both" setting is
no different than the default of null.) When labels are on the x-axis, and if you're sizing bars very tightly to
labels by defining getMinClusterSize()
, you may
not want label-driven expansion, as the default separation assigned between them is very generous, and is based on the
widest labels. (You may also set minLabelGap
to
gain more control over the separation.)
getAutoScrollData()
public FacetChart setAutoSortBubblePoints(boolean autoSortBubblePoints) throws java.lang.IllegalStateException
point size
so that small values are less likely to be
completely occluded by larger values. Set this to false
to draw the data points in the same order that
they appear in the data.autoSortBubblePoints
- New autoSortBubblePoints value. Default value is trueFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic boolean getAutoSortBubblePoints()
point size
so that small values are less likely to be
completely occluded by larger values. Set this to false
to draw the data points in the same order that
they appear in the data.public FacetChart setAxisEndValue(java.lang.Double axisEndValue) throws java.lang.IllegalStateException
If set to an explicit value, this will be respected. If unset, the axis end value will default to a value large enough to the largest data point, rounded up to the nearest (next) gradation.
For multi-axis charts, Bubble charts, and Scatter charts, the facetChart.axisEndValue
affects only the
first axis of the chart. End values for other axes of multi-axis charts can be set on a per-axis basis via MetricSettings.xAxisEndValue
. For Scatter charts,
the xAxisEndValue
property must be used to set the
end value of the x-axis.
Note that if this chart's data includes points that fall above this value, they are
ommitted and effectively treated as null values. For charts showing a data line, developers may wish to set discontinuousLines
to true in this case.
axisEndValue
- New axisEndValue value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Double getAxisEndValue()
If set to an explicit value, this will be respected. If unset, the axis end value will default to a value large enough to the largest data point, rounded up to the nearest (next) gradation.
For multi-axis charts, Bubble charts, and Scatter charts, the facetChart.axisEndValue
affects only the
first axis of the chart. End values for other axes of multi-axis charts can be set on a per-axis basis via MetricSettings.xAxisEndValue
. For Scatter charts,
the xAxisEndValue
property must be used to set the
end value of the x-axis.
Note that if this chart's data includes points that fall above this value, they are
ommitted and effectively treated as null values. For charts showing a data line, developers may wish to set discontinuousLines
to true in this case.
public FacetChart setAxisStartValue(java.lang.Double axisStartValue) throws java.lang.IllegalStateException
If set to an explicit value, this will be respected. If unset, the
axis start value will default to 0, or to a value that makes good use of vertical space based on minDataSpreadPercent
.
For multi-axis charts,
Bubble charts, and Scatter charts, the facetChart.axisStartValue
affects only the first axis of the
chart. Start values for other axes of multi-axis charts can be set on a per-axis basis via MetricSettings.axisStartValue
. For Scatter charts,
the xAxisStartValue
property must be used to set
the start value of the x-axis.
Note that if this chart's data includes points that fall below this value, they are
ommitted and effectively treated as null values. For charts showing a data line, developers may wish to set discontinuousLines
to true in this case.
axisStartValue
- New axisStartValue value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Double getAxisStartValue()
If set to an explicit value, this will be respected. If unset, the
axis start value will default to 0, or to a value that makes good use of vertical space based on minDataSpreadPercent
.
For multi-axis charts,
Bubble charts, and Scatter charts, the facetChart.axisStartValue
affects only the first axis of the
chart. Start values for other axes of multi-axis charts can be set on a per-axis basis via MetricSettings.axisStartValue
. For Scatter charts,
the xAxisStartValue
property must be used to set
the start value of the x-axis.
Note that if this chart's data includes points that fall below this value, they are
ommitted and effectively treated as null values. For charts showing a data line, developers may wish to set discontinuousLines
to true in this case.
public FacetChart setBackgroundBandProperties(DrawRect backgroundBandProperties) throws java.lang.IllegalStateException
backgroundBandProperties
- New backgroundBandProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public DrawRect getBackgroundBandProperties()
public FacetChart setBandedBackground(java.lang.Boolean bandedBackground) throws java.lang.IllegalStateException
backgroundBandProperties
.bandedBackground
- New bandedBackground value. Default value is trueFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getBandedBackground()
backgroundBandProperties
.public FacetChart setBandedStandardDeviations(java.lang.Boolean bandedStandardDeviations) throws java.lang.IllegalStateException
standard deviation
lines. Standard deviation bands are not available for pie or radar charts.
bandedStandardDeviations
- New bandedStandardDeviations value. Default value is falseFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetStandardDeviationBandProperties(com.smartgwt.client.widgets.drawing.DrawItem...)
public java.lang.Boolean getBandedStandardDeviations()
standard deviation
lines. Standard deviation bands are not available for pie or radar charts.
com.smartgwt.client.widgets.chart.FacetChart#getStandardDeviationBandProperties
public FacetChart setBarMargin(int barMargin) throws java.lang.IllegalStateException
minBarThickness
.barMargin
- New barMargin value. Default value is 4FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getBarMargin()
minBarThickness
.public FacetChart setBarProperties(DrawRect barProperties)
barProperties
- New barProperties value. Default value is nullFacetChart
instance, for chaining setter callsSGWTProperties
public DrawRect getBarProperties()
public FacetChart setBrightenAllOnHover(java.lang.Boolean brightenAllOnHover)
brightenAllOnHover
- New brightenAllOnHover value. Default value is nullFacetChart
instance, for chaining setter callspublic java.lang.Boolean getBrightenAllOnHover()
public FacetChart setBubbleHoverMaxDistance(int bubbleHoverMaxDistance) throws java.lang.IllegalStateException
bubbleHoverMaxDistance
- New bubbleHoverMaxDistance value. Default value is 50FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getBubbleHoverMaxDistance()
public FacetChart setBubbleProperties(DrawItem bubbleProperties) throws java.lang.IllegalStateException
When either the pointSizeMetric
or the colorScaleMetric
is active the default
bubbleProperties
displays each data points with a linear gradient.
bubbleProperties
- New bubbleProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
,
Bubble Chart Examplepublic DrawItem getBubbleProperties()
When either the pointSizeMetric
or the colorScaleMetric
is active the default
bubbleProperties
displays each data points with a linear gradient.
public FacetChart setCanMoveAxes(java.lang.Boolean canMoveAxes) throws java.lang.IllegalStateException
canMoveAxes
- New canMoveAxes value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getCanMoveAxes()
public FacetChart setCanZoom(java.lang.Boolean canZoom) throws java.lang.IllegalStateException
second smaller chart
appears with slider controls
allowing a range to be selected for display in the main chart. A labelCollapseMode
is automatically enabled if unset
and is based on the type of the first non-null data value.
canZoom
- New canZoom value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getCanZoom()
second smaller chart
appears with slider controls
allowing a range to be selected for display in the main chart. A labelCollapseMode
is automatically enabled if unset
and is based on the type of the first non-null data value.
public FacetChart setCenterLegend(java.lang.Boolean centerLegend) throws java.lang.IllegalStateException
chart legend
with respect to the
full, scrollable width of the chart when autoScrollData
is active. The default of false means that the legend will be placed in the visible, non-overflowed
region of the chart, for greater visibility. Note that alignment of the legend itself is governed by legendAlign
.
Note that this setting has no impact on axis labeling, which always occurs with respect to the full, expanded width of the chart.
centerLegend
- New centerLegend value. Default value is falseFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetShowLegend(java.lang.Boolean)
,
setCenterTitle(java.lang.Boolean)
,
setAutoScrollData(boolean)
public java.lang.Boolean getCenterLegend()
chart legend
with respect to the
full, scrollable width of the chart when autoScrollData
is active. The default of false means that the legend will be placed in the visible, non-overflowed
region of the chart, for greater visibility. Note that alignment of the legend itself is governed by legendAlign
.
Note that this setting has no impact on axis labeling, which always occurs with respect to the full, expanded width of the chart.
getShowLegend()
,
getCenterTitle()
,
getAutoScrollData()
public FacetChart setCenterTitle(java.lang.Boolean centerTitle) throws java.lang.IllegalStateException
chart title
with respect to the
full, scrollable width of the chart when autoScrollData
is active. The default of false means that the title will be placed in the visible, non-overflowed
region of the chart, for greater visibility. Note that alignment of the title itself is governed by titleAlign
.
centerTitle
- New centerTitle value. Default value is falseFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetTitle(java.lang.String)
,
setShowTitle(java.lang.Boolean)
,
setCenterLegend(java.lang.Boolean)
,
setAutoScrollData(boolean)
public java.lang.Boolean getCenterTitle()
chart title
with respect to the
full, scrollable width of the chart when autoScrollData
is active. The default of false means that the title will be placed in the visible, non-overflowed
region of the chart, for greater visibility. Note that alignment of the title itself is governed by titleAlign
.
getTitle()
,
getShowTitle()
,
getCenterLegend()
,
getAutoScrollData()
public FacetChart setChartRectMargin(int chartRectMargin) throws java.lang.IllegalStateException
chartRectMargin
- New chartRectMargin value. Default value is 5FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getChartRectMargin()
public FacetChart setChartRectProperties(DrawRect chartRectProperties)
rounding
of the
chart rect. causes the gradation lines to be automatically inset from the edge so that they do not run right along the
curve. Set padChartRectByCornerRadius
to false
to change this default.chartRectProperties
- New chartRectProperties value. Default value is nullFacetChart
instance, for chaining setter callsSGWTProperties
public DrawRect getChartRectProperties()
rounding
of the
chart rect. causes the gradation lines to be automatically inset from the edge so that they do not run right along the
curve. Set padChartRectByCornerRadius
to false
to change this default.public FacetChart setChartType(ChartType chartType)
ChartType
for a list of known types - Column, Bar, Line, Pie, Doughnut, Area,
Radar, and Histogram charts are supported.
chartType
. Will redraw the chart if drawn. Will use default settings for the new chart type for stacked
and filled
if those values are null. Note that for multi-axis
charts this method changes the chartType
for the main value axis only.
chartType
- new chart type. Default value is "Column"FacetChart
instance, for chaining setter callspublic ChartType getChartType()
ChartType
for a list of known types - Column, Bar, Line, Pie, Doughnut, Area,
Radar, and Histogram charts are supported.public FacetChart setClusterMarginRatio(float clusterMarginRatio) throws java.lang.IllegalStateException
clusterMarginRatio
- New clusterMarginRatio value. Default value is 4FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic float getClusterMarginRatio()
public FacetChart setColorMutePercent(java.lang.Float colorMutePercent) throws java.lang.IllegalStateException
colorMutePercent
- New colorMutePercent value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Float getColorMutePercent()
public FacetChart setColorScaleMetric(java.lang.String colorScaleMetric) throws java.lang.IllegalStateException
showDataPoints
is enabled, this
property specifies an additional metric (i.e. an "id" of a metric facet value) that causes the data points to be colored
from scaleStartColor
to scaleEndColor
based on a linear scale over the values of
this metric. Log-scaling for color scale is also supported with logScalePointColor
.colorScaleMetric
- New colorScaleMetric value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getColorScaleMetric()
showDataPoints
is enabled, this
property specifies an additional metric (i.e. an "id" of a metric facet value) that causes the data points to be colored
from scaleStartColor
to scaleEndColor
based on a linear scale over the values of
this metric. Log-scaling for color scale is also supported with logScalePointColor
.public FacetChart setDataAxisLabelProperties(DrawLabel dataAxisLabelProperties)
dataAxisLabelProperties
- New dataAxisLabelProperties value. Default value is nullFacetChart
instance, for chaining setter callsSGWTProperties
public DrawLabel getDataAxisLabelProperties()
public FacetChart setDataColors(java.lang.String... dataColors)
Colors must be in the format of a leading hash (#) plus 6 hexadecimal digits, for
example, "#FFFFFF" is white, "#FF0000" is pure red.
If this method is called after the component has been drawn/initialized:
Setter for dataColors
.
dataColors
- New set of data colors. Default value is see belowFacetChart
instance, for chaining setter callsCSSColor
public java.lang.String[] getDataColors()
Colors must be in the format of a leading hash (#) plus 6 hexadecimal digits, for example, "#FFFFFF" is white, "#FF0000" is pure red.
CSSColor
public FacetChart setDataLabelProperties(DrawLabel dataLabelProperties)
dataLabelProperties
- New dataLabelProperties value. Default value is nullFacetChart
instance, for chaining setter callsSGWTProperties
public DrawLabel getDataLabelProperties()
public FacetChart setDataLineProperties(DrawLine dataLineProperties) throws java.lang.IllegalStateException
dataLineProperties
- New dataLineProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public DrawLine getDataLineProperties()
public FacetChart setDataLineType(DataLineType dataLineType)
DataLineType
. Does not apply to boundary lines for shapes in Area or Radar plots.
If this method is called after the component has been drawn/initialized:
Method to change the current dataLineType
. Will redraw the chart if drawn.
dataLineType
- ow to draw lines between adjacent data points in Line and Scatter charts. Default value is nullFacetChart
instance, for chaining setter callspublic DataLineType getDataLineType()
DataLineType
. Does not apply to boundary lines for shapes in Area or Radar plots.
public FacetChart setDataMargin(int dataMargin) throws java.lang.IllegalStateException
dataMargin
- New dataMargin value. Default value is 10FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getDataMargin()
public FacetChart setDataOutlineProperties(DrawItem dataOutlineProperties) throws java.lang.IllegalStateException
dataOutlineProperties
- New dataOutlineProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public DrawItem getDataOutlineProperties()
public FacetChart setDataPointProperties(DrawItem dataPointProperties) throws java.lang.IllegalStateException
showDataPoints
).dataPointProperties
- New dataPointProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public DrawItem getDataPointProperties()
showDataPoints
).public FacetChart setDataPointSize(int dataPointSize) throws java.lang.IllegalStateException
dataPointSize
- New dataPointSize value. Default value is 5FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getDataPointSize()
public FacetChart setDataShapeProperties(DrawPath dataShapeProperties) throws java.lang.IllegalStateException
dataShapeProperties
- New dataShapeProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public DrawPath getDataShapeProperties()
public FacetChart setDecimalPrecision(int decimalPrecision) throws java.lang.IllegalStateException
decimalPrecision
- New decimalPrecision value. Default value is 2FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getDecimalPrecision()
public FacetChart setDiscontinuousLines(java.lang.Boolean discontinuousLines)
false
then null values are ignored. Defaults to true
for filled
charts and to false
for line charts.discontinuousLines
- New discontinuousLines value. Default value is nullFacetChart
instance, for chaining setter callspublic java.lang.Boolean getDiscontinuousLines()
false
then null values are ignored. Defaults to true
for filled
charts and to false
for line charts.public FacetChart setDoughnutHoleProperties(DrawOval doughnutHoleProperties)
doughnutHoleProperties
- New doughnutHoleProperties value. Default value is nullFacetChart
instance, for chaining setter callsSGWTProperties
public DrawOval getDoughnutHoleProperties()
public FacetChart setDoughnutRatio(float doughnutRatio) throws java.lang.IllegalStateException
showDoughnut
),
ratio of the size of the doughnut hole to the size of the overall pie chart, as a number between 0 to 1.doughnutRatio
- New doughnutRatio value. Default value is 0.2FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic float getDoughnutRatio()
showDoughnut
),
ratio of the size of the doughnut hole to the size of the overall pie chart, as a number between 0 to 1.public FacetChart setDrawLegendBoundary(java.lang.Boolean drawLegendBoundary) throws java.lang.IllegalStateException
legendRectProperties
settings should be used
instead.drawLegendBoundary
- New drawLegendBoundary value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getDrawLegendBoundary()
legendRectProperties
settings should be used
instead.public FacetChart setDrawTitleBackground(java.lang.Boolean drawTitleBackground)
titleBackgroundProperties
to set these values
if this is true.drawTitleBackground
- New drawTitleBackground value. Default value is nullFacetChart
instance, for chaining setter callspublic java.lang.Boolean getDrawTitleBackground()
titleBackgroundProperties
to set these values
if this is true.public FacetChart setDrawTitleBoundary(java.lang.Boolean drawTitleBoundary)
titleBackgroundProperties
settings should be
used instead.drawTitleBoundary
- New drawTitleBoundary value. Default value is nullFacetChart
instance, for chaining setter callspublic java.lang.Boolean getDrawTitleBoundary()
titleBackgroundProperties
settings should be
used instead.public FacetChart setEditProxyConstructor(java.lang.String editProxyConstructor) throws java.lang.IllegalStateException
EditProxy
for this component when the component is
first placed into edit mode
.setEditProxyConstructor
in class DrawPane
editProxyConstructor
- New editProxyConstructor value. Default value is "FacetChartEditProxy"FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSCClassName
public java.lang.String getEditProxyConstructor()
EditProxy
for this component when the component is
first placed into edit mode
.getEditProxyConstructor
in class DrawPane
SCClassName
public FacetChart setEndValueMetric(java.lang.String endValueMetric) throws java.lang.IllegalStateException
valueProperty
.endValueMetric
- New endValueMetric value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetMetricFacetId(java.lang.String)
public java.lang.String getEndValueMetric()
valueProperty
.getMetricFacetId()
public FacetChart setErrorBarColorMutePercent(float errorBarColorMutePercent) throws java.lang.IllegalStateException
errorBarColorMutePercent
- New errorBarColorMutePercent value. Default value is -60FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic float getErrorBarColorMutePercent()
public FacetChart setErrorBarWidth(int errorBarWidth) throws java.lang.IllegalStateException
errorBarWidth
- New errorBarWidth value. Default value is 6FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getErrorBarWidth()
public FacetChart setErrorLineProperties(DrawLine errorLineProperties) throws java.lang.IllegalStateException
Note that the lineColor
property has no effect as the color of the error bars is derived from the color of the data line.
errorLineProperties
- New errorLineProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetErrorBarColorMutePercent(float)
,
SGWTProperties
public DrawLine getErrorLineProperties()
Note that the lineColor
property has no effect as the color of the error bars is derived from the color of the data line.
getErrorBarColorMutePercent()
public FacetChart setExpectedValueLineProperties(DrawItem expectedValueLineProperties) throws java.lang.IllegalStateException
line drawn at the mean
value
. Note that for rectangular charts the properties are for a DrawLine
, and for radar charts the properties are for a DrawOval
.
expectedValueLineProperties
- New expectedValueLineProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public DrawItem getExpectedValueLineProperties()
line drawn at the mean
value
. Note that for rectangular charts the properties are for a DrawLine
, and for radar charts the properties are for a DrawOval
.
public FacetChart setExtraAxisLabelAlign(Alignment extraAxisLabelAlign)
extraAxisLabelAlign
- New extraAxisLabelAlign value. Default value is "left"FacetChart
instance, for chaining setter callspublic Alignment getExtraAxisLabelAlign()
public FacetChart setExtraAxisMetrics(java.lang.String... extraAxisMetrics) throws java.lang.IllegalStateException
FacetChart
docs for an overview of how multi-axis charts are used. Each metric
corresponds to different value property of the data records and superimposes its drawn data onto the chart rectangle.
The value properties are called metrics, and they can be either the valueProperty
or the "id" of a FacetValue
of the inlined Facet
(which is
then called the metric facet). Each value axis has its own gradations that are shown as tick marks along the length of
the axis. This property, extraAxisMetrics, specifies the metrics to use for additional value axes to the main value
axis.
The additional value axis may have their own gradations, chart type, log scale, data colors and gradients, and
other chart properties. These properties are specified with the extraAxisSettings
property.
Value axes, including
the main value axis, are labelled in the legend along with representations of the charted data. The labels are taken
from the FacetValue.title
of each metric's FacetValue (or
the valueTitle
if the metric is the valueProperty
).
The order of the metrics determines the position of the corresponding axes on the chart as well as the z-ordering of the corresponding data lines. The first and second extra value axes are placed to the right of the chart rectangle, and any remaining extra value axes are placed to the left of the main value axis (and therefore to the left of the chart rectangle).
extraAxisMetrics
- New extraAxisMetrics value. Default value is []FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String[] getExtraAxisMetrics()
FacetChart
docs for an overview of how multi-axis charts are used. Each metric
corresponds to different value property of the data records and superimposes its drawn data onto the chart rectangle.
The value properties are called metrics, and they can be either the valueProperty
or the "id" of a FacetValue
of the inlined Facet
(which is
then called the metric facet). Each value axis has its own gradations that are shown as tick marks along the length of
the axis. This property, extraAxisMetrics, specifies the metrics to use for additional value axes to the main value
axis.
The additional value axis may have their own gradations, chart type, log scale, data colors and gradients, and
other chart properties. These properties are specified with the extraAxisSettings
property.
Value axes, including
the main value axis, are labelled in the legend along with representations of the charted data. The labels are taken
from the FacetValue.title
of each metric's FacetValue (or
the valueTitle
if the metric is the valueProperty
).
The order of the metrics determines the position of the corresponding axes on the chart as well as the z-ordering of the corresponding data lines. The first and second extra value axes are placed to the right of the chart rectangle, and any remaining extra value axes are placed to the left of the main value axis (and therefore to the left of the chart rectangle).
public FacetChart setExtraAxisSettings(MetricSettings... extraAxisSettings) throws java.lang.IllegalStateException
extra axis metric
is plotted. See the main FacetChart
docs for an overview of how multi-axis charts are used. The chart of
each metric's values may be of any rectangular chart type that uses a vertical value axis ("Column", "Area", or "Line" -
"Histogram" is not supported). Because the charts will be superimposed over the same drawing area, there can only be one
"Column" chart and one "Area" chart. The column chart is placed on the bottom followed by the area chart, and then the
line charts are drawn on top in the order of their metric in the extraAxisMetrics
array. If the chartType
s are left unspecified then by default the first
metric will be drawn as columns and the remaining will be drawn as lines.
extraAxisSettings
- New extraAxisSettings value. Default value is []FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic MetricSettings[] getExtraAxisSettings()
extra axis metric
is plotted. See the main FacetChart
docs for an overview of how multi-axis charts are used. The chart of
each metric's values may be of any rectangular chart type that uses a vertical value axis ("Column", "Area", or "Line" -
"Histogram" is not supported). Because the charts will be superimposed over the same drawing area, there can only be one
"Column" chart and one "Area" chart. The column chart is placed on the bottom followed by the area chart, and then the
line charts are drawn on top in the order of their metric in the extraAxisMetrics
array. If the chartType
s are left unspecified then by default the first
metric will be drawn as columns and the remaining will be drawn as lines.
public FacetChart setFacets(Facet... facets) throws java.lang.IllegalStateException
CubeGrid.facets
,
except that:
In all chart types except "Bubble" and "Scatter", the chart displays a value for each discrete value of one facet (i.e.
single-facet charts) or it displays a value for each combination of discrete values of two facets (multi-facet charts).
The two discrete facets are the data label facet
and the legend facet
. They are named based on where
the values
of the facet appear in the chart. The facet whose
values are rendered as labels along the data axis or in the main chart area is the data label facet, and the facet whose
values are rendered in the legend is the legend facet.
For single-facet charts, most chart types have a data label facet as the first facet but no legend facet. Single-facet Pie charts have a legend facet as the first facet but no data label facet. Bubble and Scatter plots may have a legend facet as the second facet, after the metric facet.
In all multi-facet charts, the data label facet is always first and the legend facet is second. In most chart types the data label facet and the legend facet may be swapped on the fly by the user clicking on the "Swap Facets" item of the context menu.
facets
- New facets value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic Facet[] getFacets()
CubeGrid.facets
,
except that:
In all chart types except "Bubble" and "Scatter", the chart displays a value for each discrete value of one facet (i.e.
single-facet charts) or it displays a value for each combination of discrete values of two facets (multi-facet charts).
The two discrete facets are the data label facet
and the legend facet
. They are named based on where
the values
of the facet appear in the chart. The facet whose
values are rendered as labels along the data axis or in the main chart area is the data label facet, and the facet whose
values are rendered in the legend is the legend facet.
For single-facet charts, most chart types have a data label facet as the first facet but no legend facet. Single-facet Pie charts have a legend facet as the first facet but no data label facet. Bubble and Scatter plots may have a legend facet as the second facet, after the metric facet.
In all multi-facet charts, the data label facet is always first and the legend facet is second. In most chart types the data label facet and the legend facet may be swapped on the fly by the user clicking on the "Swap Facets" item of the context menu.
public FacetChart setFacets(Facet facets) throws java.lang.IllegalStateException
CubeGrid.facets
,
except that:
In all chart types except "Bubble" and "Scatter", the chart displays a value for each discrete value of one facet (i.e.
single-facet charts) or it displays a value for each combination of discrete values of two facets (multi-facet charts).
The two discrete facets are the data label facet
and the legend facet
. They are named based on where
the values
of the facet appear in the chart. The facet whose
values are rendered as labels along the data axis or in the main chart area is the data label facet, and the facet whose
values are rendered in the legend is the legend facet.
For single-facet charts, most chart types have a data label facet as the first facet but no legend facet. Single-facet Pie charts have a legend facet as the first facet but no data label facet. Bubble and Scatter plots may have a legend facet as the second facet, after the metric facet.
In all multi-facet charts, the data label facet is always first and the legend facet is second. In most chart types the data label facet and the legend facet may be swapped on the fly by the user clicking on the "Swap Facets" item of the context menu.
facets
- New facets value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic Facet getFacetsAsFacet()
CubeGrid.facets
,
except that:
In all chart types except "Bubble" and "Scatter", the chart displays a value for each discrete value of one facet (i.e.
single-facet charts) or it displays a value for each combination of discrete values of two facets (multi-facet charts).
The two discrete facets are the data label facet
and the legend facet
. They are named based on where
the values
of the facet appear in the chart. The facet whose
values are rendered as labels along the data axis or in the main chart area is the data label facet, and the facet whose
values are rendered in the legend is the legend facet.
For single-facet charts, most chart types have a data label facet as the first facet but no legend facet. Single-facet Pie charts have a legend facet as the first facet but no data label facet. Bubble and Scatter plots may have a legend facet as the second facet, after the metric facet.
In all multi-facet charts, the data label facet is always first and the legend facet is second. In most chart types the data label facet and the legend facet may be swapped on the fly by the user clicking on the "Swap Facets" item of the context menu.
public FacetChart setFilled(java.lang.Boolean filled)
If unset, fills will be automatically used when there are multiple facets and stacking is active (so Line and Radar charts will show stacked regions).
You can explicitly set filled:false to
create multi-facet Line or Radar charts where translucent regions overlap, or filled:true to fill in a single-facet Line
or Radar chart.
If this method is called after the component has been drawn/initialized:
Method to change filled
. Use null to apply a default value for the current chartType
.
filled
- new value. Default value is nullFacetChart
instance, for chaining setter callspublic java.lang.Boolean getFilled()
If unset, fills will be automatically used when there are multiple facets and stacking is active (so Line and Radar charts will show stacked regions).
You can explicitly set filled:false to create multi-facet Line or Radar charts where translucent regions overlap, or filled:true to fill in a single-facet Line or Radar chart.
public FacetChart setFormatStringFacetValueIds(java.lang.Boolean formatStringFacetValueIds)
setXAxisValueFormatter()
or
formatFacetValueId()
on a facet value id when
the id is a string. Can be set false to allow the formatting function(s) to be written without having to handle the
string case.formatStringFacetValueIds
- New formatStringFacetValueIds value. Default value is trueFacetChart
instance, for chaining setter callssetXAxisValueFormatter(com.smartgwt.client.widgets.chart.ValueFormatter)
,
formatFacetValueId(java.lang.Object, com.smartgwt.client.widgets.cube.Facet)
public java.lang.Boolean getFormatStringFacetValueIds()
setXAxisValueFormatter()
or
formatFacetValueId()
on a facet value id when
the id is a string. Can be set false to allow the formatting function(s) to be written without having to handle the
string case.setXAxisValueFormatter(com.smartgwt.client.widgets.chart.ValueFormatter)
,
formatFacetValueId(java.lang.Object, com.smartgwt.client.widgets.cube.Facet)
public FacetChart setGradationGaps(float... gradationGaps)
Candidates are expressed as a series of numbers between 1 and 10, representing boundaries within a given order of magnitude (power of 10).
For example, the setting
[1, 2.5, 5] means that, for a chart showing values that are only between 0 and 1, gradations of 0.1, 0.25 and 0.5 would
be evaluated to see which is a closer fit given the pixelsPerGradation
setting and the chart's height.
The same setting, with a chart showing values from 0 to 1,000,000 would imply that gradation gaps of 100,000, 250,000
and 500,000 would be evaluated.
If this method is called after the component has been drawn/initialized:
Setter for gradationGaps
.
gradationGaps
- new gradationGaps
value. Default value is [1, 2, 5]FacetChart
instance, for chaining setter callspublic float[] getGradationGaps()
Candidates are expressed as a series of numbers between 1 and 10, representing boundaries within a given order of magnitude (power of 10).
For example, the setting
[1, 2.5, 5] means that, for a chart showing values that are only between 0 and 1, gradations of 0.1, 0.25 and 0.5 would
be evaluated to see which is a closer fit given the pixelsPerGradation
setting and the chart's height.
The same setting, with a chart showing values from 0 to 1,000,000 would imply that gradation gaps of 100,000, 250,000
and 500,000 would be evaluated.
public FacetChart setGradationLabelPadding(int gradationLabelPadding) throws java.lang.IllegalStateException
gradationLabelPadding
- New gradationLabelPadding value. Default value is 5FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getGradationLabelPadding()
public FacetChart setGradationLabelProperties(DrawLabel gradationLabelProperties) throws java.lang.IllegalStateException
gradationLabelProperties
- New gradationLabelProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public DrawLabel getGradationLabelProperties()
public FacetChart setGradationLineProperties(DrawLine gradationLineProperties) throws java.lang.IllegalStateException
gradationLineProperties
- New gradationLineProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public DrawLine getGradationLineProperties()
public FacetChart setGradationTickMarkLength(java.lang.Integer gradationTickMarkLength) throws java.lang.IllegalStateException
tickLength
insteadgradationTickMarkLength
- New gradationTickMarkLength value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetTickLength(int)
public java.lang.Integer getGradationTickMarkLength()
tickLength
insteadgetTickLength()
public FacetChart setGradationZeroLineProperties(DrawLine gradationZeroLineProperties) throws java.lang.IllegalStateException
gradationZeroLineProperties
- New gradationZeroLineProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public DrawLine getGradationZeroLineProperties()
public FacetChart setHighErrorMetric(java.lang.String highErrorMetric) throws java.lang.IllegalStateException
lowErrorMetric
.highErrorMetric
- New highErrorMetric value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getHighErrorMetric()
lowErrorMetric
.public FacetChart setHoverLabelPadding(int hoverLabelPadding) throws java.lang.IllegalStateException
hoverLabel
when showValueOnHover
is enabled.
Note : This is an advanced setting
hoverLabelPadding
- New hoverLabelPadding value. Default value is 4FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getHoverLabelPadding()
hoverLabel
when showValueOnHover
is enabled.public FacetChart setHoverLabelProperties(DrawLabel hoverLabelProperties) throws java.lang.IllegalStateException
showValueOnHover
is enabled.hoverLabelProperties
- New hoverLabelProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetHoverLabelPadding(int)
,
SGWTProperties
public DrawLabel getHoverLabelProperties()
showValueOnHover
is enabled.getHoverLabelPadding()
public FacetChart setHoverRectProperties(DrawRect hoverRectProperties) throws java.lang.IllegalStateException
showValueOnHover
for more details.hoverRectProperties
- New hoverRectProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public DrawRect getHoverRectProperties()
showValueOnHover
for more details.public FacetChart setLabelCollapseMode(LabelCollapseMode labelCollapseMode) throws java.lang.IllegalStateException
LabelCollapseMode
. Each of the possible strategies is re-applied when the user resizes the chart as a whole, so if labels are omitted the user can make them visible via resize or zoom.
If the labelCollapseMode is "numeric" then vertical lines will be drawn at gradation values automatically chosen by the chart.
If the labelCollapseMode is "time" then vertical lines are drawn to represent a sequence of significant datetime values on the x-axis, such as the first day of the month or week. The chart automatically chooses the sequence of Dates such that the spacing between them expresses the smallest granularity of time possible while still allowing the axis labels to make good use of the space. If, for example, the Date values in the data span a few years in time then the chart may select January 1 of the same year of the earliest data point and every January 1 thereafter (in range of the data) as the sequence of Dates and label each Date by the four-digit year. If the time span of the data values is on the order of minutes then the chart may select multiples of 15 minutes as the seqeunce of Dates. FacetChart currently supports the following granularities of time: years, quarters, months, weeks, days, hours, half-hours, quarter-hours, 5 minutes, minutes, 30 seconds, and 15 seconds.
The format of the Date labels is fixed by FacetChart.
In particular, the format
method for any setter applied
with setXAxisValueFormatter()
will not be
called on values for the x-axis. However, FacetChart uses the global array of abbreviated month names
for the time granularities
of quarters, months, and weeks, uses the default
short time format
to format labels for time granularities from minutes to hours, and uses the default time format
to format labels for the time
granularities of 15 seconds and 30 seconds. The label format can be customized by changing these three formatters.
Also note that for the time granularity of weeks the sequence of Dates will be the first day of each week, as specified
by setFirstDayOfWeek()
.
Note that if the
labelCollapseMode is "time" or "numeric" then the data
must
be initially sorted with the data label facet
's
values in ascending order.
labelCollapseMode
- New labelCollapseMode value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetXAxisValueFormatter(com.smartgwt.client.widgets.chart.ValueFormatter)
public LabelCollapseMode getLabelCollapseMode()
LabelCollapseMode
. Each of the possible strategies is re-applied when the user resizes the chart as a whole, so if labels are omitted the user can make them visible via resize or zoom.
If the labelCollapseMode is "numeric" then vertical lines will be drawn at gradation values automatically chosen by the chart.
If the labelCollapseMode is "time" then vertical lines are drawn to represent a sequence of significant datetime values on the x-axis, such as the first day of the month or week. The chart automatically chooses the sequence of Dates such that the spacing between them expresses the smallest granularity of time possible while still allowing the axis labels to make good use of the space. If, for example, the Date values in the data span a few years in time then the chart may select January 1 of the same year of the earliest data point and every January 1 thereafter (in range of the data) as the sequence of Dates and label each Date by the four-digit year. If the time span of the data values is on the order of minutes then the chart may select multiples of 15 minutes as the seqeunce of Dates. FacetChart currently supports the following granularities of time: years, quarters, months, weeks, days, hours, half-hours, quarter-hours, 5 minutes, minutes, 30 seconds, and 15 seconds.
The format of the Date labels is fixed by FacetChart.
In particular, the format
method for any setter applied
with setXAxisValueFormatter()
will not be
called on values for the x-axis. However, FacetChart uses the global array of abbreviated month names
for the time granularities
of quarters, months, and weeks, uses the default
short time format
to format labels for time granularities from minutes to hours, and uses the default time format
to format labels for the time
granularities of 15 seconds and 30 seconds. The label format can be customized by changing these three formatters.
Also note that for the time granularity of weeks the sequence of Dates will be the first day of each week, as specified
by setFirstDayOfWeek()
.
Note that if the
labelCollapseMode is "time" or "numeric" then the data
must
be initially sorted with the data label facet
's
values in ascending order.
setXAxisValueFormatter(com.smartgwt.client.widgets.chart.ValueFormatter)
public FacetChart setLegendAlign(LegendAlign legendAlign)
legend widget
.legendAlign
- New legendAlign value. Default value is "center"FacetChart
instance, for chaining setter callspublic LegendAlign getLegendAlign()
legend widget
.public FacetChart setLegendBoundaryProperties(DrawLine legendBoundaryProperties) throws java.lang.IllegalStateException
drawLegendBoundary
legendBoundaryProperties
- New legendBoundaryProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public DrawLine getLegendBoundaryProperties()
drawLegendBoundary
public FacetChart setLegendItemPadding(int legendItemPadding) throws java.lang.IllegalStateException
legendItemPadding
- New legendItemPadding value. Default value is 5FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getLegendItemPadding()
public FacetChart setLegendLabelProperties(DrawLabel legendLabelProperties) throws java.lang.IllegalStateException
legendLabelProperties
- New legendLabelProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public DrawLabel getLegendLabelProperties()
public FacetChart setLegendMargin(int legendMargin) throws java.lang.IllegalStateException
legendMargin
- New legendMargin value. Default value is 10FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getLegendMargin()
public FacetChart setLegendPadding(int legendPadding) throws java.lang.IllegalStateException
legendPadding
- New legendPadding value. Default value is 5FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getLegendPadding()
public FacetChart setLegendRectHeight(int legendRectHeight) throws java.lang.IllegalStateException
legendRectHeight
- New legendRectHeight value. Default value is 5FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getLegendRectHeight()
public FacetChart setLegendRectProperties(DrawRect legendRectProperties) throws java.lang.IllegalStateException
legendRectProperties
- New legendRectProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public DrawRect getLegendRectProperties()
public FacetChart setLegendSwatchProperties(DrawRect legendSwatchProperties) throws java.lang.IllegalStateException
legendSwatchProperties
- New legendSwatchProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public DrawRect getLegendSwatchProperties()
public FacetChart setLegendSwatchSize(int legendSwatchSize) throws java.lang.IllegalStateException
legendSwatchSize
- New legendSwatchSize value. Default value is 16FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getLegendSwatchSize()
public FacetChart setLegendTextPadding(int legendTextPadding) throws java.lang.IllegalStateException
legendTextPadding
- New legendTextPadding value. Default value is 5FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getLegendTextPadding()
public FacetChart setLogBase(int logBase) throws java.lang.IllegalStateException
useLogGradations
, base value for
logarithmic gradation lines. Gradation lines will be shown at every power of this value plus intervening values
specified by logGradations
.logBase
- New logBase value. Default value is 10FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getLogBase()
useLogGradations
, base value for
logarithmic gradation lines. Gradation lines will be shown at every power of this value plus intervening values
specified by logGradations
.public FacetChart setLogGradations(float... logGradations) throws java.lang.IllegalStateException
useLogGradations
is set, gradation lines
to show in between powers,
expressed as a series of integer or float values between 1 and logBase
.
Some common possibilities (for base 10):
[ 1 ] // show only orders of magnitude (0.1, 1, 10, 100, etc) [ 1, 5 ] // show only orders of magnitude plus halfway mark [ 1, 2, 4, 8 ] // show powers of 2 between orders [ 1, 2.5, 5, 7.5 ] // show quartersOr base 2:
[ 1 ] [ 1, 1.5 ]
logGradations
- New logGradations value. Default value is [ 1,2,4,6,8 ]FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic float[] getLogGradations()
useLogGradations
is set, gradation lines
to show in between powers,
expressed as a series of integer or float values between 1 and logBase
.
Some common possibilities (for base 10):
[ 1 ] // show only orders of magnitude (0.1, 1, 10, 100, etc) [ 1, 5 ] // show only orders of magnitude plus halfway mark [ 1, 2, 4, 8 ] // show powers of 2 between orders [ 1, 2.5, 5, 7.5 ] // show quartersOr base 2:
[ 1 ] [ 1, 1.5 ]
public FacetChart setLogScale(java.lang.Boolean logScale) throws java.lang.IllegalStateException
Logarithmic scale charts show an equivalent percentage increase as equivalent distance on the chart. That is, 10 and 100 are the same distance apart as 100 and 1000 (each being a 10 times or 1000% increase).
logScale
- New logScale value. Default value is falseFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getLogScale()
Logarithmic scale charts show an equivalent percentage increase as equivalent distance on the chart. That is, 10 and 100 are the same distance apart as 100 and 1000 (each being a 10 times or 1000% increase).
public FacetChart setLogScalePointColor(boolean logScalePointColor) throws java.lang.IllegalStateException
color
scale
of the data points. Defaults to the value of logScale
.logScalePointColor
- New logScalePointColor value. Default value is falseFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetPointColorLogBase(java.lang.Integer)
,
Color Scale Chart Examplepublic boolean getLogScalePointColor()
color
scale
of the data points. Defaults to the value of logScale
.getPointColorLogBase()
,
Color Scale Chart Examplepublic FacetChart setLogScalePointSize(boolean logScalePointSize) throws java.lang.IllegalStateException
data
point sizes
. Defaults to the value of logScale
.logScalePointSize
- New logScalePointSize value. Default value is falseFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetPointSizeLogBase(java.lang.Integer)
,
Bubble Chart Examplepublic boolean getLogScalePointSize()
data
point sizes
. Defaults to the value of logScale
.getPointSizeLogBase()
,
Bubble Chart Examplepublic FacetChart setLowErrorMetric(java.lang.String lowErrorMetric) throws java.lang.IllegalStateException
lowErrorMetric
and highErrorMetric
can be used to cause error bars to appear above and below the main data point. lowErrorMetric
and
highErrorMetric
provide the name of an additional attributes that appears in each Record holding the low
error value and high error value respectively.
Error bars are supported for single-axis charts only.
lowErrorMetric
- New lowErrorMetric value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetMetricFacetId(java.lang.String)
,
Error Bars Examplepublic java.lang.String getLowErrorMetric()
lowErrorMetric
and highErrorMetric
can be used to cause error bars to appear above and below the main data point. lowErrorMetric
and
highErrorMetric
provide the name of an additional attributes that appears in each Record holding the low
error value and high error value respectively.
Error bars are supported for single-axis charts only.
getMetricFacetId()
,
Error Bars Examplepublic FacetChart setMajorTickGradations(float... majorTickGradations) throws java.lang.IllegalStateException
gradationGaps
, or no ticks will end up as minor ticks.
The default setting of [1] means that major ticks are used for powers of 10 only. A setting of [1,5] would mean
that major ticks are also used at half-orders of magnitude, such as 0.5 or 50. For example, if used with a gradationGaps
setting of [1,2.5] for a chart showing
values between 0 and 1, this would result in major ticks at 0, 1 and 0.5, and minor ticks at 0.25 and 0.75.
See also
majorTickTimeIntervals
for controlling
major vs minor ticks for the X-axis of time/date-valued Scatter plots.
If this method is called after the component has been drawn/initialized:
Setter for majorTickGradations
.
majorTickGradations
- new majorTickGradations
value. Default value is [1]FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic float[] getMajorTickGradations()
gradationGaps
, or no ticks will end up as minor ticks.
The default setting of [1] means that major ticks are used for powers of 10 only. A setting of [1,5] would mean
that major ticks are also used at half-orders of magnitude, such as 0.5 or 50. For example, if used with a gradationGaps
setting of [1,2.5] for a chart showing
values between 0 and 1, this would result in major ticks at 0, 1 and 0.5, and minor ticks at 0.25 and 0.75.
See also
majorTickTimeIntervals
for controlling
major vs minor ticks for the X-axis of time/date-valued Scatter plots.
public FacetChart setMajorTickTimeIntervals(java.lang.String... majorTickTimeIntervals)
shown on the X axis
for a
Scatter plot where the X axis uses time/date values, controls the intervals which are shown as major ticks. The
intervals are specified as Strings, in the same way as otherAxisGradationTimes
.
For any given interval, the first major tick is shown for the next greatest time unit. For example, for interval such as "2h" (2 hours), the first major tick starts on the day boundary (whether that day boundary is visible in the chart or not).
By default, all ticks are shown as major ticks.
If this method is called after the component has been drawn/initialized:
Setter for majorTickTimeIntervals
.
majorTickTimeIntervals
- new majorTickTimeIntervals
value. Default value is nullFacetChart
instance, for chaining setter callspublic java.lang.String[] getMajorTickTimeIntervals()
shown on the X axis
for a
Scatter plot where the X axis uses time/date values, controls the intervals which are shown as major ticks. The
intervals are specified as Strings, in the same way as otherAxisGradationTimes
.
For any given interval, the first major tick is shown for the next greatest time unit. For example, for interval such as "2h" (2 hours), the first major tick starts on the day boundary (whether that day boundary is visible in the chart or not).
By default, all ticks are shown as major ticks.
public FacetChart setMatchBarChartDataLineColor(java.lang.Boolean matchBarChartDataLineColor)
matchBarChartDataLineColor
- New matchBarChartDataLineColor value. Default value is nullFacetChart
instance, for chaining setter callspublic java.lang.Boolean getMatchBarChartDataLineColor()
public FacetChart setMaxBarThickness(int maxBarThickness) throws java.lang.IllegalStateException
maxBarThickness
- New maxBarThickness value. Default value is 150FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdcom.smartgwt.client.widgets.chart.FacetChart#getMinClusterSize
public int getMaxBarThickness()
com.smartgwt.client.widgets.chart.FacetChart#getMinClusterSize
public FacetChart setMaxDataPointSize(double maxDataPointSize) throws java.lang.IllegalStateException
pointSizeMetric
.maxDataPointSize
- New maxDataPointSize value. Default value is 14FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic double getMaxDataPointSize()
pointSizeMetric
.public FacetChart setMaxDataZIndex(java.lang.Integer maxDataZIndex) throws java.lang.IllegalStateException
zIndexMetric
in a histogram chart. Any zIndex values exceeding this property will be internally clipped so as to not
exceed it. While this property can be increased, note that very large values may hit limitations related to the
browser's implementation of the current DrawPane.drawingType
.maxDataZIndex
- New maxDataZIndex value. Default value is 10000FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdChartType
,
setZIndexMetric(java.lang.String)
public java.lang.Integer getMaxDataZIndex()
zIndexMetric
in a histogram chart. Any zIndex values exceeding this property will be internally clipped so as to not
exceed it. While this property can be increased, note that very large values may hit limitations related to the
browser's implementation of the current DrawPane.drawingType
.ChartType
,
getZIndexMetric()
public FacetChart setMetricFacetId(java.lang.String metricFacetId) throws java.lang.IllegalStateException
lowErrorMetric
and highErrorMetric
when showing error bars.metricFacetId
- New metricFacetId value. Default value is "metric"FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getMetricFacetId()
lowErrorMetric
and highErrorMetric
when showing error bars.public FacetChart setMinBarThickness(int minBarThickness) throws java.lang.IllegalStateException
minBarThickness
- New minBarThickness value. Default value is 4FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdcom.smartgwt.client.widgets.chart.FacetChart#getMinClusterSize
public int getMinBarThickness()
com.smartgwt.client.widgets.chart.FacetChart#getMinClusterSize
public FacetChart setMinChartHeight(java.lang.Integer minChartHeight) throws java.lang.IllegalStateException
minChartHeight
- New minChartHeight value. Default value is 1FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getMinChartHeight()
minimum height
for the chart body. Default value is 1public FacetChart setMinChartWidth(java.lang.Integer minChartWidth) throws java.lang.IllegalStateException
minChartWidth
- New minChartWidth value. Default value is 1FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getMinChartWidth()
minimum width
for the chart body. Default value is 1public FacetChart setMinContentHeight(int minContentHeight)
autoScrollContent
is true, limits the
minimum height of the chart-content, including data, labels, title and legends. If this widget is sized smaller than
this height, scrollbars are introduced to reach the hidden content. See minContentWidth
to affect the minimum horizontal
content-size.minContentHeight
- New minContentHeight value. Default value is 150FacetChart
instance, for chaining setter callspublic int getMinContentHeight()
autoScrollContent
is true, limits the
minimum height of the chart-content, including data, labels, title and legends. If this widget is sized smaller than
this height, scrollbars are introduced to reach the hidden content. See minContentWidth
to affect the minimum horizontal
content-size.minContentHeight
for this facet
chart when autoScrollContent
is enabled. Default value is 150public FacetChart setMinContentWidth(int minContentWidth)
autoScrollContent
is true, limits the
minimum width of the chart-content, including data, labels, titles and legends. If this widget is sized smaller than
this width, scrollbars are introduced to reach the hidden content. See minContentHeight
to affect the minimum vertical
content-size.minContentWidth
- New minContentWidth value. Default value is 150FacetChart
instance, for chaining setter callspublic int getMinContentWidth()
autoScrollContent
is true, limits the
minimum width of the chart-content, including data, labels, titles and legends. If this widget is sized smaller than
this width, scrollbars are introduced to reach the hidden content. See minContentHeight
to affect the minimum vertical
content-size.minContentWidth
for this facet chart
when autoScrollContent
is enabled. Default value is 150public FacetChart setMinDataPointSize(double minDataPointSize) throws java.lang.IllegalStateException
pointSizeMetric
.minDataPointSize
- New minDataPointSize value. Default value is 3FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic double getMinDataPointSize()
pointSizeMetric
.public FacetChart setMinDataSpreadPercent(int minDataSpreadPercent) throws java.lang.IllegalStateException
minDataSpreadPercent
of the axis, the start values
of axes will be automatically adjusted to make better use of space. For example, if a column chart has all data
values between 500,000 and 500,100, if the axis starts at 0, differences in column heights will be visually
indistinguishable. In this case, since all data values appear in well under 30% of the axis length, the default
minDataSpreadPercent
setting would cause the axis to start at a value that would make the column heights
obviously different (for example, starting the axis as 500,000).
Setting an explicit axisStartValue
or axisEndValue
, disables this behavior, as does setting
minDataSpreadPercent
to 0.
For multi-axis charts, use MetricSettings.minDataSpreadPercent
for
per-axis settings.
For Bubble and Scatter charts, minDataSpreadPercent
affects only the y-axis of the
chart. The property minXDataSpreadPercent
must be used to enable the corresponding feature for the x-axis.
minDataSpreadPercent
- New minDataSpreadPercent value. Default value is 30FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getMinDataSpreadPercent()
minDataSpreadPercent
of the axis, the start values
of axes will be automatically adjusted to make better use of space. For example, if a column chart has all data
values between 500,000 and 500,100, if the axis starts at 0, differences in column heights will be visually
indistinguishable. In this case, since all data values appear in well under 30% of the axis length, the default
minDataSpreadPercent
setting would cause the axis to start at a value that would make the column heights
obviously different (for example, starting the axis as 500,000).
Setting an explicit axisStartValue
or axisEndValue
, disables this behavior, as does setting
minDataSpreadPercent
to 0.
For multi-axis charts, use MetricSettings.minDataSpreadPercent
for
per-axis settings.
For Bubble and Scatter charts, minDataSpreadPercent
affects only the y-axis of the
chart. The property minXDataSpreadPercent
must be used to enable the corresponding feature for the x-axis.
public FacetChart setMinLabelGap(java.lang.Integer minLabelGap) throws java.lang.IllegalStateException
labelCollapseMode
. Default is based on label orientation. If labels are vertical, the minimum gap is the height of half a line of text. If horizontal it's the width of 4 "X" letters.
minLabelGap
- New minLabelGap value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getMinLabelGap()
labelCollapseMode
. Default is based on label orientation. If labels are vertical, the minimum gap is the height of half a line of text. If horizontal it's the width of 4 "X" letters.
public FacetChart setMinorTickLength(int minorTickLength)
minor tick marks
are enabled.
minorTickLength
.minorTickLength
- new minorTickLength
value. Default value is 2FacetChart
instance, for chaining setter callssetTickLength(int)
public int getMinorTickLength()
minor tick marks
are enabled.getTickLength()
public FacetChart setMinXDataSpreadPercent(int minXDataSpreadPercent) throws java.lang.IllegalStateException
minXDataSpreadPercent
of the x-axis, the start
value of x-axis will be automatically adjusted to make better use of space. Setting an explicit xAxisStartValue
disables this behavior, as does setting
minXDataSpreadPercent
to 0.
minXDataSpreadPercent
- New minXDataSpreadPercent value. Default value is 30FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetMinDataSpreadPercent(int)
public int getMinXDataSpreadPercent()
minXDataSpreadPercent
of the x-axis, the start
value of x-axis will be automatically adjusted to make better use of space. Setting an explicit xAxisStartValue
disables this behavior, as does setting
minXDataSpreadPercent
to 0.
getMinDataSpreadPercent()
public FacetChart setOtherAxisGradationGaps(float... otherAxisGradationGaps)
gradationGaps
, except allows control of
gradations for the X (horizontal) axis, for Scatter charts only. See also otherAxisGradationTimes
for control of
gradations when the X axis is time-valued.
Defaults to the value of pixelsPerGradation
if unset.
If this method is called after the component has been drawn/initialized:
Setter for otherAxisGradationGaps
.
otherAxisGradationGaps
- new otherAxisGradationGaps
value. Default value is nullFacetChart
instance, for chaining setter callspublic float[] getOtherAxisGradationGaps()
gradationGaps
, except allows control of
gradations for the X (horizontal) axis, for Scatter charts only. See also otherAxisGradationTimes
for control of
gradations when the X axis is time-valued.
Defaults to the value of pixelsPerGradation
if unset.
public FacetChart setOtherAxisGradationTimes(java.lang.String... otherAxisGradationTimes)
When time units are used, there is no way to scale the same unit to a much larger or smaller range of time (as there is with numeric gradations). For example, a setting of "30mn" meaning "30 minutes" does not mean that 30 hours is a natural choice for chart with a longer timeline (days should obviously be chosen instead). Therefore, when specifying time gradations, candidate gradations must be provided for the entire possible displayed range. If insufficient gradations are specified, this can result in unreadable charts; for example, if the largest available gradation is "15mn" and the chart is showing a full week's data in around 500px, there will be more than one gradation per pixel, and labels will be drawn on top of each other.
To prevent this, be sure to specify enough gradations to cover the all time ranges your
chart may need to display. However, if gradations are not specified for granularities
under 1 second or over 1 year, further gradations will be chosen based on using
otherAxisGradationGaps
to choose
fractions of seconds or multiples of years.
The default setting is effectively:
["1s", "15s", "30s", "1mn", "5mn", "15mn", "30mn", "1h", "1d", "1w", "1m", "1q", "1y"]
otherAxisGradationTimes
.otherAxisGradationTimes
- new otherAxisGradationTimes
value. Default value is nullFacetChart
instance, for chaining setter callspublic java.lang.String[] getOtherAxisGradationTimes()
When time units are used, there is no way to scale the same unit to a much larger or smaller range of time (as there is with numeric gradations). For example, a setting of "30mn" meaning "30 minutes" does not mean that 30 hours is a natural choice for chart with a longer timeline (days should obviously be chosen instead). Therefore, when specifying time gradations, candidate gradations must be provided for the entire possible displayed range. If insufficient gradations are specified, this can result in unreadable charts; for example, if the largest available gradation is "15mn" and the chart is showing a full week's data in around 500px, there will be more than one gradation per pixel, and labels will be drawn on top of each other.
To prevent this, be sure to specify enough gradations to cover the all time ranges your
chart may need to display. However, if gradations are not specified for granularities
under 1 second or over 1 year, further gradations will be chosen based on using
otherAxisGradationGaps
to choose
fractions of seconds or multiples of years.
The default setting is effectively:
["1s", "15s", "30s", "1mn", "5mn", "15mn", "30mn", "1h", "1d", "1w", "1m", "1q", "1y"]
public FacetChart setOtherAxisPixelsPerGradation(java.lang.Integer otherAxisPixelsPerGradation)
Defaults
to the value of pixelsPerGradation
if unset.
If this method is called after the component has been drawn/initialized:
Setter for otherAxisPixelsPerGradation
.
otherAxisPixelsPerGradation
- new otherAxisPixelsPerGradation
value. Default value is nullFacetChart
instance, for chaining setter callssetPixelsPerGradation(int)
public java.lang.Integer getOtherAxisPixelsPerGradation()
Defaults
to the value of pixelsPerGradation
if unset.
getPixelsPerGradation()
public FacetChart setPadChartRectByCornerRadius(boolean padChartRectByCornerRadius) throws java.lang.IllegalStateException
showChartRect
is enabled and if chartRectProperties
specifies a nonzero rounding
, whether the padding around the inside of the chart
rect. should include at least the radius of the rounded corner.padChartRectByCornerRadius
- New padChartRectByCornerRadius value. Default value is trueFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic boolean getPadChartRectByCornerRadius()
showChartRect
is enabled and if chartRectProperties
specifies a nonzero rounding
, whether the padding around the inside of the chart
rect. should include at least the radius of the rounded corner.public FacetChart setPieBorderProperties(DrawOval pieBorderProperties) throws java.lang.IllegalStateException
pieBorderProperties
- New pieBorderProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public DrawOval getPieBorderProperties()
public FacetChart setPieLabelAngleStart(int pieLabelAngleStart) throws java.lang.IllegalStateException
pieLabelAngleStart
- New pieLabelAngleStart value. Default value is 20FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getPieLabelAngleStart()
public FacetChart setPieLabelLineExtent(int pieLabelLineExtent) throws java.lang.IllegalStateException
pieLabelLineExtent
- New pieLabelLineExtent value. Default value is 7FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getPieLabelLineExtent()
public FacetChart setPieLabelLineProperties(DrawLine pieLabelLineProperties)
pieLabelLineProperties
- New pieLabelLineProperties value. Default value is nullFacetChart
instance, for chaining setter callsSGWTProperties
public DrawLine getPieLabelLineProperties()
public FacetChart setPieRingBorderProperties(DrawOval pieRingBorderProperties) throws java.lang.IllegalStateException
pieRingBorderProperties
- New pieRingBorderProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public DrawOval getPieRingBorderProperties()
public FacetChart setPieSliceProperties(DrawSector pieSliceProperties) throws java.lang.IllegalStateException
pieSliceProperties
- New pieSliceProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public DrawSector getPieSliceProperties()
public FacetChart setPieStartAngle(java.lang.Integer pieStartAngle) throws java.lang.IllegalStateException
pieStartAngle
- New pieStartAngle value. Default value is 0FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getPieStartAngle()
public FacetChart setPixelsPerGradation(int pixelsPerGradation)
The chart will detect the range of values being displayed and available pixels on the
vertical axis, and generate gradations that are spaced approximately pixelsPerGradations
apart.
Note that the Framework will attempt to approach the specified target gap from above - the chart will never be drawn
with gradations spaced closer than pixelsPerGradation
.
If this method is called after the component has been drawn/initialized:
Setter for pixelsPerGradation
.
pixelsPerGradation
- new pixelsPerGradation
value. Default value is 28FacetChart
instance, for chaining setter callssetOtherAxisPixelsPerGradation(java.lang.Integer)
public int getPixelsPerGradation()
The chart will detect the range of values being displayed and available pixels on the
vertical axis, and generate gradations that are spaced approximately pixelsPerGradations
apart.
Note that the Framework will attempt to approach the specified target gap from above - the chart will never be drawn
with gradations spaced closer than pixelsPerGradation
.
getOtherAxisPixelsPerGradation()
public FacetChart setPointColorLogBase(java.lang.Integer pointColorLogBase) throws java.lang.IllegalStateException
logScalePointColor
is true
,
this property specifies the base value for logarithmic color scale metric
values.pointColorLogBase
- New pointColorLogBase value. Default value is 10FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getPointColorLogBase()
logScalePointColor
is true
,
this property specifies the base value for logarithmic color scale metric
values.public FacetChart setPointShapes(PointShape... pointShapes) throws java.lang.IllegalStateException
showDataPoints
is enabled, this
property specifies an array of geometric shapes to draw for the data points of each series.pointShapes
- New pointShapes value. Default value is ["Oval", "Square", "Diamond", "Triangle"]FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic PointShape[] getPointShapes()
showDataPoints
is enabled, this
property specifies an array of geometric shapes to draw for the data points of each series.public FacetChart setPointSizeGradations(java.lang.Integer pointSizeGradations) throws java.lang.IllegalStateException
point size legend
is shown, this
property controls the number of gradations of the pointSizeMetric
that the chart tries to display. Note that if usePointSizeLogGradations
is set then the
number of gradations is not given by this property but rather by the entries of pointSizeLogGradations
.
pointSizeGradations
- New pointSizeGradations value. Default value is 5FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getPointSizeGradations()
point size legend
is shown, this
property controls the number of gradations of the pointSizeMetric
that the chart tries to display. Note that if usePointSizeLogGradations
is set then the
number of gradations is not given by this property but rather by the entries of pointSizeLogGradations
.
public FacetChart setPointSizeLogBase(java.lang.Integer pointSizeLogBase) throws java.lang.IllegalStateException
logScalePointSize
is true, base value for
logarithmic point size metric values.pointSizeLogBase
- New pointSizeLogBase value. Default value is 10FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getPointSizeLogBase()
logScalePointSize
is true, base value for
logarithmic point size metric values.public FacetChart setPointSizeLogGradations(float... pointSizeLogGradations) throws java.lang.IllegalStateException
usePointSizeLogGradations
is set,
this property specifies the pointSizeMetric
value gradations to show in the point size
legend
in between powers, expressed as a series of integer or float values between 1 and pointSizeLogBase
.pointSizeLogGradations
- New pointSizeLogGradations value. Default value is [1, 5]FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetLogGradations(float...)
public float[] getPointSizeLogGradations()
usePointSizeLogGradations
is set,
this property specifies the pointSizeMetric
value gradations to show in the point size
legend
in between powers, expressed as a series of integer or float values between 1 and pointSizeLogBase
.getLogGradations()
public FacetChart setPointSizeMetric(java.lang.String pointSizeMetric) throws java.lang.IllegalStateException
showDataPoints
is enabled, this
property specifies an additional metric (i.e. an "id" of a metric facet value) that determines the size of the data
points drawn. For example, when a circle is drawn to represent a data point then the size of the data point is the
diameter of the circle, in pixels. The size is calculated by linearly scaling the value of the
pointSizeMetric
of the point between the minDataPointSize
and maxDataPointSize
. The data point that has the lowest
value for the pointSizeMetric
will be drawn as a shape minDataPointSize
pixels in size, and
the data point that has the highest value for the pointSizeMetric
will be drawn as a shape
maxDataPointSize
pixels in size.
Using a log-scale to calulate the size of the data points is achieved
by enabling logScalePointSize
.
If the
ChartType
is "Bubble"
then the default pointSizeMetric
is
"pointSize"
.
Note that setting pointSizeMetric
to non-null
implicitly enables
showDataPoints
.
pointSizeMetric
- New pointSizeMetric value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getPointSizeMetric()
showDataPoints
is enabled, this
property specifies an additional metric (i.e. an "id" of a metric facet value) that determines the size of the data
points drawn. For example, when a circle is drawn to represent a data point then the size of the data point is the
diameter of the circle, in pixels. The size is calculated by linearly scaling the value of the
pointSizeMetric
of the point between the minDataPointSize
and maxDataPointSize
. The data point that has the lowest
value for the pointSizeMetric
will be drawn as a shape minDataPointSize
pixels in size, and
the data point that has the highest value for the pointSizeMetric
will be drawn as a shape
maxDataPointSize
pixels in size.
Using a log-scale to calulate the size of the data points is achieved
by enabling logScalePointSize
.
If the
ChartType
is "Bubble"
then the default pointSizeMetric
is
"pointSize"
.
Note that setting pointSizeMetric
to non-null
implicitly enables
showDataPoints
.
public FacetChart setPrintZoomChart(boolean printZoomChart)
zoom chart
be printed with this
FacetChart
? If true
, then the SVG string returned by DrawPane.getSvgString()
will include the zoom chart's SVG as
well.
Note : This is an advanced setting
printZoomChart
- New printZoomChart value. Default value is trueFacetChart
instance, for chaining setter callsPrinting overview and related methods
public boolean getPrintZoomChart()
zoom chart
be printed with this
FacetChart
? If true
, then the SVG string returned by DrawPane.getSvgString()
will include the zoom chart's SVG as
well.Printing overview and related methods
public FacetChart setProbabilityMetric(java.lang.String probabilityMetric) throws java.lang.IllegalStateException
getMean()
and getStdDev()
). The default value of this property is null which
causes the FacetChart to assign probabilities to the data records according to a uniform probability distribution.
Note that the FacetChart handles cases where the sum total of all probabilities in the data
is not exactly one by scaling the assigned probabilities.
probabilityMetric
- New probabilityMetric value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdgetMean(java.lang.String)
,
getMedian(java.lang.String)
,
getStdDev(java.lang.String, boolean)
,
getVariance(java.lang.String, boolean)
public java.lang.String getProbabilityMetric()
getMean()
and getStdDev()
). The default value of this property is null which
causes the FacetChart to assign probabilities to the data records according to a uniform probability distribution.
Note that the FacetChart handles cases where the sum total of all probabilities in the data
is not exactly one by scaling the assigned probabilities.
getMean(java.lang.String)
,
getMedian(java.lang.String)
,
getStdDev(java.lang.String, boolean)
,
getVariance(java.lang.String, boolean)
public FacetChart setProportional(java.lang.Boolean proportional)
Gradation labels will be switched to show percentage instead of absolute values.
This setting is valid only for
Column, Bar, Area and Radar chart types and only in stacked
mode. Stacked columns will be as tall as the chart rect and stacked bars will be as wide as the chart rect.
Area and Radar charts will be completely filled except for facet values where all values are 0.
If this method is called after the component has been drawn/initialized:
Setter for proportional
.
proportional
- Whether the chart should now use proportional mode. Default value is nullFacetChart
instance, for chaining setter callspublic java.lang.Boolean getProportional()
Gradation labels will be switched to show percentage instead of absolute values.
This setting is valid only for
Column, Bar, Area and Radar chart types and only in stacked
mode. Stacked columns will be as tall as the chart rect and stacked bars will be as wide as the chart rect.
Area and Radar charts will be completely filled except for facet values where all values are 0.
public FacetChart setProportionalAxisLabel(java.lang.String proportionalAxisLabel) throws java.lang.IllegalStateException
proportional rendering mode
. This title will be used
unless the legend facet
defines a proportionalTitle
.proportionalAxisLabel
- New proportionalAxisLabel value. Default value is "Percent"FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getProportionalAxisLabel()
proportional rendering mode
. This title will be used
unless the legend facet
defines a proportionalTitle
.public FacetChart setRadarBackgroundProperties(DrawOval radarBackgroundProperties) throws java.lang.IllegalStateException
radarBackgroundProperties
- New radarBackgroundProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public DrawOval getRadarBackgroundProperties()
public FacetChart setRadarRotateLabels(LabelRotationMode radarRotateLabels) throws java.lang.IllegalStateException
data label facet
of radar or stacked
pie charts so that each label is parallel to its radial
gradation (these are the labels that appear around the perimeter). For now, "auto" means the same thing as "always" -
but this may change in the future if heuristics are added to determine when the affected labels are likely to overlap
and not be legible. If rotateLabels is "never" then the labels will not be rotated. radarRotateLabels
- New radarRotateLabels value. Default value is "auto"FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetRotateLabels(com.smartgwt.client.types.LabelRotationMode)
,
setRadialLabelOffset(java.lang.Integer)
public LabelRotationMode getRadarRotateLabels()
data label facet
of radar or stacked
pie charts so that each label is parallel to its radial
gradation (these are the labels that appear around the perimeter). For now, "auto" means the same thing as "always" -
but this may change in the future if heuristics are added to determine when the affected labels are likely to overlap
and not be legible. If rotateLabels is "never" then the labels will not be rotated. getRotateLabels()
,
getRadialLabelOffset()
public FacetChart setRadialLabelOffset(java.lang.Integer radialLabelOffset) throws java.lang.IllegalStateException
ChartType
and radarRotateLabels
.radialLabelOffset
- New radialLabelOffset value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getRadialLabelOffset()
ChartType
and radarRotateLabels
.public FacetChart setRegressionLineProperties(DrawLine regressionLineProperties) throws java.lang.IllegalStateException
regression line
.regressionLineProperties
- New regressionLineProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public DrawLine getRegressionLineProperties()
regression line
.public FacetChart setRegressionLineType(RegressionLineType regressionLineType)
regression
line
.
RegressionLineType
.regressionLineType
- New value for this.regressionLineType. Default value is "line"FacetChart
instance, for chaining setter callspublic RegressionLineType getRegressionLineType()
regression
line
.public FacetChart setRegressionPolynomialDegree(int regressionPolynomialDegree)
regressionPolynomialDegree
.regressionPolynomialDegree
- New value for this.regressionPolynomialDegree. Default value is 3FacetChart
instance, for chaining setter callspublic int getRegressionPolynomialDegree()
public FacetChart setRotateDataValues(LabelRotationMode rotateDataValues)
Column-type charts
. "auto" will rotate all data-values if any of them are wider than their columns. In all cases,
whether rotated or not, data-values are hidden and instead shown in hovers if any of them exceed their bar's width.rotateDataValues
- New rotateDataValues value. Default value is "auto"FacetChart
instance, for chaining setter callssetRotateLabels(com.smartgwt.client.types.LabelRotationMode)
public LabelRotationMode getRotateDataValues()
Column-type charts
. "auto" will rotate all data-values if any of them are wider than their columns. In all cases,
whether rotated or not, data-values are hidden and instead shown in hovers if any of them exceed their bar's width.getRotateLabels()
public FacetChart setRotateLabels(LabelRotationMode rotateLabels) throws java.lang.IllegalStateException
Note that automatic rotation is incompatible with setting a cluster-size-minimum customizer
using FacetChart.setMinClusterSizeMapper()
, so that LabelRotationMode.AUTO
will be treated
as LabelRotationMode.NEVER
if that method has been specified on a column, bar, or
histogram chart.
rotateLabels
- New rotateLabels value. Default value is "auto"FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetRadarRotateLabels(com.smartgwt.client.types.LabelRotationMode)
public LabelRotationMode getRotateLabels()
Note that automatic rotation is incompatible with setting a cluster-size-minimum customizer
using FacetChart.setMinClusterSizeMapper()
, so that LabelRotationMode.AUTO
will be treated
as LabelRotationMode.NEVER
if that method has been specified on a column, bar, or
histogram chart.
getRadarRotateLabels()
public FacetChart setScaleEndColor(java.lang.String scaleEndColor)
color scale metric
. If neither this property nor the
scaleStartColor
is set then the whole color
range is used by default. Note that using CSS color shortcuts (e.g. "lightblue") is not allowed for this property.
If this method is called after the component has been drawn/initialized:
Setter for scaleEndColor
.
scaleEndColor
- The new end color for the color scale. Default value is nullFacetChart
instance, for chaining setter callsCSSColor
,
Color Scale Chart Examplepublic java.lang.String getScaleEndColor()
color scale metric
. If neither this property nor the
scaleStartColor
is set then the whole color
range is used by default. Note that using CSS color shortcuts (e.g. "lightblue") is not allowed for this property.
CSSColor
,
Color Scale Chart Examplepublic FacetChart setScaleStartColor(java.lang.String scaleStartColor)
color scale metric
. If neither this property nor the
scaleEndColor
is set then the whole color range is
used by default. Note that using CSS color shortcuts (e.g. "lightblue") is not allowed for this property.
If this method is called after the component has been drawn/initialized:
Setter for scaleStartColor
.
scaleStartColor
- The new start color for the color scale. Default value is nullFacetChart
instance, for chaining setter callsCSSColor
,
Color Scale Chart Examplepublic java.lang.String getScaleStartColor()
color scale metric
. If neither this property nor the
scaleEndColor
is set then the whole color range is
used by default. Note that using CSS color shortcuts (e.g. "lightblue") is not allowed for this property.
CSSColor
,
Color Scale Chart Examplepublic FacetChart setShadowProperties(DrawOval shadowProperties) throws java.lang.IllegalStateException
shadowProperties
- New shadowProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public DrawOval getShadowProperties()
public FacetChart setShowBubbleLegendPerShape(boolean showBubbleLegendPerShape) throws java.lang.IllegalStateException
Note
that this setting has no effect if useMultiplePointShapes
is disabled.
showBubbleLegendPerShape
- New showBubbleLegendPerShape value. Default value is falseFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic boolean getShowBubbleLegendPerShape()
Note
that this setting has no effect if useMultiplePointShapes
is disabled.
public FacetChart setShowChartRect(java.lang.Boolean showChartRect) throws java.lang.IllegalStateException
showChartRect
- New showChartRect value. Default value is falseFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowChartRect()
public FacetChart setShowColorScaleLegend(java.lang.Boolean showColorScaleLegend) throws java.lang.IllegalStateException
true
if
a valid colorScaleMetric
is specified.showColorScaleLegend
- New showColorScaleLegend value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetScaleStartColor(java.lang.String)
,
setScaleEndColor(java.lang.String)
,
Color Scale Chart Examplepublic java.lang.Boolean getShowColorScaleLegend()
true
if
a valid colorScaleMetric
is specified.getScaleStartColor()
,
getScaleEndColor()
,
Color Scale Chart Examplepublic FacetChart setShowDataAxisLabel(java.lang.Boolean showDataAxisLabel) throws java.lang.IllegalStateException
Facet.title
for the data label facet will be shown as the
label. Automatically disabled for non-rectangular charts (eg Pie, Radar).
showDataAxisLabel
- New showDataAxisLabel value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowDataAxisLabel()
Facet.title
for the data label facet will be shown as the
label. Automatically disabled for non-rectangular charts (eg Pie, Radar).
public FacetChart setShowDataLabels(boolean showDataLabels) throws java.lang.IllegalStateException
false
, data labels for values are entirely omitted. This property would generally only be set
to false
if several small charts are shown together and the data labels are drawn elsewhere on the screen
(above an entire stack of charts, for instance) or are otherwise implicit.
showDataLabels
- New showDataLabels value. Default value is trueFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic boolean getShowDataLabels()
false
, data labels for values are entirely omitted. This property would generally only be set
to false
if several small charts are shown together and the data labels are drawn elsewhere on the screen
(above an entire stack of charts, for instance) or are otherwise implicit.
public FacetChart setShowDataPoints(java.lang.Boolean showDataPoints) throws java.lang.IllegalStateException
If
shown, the pointClick()
and getPointHoverHTML()
APIs can be used to create
interactivity.
showDataPoints
- New showDataPoints value. Default value is falseFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowDataPoints()
If
shown, the pointClick()
and getPointHoverHTML()
APIs can be used to create
interactivity.
public FacetChart setShowDataValues(boolean showDataValues) throws java.lang.IllegalStateException
showDataValuesMode
, a compound
setting that supports showing data-values in the chart and in hovers in various combinations. The equivalent to
showDataValues:true is ShowDataValuesMode.inChartOnly
or
ShowDataValuesMode.inChartOrHover
if showValueOnHover was also set to true.If set to false, then data values will not be shown.
If set to
true, data values will be shown unless the data density is high enough that labels will potentially overlap, in which
case, data values will not be shown and hovers will be shown instead, in the same way as showValueOnHover
shows hovers.
showDataValues
- New showDataValues value. Default value is falseFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic boolean getShowDataValues()
showDataValuesMode
, a compound
setting that supports showing data-values in the chart and in hovers in various combinations. The equivalent to
showDataValues:true is ShowDataValuesMode.inChartOnly
or
ShowDataValuesMode.inChartOrHover
if showValueOnHover was also set to true.If set to false, then data values will not be shown.
If set to
true, data values will be shown unless the data density is high enough that labels will potentially overlap, in which
case, data values will not be shown and hovers will be shown instead, in the same way as showValueOnHover
shows hovers.
public FacetChart setShowDataValuesMode(ShowDataValuesMode showDataValuesMode)
automatic rotation
where
supported. Depending on the chart type, there are different options for showing data-values - eg, stacked-charts
cannot show values inline in the chart-body;
column-charts can, and they can rotate titles if they're wider than their columns; pie charts can show some
data-values in the chart but not others; all the types can show values in hovers.
If set to never, then data-values will never be shown; inChartOnly allows data-values in the chart-body, where supported and where they will fit, but suppresses them in hovers and inHoverOnly always shows all data-values in hovers.
If set to auto, first try to show values in the chart, where the chart-type supports it, and where they'll fit. If they don't all fit, show the ones that do, including rotating them if necessary, if the chart-type allows it, and then switch on hovers as well, as needed. This mode is particularly useful in situations where the chart-type can be changed by the user.
showDataValuesMode
- New showDataValuesMode value. Default value is "never"FacetChart
instance, for chaining setter callspublic ShowDataValuesMode getShowDataValuesMode()
automatic rotation
where
supported. Depending on the chart type, there are different options for showing data-values - eg, stacked-charts
cannot show values inline in the chart-body;
column-charts can, and they can rotate titles if they're wider than their columns; pie charts can show some
data-values in the chart but not others; all the types can show values in hovers.
If set to never, then data-values will never be shown; inChartOnly allows data-values in the chart-body, where supported and where they will fit, but suppresses them in hovers and inHoverOnly always shows all data-values in hovers.
If set to auto, first try to show values in the chart, where the chart-type supports it, and where they'll fit. If they don't all fit, show the ones that do, including rotating them if necessary, if the chart-type allows it, and then switch on hovers as well, as needed. This mode is particularly useful in situations where the chart-type can be changed by the user.
public FacetChart setShowDoughnut(java.lang.Boolean showDoughnut) throws java.lang.IllegalStateException
showDoughnut
.showDoughnut
- New showDoughnut value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowDoughnut()
showDoughnut
.public FacetChart setShowExpectedValueLine(java.lang.Boolean showExpectedValueLine) throws java.lang.IllegalStateException
mean value
. Note that this
expected value is computed using all of the data points, pooled across all facets. The computation relies only on the
values of the main value axis metric and the probability metric
.
showExpectedValueLine
- New showExpectedValueLine value. Default value is falseFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowExpectedValueLine()
mean value
. Note that this
expected value is computed using all of the data points, pooled across all facets. The computation relies only on the
values of the main value axis metric and the probability metric
.
public FacetChart setShowGradationsOverData(java.lang.Boolean showGradationsOverData) throws java.lang.IllegalStateException
showGradationsOverData
- New showGradationsOverData value. Default value is falseFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowGradationsOverData()
public FacetChart setShowInlineLabels(java.lang.Boolean showInlineLabels) throws java.lang.IllegalStateException
showInlineLabels
- New showInlineLabels value. Default value is falseFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowInlineLabels()
public FacetChart setShowLegend(java.lang.Boolean showLegend) throws java.lang.IllegalStateException
showLegend
- New showLegend value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowLegend()
public FacetChart setShowMinorTicks(boolean showMinorTicks)
ticks
are being shown, controls whether a
distinction is made between major and minor tick marks. If minor ticks are used, by default, major ticks are used
for powers of 10 and minor ticks are used for other gradations. See majorTickGradations
for control over which ticks
are rendered as major vs minor ticks.
If this method is called after the component has been drawn/initialized:
Setter for showMinorTicks
.
showMinorTicks
- new showMinorTicks
value. Default value is trueFacetChart
instance, for chaining setter callspublic boolean getShowMinorTicks()
ticks
are being shown, controls whether a
distinction is made between major and minor tick marks. If minor ticks are used, by default, major ticks are used
for powers of 10 and minor ticks are used for other gradations. See majorTickGradations
for control over which ticks
are rendered as major vs minor ticks.
public FacetChart setShowPointSizeLegend(java.lang.Boolean showPointSizeLegend) throws java.lang.IllegalStateException
point size
. The default is true
for
bubble charts and false
for all other chart types.showPointSizeLegend
- New showPointSizeLegend value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetPointSizeGradations(java.lang.Integer)
,
setUsePointSizeLogGradations(java.lang.Boolean)
,
setPointSizeLogGradations(float...)
,
setShowBubbleLegendPerShape(boolean)
,
Bubble Chart Examplepublic java.lang.Boolean getShowPointSizeLegend()
point size
. The default is true
for
bubble charts and false
for all other chart types.getPointSizeGradations()
,
getUsePointSizeLogGradations()
,
getPointSizeLogGradations()
,
getShowBubbleLegendPerShape()
,
Bubble Chart Examplepublic FacetChart setShowRadarGradationLabels(java.lang.Boolean showRadarGradationLabels) throws java.lang.IllegalStateException
showRadarGradationLabels
- New showRadarGradationLabels value. Default value is trueFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowRadarGradationLabels()
public FacetChart setShowRegressionLine(java.lang.Boolean showRegressionLine)
The type of regression curve used depends on the RegressionLineType
property,
which can be:
regressionPolynomialDegree
).Note that the regression is computed using all of the data points and it does not depend on the values of any non-metric facets. For example, adding a legend facet will not change the regression curve.
See http://en.wikipedia.org/wiki/Simple_linear_regression.
See http://en.wikipedia.org/wiki/Polynomial_regression.
If this method is called after the component has been drawn/initialized:
Setter for showRegressionLine
.
showRegressionLine
- New value for this.showRegressionLine. Default value is falseFacetChart
instance, for chaining setter callssetXAxisMetric(java.lang.String)
,
setYAxisMetric(java.lang.String)
,
setRegressionLineProperties(com.smartgwt.client.widgets.drawing.DrawLine)
public java.lang.Boolean getShowRegressionLine()
The type of regression curve used depends on the RegressionLineType
property,
which can be:
regressionPolynomialDegree
).Note that the regression is computed using all of the data points and it does not depend on the values of any non-metric facets. For example, adding a legend facet will not change the regression curve.
See http://en.wikipedia.org/wiki/Simple_linear_regression. See http://en.wikipedia.org/wiki/Polynomial_regression.
getXAxisMetric()
,
getYAxisMetric()
,
getRegressionLineProperties()
public FacetChart setShowScatterLines(java.lang.Boolean showScatterLines)
DataLineType
for enabling smoothing.
showScatterLines
. Will redraw the chart if drawn.showScatterLines
- whether to draw lines between adjacent data points in "Scatter" plots. Default value is falseFacetChart
instance, for chaining setter callspublic java.lang.Boolean getShowScatterLines()
DataLineType
for enabling smoothing.public FacetChart setShowShadows(java.lang.Boolean showShadows) throws java.lang.IllegalStateException
showShadows
- New showShadows value. Default value is trueFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowShadows()
public FacetChart setShowStandardDeviationLines(java.lang.Boolean showStandardDeviationLines) throws java.lang.IllegalStateException
standard deviations
away from the mean
as lines. The exact deviations to display can be customized with standardDeviations
. Note that these standard
deviations are computed using all of the data points, pooled across all facets. The computation relies only on the
values of the main value axis metric and the probability metric
.
showStandardDeviationLines
- New showStandardDeviationLines value. Default value is falseFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowStandardDeviationLines()
standard deviations
away from the mean
as lines. The exact deviations to display can be customized with standardDeviations
. Note that these standard
deviations are computed using all of the data points, pooled across all facets. The computation relies only on the
values of the main value axis metric and the probability metric
.
public FacetChart setShowStatisticsOverData(java.lang.Boolean showStatisticsOverData) throws java.lang.IllegalStateException
mean line
, standard deviation lines
, standard deviation bands
, and regression curves
are drawn on top of the data
rather than underneath.showStatisticsOverData
- New showStatisticsOverData value. Default value is falseFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowStatisticsOverData()
mean line
, standard deviation lines
, standard deviation bands
, and regression curves
are drawn on top of the data
rather than underneath.public FacetChart setShowTitle(java.lang.Boolean showTitle)
showTitle
- New showTitle value. Default value is trueFacetChart
instance, for chaining setter callspublic java.lang.Boolean getShowTitle()
public FacetChart setShowValueAxisLabel(java.lang.Boolean showValueAxisLabel) throws java.lang.IllegalStateException
valueTitle
(or, in the case of
proportional rendering mode
, the proportionalAxisLabel
) as a label on the value
axis. Automatically disabled for non-rectangular charts (eg Pie, Radar).
showValueAxisLabel
- New showValueAxisLabel value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowValueAxisLabel()
valueTitle
(or, in the case of
proportional rendering mode
, the proportionalAxisLabel
) as a label on the value
axis. Automatically disabled for non-rectangular charts (eg Pie, Radar).
public FacetChart setShowValueOnHover(java.lang.Boolean showValueOnHover) throws java.lang.IllegalStateException
showDataValuesMode
, a compound
setting that supports showing data-values in the chart and in hovers in various combinations. The equivalent to
showValueOnHover:true is ShowDataValuesMode.inHoverOnly. Calculates nearest value based on getNearestDrawnValue()
.
The data value will be
formatted using setDataValueFormatter()
. The
label's appearance is controlled by hoverLabelProperties
.
showValueOnHover
- New showValueOnHover value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowValueOnHover()
showDataValuesMode
, a compound
setting that supports showing data-values in the chart and in hovers in various combinations. The equivalent to
showValueOnHover:true is ShowDataValuesMode.inHoverOnly. Calculates nearest value based on getNearestDrawnValue()
.
The data value will be
formatted using setDataValueFormatter()
. The
label's appearance is controlled by hoverLabelProperties
.
public FacetChart setShowXTicks(boolean showXTicks)
showXTicks
.showXTicks
- new showXTicks
value. Default value is falseFacetChart
instance, for chaining setter callssetShowYTicks(boolean)
,
Custom Date Ticks Examplepublic boolean getShowXTicks()
getShowYTicks()
,
Custom Date Ticks Examplepublic FacetChart setShowYTicks(boolean showYTicks)
Normally, ticks are not shown for the
primary axis, since gradation lines
show value
demarcations. Gradation lines are always show for extra value axes
in multi-axis charts (since there are
no gradation lines for the additional axes).
showXTicks
can be used to control whether ticks are shown for the horizontal axis, for certain chart types. See also
majorTickGradations
for control of which
ticks are shown as major vs minor ticks.
If this method is called after the component has been drawn/initialized:
Setter for showYTicks
.
showYTicks
- new showYTicks
value. Default value is falseFacetChart
instance, for chaining setter callspublic boolean getShowYTicks()
Normally, ticks are not shown for the
primary axis, since gradation lines
show value
demarcations. Gradation lines are always show for extra value axes
in multi-axis charts (since there are
no gradation lines for the additional axes).
showXTicks
can be used to control whether ticks are shown for the horizontal axis, for certain chart types. See also
majorTickGradations
for control of which
ticks are shown as major vs minor ticks.
public FacetChart setStacked(java.lang.Boolean stacked)
stacked
. Use null to apply a default value for the current chartType
.stacked
- new value. Default value is nullFacetChart
instance, for chaining setter callspublic java.lang.Boolean getStacked()
public FacetChart setStandardDeviationBandProperties(DrawItem... standardDeviationBandProperties) throws java.lang.IllegalStateException
standard deviation lines
. The length of the
Array must be one less than the length of the standardDeviations
Array. Having no band between certain standard deviations from the mean can be specified by having a null element at the corresponding index of this Array.
Note that if useSymmetricStandardDeviations
is set
then for each standard deviation band that is drawn a corresponding band will also be drawn on the opposite side of the
mean line.
standardDeviationBandProperties
- New standardDeviationBandProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public FacetChart setStandardDeviationLineProperties(DrawItem standardDeviationLineProperties) throws java.lang.IllegalStateException
standard deviation
lines
. Note that for rectangular charts the properties are for a DrawLine
, and for radar charts the properties are for a DrawOval
.
standardDeviationLineProperties
- New standardDeviationLineProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public DrawItem getStandardDeviationLineProperties()
standard deviation
lines
. Note that for rectangular charts the properties are for a DrawLine
, and for radar charts the properties are for a DrawOval
.
public FacetChart setStandardDeviations(float... standardDeviations) throws java.lang.IllegalStateException
showStandardDeviationLines
is
set, the number of standard deviation lines drawn
and their respective standard deviation away from the mean are specified by this property.
The default is to display lines corresponding to the mean plus or minus one standard
deviation.
Note that having zero in this list of standard deviations is identical to drawing a line at the mean.
For example assume that chart1 and chart2 both plot data with mean 1 and standard deviation 0.1. chart1 will draw a blue line at the value 1 and two red lines at the values 0.7 and 1.2. chart2 will draw three red lines at values 0.9, 1.0, and 1.1.
DrawLine blueLine = new DrawLine(), redLine = new DrawLine(); blueLine.setLineColor("blue"); redLine.setLineColor("red"); FacetChart chart1 = new FacetChart(); chart1.setID("chart1"); chart1.setStandardDeviations(new Float[] { -3f, 2f }); chart1.setShowExpectedValueLine(true); chart1.setShowStandardDeviationLines(true); chart1.setExpectedValueLineProperties(blueLine); chart1.setStandardDeviationLineProperties(redLine); chart1.setUseSymmetricStandardDeviations(false); // ... FacetChart chart2 = new FacetChart(); chart2.setID("chart2"); chart2.setStandardDeviations(new Float[] { -1f, 0f, 1f }); chart2.setShowExpectedValueLine(false); chart2.setShowStandardDeviationLines(true); chart2.setExpectedValueLineProperties(blueLine); chart2.setStandardDeviationLineProperties(redLine); chart2.setUseSymmetricStandardDeviations(false); // ... chart1.draw(); chart2.draw();
standardDeviations
- New standardDeviations value. Default value is [-1, 1]FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic float[] getStandardDeviations()
showStandardDeviationLines
is
set, the number of standard deviation lines drawn
and their respective standard deviation away from the mean are specified by this property.
The default is to display lines corresponding to the mean plus or minus one standard
deviation.
Note that having zero in this list of standard deviations is identical to drawing a line at the mean.
For example assume that chart1 and chart2 both plot data with mean 1 and standard deviation 0.1. chart1 will draw a blue line at the value 1 and two red lines at the values 0.7 and 1.2. chart2 will draw three red lines at values 0.9, 1.0, and 1.1.
DrawLine blueLine = new DrawLine(), redLine = new DrawLine(); blueLine.setLineColor("blue"); redLine.setLineColor("red"); FacetChart chart1 = new FacetChart(); chart1.setID("chart1"); chart1.setStandardDeviations(new Float[] { -3f, 2f }); chart1.setShowExpectedValueLine(true); chart1.setShowStandardDeviationLines(true); chart1.setExpectedValueLineProperties(blueLine); chart1.setStandardDeviationLineProperties(redLine); chart1.setUseSymmetricStandardDeviations(false); // ... FacetChart chart2 = new FacetChart(); chart2.setID("chart2"); chart2.setStandardDeviations(new Float[] { -1f, 0f, 1f }); chart2.setShowExpectedValueLine(false); chart2.setShowStandardDeviationLines(true); chart2.setExpectedValueLineProperties(blueLine); chart2.setStandardDeviationLineProperties(redLine); chart2.setUseSymmetricStandardDeviations(false); // ... chart1.draw(); chart2.draw();
public void setStyleName(java.lang.String styleName)
setStyleName
in class Canvas
styleName
- New styleName value. Default value is "scChart"CSSStyleName
public java.lang.String getStyleName()
getStyleName
in class Canvas
CSSStyleName
public FacetChart setTickLength(int tickLength)
showXTicks
or showYTicks
is enabled, or when extra value axes
are in use. If minor tick marks
are also shown, their length is controlled by minorTickLength
.
If this method is called after the component has been drawn/initialized:
Setter for tickLength
.
tickLength
- new tickLength
value. Default value is 5FacetChart
instance, for chaining setter callspublic int getTickLength()
showXTicks
or showYTicks
is enabled, or when extra value axes
are in use. If minor tick marks
are also shown, their length is controlled by minorTickLength
.
public FacetChart setTickMarkToValueAxisMargin(int tickMarkToValueAxisMargin) throws java.lang.IllegalStateException
extra value axes
.tickMarkToValueAxisMargin
- New tickMarkToValueAxisMargin value. Default value is 7FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getTickMarkToValueAxisMargin()
extra value axes
.public void setTitle(java.lang.String title)
public java.lang.String getTitle()
public FacetChart setTitleAlign(TitleAlign titleAlign)
title
.titleAlign
- New titleAlign value. Default value is "center"FacetChart
instance, for chaining setter callspublic TitleAlign getTitleAlign()
title
.public FacetChart setTitleBackgroundProperties(DrawLabel titleBackgroundProperties)
titleBackgroundProperties
- New titleBackgroundProperties value. Default value is nullFacetChart
instance, for chaining setter callsSGWTProperties
public DrawLabel getTitleBackgroundProperties()
public FacetChart setTitleBoundaryProperties(DrawLine titleBoundaryProperties) throws java.lang.IllegalStateException
drawTitleBoundary
titleBoundaryProperties
- New titleBoundaryProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public DrawLine getTitleBoundaryProperties()
drawTitleBoundary
public FacetChart setTitlePadding(int titlePadding)
titlePadding
- New titlePadding value. Default value is 0FacetChart
instance, for chaining setter callspublic int getTitlePadding()
public FacetChart setTitleProperties(DrawLabel titleProperties)
titleProperties
- New titleProperties value. Default value is nullFacetChart
instance, for chaining setter callsSGWTProperties
public DrawLabel getTitleProperties()
public FacetChart setTitleRectHeight(int titleRectHeight)
titleRectHeight
- New titleRectHeight value. Default value is 5FacetChart
instance, for chaining setter callspublic int getTitleRectHeight()
public FacetChart setUseAutoGradients(java.lang.Boolean useAutoGradients) throws java.lang.IllegalStateException
dataColors
but specify chart-specific gradients based on the primary data color per chart type.useAutoGradients
- New useAutoGradients value. Default value is trueFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getUseAutoGradients()
dataColors
but specify chart-specific gradients based on the primary data color per chart type.public FacetChart setUseLogGradations(java.lang.Boolean useLogGradations) throws java.lang.IllegalStateException
Default gradations can be overridden via logBase
and
logGradations
.
useLogGradations
- New useLogGradations value. Default value is falseFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getUseLogGradations()
Default gradations can be overridden via logBase
and
logGradations
.
public FacetChart setUseMultiplePointShapes(java.lang.Boolean useMultiplePointShapes)
true
then the chart is allowed
to use all supported shapes
: circles, squares,
diamonds, and triangles. If set to false
then just the first supported shape (circles, for example) will
be used. The default is false
for bubble charts and color scale charts
and true
for all other
chart types.
useMultiplePointShapes
.useMultiplePointShapes
- Whether the chart should now use multiple shapes to show data points. Default value is nullFacetChart
instance, for chaining setter callspublic java.lang.Boolean getUseMultiplePointShapes()
true
then the chart is allowed
to use all supported shapes
: circles, squares,
diamonds, and triangles. If set to false
then just the first supported shape (circles, for example) will
be used. The default is false
for bubble charts and color scale charts
and true
for all other
chart types.public FacetChart setUsePointSizeLogGradations(java.lang.Boolean usePointSizeLogGradations) throws java.lang.IllegalStateException
pointSizeMetric
values displayed in the point size legend
.
Gradations also begin and end on an order of magnitude. For example, 1, 2, 4, 6, 8, 10, 20, 40, 60, 80, 100.
Default gradations can be overridden via pointSizeLogBase
and pointSizeLogGradations
.
usePointSizeLogGradations
- New usePointSizeLogGradations value. Default value is falseFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetUseLogGradations(java.lang.Boolean)
public java.lang.Boolean getUsePointSizeLogGradations()
pointSizeMetric
values displayed in the point size legend
.
Gradations also begin and end on an order of magnitude. For example, 1, 2, 4, 6, 8, 10, 20, 40, 60, 80, 100.
Default gradations can be overridden via pointSizeLogBase
and pointSizeLogGradations
.
getUseLogGradations()
public FacetChart setUseSymmetricStandardDeviations(java.lang.Boolean useSymmetricStandardDeviations) throws java.lang.IllegalStateException
standard deviations
.useSymmetricStandardDeviations
- New useSymmetricStandardDeviations value. Default value is trueFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getUseSymmetricStandardDeviations()
standard deviations
.public FacetChart setValueAxisLabelProperties(DrawLabel valueAxisLabelProperties)
valueAxisLabelProperties
- New valueAxisLabelProperties value. Default value is nullFacetChart
instance, for chaining setter callsSGWTProperties
public DrawLabel getValueAxisLabelProperties()
public FacetChart setValueAxisMargin(int valueAxisMargin) throws java.lang.IllegalStateException
multiple value axes
.valueAxisMargin
- New valueAxisMargin value. Default value is 10FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getValueAxisMargin()
multiple value axes
.public FacetChart setValueLineProperties(DrawLine valueLineProperties) throws java.lang.IllegalStateException
valueLineProperties
- New valueLineProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public DrawLine getValueLineProperties()
public FacetChart setValueProperty(java.lang.String valueProperty) throws java.lang.IllegalStateException
Not used if there is an inline facet, see Chart.data.
valueProperty
- New valueProperty value. Default value is "_value"FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getValueProperty()
Not used if there is an inline facet, see Chart.data.
public FacetChart setValueTitle(java.lang.String valueTitle) throws java.lang.IllegalStateException
valueTitle
- New valueTitle value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getValueTitle()
public FacetChart setXAxisEndValue(java.lang.Double xAxisEndValue) throws java.lang.IllegalStateException
If set to an explicit value, this will be respected. If unset, the axis end value will default to a value large enough to show the largest data point.
If the x-axis metric is date-valued, this value should be a date (typically applies to Scatter charts only).
xAxisEndValue
- New xAxisEndValue value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetAxisEndValue(java.lang.Double)
public java.lang.Double getXAxisEndValue()
If set to an explicit value, this will be respected. If unset, the axis end value will default to a value large enough to show the largest data point.
If the x-axis metric is date-valued, this value should be a date (typically applies to Scatter charts only).
getAxisEndValue()
public FacetChart setXAxisEndValue(java.util.Date xAxisEndValue) throws java.lang.IllegalStateException
If set to an explicit value, this will be respected. If unset, the axis end value will default to a value large enough to show the largest data point.
If the x-axis metric is date-valued, this value should be a date (typically applies to Scatter charts only).
xAxisEndValue
- New xAxisEndValue value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetAxisEndValue(java.lang.Double)
public java.util.Date getXAxisEndValueAsDate()
If set to an explicit value, this will be respected. If unset, the axis end value will default to a value large enough to show the largest data point.
If the x-axis metric is date-valued, this value should be a date (typically applies to Scatter charts only).
getAxisEndValue()
public FacetChart setXAxisMetric(java.lang.String xAxisMetric) throws java.lang.IllegalStateException
The default x-axis metric is the second value of the metric facet.
xAxisMetric
- New xAxisMetric value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getXAxisMetric()
The default x-axis metric is the second value of the metric facet.
public FacetChart setXAxisStartValue(java.lang.Double xAxisStartValue) throws java.lang.IllegalStateException
Defaults to 0, or to a value that makes good use
of horizontal space based on minXDataSpreadPercent
.
If the x-axis metric is date-valued, this value should be a date (typically applies to Scatter charts only).
xAxisStartValue
- New xAxisStartValue value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetAxisStartValue(java.lang.Double)
public java.lang.Double getXAxisStartValue()
Defaults to 0, or to a value that makes good use
of horizontal space based on minXDataSpreadPercent
.
If the x-axis metric is date-valued, this value should be a date (typically applies to Scatter charts only).
getAxisStartValue()
public FacetChart setXAxisStartValue(java.util.Date xAxisStartValue) throws java.lang.IllegalStateException
Defaults to 0, or to a value that makes good use
of horizontal space based on minXDataSpreadPercent
.
If the x-axis metric is date-valued, this value should be a date (typically applies to Scatter charts only).
xAxisStartValue
- New xAxisStartValue value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetAxisStartValue(java.lang.Double)
public java.util.Date getXAxisStartValueAsDate()
Defaults to 0, or to a value that makes good use
of horizontal space based on minXDataSpreadPercent
.
If the x-axis metric is date-valued, this value should be a date (typically applies to Scatter charts only).
getAxisStartValue()
public FacetChart setYAxisLabelAlign(Alignment yAxisLabelAlign)
yAxisLabelAlign
- New yAxisLabelAlign value. Default value is "right"FacetChart
instance, for chaining setter callspublic Alignment getYAxisLabelAlign()
public FacetChart setYAxisLabelPadding(int yAxisLabelPadding) throws java.lang.IllegalStateException
yAxisLabelPadding
- New yAxisLabelPadding value. Default value is 5FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getYAxisLabelPadding()
public FacetChart setYAxisMetric(java.lang.String yAxisMetric) throws java.lang.IllegalStateException
The default y-axis metric is the first value of the metric facet.
yAxisMetric
- New yAxisMetric value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getYAxisMetric()
The default y-axis metric is the first value of the metric facet.
public FacetChart setZIndexMetric(java.lang.String zIndexMetric)
Note that zIndex values should be integers between 0
and maxDataZIndex
, inclusive, and don't directly
map to the DrawItem.zIndex
values of the underlying
DrawRect
s. This allows the Framework to use automatic z-ordering in the
chart logic without any additional sorting or overhead that would otherwise be required.
If this method is called after the component has been drawn/initialized:
Method to change the current zIndexMetric
- see property for more details. Will redraw the chart if drawn.
zIndexMetric
- name of zIndex metric. Default value is nullFacetChart
instance, for chaining setter callssetMetricFacetId(java.lang.String)
,
setMaxDataZIndex(java.lang.Integer)
,
getDataLabelFacet()
public java.lang.String getZIndexMetric()
Note that zIndex values should be integers between 0
and maxDataZIndex
, inclusive, and don't directly
map to the DrawItem.zIndex
values of the underlying
DrawRect
s. This allows the Framework to use automatic z-ordering in the
chart logic without any additional sorting or overhead that would otherwise be required.
getMetricFacetId()
,
getMaxDataZIndex()
,
getDataLabelFacet()
public FacetChart getZoomChart() throws java.lang.IllegalStateException
canZoom
is
enabled. This chart automatically has certain visual tweaks applied, including showInlineLabels
, muted colors
and logarithmic scaling
. It can be further configured via
zoomChartProperties
.
The selected range
from this chart defaults to being shown with distinct styling as well (if zoomShowSelection
is set), which can be controlled
via zoomSelectionChartProperties
.
This component is an AutoChild named "zoomChart". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public FacetChart setZoomChartHeight(double zoomChartHeight) throws java.lang.IllegalStateException
zoomChart
. The zoomChart is always as
wide as the main chart.zoomChartHeight
- New zoomChartHeight value. Default value is 100FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic double getZoomChartHeight()
zoomChart
. The zoomChart is always as
wide as the main chart.public FacetChart setZoomChartProperties(FacetChart zoomChartProperties) throws java.lang.IllegalStateException
zoomChart
.zoomChartProperties
- New zoomChartProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public FacetChart getZoomChartProperties()
zoomChart
.public RangeSlider getZoomChartSlider() throws java.lang.IllegalStateException
canZoom
is enabled.
This component is an AutoChild named "zoomChartSlider". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public FacetChart setZoomLogScale(java.lang.Boolean zoomLogScale) throws java.lang.IllegalStateException
canZoom
is enabled, the zoomChart
uses logarithmic scaling so that spikes in the data
don't result in a zoomed chart that is mostly a flat line. Logarithmic scaling is automatically disabled if the dataset spans zero (eg, has negative and positive values) as this can't be shown in a logarithmic scale.
Set
zoomLogScale
to explicitly enable or disable logarithmic scaling.
zoomLogScale
- New zoomLogScale value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getZoomLogScale()
canZoom
is enabled, the zoomChart
uses logarithmic scaling so that spikes in the data
don't result in a zoomed chart that is mostly a flat line. Logarithmic scaling is automatically disabled if the dataset spans zero (eg, has negative and positive values) as this can't be shown in a logarithmic scale.
Set
zoomLogScale
to explicitly enable or disable logarithmic scaling.
public FacetChart setZoomMutePercent(float zoomMutePercent) throws java.lang.IllegalStateException
colorMutePercent
to use for the zoomChart
.zoomMutePercent
- New zoomMutePercent value. Default value is -35FacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic float getZoomMutePercent()
colorMutePercent
to use for the zoomChart
.public FacetChart getZoomSelectionChart() throws java.lang.IllegalStateException
canZoom
is enabled. This chart
represents the currently selected range of data shown in the main chart.
This component is an AutoChild named "zoomSelectionChart". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public FacetChart setZoomSelectionChartProperties(FacetChart zoomSelectionChartProperties) throws java.lang.IllegalStateException
zoomSelectionChart
.zoomSelectionChartProperties
- New zoomSelectionChartProperties value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public FacetChart getZoomSelectionChartProperties()
zoomSelectionChart
.public FacetChart setZoomShowSelection(java.lang.Boolean zoomShowSelection) throws java.lang.IllegalStateException
zoomSelectionChartProperties
. This has
performance consequences and makes the rendering of the mini-chart slightly slower.zoomShowSelection
- New zoomShowSelection value. Default value is trueFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getZoomShowSelection()
zoomSelectionChartProperties
. This has
performance consequences and makes the rendering of the mini-chart slightly slower.public FacetChart setZoomStartPosition(ZoomStartPosition zoomStartPosition) throws java.lang.IllegalStateException
zoomed chart
, determines what portion of the
overall dataset should be initially shown in the main chart. Default is to show the end of the dataset if the X axis shows time and includes today's date, otherwise to show the start of the dataset.
Set this property to override this
default, or use zoomStartValue
and zoomEndValue
to start with a particular range.
zoomStartPosition
- New zoomStartPosition value. Default value is nullFacetChart
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic ZoomStartPosition getZoomStartPosition()
zoomed chart
, determines what portion of the
overall dataset should be initially shown in the main chart. Default is to show the end of the dataset if the X axis shows time and includes today's date, otherwise to show the start of the dataset.
Set this property to override this
default, or use zoomStartValue
and zoomEndValue
to start with a particular range.
public com.google.gwt.event.shared.HandlerRegistration addChartBackgroundDrawnHandler(ChartBackgroundDrawnHandler handler)
Called when most elements of the chart other than data data have been drawn, including gradations and legend.
This notification will be fired each time the chart is redrawn (due to resize, data change, etc). If you want to draw
additional information on the chart using DrawPane
(FacetChart's superclass)
and various DrawItem
s, you should do in response to this notification. Due
to auto-sizing, APIs that are typically used to position custom DrawItems (such as FacetChart.getChartLeft()
) may return bad values if called at
other times.
Additional DrawItems added in this method will appear underneath data elements such as bars or columns.
See FacetChart.chartDrawn()
for placing
DrawItems on top of data elements.
addChartBackgroundDrawnHandler
in interface HasChartBackgroundDrawnHandlers
handler
- the chartBackgroundDrawn handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addChartDrawnHandler(ChartDrawnHandler handler)
Called when all elements of the chart (data lines / shapes, gradations, legend, labels etc) have completed drawing.
See FacetChart.chartBackgroundDrawn()
for usage information.
addChartDrawnHandler
in interface HasChartDrawnHandlers
handler
- the chartDrawn handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addDataLabelClickHandler(DataLabelClickHandler handler)
Fires when the user clicks on a data label, that is, a text label showing values from the first facet. For example, the labels underneath the X-axis of a column chart, labelling each column.
addDataLabelClickHandler
in interface HasDataLabelClickHandlers
handler
- the dataLabelClick handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addDataLabelHoverHandler(DataLabelHoverHandler handler)
Fires when the mouse hovers over a data label, that is, a text label showing values from the first facet. For example, the labels underneath the X-axis of a column chart, labelling each column.
addDataLabelHoverHandler
in interface HasDataLabelHoverHandlers
handler
- the dataLabelHover handlerHandlerRegistration
used to remove this handlerpublic java.lang.Boolean drawnValueContainsPoint(DrawnValue drawnValue)
DrawnValue
contains a point. The point's X and Y
coordinates may be passed into this method, or, if unspecified, the coordinates used are the current mouse event
coordinates. For Area, Bubble, Line, Radar, and Scatter charts, a DrawnValue is considered to contain a point if the
Euclidean distance from the DrawnValue's center (x
, y
) to the point is less than this.dataPointSize
. For Pie charts, the DrawnValue is
considered to contain a point if the point is within the pie slice. Similarly, for Doughnut charts, the DrawnValue is
considered to contain a point if the point is within the pie slice and not in the doughnut hole. For Bar and Column
charts, the DrawnValue is considered to contain a point if the point is within the bar or column, respectively. Note
that for stacked Bar and Column charts, the point must also be in the stacked portion as opposed to anywhere within the
bar or column.
drawnValue
- the DrawnValue to check. The DrawnValue must be a valid DrawnValue from this chart.public java.lang.Boolean drawnValueContainsPoint(DrawnValue drawnValue, java.lang.Integer x)
public java.lang.Boolean drawnValueContainsPoint(DrawnValue drawnValue, java.lang.Integer x, java.lang.Integer y)
DrawnValue
contains a point. The point's X and Y
coordinates may be passed into this method, or, if unspecified, the coordinates used are the current mouse event
coordinates. For Area, Bubble, Line, Radar, and Scatter charts, a DrawnValue is considered to contain a point if the
Euclidean distance from the DrawnValue's center (x
, y
) to the point is less than this.dataPointSize
. For Pie charts, the DrawnValue is
considered to contain a point if the point is within the pie slice. Similarly, for Doughnut charts, the DrawnValue is
considered to contain a point if the point is within the pie slice and not in the doughnut hole. For Bar and Column
charts, the DrawnValue is considered to contain a point if the point is within the bar or column, respectively. Note
that for stacked Bar and Column charts, the point must also be in the stacked portion as opposed to anywhere within the
bar or column.
drawnValue
- the DrawnValue to check. The DrawnValue must be a valid DrawnValue from this chart.x
- X coordinate of the point. If this parameter is specified, then y
is a required parameter.y
- Y coordinate of the pointpublic java.lang.String formatFacetValueId(java.lang.Object value, Facet facet)
chartType
s that have circumference or non-axis labels, such
as for example "Pie" or "Radar" charts.value
- raw value of the metricfacet
- facet containing the valuesetXAxisValueFormatter(com.smartgwt.client.widgets.chart.ValueFormatter)
,
getFormatStringFacetValueIds()
public java.lang.String formatSegmentLabel(java.lang.Object startValue, java.lang.Object endValue)
setDataValueFormatter()
to format the values.
Note that this method has no impact on the facet value labels appearing on the horizontal axis of the histogram chart.
startValue
- raw start value of the segmentendValue
- raw end value of the segmentpublic Point getChartCenter()
Note that unstacked pie charts draw multiple pies, each with their own centers.
This is only allowed to be called when FacetChart.chartDrawn()
fires.
public float getChartHeight(boolean recalc)
GwtFloatVsDouble
This is only allowed to be called when FacetChart.chartDrawn()
fires.
recalc
- if false then cached value will be returned, otherwise will be recalculated.public double getChartHeightAsDouble(boolean recalc)
This is only allowed to be called when FacetChart.chartDrawn()
fires.
recalc
- if false then cached value will be returned, otherwise will be recalculated.public float getChartLeft()
GwtFloatVsDouble
This is only allowed to be called when
FacetChart.chartDrawn()
fires.
public double getChartLeftAsDouble()
This is only allowed to be called when
FacetChart.chartDrawn()
fires.
public float getChartRadius()
GwtFloatVsDouble
Note that unstacked pie charts draw multiple pies, each with their own radii.
This is only allowed to be called when
FacetChart.chartDrawn()
fires.
public double getChartRadiusAsDouble()
Note that unstacked pie charts draw multiple pies, each with their own radii.
This is only allowed to be called when
FacetChart.chartDrawn()
fires.
public float getChartTop()
GwtFloatVsDouble
This is only allowed to be called
when FacetChart.chartDrawn()
fires.
public double getChartTopAsDouble()
This is only allowed to be called
when FacetChart.chartDrawn()
fires.
public float getChartWidth(boolean recalc)
GwtFloatVsDouble
This is only allowed to be called when FacetChart.chartDrawn()
fires.
recalc
- if false then cached value will be returned, otherwise will be recalculated.public double getChartWidthAsDouble(boolean recalc)
This is only allowed to be called when FacetChart.chartDrawn()
fires.
recalc
- if false then cached value will be returned, otherwise will be recalculated.public Facet getDataLabelFacet()
Facet
in the list of facets
whose values
are rendered as labels along the data axis of the chart or in
the main chart area. Most single-facet charts and all multi-facet charts have the data label facet as their first facet. The exceptions are that single-facet Pie/Doughnut charts and Bubble and Scatter charts do not have data label facets.
Note that the user may swap the data label facet and the legend facet
in most chart types using the context menu.
null
if there is no such facetgetFacets()
public java.lang.String getDataLabelHoverHTML(FacetValue facetValue)
facetValue
- facetValue that was hoveredHTMLString
public DrawnValue getDrawnValue(FacetValueMap facetValues)
If called before FacetChart.chartDrawn()
, logs a warning and returns
null.
facetValues
- facet values of desired data valuepublic DrawnValue getDrawnValueAtPoint()
DrawnValue
object for the data value that is shown nearest to the
passed coordinates only if it's under the given coordinates, or under the current mouse event coordinates if no
coordinates are passed. This method is similar to getNearestDrawnValue()
, but the DrawnValue is only
returned if it's under the coordinates. See drawnValueContainsPoint()
for the criteria that
determine whether a DrawnValue is under (contains) the coordinates.
public DrawnValue getDrawnValueAtPoint(java.lang.Integer x)
getDrawnValueAtPoint()
public DrawnValue getDrawnValueAtPoint(java.lang.Integer x, java.lang.Integer y)
getDrawnValueAtPoint()
public DrawnValue getDrawnValueAtPoint(java.lang.Integer x, java.lang.Integer y, java.lang.String metric)
DrawnValue
object for the data value that is shown nearest to the
passed coordinates only if it's under the given coordinates, or under the current mouse event coordinates if no
coordinates are passed. This method is similar to getNearestDrawnValue()
, but the DrawnValue is only
returned if it's under the coordinates. See drawnValueContainsPoint()
for the criteria that
determine whether a DrawnValue is under (contains) the coordinates.
x
- X coordinate. If this parameter is specified, then y
is a required parameter.y
- Y coordinatemetric
- metric over which to determine the drawn valuepublic DrawnValue[] getDrawnValues()
If called before FacetChart.chartDrawn()
, logs a warning and returns
null.
public DrawnValue[] getDrawnValues(FacetValueMap facetValues)
If called before FacetChart.chartDrawn()
, logs a warning and returns
null.
facetValues
- facet values of desired DrawnValues. If no FacetValueMap is provided, then all DrawnValues are returned.public DrawnValue[] getDrawnValuesAtPoint()
DrawnValue
objects for the data values of each metric that
are shown nearest to the passed coordinates, but only if they're under the given coordinates, or under the current mouse
event coordinates if no coordinates are passed. This method is similar to getNearestDrawnValues()
, but DrawnValues are only
included in the returned array if they're under the coordinates. See drawnValueContainsPoint()
for the criteria that
determine whether a DrawnValue is under (contains) the coordinates.
public DrawnValue[] getDrawnValuesAtPoint(java.lang.Integer x)
getDrawnValuesAtPoint()
public DrawnValue[] getDrawnValuesAtPoint(java.lang.Integer x, java.lang.Integer y)
DrawnValue
objects for the data values of each metric that
are shown nearest to the passed coordinates, but only if they're under the given coordinates, or under the current mouse
event coordinates if no coordinates are passed. This method is similar to getNearestDrawnValues()
, but DrawnValues are only
included in the returned array if they're under the coordinates. See drawnValueContainsPoint()
for the criteria that
determine whether a DrawnValue is under (contains) the coordinates.
x
- X coordinate. If this parameter is specified, then y
is a required parameter.y
- Y coordinatepublic Facet getFacet(java.lang.String facetId)
facetId
- the id of the facet to retrieveFacet
public FacetValue getFacetValue(java.lang.String facetId, java.lang.String facetValueId)
facetId
- the id of the facet to retrievefacetValueId
- the id of the facet value to retrieveFacetValue
public float[] getGradations()
getXCoord()
/ getYCoord()
(depending on the orientation of the chart) to
discover the coordinates where gradations are drawn. This is only allowed to be called when FacetChart.chartDrawn()
fires.
public Facet getLegendFacet()
Facet
in the list of facets
whose values
are rendered in the chart's legend. Most single-facet charts do not have a legend facet. The exceptions are that single-facet Pie/Doughnut charts have a legend facet as the first facet and Bubble and Scatter charts may optionally have a legend facet as the second facet, after the metric facet.
In all multi-facet charts, the legend facet is the second facet.
Note that the user may swap the legend
facet and the data label facet
in most chart
types using the context menu.
null
if there is no such facetgetFacets()
public java.lang.String getLegendHoverHTML(FacetValue facetValue, FacetValue metricFacetValue)
The FacetValue
that the user is hovering over is provided. If the chart is a multi-axis chart
, the FacetValue
for the hovered-over metric will also be provided.
facetValue
- facetValue that the mouse is overmetricFacetValue
- for a multi-axis chart, facetValue representing the hovered-over metric. Null if chart is not multi-axisHTMLString
public DrawnValue getNearestDrawnValue()
DrawnValue
object. Passed X and Y coordinates should be relative to the
FacetChart. If neither an X or Y coordinate is passed, both X and Y will use the current Canvas.getOffsetX()
and Canvas.getOffsetY()
.
If called before FacetChart.chartDrawn()
, logs a warning and returns
null. For a chart with multiple vertical axes, returns the nearest point from the first metric only (see FacetChart overview
). For scatter charts, returns a DrawnValue where the
value
is from the y-axis metric
.
To get the nearest DrawnValue only if it
contains the given coordinates, you can either use the getDrawnValueAtPoint()
API or call drawnValueContainsPoint()
on the return value.
Behavior for different chart types is as follows:
Returns the centerpoint of the end of the nearest bar or column by considering the Y coordinate (bar) or X coordinate (column) only.
Returns the nearest point based on which data label is nearest to the passed X coordinate. For multi-series charts, if Y coordinate is not passed the data point returned is from the series that has the highest value at the data label.
Returns the data point nearest the passed coordinates by straight line distance. Passing only one
coordinate will cause a warning to be logged and null to be returned; passing neither coordinate is allowed
(getOffsetX/Y
will be used).
Returns the data point for the segment that would be hit if a line were drawn from the passed coordinates to the center of the pie.
If there are multiple stacked pies, uses the pie that contains the passed coordinates, otherwise the outermost pie.
If there are multiple non-stacked pies, uses the pie that is nearest the passed coordinates by straight-line distance to the center of the pie.
Passing only
one coordinate will cause a warning to be logged and null to be returned; passing neither coordinate is allowed
(getOffsetX/Y
will be used).
If the chart is a multi-axis chart
then this method takes an optional
parameter, metric
, which causes this method to return a DrawnValue
from the specified metric.
If a metric is not passed then the first metric of the metric facet will be used (or just the valueProperty
if there is no metric facet).
public DrawnValue getNearestDrawnValue(java.lang.Integer x)
getNearestDrawnValue()
public DrawnValue getNearestDrawnValue(java.lang.Integer x, java.lang.Integer y)
getNearestDrawnValue()
public DrawnValue getNearestDrawnValue(java.lang.Integer x, java.lang.Integer y, java.lang.String metric)
DrawnValue
object. Passed X and Y coordinates should be relative to the
FacetChart. If neither an X or Y coordinate is passed, both X and Y will use the current Canvas.getOffsetX()
and Canvas.getOffsetY()
.
If called before FacetChart.chartDrawn()
, logs a warning and returns
null. For a chart with multiple vertical axes, returns the nearest point from the first metric only (see FacetChart overview
). For scatter charts, returns a DrawnValue where the
value
is from the y-axis metric
.
To get the nearest DrawnValue only if it
contains the given coordinates, you can either use the getDrawnValueAtPoint()
API or call drawnValueContainsPoint()
on the return value.
Behavior for different chart types is as follows:
Returns the centerpoint of the end of the nearest bar or column by considering the Y coordinate (bar) or X coordinate (column) only.
Returns the nearest point based on which data label is nearest to the passed X coordinate. For multi-series charts, if Y coordinate is not passed the data point returned is from the series that has the highest value at the data label.
Returns the data point nearest the passed coordinates by straight line distance. Passing only one
coordinate will cause a warning to be logged and null to be returned; passing neither coordinate is allowed
(getOffsetX/Y
will be used).
Returns the data point for the segment that would be hit if a line were drawn from the passed coordinates to the center of the pie.
If there are multiple stacked pies, uses the pie that contains the passed coordinates, otherwise the outermost pie.
If there are multiple non-stacked pies, uses the pie that is nearest the passed coordinates by straight-line distance to the center of the pie.
Passing only
one coordinate will cause a warning to be logged and null to be returned; passing neither coordinate is allowed
(getOffsetX/Y
will be used).
If the chart is a multi-axis chart
then this method takes an optional
parameter, metric
, which causes this method to return a DrawnValue
from the specified metric.
If a metric is not passed then the first metric of the metric facet will be used (or just the valueProperty
if there is no metric facet).
x
- X coordinate. If this parameter is specified, then y
is a required parameter.y
- Y coordinatemetric
- metric over which to determine the drawn valuepublic DrawnValue[] getNearestDrawnValues()
DrawnValue
objects containing rendering information for
the data values having each metric that are shown nearest to the passed coordinates. Passed X and Y coordinates
should be relative to the FacetChart. If neither an X or Y coordinate is passed, both X and Y will use the current
Canvas.getOffsetX()
and Canvas.getOffsetY()
.
The behavior for different chart types is the
same as getNearestDrawnValue()
. This method
also logs a warning and returns null if called before FacetChart.chartDrawn()
.
To get the nearest
DrawnValues only if they contain the given coordinates, you can either use the getDrawnValuesAtPoint()
API or check whether each
DrawnValue in the returned array contains the point by calling drawnValueContainsPoint()
.
getDrawnValuesAtPoint()
public DrawnValue[] getNearestDrawnValues(java.lang.Integer x)
getNearestDrawnValues()
public DrawnValue[] getNearestDrawnValues(java.lang.Integer x, java.lang.Integer y)
DrawnValue
objects containing rendering information for
the data values having each metric that are shown nearest to the passed coordinates. Passed X and Y coordinates
should be relative to the FacetChart. If neither an X or Y coordinate is passed, both X and Y will use the current
Canvas.getOffsetX()
and Canvas.getOffsetY()
.
The behavior for different chart types is the
same as getNearestDrawnValue()
. This method
also logs a warning and returns null if called before FacetChart.chartDrawn()
.
To get the nearest
DrawnValues only if they contain the given coordinates, you can either use the getDrawnValuesAtPoint()
API or check whether each
DrawnValue in the returned array contains the point by calling drawnValueContainsPoint()
.
x
- X coordinate. If this parameter is specified, then y
is a required parameter.y
- Y coordinategetDrawnValuesAtPoint()
public java.lang.Integer getNumDataPoints()
public java.lang.Integer getNumDataPoints(FacetValueMap criteria)
criteria
- a set of facetValues describing a slice of the datapublic void getPolynomialRegressionFunction()
public void getPolynomialRegressionFunction(java.lang.Integer degree)
getPolynomialRegressionFunction()
public void getPolynomialRegressionFunction(java.lang.Integer degree, java.lang.String xMetric)
getPolynomialRegressionFunction()
public void getPolynomialRegressionFunction(java.lang.Integer degree, java.lang.String xMetric, java.lang.String yMetric)