Class FacetChart
- All Implemented Interfaces:
HasAttachHandlers
,HasHandlers
,EventListener
,HasVisibility
,IsWidget
,LogicalStructure
,HasChartBackgroundDrawnHandlers
,HasChartDrawnHandlers
,HasDataLabelClickHandlers
,HasDataLabelHoverHandlers
,HasLegendClickHandlers
,HasLegendHoverHandlers
,HasValueClickHandlers
,HasZoomChangedHandlers
,DataBoundComponent
,HasDrawEndHandlers
,HasDrawStartHandlers
,HasClearHandlers
,HasClickHandlers
,HasDoubleClickHandlers
,HasDragCompleteHandlers
,HasDragMoveHandlers
,HasDragRepositionMoveHandlers
,HasDragRepositionStartHandlers
,HasDragRepositionStopHandlers
,HasDragResizeMoveHandlers
,HasDragResizeStartHandlers
,HasDragResizeStopHandlers
,HasDragStartHandlers
,HasDragStopHandlers
,HasDropCompleteHandlers
,HasDropHandlers
,HasDropMoveHandlers
,HasDropOutHandlers
,HasDropOverHandlers
,HasFetchDataHandlers
,HasFocusChangedHandlers
,HasHoverHandlers
,HasHoverHiddenHandlers
,HasKeyDownHandlers
,HasKeyPressHandlers
,HasMouseDownHandlers
,HasMouseMoveHandlers
,HasMouseOutHandlers
,HasMouseOverHandlers
,HasMouseStillDownHandlers
,HasMouseUpHandlers
,HasMouseWheelHandlers
,HasMovedHandlers
,HasParentMovedHandlers
,HasResizedHandlers
,HasRightMouseDownHandlers
,HasRuleContextChangedHandlers
,HasScrolledHandlers
,HasShowContextMenuHandlers
,HasVisibilityChangedHandlers
Can be used directly, or specified as ListGrid.chartConstructor
or
CubeGrid.chartConstructor
.
NOTE: you must load the standard Drawing and
Optional
Charts 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");
A DataSource
may be provided instead of inline data
to use the
chart as a DataBoundComponent
. In this case, facetFields
may be provided instead of facets
, to specify which
DataSource fields to use as the facets. If neither is set, the framework will attempt to
auto-derive the facetFields
. The
valueProperty
will also be auto-derived for
databound charts
if it hasn't been set in the chart instance.
The following SDK examples demonstrate charts with a single facet:
- Log Scaling example,
- Interactive Data Points example, and
- Adding Element example.
- @see Simple Chart example,
- Multi-Series Chart example, and
- Dynamic Data example.
the Inlined 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");
Dual axis or multi-axis charts
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.
Mixed plots
In some cases you want to show some data series as one shape and other data series as another shape but use the same axis. This is commonly used when one series is of a fundamentally different kind than the other series (for example, a projection or average) but still has the same scale.
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.
Histogram Charts
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
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".
Bubble Charts
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.
Color Scale Charts
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.
Three-Facet Bar and Column Charts
Bar and Column charts support having three facets declared, unlike most other charts
supporting data labels, which only allow two. With three facets, the first two are shown
as data label facets
, as separate rows of labels,
and the third facet is used as the legend facet
.
You can use features such as stacking
and
extra axes
with a three-facet Bar or Column
chart, but
certain chart settings are incompatible:
Zooming
isn't supportedInline labels
aren't supported- The only mode supported for
label collapsing
is "sample".
setChartType()
to switch between Bar and Column charts. Switching to other types is not supported.
Take a look at this example to see this feature in action.
Notes on printing
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()
.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.smartgwt.client.widgets.drawing.DrawPane
DrawPane.InvalidDrawingTypeException
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled
-
Field Summary
Fields inherited from class com.smartgwt.client.widgets.BaseWidget
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionAdd a chartBackgroundDrawn handler.addChartDrawnHandler
(ChartDrawnHandler handler) Add a chartDrawn handler.Add a dataLabelClick handler.Add a dataLabelHover handler.Add acom.smartgwt.client.widgets.DragCompleteHandler
.Add acom.smartgwt.client.widgets.DropCompleteHandler
.addFetchDataHandler
(FetchDataHandler handler) Add a fetchData handler.void
Convenience method to display a {@link com.smartgwt.client..FormulaBuilder} to create a new Formula Field.addLegendClickHandler
(LegendClickHandler handler) Add a legendClick handler.addLegendHoverHandler
(LegendHoverHandler handler) Add a legendHover handler.void
Convenience method to display a {@link com.smartgwt.client..SummaryBuilder} to create a new Summary Field.addValueClickHandler
(ValueClickHandler handler) Add a valueClick handler.addZoomChangedHandler
(ZoomChangedHandler handler) Add a zoomChanged handler.Whether at least one item is selected
static void
changeAutoChildDefaults
(String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren namedautoChildName
.static void
changeAutoChildDefaults
(String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren namedautoChildName
.protected JavaScriptObject
create()
void

 Deselect all records

void
deselectRecord
(int record) Deselect aRecord
passed in explicitly, or by index.void
deselectRecord
(Record record) Deselect aRecord
passed in explicitly, or by index.void
deselectRecords
(int[] records) Deselect a list ofRecord
s passed in explicitly, or by index.void
deselectRecords
(Record[] records) Deselect a list ofRecord
s passed in explicitly, or by index.void
disableHilite
(String hiliteID) Disable a hilite

void
Disable all hilites.

drawnValueContainsPoint
(DrawnValue drawnValue) Returns whether a givenDrawnValue
contains a point.drawnValueContainsPoint
(DrawnValue drawnValue, Integer x) drawnValueContainsPoint
(DrawnValue drawnValue, Integer x, Integer y) Returns whether a givenDrawnValue
contains a point.void
Shows a FieldPicker interface allowing end-users to rearrange the order and visibiility of the fields in the associated DataBoundComponent.void
Shows a HiliteEditor interface allowing end-users to edit the data-hilites currently in use by this DataBoundComponent.void
enableHilite
(String hiliteID) Enable / disable ahilites


void
enableHilite
(String hiliteID, boolean enable) Enable / disable ahilites


void
Enable all hilites.

void
enableHiliting
(boolean enable) Enable all hilites.

void
void
exportData
(DSRequest requestProperties) void
exportData
(DSRequest requestProperties, RPCCallback callback) Uses a "fetch" operation on the currentDataSource
to retrieve data that matches the current filter and sort criteria for this component, then exports the resulting data to a file or window in the requested format.void
Retrieves data from the DataSource that matches the specified criteria.void
Retrieves data from the DataSource that matches the specified criteria.void
fetchData
(Criteria criteria, DSCallback callback) Retrieves data from the DataSource that matches the specified criteria.void
fetchData
(Criteria criteria, DSCallback callback, DSRequest requestProperties) Retrieves data from the DataSource that matches the specified criteria.void
fetchRelatedData
(ListGridRecord record, Canvas schema) Based on the relationship between the DataSource this component is bound to and the DataSource specified as the "schema" argument, call fetchData() to retrieve records in this grid that are related to the passed-in record.void
fetchRelatedData
(ListGridRecord record, Canvas schema, DSCallback callback) void
fetchRelatedData
(ListGridRecord record, Canvas schema, DSCallback callback, DSRequest requestProperties) Based on the relationship between the DataSource this component is bound to and the DataSource specified as the "schema" argument, call fetchData() to retrieve records in this grid that are related to the passed-in record.void
Retrieves data that matches the provided criteria and displays the matching data in this component.void
filterData
(Criteria criteria) Retrieves data that matches the provided criteria and displays the matching data in this component.void
filterData
(Criteria criteria, DSCallback callback) Retrieves data that matches the provided criteria and displays the matching data in this component.void
filterData
(Criteria criteria, DSCallback callback, DSRequest requestProperties) Retrieves data that matches the provided criteria and displays the matching data in this component.find
(AdvancedCriteria adCriteria) Filters all objects according to the AdvancedCriteria passed and returns the first matching object or null if not foundRecord[]
findAll
(AdvancedCriteria adCriteria) Filters all objects according to the AdvancedCriteria passedint
findIndex
(AdvancedCriteria adCriteria) Finds the index of the first Record that matches with the AdvacendCriteria passed.int
findNextIndex
(int startIndex, AdvancedCriteria adCriteria) LikeRecordList.findIndex(java.util.Map)
, but considering the startIndex parameter.int
findNextIndex
(int startIndex, AdvancedCriteria adCriteria, int endIndex) LikeRecordList.findIndex(java.util.Map)
, but considering the startIndex and endIndex parameters.formatFacetValueId
(Object value, Facet facet) Return the text string to display for facet value labels that appear in chart legends or as labels forchartType
s that have circumference or non-axis labels, such as for example "Pie" or "Radar" charts.formatSegmentLabel
(Object startValue, Object endValue) Defines the format of the label for a segment in a histogram chart.Indicates whether to add "drop values" to items dropped on this component, if both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key.Text for a menu item allowing users to add a formula fieldoperationId
this component should use when performing add operations.Text for a menu item allowing users to add a formula fieldboolean
Setting this flag tofalse
prevents the chart from drawing fill gradients into the bubbles of each data point.Otherchart types
that the end user will be allowed to switch to, using the built-in context menu.IfDataBoundComponent.setAutoFetchData(Boolean)
is true, this attribute determines whether the initial fetch operation should be performed viaDataBoundComponent.fetchData()
orDataBoundComponent.filterData()
If true, when this component is first drawn, automatically callDataBoundComponent.fetchData()
orDataBoundComponent.filterData()
depending onDataBoundComponent.getAutoFetchAsFilter()
.IfautoFetchData
istrue
, this attribute allows the developer to specify a textMatchStyle for the initialDataBoundComponent.fetchData()
call.Deprecated.boolean
boolean
For somechart-types
, should the chart body be automatically expanded and scrollbars introduced according to data?If set, overrides the default behavior ofautoScrollData
, potentially limiting what factors drive the automatic expansion of the chart.boolean
Whether to draw data points in order of descendingpoint size
so that small values are less likely to be completely occluded by larger values.End value for the primary axis of the chart.Start value for the primary axis of the chart.Properties for background bandWhether to show alternating color bands in the background of chart.Whether to show color bands between thestandard deviation
lines.int
Distance between bars.Properties for barWhenhighlightDataValues
is true, should the whole draw-area of the data-value be brightened bya percentage
, or just its border?int
WhenhighlightDataValues
is true, sets the percentage by which to brighten filled data-shapes in somechart-types
as the mouse is moved over the chart.int
Maximum distance from the *outer radius* of the nearest bubble when hover will be shown.Properties for the shapes displayed around the data points (for example, in a bubble chart).Adds an item to the header context menu allowing users to launch a dialog to define a new
 field based on values present in other fields, using the {@link com.smartgwt.client..FormulaBuilder}.
Adds an item to the header context menu allowing users to launch a dialog to define a new
 text field that can contain both user-defined text and the formatted values present in other 
 fields, using the {@link com.smartgwt.client..SummaryBuilder}.
Whether the positions of value axes can be changed.Enables "zooming" on the X axis, specifically, only a portion of the overall dataset is shown in the main chart, and asecond smaller chart
appears with slider controls allowing a range to be selected for display in the main chart.Deprecated.Alignment of legend and title elements is now always relative to the visible chart-width, and not the full scrollable-width, so that both elements are always on-screen for any alignmentDeprecated.Alignment of title and legend elements is now always relative to the visible chart-width, and not the full scrollable-width, so that both elements are always on-screen for any alignmentReturns 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
Deprecated.double
Get the left margin of the central chart area, where data elements appear.float
Deprecated.double
Returns the radius for radar charts and pie charts.int
Margin around the main chart rect: between title and chart, between chart and axis labels, and chart rect and right edge of chart.Properties for chart rect.float
Deprecated.double
Get the top coordinate of the central chart area, where data elements appear.SeeChartType
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
For clustered charts, ratio between margins between individual bars and margins between clusters.Should be set to a number between -100 and 100.For charts whereshowDataPoints
is enabled, this property specifies an additional metric (i.e.Determines how inner and outer data axis labels are separated for charts that support multiple data label facets.Properties for labels of data axis.getDataColor
(int index) getDataColor
(int index, Double facetValueId, String purpose) getDataColor
(int index, Integer facetValueId, String purpose) getDataColor
(int index, String facetValueId, String purpose) Get a color from thedataColors
Array.getDataColor
(int index, Date facetValueId, String purpose) String[]
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.FacetCharts do not yet support paging, and will fetch all records that meet the criteria.Determines separation between the set of inner data labels and the set of outer data labels for charts that support multiple data label facets.getDataLabelHoverHTML
(FacetValue facetValue) Called when the mouse hovers over a data label, that is, a text label showing values from the first facet.Properties for data labelint
Margin between the edge of the chart and the data labels of the data label axis.Properties for lines that show data (as opposed to gradations or borders around the data area).How to draw lines between adjacent data points in Line and Scatter charts.int
For rectangular charts (bar, column, line), margin around the inside of the main chart area, so that data elements are not flush to edge.Properties for lines that outline a data shape (in filled charts such as area or radar charts).int
When usingdata paging
, how many records to fetch at a time.Common properties to apply for all data points (seeshowDataPoints
).int
Size in pixels for data points drawn for line, area, radar and other chart types.Properties for data shapes (filled areas in area or radar charts).The DataSource that this component should bind to for default fields and for performingDataSource requests
.WhenhighlightDataValues
is true, this attribute can be set to aDrawItem shadow
to show around the draw-area of nearby filled data-value shapes as the mouse is moved around in Bar, Column, Pie and Doughnutchart-types
.int
Default precision used when formatting float numbers for axis labelsBefore we start editing values in this DataBoundComponent, should we perform a deep clone of the underlying values.Whether to treat non-numeric values in the dataset as indicating a break in the data line.Properties for doughnut holefloat
If showing a doughnut hole (seeshowDoughnut
), ratio of the size of the doughnut hole to the size of the overall pie chart, as a number between 0 to 1.Record[]
During a drag-and-drop interaction, this method returns the set of records being dragged out of the component.Indicates what to do with data dragged into another DataBoundComponent.CSS Style to apply to the drag tracker when dragging occurs on this component.Whether a boundary should be drawn above the Legend area for circumstances where the chart area already has an outer border.getDrawnValue
(FacetValueMap facetValues) Returns rendering information for the data value specified by the passed facet values.Returns aDrawnValue
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.getDrawnValueAtPoint
(Integer x, Integer y, String metric) Returns aDrawnValue
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.Returns rendering information for the data values specified by the passed facet values.getDrawnValues
(FacetValueMap facetValues) Returns rendering information for the data values specified by the passed facet values.Returns an array ofDrawnValue
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.Returns an array ofDrawnValue
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.should a background color be set behind the Title.Whether a boundary should be drawn below the title area for circumstances where the chart area already has an outer border.When an item is dropped on this component, andaddDropValues
is true and both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key, this object provides the "drop values" that Smart GWT will apply to the dropped object before updating it.Message to show when a user attempts to transfer duplicate records into this component, and
preventDuplicates
is enabled.Text for a menu item allowing users to edit a formula fieldDefault class used to construct theEditProxy
for this component when the component isfirst placed into edit mode
.Text for a menu item allowing users to edit the formatter for a fieldSpecifies the attribute in the metric facet that will define the end point of segments in a histogram chart.float
This property helps specify the color of the error bars and its value must be a number between -100 and 100.int
Width of the horizontal line of the "T"-shape portion of the error bar).Properties of the lines used to draw error bars (short, horizontal lines at the low and high metric values, and a vertical connecting line).Properties for theline drawn at the mean value
.Setting exportAll to true prevents the component from passing its list of fields to the 
 export call.String[]
The list of field-names to export.If Summary rows exist for this component, whether to include them when exporting client data.Horizontal alignment of labels shown in extra y-axes, shown to the right of the chart.String[]
Defines the set of metrics that will be plotted as additional vertical axes.For charts will multiple vertical axes, optionally provides settings for how eachextra axis metric
is plotted.Get a facet definition by facetId.String[]
Specifies whatDataSource
fields to use as the chartfacets
for a databound chart.Specifies whatDataSource
fields to use as the chartfacets
for a databound chart.Facet[]
An Array of facets, exactly analogous toCubeGrid.facets
, except that: the "inlinedValues" property can be set on a facet to change data representation as described under Chart.data.An Array of facets, exactly analogous toCubeGrid.facets
, except that: the "inlinedValues" property can be set on a facet to change data representation as described under Chart.data.getFacetValue
(String facetId, String facetValueId) Get facet value definition by facetId and facetValueId.Operation ID this component should use when performing fetch operations.IfautoFetchData
istrue
, this attribute allows the developer to declaratively specifyDSRequest
properties for the initialfetchData()
call.Returna an array of field alignments for this gridint
Return the number of fields.Return the fields as JavaScriptObjects rather than as SmartGWT Java wrappers of the field class type (e.g.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.Whether to callsetXAxisValueFormatter()
orformatFacetValueId()
on a facet value id when the id is a string.float[]
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
Padding from edge of Y the Axis Label.Properties for gradation labelsProperties for gradation linesfloat[]
Return an array of the gradation values used in the current chart.Deprecated.usetickLength
insteadProperties for the gradation line drawn for zero (slightly thicker by default).SeelowErrorMetric
.Should the draw-area of nearby filled data-value shapes be highlighted as the mouse is moved over somechart-types
?Marker that can be set on a record to flag that record as hilited.Hilite[]
Return the set of hilite-objects currently applied to this DataBoundComponent.Get the current hilites encoded as a String, for saving.int
An extra amount of padding to show around thehoverLabel
whenshowValueOnHover
is enabled.Properties for text in a floating label that represents the data value shown whenever the mouse moves withing the main chart area whenshowValueOnHover
is enabled.Properties for rectangle that draws behind of a floating hover label that represents the data value.Criteria that are never shown to or edited by the user and are cumulative with any criteria provided viaDataBoundComponent.initialCriteria
,DataBoundComponent.setCriteria()
etc.Criteria to use whenDataBoundComponent.setAutoFetchData(Boolean)
is used.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 - seeLabelCollapseMode
.Horizontal alignment of the chart'slegend widget
.Properties for top boundary of the legend are, when there is already an outer container around the whole chart.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
Padding between each swatch and label pair.Properties for labels shown next to legend color swatches.int
Space between the legend and the chart rect or axis labels (whatever the legend is adjacent to.int
Padding around the legend as a whole.int
If drawing a border around the legend, the height of the drawn Rectangle.Properties for rectangle around the legend as a whole.Properties for the swatches of color shown in the legend.int
Size of individual color swatches in legend.int
Padding between color swatch and its label.int
WhenuseLogGradations
, base value for logarithmic gradation lines.float[]
WhenuseLogGradations
is set, gradation lines to show in between powers, expressed as a series of integer or float values between 1 andlogBase
.Getter implementing theLogicalStructure
interface, which supports Eclipse's logical structure debugging facility.Whether to use logarithmic scaling for values.boolean
Whether to use logarithmic scaling for thecolor scale
of the data points.boolean
Whether to use logarithmic scaling for thedata point sizes
.lowErrorMetric
andhighErrorMetric
can be used to cause error bars to appear above and below the main data point.float[]
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).String[]
When ticks are beingshown 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.Setting to define whether the border around the bar chart area should be the same color as the main chart area.getMax
(FacetValueMap criteria) Calculate the maximum of the data from a single metric.Calculate the maximum of the data from a single metric.int
Bars will not be drawn over this thickness, instead, margins will be increased.double
The maximum allowed data point size when controlled bypointSizeMetric
.Maximum allowed zIndex that can be specified throughzIndexMetric
in a histogram chart.getMean
(FacetValueMap criteria) Calculate the mean, or expected value, of the data over a single metric.Calculate the mean, or expected value, of the data over a single metric.getMedian
(FacetValueMap criteria) Calculate the median of the data over a single metric.Calculate the median of the data over a single metric.Specifies the "id" of the default metric facet value.getMin
(FacetValueMap criteria) Calculate the minimum of the data from a single metric.Calculate the minimum of the data from a single metric.int
If bars would be smaller than this size, margins are reduced until bars overlap.Minimum height for this chart instance.Minimum width for this chart instance.int
WhenautoScrollContent
is true, limits the minimum height of the chart-content, including data, labels, title and legends.int
WhenautoScrollContent
is true, limits the minimum width of the chart-content, including data, labels, titles and legends.double
The minimum allowed data point size when controlled bypointSizeMetric
.int
If all data values would be spread across less thanminDataSpreadPercent
of the axis, the start values of axes will be automatically adjusted to make better use of space.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 thelabelCollapseMode
.int
Length of minor ticks marks shown along axis, ifminor tick marks
are enabled.int
For scatter charts only, if all data points would be spread across less thanminXDataSpreadPercent
of the x-axis, the start value of x-axis will be automatically adjusted to make better use of space.Returns rendering information for the data value that is shown nearest to the passed coordinates, as aDrawnValue
object.getNearestDrawnValue
(Integer x, Integer y, String metric) Returns rendering information for the data value that is shown nearest to the passed coordinates, as aDrawnValue
object.Returns an array ofDrawnValue
objects containing rendering information for the data values having each metric that are shown nearest to the passed coordinates.Returns an array ofDrawnValue
objects containing rendering information for the data values having each metric that are shown nearest to the passed coordinates.Count the number of data points.getNumDataPoints
(FacetValueMap criteria) Count the number of data points.static FacetChart
getOrCreateRef
(JavaScriptObject jsObj) float[]
LikegradationGaps
, except allows control of gradations for the X (horizontal) axis, for Scatter charts only.String[]
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.Ideal number of pixels to leave between each gradation on the x (horizontal axis), for Scatter plots only.Properties for the lines drawn to show the span of outer data label facet values, if present.boolean
IfshowChartRect
is enabled and ifchartRectProperties
specifies a nonzerorounding
, whether the padding around the inside of the chart rect.getPercentile
(FacetValueMap criteria, float percentile) Calculate a percentile of the data over a single metric.getPercentile
(String criteria, float percentile) Calculate a percentile of the data over a single metric.Properties for the border around a pie chart.int
Angle where first label is placed in a Pie chart in stacked mode, in degrees.int
How far label lines stick out of the pie radius in a Pie chart in stacked mode.Properties for pie label lineProperties for pie ring borderProperties for pie slicesDefault angle in degrees where pie charts start drawing sectors to represent data values.int
Ideal number of pixels to leave between each gradation on the primary axis, which is typically the y (vertical) axis except for Bar charts.WhenlogScalePointColor
istrue
, this property specifies the base value for logarithmiccolor scale metric
values.For charts whereshowDataPoints
is enabled, this property specifies an array of geometric shapes to draw for the data points of each series.When apoint size legend
is shown, this property controls the number of gradations of thepointSizeMetric
that the chart tries to display.WhenlogScalePointSize
is true, base value for logarithmic point size metric values.float[]
WhenusePointSizeLogGradations
is set, this property specifies thepointSizeMetric
value gradations to show in thepoint size legend
in between powers, expressed as a series of integer or float values between 1 andpointSizeLogBase
.For charts whereshowDataPoints
is enabled, this property specifies an additional metric (i.e.void
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
void
getPolynomialRegressionFunction
(Integer degree, String xMetric) void
getPolynomialRegressionFunction
(Integer degree, String xMetric, 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.If set, detect and prevent duplicate records from being transferred to this component, either via
 drag and drop or viaDataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent)
.getPrintHTML
(PrintProperties printProperties, PrintHTMLCallback callback) Retrieves printable HTML for this component and all printable subcomponents.boolean
Should thezoom chart
be printed with thisFacetChart
? Iftrue
, then the SVG string returned byDrawPane.getSvgString()
will include the zoom chart's SVG as well.The "id" of the metric facet value that assigns a probability to each combination of facets and their values.Indicates whether or not this component will load its dataprogressively
For multi-facet charts, render data values as a proportion of the sum of all data values that have the same label.Default title for the value axis label when the chart is inproportional rendering mode
.Properties for radar backgroundThis property controls whether to rotate the labels on thedata label facet
of radar orstacked
pie charts so that each label is parallel to its radial gradation (these are the labels that appear around the perimeter).Distance in pixels that radial labels are offset from the outside of the circle.getRange
(FacetValueMap criteria) Calculate the range of the data from a single metric.Calculate the range of the data from a single metric.int
getRecordIndex
(Record record) Get the index of the provided record.
Return the underlying data of this DataBoundComponent as aRecordList
.Record[]
Properties for theregression line
.Regression algorithm used for theregression line
.int
For scatter plots only, specify the degree of polynomial to use for any polynomial regression that is calculated.operationId
this component should use when performing remove operations.Return the underlying data of this DataBoundComponent as aResultSet
.This property controls whether to rotate the labels shown for data-values inColumn-type charts
.This property controls whether to rotate the labels on the X-axis.Optional identifier for saved searches that should be applied to this component.The ending color of the color scale when the data points are colored according to acolor scale metric
.The starting color of the color scale when the data points are colored according to acolor scale metric
.Properties for shadows.boolean
Whether to draw multiple bubble legends horizontally stacked to the right of the chart, one per shape type.Whether to show a rectangular shape around the area of the chart where data is plotted.Whether to show an additional legend underneath the chart to indicate color values.Whether to show fields of non-atomic types when a DataBoundComponent is given a
 DataSource but nocomponent.fields
.
Whether to show a label for the data axis as a whole (the data axis is where labels for each data point appear).boolean
If set tofalse
, data labels for values are entirely omitted.For Line, Area, Radar, Scatter or Bubble charts, whether to show data points for each individual data value.boolean
Deprecated.in favor ofshowDataValuesMode
, a compound setting that supports showing data-values in the chart and in hovers in various combinations.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, includingautomatic rotation
where supported.ThisDataBoundComponent
property is not applicable to charts.Whether to show a "doughnut hole" in the middle of pie charts.Display a line at themean value
.If set, gradation lines are drawn on top of data rather than underneath.Whether to show fields markedhidden:true
when a DataBoundComponent is given a
 DataSource but nocomponent.fields
.
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.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
Ifticks
are being shown, controls whether a distinction is made between major and minor tick marks.Whether to show an additional legend to the right of the chart to indicatepoint size
.Whether to show gradation labels in radar charts.For scatter plots only, whether to display a regression curve that best fits the data of the two metric facet values.boolean
Whether to associate saved searches by default with the currentDataSource
of a component when asavedSearchId
is not provided.Whether to draw lines between adjacent data points in "Scatter" plots.Whether to automatically show shadows for various charts.Display multiplestandard deviations
away from the mean as lines.If set, themean line
,standard deviation lines
,standard deviation bands
, andregression curves
are drawn on top of the data rather than underneath.Whether to show a title.Whether to show thevalueTitle
(or, in the case ofproportional rendering mode
, theproportionalAxisLabel
) as a label on the value axis.Deprecated.in favor ofshowDataValuesMode
, a compound setting that supports showing data-values in the chart and in hovers in various combinations.boolean
When set, ticks are shown for the X (horizontal) axis for Scatter plots or Bar charts.boolean
When set, ticks are shown for the Y (vertical) axis if it's a value axis.void
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
(String xMetric) void
getSimpleLinearRegressionFunction
(String xMetric, 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.getSort()
Returns the currentSortSpecifiers
for this component.If true,ListGrid.getFieldState()
andListGrid.setFieldState(java.lang.String)
will omit state information for hidden fields by default.Whether to use stacking for charts where this makes sense (column, area, pie, line and radar charts).Properties for thestandard deviation lines
.float[]
WhenshowStandardDeviationLines
is set, the number of standard deviation lines drawn and their respective standard deviation away from the mean are specified by this property.getStdDev
(FacetValueMap criteria, boolean population) Calculate the standard deviation of the data from a single metric.Calculate the standard deviation of the data from a single metric.Default styleName for the chart.int
Length of the tick marks used when eithershowXTicks
orshowYTicks
is enabled, or whenextra value axes
are in use.int
Margin between the tick marks and the labels of theextra value axes
.getTitle()
Title for the chart as a whole.Horizontal alignment of the chart'stitle
with respect to the the visible chart-width.Properties for title background (if being drawn).Properties for bottom boundary of the title area, when there is already an outer container around the whole chart.Method to return the fieldName which represents the "title" for records in this
 Component.

 If this.titleField is explicitly specified it will always be used.
 Otherwise, default implementation will checktitleField
for databound
 components.

 For non databound components returns the first defined field name of"title"
, 
"name"
, or"id"
.getTitleFieldValue
(Record record) Get the value of the titleField for the passed record
int
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 edgeProperties for title label.int
The height of the bordered rect around the title - defaults to 0 (assuming no border)operationId
this component should use when performing update operations.If true, the set of fields given by the "default binding" (see 
fields
) is used, with any fields specified in
component.fields
acting as overrides that can suppress or modify the
 display of individual fields, without having to list the entire set of fields that
 should be shown.
Causes the chart to use the colors specified indataColors
but specify chart-specific gradients based on the primary data color per chart type.TheuseFlatFields
flag causes all simple type fields anywhere in a nested
 set of DataSources to be exposed as a flat list for form binding.Whether to use classic logarithmic gradations, where each order of magnitude is shown as a gradation as well as a few intervening lines.Whether the chart should use multiple shapes to show data points.Whether to use classic logarithmic gradations, where each order of magnitude is shown as a gradation as well as a few intervening values, for thepointSizeMetric
values displayed in thepoint size legend
.Whether to display both the positive and negative of thestandard deviations
.Properties for labels of value axis.int
Margin betweenmultiple value axes
.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.Property in each record that holds a data value.A label for the data values, such as "Sales in Thousands", typically used as the label for the value axis.getVariance
(FacetValueMap criteria, boolean population) Calculate the variance of the data from a single metric.getVariance
(String criteria, boolean population) Calculate the variance of the data from a single metric.For Bubble and Scatter charts only, the end value for the x-axis.For Bubble and Scatter charts only, the end value for the x-axis.For scatter charts only, the "id" of the metric facet value to use for the x-axis.For Bubble and Scatter charts only, the start value for the x-axis.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.Horizontal alignment of y-axis labels, shown to the left of the chart.int
Padding between each swatch and label pair.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.Specifies the attribute in the metric facet that will define the z-ordering of the segments in a histogram chart.Mini-chart created to allow zooming whencanZoom
is enabled.double
Height of thezoomChart
.Properties to further configure thezoomChart
.Slider controls shown on the mini-chart which is created whencanZoom
is enabled.For azoomed chart
, end value of the data range shown in the main chart.float
colorMutePercent
to use for thezoomChart
.Mini-chart created whencanZoom
is enabled.Properties to further configure thezoomSelectionChart
.Whether the selected range should be shown in a different style, which can be configured viazoomSelectionChartProperties
.For azoomed chart
, determines what portion of the overall dataset should be initially shown in the main chart.For azoomed chart
, start value of the data range shown in the main chart.void
Invalidate the current data cache for this databound component via a call to the dataset'sinvalidateCache()
method, for example,ResultSet.invalidateCache()
.void
Select all records

void
selectRecord
(int record) Select/deselect aRecord
passed in explicitly, or by index.void
selectRecord
(int record, boolean newState) Select/deselect aRecord
passed in explicitly, or by index.void
selectRecord
(Record record) Select/deselect aRecord
passed in explicitly, or by index.void
selectRecord
(Record record, boolean newState) Select/deselect aRecord
passed in explicitly, or by index.void
selectRecords
(int[] records) Select/deselect a list ofRecord
s passed in explicitly, or by index.void
selectRecords
(int[] records, boolean newState) Select/deselect a list ofRecord
s passed in explicitly, or by index.void
selectRecords
(Record[] records) Select/deselect a list ofRecord
s passed in explicitly, or by index.void
selectRecords
(Record[] records, boolean newState) Select/deselect a list ofRecord
s passed in explicitly, or by index.setAddDropValues
(Boolean addDropValues) Indicates whether to add "drop values" to items dropped on this component, if both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key.setAddFormulaFieldText
(String addFormulaFieldText) Text for a menu item allowing users to add a formula fieldsetAddOperation
(String addOperation) operationId
this component should use when performing add operations.setAddSummaryFieldText
(String addSummaryFieldText) Text for a menu item allowing users to add a formula fieldsetAllowBubbleGradients
(boolean allowBubbleGradients) Setting this flag tofalse
prevents the chart from drawing fill gradients into the bubbles of each data point.setAllowedChartTypes
(ChartType... allowedChartTypes) Otherchart types
that the end user will be allowed to switch to, using the built-in context menu.setAutoFetchAsFilter
(Boolean autoFetchAsFilter) IfDataBoundComponent.setAutoFetchData(Boolean)
is true, this attribute determines whether the initial fetch operation should be performed viaDataBoundComponent.fetchData()
orDataBoundComponent.filterData()
setAutoFetchData
(Boolean autoFetchData) If true, when this component is first drawn, automatically callDataBoundComponent.fetchData()
orDataBoundComponent.filterData()
depending onDataBoundComponent.getAutoFetchAsFilter()
.setAutoFetchTextMatchStyle
(TextMatchStyle autoFetchTextMatchStyle) IfautoFetchData
istrue
, this attribute allows the developer to specify a textMatchStyle for the initialDataBoundComponent.fetchData()
call.setAutoRotateLabels
(Boolean autoRotateLabels) Deprecated.As of Smart GWT 9.0 this property is replaced by the propertyrotateLabels
.setAutoScrollContent
(boolean autoScrollContent) setAutoScrollData
(boolean autoScrollData) For somechart-types
, should the chart body be automatically expanded and scrollbars introduced according to data?setAutoScrollDataApproach
(AutoScrollDataApproach autoScrollDataApproach) If set, overrides the default behavior ofautoScrollData
, potentially limiting what factors drive the automatic expansion of the chart.setAutoSortBubblePoints
(boolean autoSortBubblePoints) Whether to draw data points in order of descendingpoint size
so that small values are less likely to be completely occluded by larger values.setAxisEndValue
(Double axisEndValue) End value for the primary axis of the chart.setAxisStartValue
(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.setBackgroundBandProperties
(DrawRect backgroundBandProperties) Properties for background bandsetBandedBackground
(Boolean bandedBackground) Whether to show alternating color bands in the background of chart.setBandedStandardDeviations
(Boolean bandedStandardDeviations) Whether to show color bands between thestandard deviation
lines.setBarMargin
(int barMargin) Distance between bars.setBarProperties
(DrawRect barProperties) Properties for barsetBrightenAllOnHover
(Boolean brightenAllOnHover) WhenhighlightDataValues
is true, should the whole draw-area of the data-value be brightened bya percentage
, or just its border?setBrightenPercent
(int brightenPercent) WhenhighlightDataValues
is true, sets the percentage by which to brighten filled data-shapes in somechart-types
as the mouse is moved over the chart.setBubbleHoverMaxDistance
(int bubbleHoverMaxDistance) Maximum distance from the *outer radius* of the nearest bubble when hover will be shown.setBubbleProperties
(DrawItem bubbleProperties) Properties for the shapes displayed around the data points (for example, in a bubble chart).setCanAddFormulaFields
(Boolean canAddFormulaFields) Adds an item to the header context menu allowing users to launch a dialog to define a new
 field based on values present in other fields, using the {@link com.smartgwt.client..FormulaBuilder}.
setCanAddSummaryFields
(Boolean canAddSummaryFields) Adds an item to the header context menu allowing users to launch a dialog to define a new
 text field that can contain both user-defined text and the formatted values present in other 
 fields, using the {@link com.smartgwt.client..SummaryBuilder}.
setCanMoveAxes
(Boolean canMoveAxes) Whether the positions of value axes can be changed.setCanZoom
(Boolean canZoom) Enables "zooming" on the X axis, specifically, only a portion of the overall dataset is shown in the main chart, and asecond smaller chart
appears with slider controls allowing a range to be selected for display in the main chart.setCenterLegend
(Boolean centerLegend) Deprecated.Alignment of legend and title elements is now always relative to the visible chart-width, and not the full scrollable-width, so that both elements are always on-screen for any alignmentsetCenterTitle
(Boolean centerTitle) Deprecated.Alignment of title and legend elements is now always relative to the visible chart-width, and not the full scrollable-width, so that both elements are always on-screen for any alignmentsetChartRectMargin
(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.setChartRectProperties
(DrawRect chartRectProperties) Properties for chart rect.setChartType
(ChartType chartType) SeeChartType
for a list of known types - Column, Bar, Line, Pie, Doughnut, Area, Radar, and Histogram charts are supported.setClusterMarginRatio
(float clusterMarginRatio) For clustered charts, ratio between margins between individual bars and margins between clusters.setColorMutePercent
(Float colorMutePercent) Should be set to a number between -100 and 100.setColorScaleMetric
(String colorScaleMetric) For charts whereshowDataPoints
is enabled, this property specifies an additional metric (i.e.void
Dataset for this chart.
void
setData
(RecordList records) setDataAxisLabelDelimiter
(String dataAxisLabelDelimiter) Determines how inner and outer data axis labels are separated for charts that support multiple data label facets.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.setDataColors
(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.setDataFetchMode
(FetchMode dataFetchMode) FacetCharts do not yet support paging, and will fetch all records that meet the criteria.void
setDataGradientMapper
(GradientMapper gradientMapper) Sets a customizer to redefine what gradients are used when rendering the chart data.setDataLabelFacetsMargin
(String dataLabelFacetsMargin) Determines separation between the set of inner data labels and the set of outer data labels for charts that support multiple data label facets.void
setDataLabelHoverHTMLCustomizer
(DataLabelHoverCustomizer dataLabelHoverHTMLCustomizer) Called when the mouse hovers over a data label, that is, a text label showing values from the first facet.setDataLabelProperties
(DrawLabel dataLabelProperties) Properties for data labelsetDataLabelToValueAxisMargin
(int dataLabelToValueAxisMargin) Margin between the edge of the chart and the data labels of the data label axis.void
setDataLineColorMapper
(ColorMapper colorMapper) Sets a customizer to redefine what colors are used when rendering lines for the chart data.setDataLineProperties
(DrawLine dataLineProperties) Properties for lines that show data (as opposed to gradations or borders around the data area).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.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.setDataOutlineProperties
(DrawItem dataOutlineProperties) Properties for lines that outline a data shape (in filled charts such as area or radar charts).setDataPageSize
(int dataPageSize) When usingdata paging
, how many records to fetch at a time.setDataPointProperties
(DrawItem dataPointProperties) Common properties to apply for all data points (seeshowDataPoints
).setDataPointSize
(int dataPointSize) Size in pixels for data points drawn for line, area, radar and other chart types.setDataShapeProperties
(DrawPath dataShapeProperties) Properties for data shapes (filled areas in area or radar charts).setDataSource
(DataSource dataSource) The DataSource that this component should bind to for default fields and for performingDataSource requests
.setDataSource
(String dataSource) The DataSource that this component should bind to for default fields and for performingDataSource requests
.void
setDataValueFormatter
(ValueFormatter formatter) Formatter to apply to values displayed in the hover labels and other value labelssetDataValueHoverShadow
(Shadow dataValueHoverShadow) WhenhighlightDataValues
is true, this attribute can be set to aDrawItem shadow
to show around the draw-area of nearby filled data-value shapes as the mouse is moved around in Bar, Column, Pie and Doughnutchart-types
.setDecimalPrecision
(int decimalPrecision) Default precision used when formatting float numbers for axis labelssetDeepCloneOnEdit
(Boolean deepCloneOnEdit) Before we start editing values in this DataBoundComponent, should we perform a deep clone of the underlying values.static void
setDefaultProperties
(FacetChart facetChartProperties) Class level method to set the default properties of this class.setDiscontinuousLines
(Boolean discontinuousLines) Whether to treat non-numeric values in the dataset as indicating a break in the data line.setDoughnutHoleProperties
(DrawOval doughnutHoleProperties) Properties for doughnut holesetDoughnutRatio
(float doughnutRatio) If showing a doughnut hole (seeshowDoughnut
), ratio of the size of the doughnut hole to the size of the overall pie chart, as a number between 0 to 1.setDragDataAction
(DragDataAction dragDataAction) Indicates what to do with data dragged into another DataBoundComponent.setDragDataCustomizer
(DragDataCustomizer customizer) During a drag-and-drop interaction, this method returns the set of records being dragged out of the component.setDragTrackerStyle
(String dragTrackerStyle) CSS Style to apply to the drag tracker when dragging occurs on this component.setDrawLegendBoundary
(Boolean drawLegendBoundary) Whether a boundary should be drawn above the Legend area for circumstances where the chart area already has an outer border.setDrawTitleBackground
(Boolean drawTitleBackground) should a background color be set behind the Title.setDrawTitleBoundary
(Boolean drawTitleBoundary) Whether a boundary should be drawn below the title area for circumstances where the chart area already has an outer border.setDropValues
(Map dropValues) When an item is dropped on this component, andaddDropValues
is true and both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key, this object provides the "drop values" that Smart GWT will apply to the dropped object before updating it.setDuplicateDragMessage
(String duplicateDragMessage) Message to show when a user attempts to transfer duplicate records into this component, and
preventDuplicates
is enabled.setEditFormulaFieldText
(String editFormulaFieldText) Text for a menu item allowing users to edit a formula fieldsetEditProxyConstructor
(String editProxyConstructor) Default class used to construct theEditProxy
for this component when the component isfirst placed into edit mode
.setEditSummaryFieldText
(String editSummaryFieldText) Text for a menu item allowing users to edit the formatter for a fieldsetEndValueMetric
(String endValueMetric) Specifies the attribute in the metric facet that will define the end point of segments in a histogram chart.setErrorBarColorMutePercent
(float errorBarColorMutePercent) This property helps specify the color of the error bars and its value must be a number between -100 and 100.setErrorBarWidth
(int errorBarWidth) Width of the horizontal line of the "T"-shape portion of the error bar).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).setExpectedValueLineProperties
(DrawItem expectedValueLineProperties) Properties for theline drawn at the mean value
.setExportAll
(Boolean exportAll) Setting exportAll to true prevents the component from passing its list of fields to the 
 export call.setExportFields
(String[] exportFields) The list of field-names to export.setExportIncludeSummaries
(Boolean exportIncludeSummaries) If Summary rows exist for this component, whether to include them when exporting client data.setExtraAxisLabelAlign
(Alignment extraAxisLabelAlign) Horizontal alignment of labels shown in extra y-axes, shown to the right of the chart.setExtraAxisMetrics
(String... extraAxisMetrics) Defines the set of metrics that will be plotted as additional vertical axes.setExtraAxisSettings
(MetricSettings... extraAxisSettings) For charts will multiple vertical axes, optionally provides settings for how eachextra axis metric
is plotted.setFacetFields
(String facetFields) Specifies whatDataSource
fields to use as the chartfacets
for a databound chart.setFacetFields
(String... facetFields) Specifies whatDataSource
fields to use as the chartfacets
for a databound chart.An Array of facets, exactly analogous toCubeGrid.facets
, except that: the "inlinedValues" property can be set on a facet to change data representation as described under Chart.data.An Array of facets, exactly analogous toCubeGrid.facets
, except that: the "inlinedValues" property can be set on a facet to change data representation as described under Chart.data.setFetchOperation
(String fetchOperation) Operation ID this component should use when performing fetch operations.setFetchRequestProperties
(DSRequest fetchRequestProperties) IfautoFetchData
istrue
, this attribute allows the developer to declaratively specifyDSRequest
properties for the initialfetchData()
call.setFields
(JavaScriptObject... fields) Field setter variant (alternative tosetFields(FormItem...)
,setFields(ListGridField...)
, etc.) that will accept an array of JavaScriptObject, rather than an array of SmartGWT Java wrappers of the field class type (e.g.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.setFormatStringFacetValueIds
(Boolean formatStringFacetValueIds) Whether to callsetXAxisValueFormatter()
orformatFacetValueId()
on a facet value id when the id is a string.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.setGradationLabelPadding
(int gradationLabelPadding) Padding from edge of Y the Axis Label.setGradationLabelProperties
(DrawLabel gradationLabelProperties) Properties for gradation labelssetGradationLineProperties
(DrawLine gradationLineProperties) Properties for gradation linessetGradationTickMarkLength
(Integer gradationTickMarkLength) Deprecated.usetickLength
insteadsetGradationZeroLineProperties
(DrawLine gradationZeroLineProperties) Properties for the gradation line drawn for zero (slightly thicker by default).setHighErrorMetric
(String highErrorMetric) SeelowErrorMetric
.setHighlightDataValues
(Boolean highlightDataValues) Should the draw-area of nearby filled data-value shapes be highlighted as the mouse is moved over somechart-types
?setHiliteProperty
(String hiliteProperty) Marker that can be set on a record to flag that record as hilited.setHilites
(Hilite[] hilites) Accepts an array of hilite objects and applies them to this DataBoundComponent.setHiliteState
(String hiliteState) Set the current hilites based on a hiliteState String previously returned from getHilitesState.setHoverLabelPadding
(int hoverLabelPadding) An extra amount of padding to show around thehoverLabel
whenshowValueOnHover
is enabled.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 whenshowValueOnHover
is enabled.setHoverRectProperties
(DrawRect hoverRectProperties) Properties for rectangle that draws behind of a floating hover label that represents the data value.setImplicitCriteria
(Criteria implicitCriteria) Criteria that are never shown to or edited by the user and are cumulative with any criteria provided viaDataBoundComponent.initialCriteria
,DataBoundComponent.setCriteria()
etc.setImplicitCriteria
(Criteria implicitCriteria, DSCallback callback) setImplicitCriteria
(Criteria criteria, DSCallback callback, Boolean initialFetch) setInitialCriteria
(Criteria initialCriteria) Criteria to use whenDataBoundComponent.setAutoFetchData(Boolean)
is used.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 - seeLabelCollapseMode
.setLegendAlign
(LegendAlign legendAlign) Horizontal alignment of the chart'slegend widget
.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.setLegendItemPadding
(int legendItemPadding) Padding between each swatch and label pair.setLegendLabelProperties
(DrawLabel legendLabelProperties) Properties for labels shown next to legend color swatches.setLegendMargin
(int legendMargin) Space between the legend and the chart rect or axis labels (whatever the legend is adjacent to.setLegendPadding
(int legendPadding) Padding around the legend as a whole.setLegendRectHeight
(int legendRectHeight) If drawing a border around the legend, the height of the drawn Rectangle.setLegendRectProperties
(DrawRect legendRectProperties) Properties for rectangle around the legend as a whole.setLegendSwatchProperties
(DrawRect legendSwatchProperties) Properties for the swatches of color shown in the legend.setLegendSwatchSize
(int legendSwatchSize) Size of individual color swatches in legend.setLegendTextPadding
(int legendTextPadding) Padding between color swatch and its label.setLogBase
(int logBase) WhenuseLogGradations
, base value for logarithmic gradation lines.setLogGradations
(float... logGradations) WhenuseLogGradations
is set, gradation lines to show in between powers, expressed as a series of integer or float values between 1 andlogBase
.Setter implementing theLogicalStructure
interface, which supports Eclipse's logical structure debugging facility.setLogScale
(Boolean logScale) Whether to use logarithmic scaling for values.setLogScalePointColor
(boolean logScalePointColor) Whether to use logarithmic scaling for thecolor scale
of the data points.setLogScalePointSize
(boolean logScalePointSize) Whether to use logarithmic scaling for thedata point sizes
.setLowErrorMetric
(String lowErrorMetric) lowErrorMetric
andhighErrorMetric
can be used to cause error bars to appear above and below the main data point.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).setMajorTickTimeIntervals
(String... majorTickTimeIntervals) When ticks are beingshown 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.setMatchBarChartDataLineColor
(Boolean matchBarChartDataLineColor) Setting to define whether the border around the bar chart area should be the same color as the main chart area.setMaxBarThickness
(int maxBarThickness) Bars will not be drawn over this thickness, instead, margins will be increased.setMaxDataPointSize
(double maxDataPointSize) The maximum allowed data point size when controlled bypointSizeMetric
.setMaxDataZIndex
(Integer maxDataZIndex) Maximum allowed zIndex that can be specified throughzIndexMetric
in a histogram chart.setMetricFacetId
(String metricFacetId) Specifies the "id" of the default metric facet value.setMinBarThickness
(int minBarThickness) If bars would be smaller than this size, margins are reduced until bars overlap.setMinChartHeight
(Integer minChartHeight) Minimum height for this chart instance.setMinChartWidth
(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 specifieddata label facet
value.setMinContentHeight
(int minContentHeight) WhenautoScrollContent
is true, limits the minimum height of the chart-content, including data, labels, title and legends.setMinContentWidth
(int minContentWidth) WhenautoScrollContent
is true, limits the minimum width of the chart-content, including data, labels, titles and legends.setMinDataPointSize
(double minDataPointSize) The minimum allowed data point size when controlled bypointSizeMetric
.setMinDataSpreadPercent
(int minDataSpreadPercent) If all data values would be spread across less thanminDataSpreadPercent
of the axis, the start values of axes will be automatically adjusted to make better use of space.setMinLabelGap
(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 thelabelCollapseMode
.setMinorTickLength
(int minorTickLength) Length of minor ticks marks shown along axis, ifminor tick marks
are enabled.setMinXDataSpreadPercent
(int minXDataSpreadPercent) For scatter charts only, if all data points would be spread across less thanminXDataSpreadPercent
of the x-axis, the start value of x-axis will be automatically adjusted to make better use of space.setOtherAxisGradationGaps
(float... otherAxisGradationGaps) LikegradationGaps
, except allows control of gradations for the X (horizontal) axis, for Scatter charts only.setOtherAxisGradationTimes
(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.setOtherAxisPixelsPerGradation
(Integer otherAxisPixelsPerGradation) Ideal number of pixels to leave between each gradation on the x (horizontal axis), for Scatter plots only.setOuterLabelFacetLineProperties
(DrawLine outerLabelFacetLineProperties) Properties for the lines drawn to show the span of outer data label facet values, if present.setPadChartRectByCornerRadius
(boolean padChartRectByCornerRadius) IfshowChartRect
is enabled and ifchartRectProperties
specifies a nonzerorounding
, whether the padding around the inside of the chart rect.setPieBorderProperties
(DrawOval pieBorderProperties) Properties for the border around a pie chart.setPieLabelAngleStart
(int pieLabelAngleStart) Angle where first label is placed in a Pie chart in stacked mode, in degrees.setPieLabelLineExtent
(int pieLabelLineExtent) How far label lines stick out of the pie radius in a Pie chart in stacked mode.setPieLabelLineProperties
(DrawLine pieLabelLineProperties) Properties for pie label linesetPieRingBorderProperties
(DrawOval pieRingBorderProperties) Properties for pie ring bordersetPieSliceProperties
(DrawSector pieSliceProperties) Properties for pie slicessetPieStartAngle
(Integer pieStartAngle) Default angle in degrees where pie charts start drawing sectors to represent data values.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
Apply a handler to fire whenshowDataPoints
is true, and the user clicks on a point.setPointColorLogBase
(Integer pointColorLogBase) WhenlogScalePointColor
istrue
, this property specifies the base value for logarithmiccolor scale metric
values.void
setPointHoverCustomizer
(ChartPointHoverCustomizer hoverCustomizer) Display custom HTML whenshowDataPoints
is true and the mouse hovers over a point.setPointShapes
(PointShape... pointShapes) For charts whereshowDataPoints
is enabled, this property specifies an array of geometric shapes to draw for the data points of each series.setPointSizeGradations
(Integer pointSizeGradations) When apoint size legend
is shown, this property controls the number of gradations of thepointSizeMetric
that the chart tries to display.setPointSizeLogBase
(Integer pointSizeLogBase) WhenlogScalePointSize
is true, base value for logarithmic point size metric values.setPointSizeLogGradations
(float... pointSizeLogGradations) WhenusePointSizeLogGradations
is set, this property specifies thepointSizeMetric
value gradations to show in thepoint size legend
in between powers, expressed as a series of integer or float values between 1 andpointSizeLogBase
.setPointSizeMetric
(String pointSizeMetric) For charts whereshowDataPoints
is enabled, this property specifies an additional metric (i.e.setPreventDuplicates
(Boolean preventDuplicates) If set, detect and prevent duplicate records from being transferred to this component, either via
 drag and drop or viaDataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent)
.setPrintZoomChart
(boolean printZoomChart) Should thezoom chart
be printed with thisFacetChart
? Iftrue
, then the SVG string returned byDrawPane.getSvgString()
will include the zoom chart's SVG as well.setProbabilityMetric
(String probabilityMetric) The "id" of the metric facet value that assigns a probability to each combination of facets and their values.setProgressiveLoading
(Boolean progressiveLoading) Indicates whether or not this component will load its dataprogressively
setProportional
(Boolean proportional) For multi-facet charts, render data values as a proportion of the sum of all data values that have the same label.setProportionalAxisLabel
(String proportionalAxisLabel) Default title for the value axis label when the chart is inproportional rendering mode
.setRadarBackgroundProperties
(DrawOval radarBackgroundProperties) Properties for radar backgroundsetRadarRotateLabels
(LabelRotationMode radarRotateLabels) This property controls whether to rotate the labels on thedata label facet
of radar orstacked
pie charts so that each label is parallel to its radial gradation (these are the labels that appear around the perimeter).setRadialLabelOffset
(Integer radialLabelOffset) Distance in pixels that radial labels are offset from the outside of the circle.setRegressionLineProperties
(DrawLine regressionLineProperties) Properties for theregression line
.setRegressionLineType
(RegressionLineType regressionLineType) Regression algorithm used for theregression line
.setRegressionPolynomialDegree
(int regressionPolynomialDegree) For scatter plots only, specify the degree of polynomial to use for any polynomial regression that is calculated.setRemoveOperation
(String removeOperation) operationId
this component should use when performing remove operations.setRotateDataValues
(LabelRotationMode rotateDataValues) This property controls whether to rotate the labels shown for data-values inColumn-type charts
.setRotateLabels
(LabelRotationMode rotateLabels) This property controls whether to rotate the labels on the X-axis.setSavedSearchId
(String savedSearchId) Optional identifier for saved searches that should be applied to this component.setScaleEndColor
(String scaleEndColor) The ending color of the color scale when the data points are colored according to acolor scale metric
.setScaleStartColor
(String scaleStartColor) The starting color of the color scale when the data points are colored according to acolor scale metric
.setShadowProperties
(DrawOval shadowProperties) Properties for shadows.setShowBubbleLegendPerShape
(boolean showBubbleLegendPerShape) Whether to draw multiple bubble legends horizontally stacked to the right of the chart, one per shape type.setShowChartRect
(Boolean showChartRect) Whether to show a rectangular shape around the area of the chart where data is plotted.setShowColorScaleLegend
(Boolean showColorScaleLegend) Whether to show an additional legend underneath the chart to indicate color values.setShowComplexFields
(Boolean showComplexFields) Whether to show fields of non-atomic types when a DataBoundComponent is given a
 DataSource but nocomponent.fields
.
setShowDataAxisLabel
(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).setShowDataLabels
(boolean showDataLabels) If set tofalse
, data labels for values are entirely omitted.setShowDataPoints
(Boolean showDataPoints) For Line, Area, Radar, Scatter or Bubble charts, whether to show data points for each individual data value.setShowDataValues
(boolean showDataValues) Deprecated.in favor ofshowDataValuesMode
, a compound setting that supports showing data-values in the chart and in hovers in various combinations.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, includingautomatic rotation
where supported.setShowDetailFields
(Boolean showDetailFields) ThisDataBoundComponent
property is not applicable to charts.setShowDoughnut
(Boolean showDoughnut) Whether to show a "doughnut hole" in the middle of pie charts.setShowExpectedValueLine
(Boolean showExpectedValueLine) Display a line at themean value
.setShowGradationsOverData
(Boolean showGradationsOverData) If set, gradation lines are drawn on top of data rather than underneath.setShowHiddenFields
(Boolean showHiddenFields) Whether to show fields markedhidden:true
when a DataBoundComponent is given a
 DataSource but nocomponent.fields
.
setShowInlineLabels
(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.setShowLegend
(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.setShowMinorTicks
(boolean showMinorTicks) Ifticks
are being shown, controls whether a distinction is made between major and minor tick marks.setShowPointSizeLegend
(Boolean showPointSizeLegend) Whether to show an additional legend to the right of the chart to indicatepoint size
.setShowRadarGradationLabels
(Boolean showRadarGradationLabels) Whether to show gradation labels in radar charts.setShowRegressionLine
(Boolean showRegressionLine) For scatter plots only, whether to display a regression curve that best fits the data of the two metric facet values.setShowSavedSearchesByDS
(boolean showSavedSearchesByDS) Whether to associate saved searches by default with the currentDataSource
of a component when asavedSearchId
is not provided.setShowScatterLines
(Boolean showScatterLines) Whether to draw lines between adjacent data points in "Scatter" plots.setShowShadows
(Boolean showShadows) Whether to automatically show shadows for various charts.setShowStandardDeviationLines
(Boolean showStandardDeviationLines) Display multiplestandard deviations
away from the mean as lines.setShowStatisticsOverData
(Boolean showStatisticsOverData) If set, themean line
,standard deviation lines
,standard deviation bands
, andregression curves
are drawn on top of the data rather than underneath.setShowTitle
(Boolean showTitle) Whether to show a title.setShowValueAxisLabel
(Boolean showValueAxisLabel) Whether to show thevalueTitle
(or, in the case ofproportional rendering mode
, theproportionalAxisLabel
) as a label on the value axis.setShowValueOnHover
(Boolean showValueOnHover) Deprecated.in favor ofshowDataValuesMode
, a compound setting that supports showing data-values in the chart and in hovers in various combinations.setShowXTicks
(boolean showXTicks) When set, ticks are shown for the X (horizontal) axis for Scatter plots or Bar charts.setShowYTicks
(boolean showYTicks) When set, ticks are shown for the Y (vertical) axis if it's a value axis.setSort
(SortSpecifier... sortSpecifiers) Sort the component on one or more fields.setSparseFieldState
(Boolean sparseFieldState) If true,ListGrid.getFieldState()
andListGrid.setFieldState(java.lang.String)
will omit state information for hidden fields by default.setStacked
(Boolean stacked) Whether to use stacking for charts where this makes sense (column, area, pie, line and radar charts).setStandardDeviationBandProperties
(DrawItem... standardDeviationBandProperties) An Array of DrawRect properties to specify the bands between thestandard deviation lines
.setStandardDeviationLineProperties
(DrawItem standardDeviationLineProperties) Properties for thestandard deviation lines
.setStandardDeviations
(float... standardDeviations) WhenshowStandardDeviationLines
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
(String styleName) Default styleName for the chart.setTickLength
(int tickLength) Length of the tick marks used when eithershowXTicks
orshowYTicks
is enabled, or whenextra value axes
are in use.setTickMarkToValueAxisMargin
(int tickMarkToValueAxisMargin) Margin between the tick marks and the labels of theextra value axes
.void
Title for the chart as a whole.setTitleAlign
(TitleAlign titleAlign) Horizontal alignment of the chart'stitle
with respect to the the visible chart-width.setTitleBackgroundProperties
(DrawLabel titleBackgroundProperties) Properties for title background (if being drawn).setTitleBoundaryProperties
(DrawLine titleBoundaryProperties) Properties for bottom boundary of the title area, when there is already an outer container around the whole chart.setTitleField
(String titleField) Sets the best field to use for a user-visible title for an individual record from this component.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 edgesetTitleProperties
(DrawLabel titleProperties) Properties for title label.setTitleRectHeight
(int titleRectHeight) The height of the bordered rect around the title - defaults to 0 (assuming no border)setUpdateOperation
(String updateOperation) operationId
this component should use when performing update operations.setUseAllDataSourceFields
(Boolean useAllDataSourceFields) If true, the set of fields given by the "default binding" (see 
fields
) is used, with any fields specified in
component.fields
acting as overrides that can suppress or modify the
 display of individual fields, without having to list the entire set of fields that
 should be shown.
setUseAutoGradients
(Boolean useAutoGradients) Causes the chart to use the colors specified indataColors
but specify chart-specific gradients based on the primary data color per chart type.setUseFlatFields
(Boolean useFlatFields) TheuseFlatFields
flag causes all simple type fields anywhere in a nested
 set of DataSources to be exposed as a flat list for form binding.setUseLogGradations
(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.setUseMultiplePointShapes
(Boolean useMultiplePointShapes) Whether the chart should use multiple shapes to show data points.setUsePointSizeLogGradations
(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 thepointSizeMetric
values displayed in thepoint size legend
.setUseSymmetricStandardDeviations
(Boolean useSymmetricStandardDeviations) Whether to display both the positive and negative of thestandard deviations
.setValueAxisLabelProperties
(DrawLabel valueAxisLabelProperties) Properties for labels of value axis.setValueAxisMargin
(int valueAxisMargin) Margin betweenmultiple value axes
.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.setValueProperty
(String valueProperty) Property in each record that holds a data value.setValueTitle
(String valueTitle) A label for the data values, such as "Sales in Thousands", typically used as the label for the value axis.setXAxisEndValue
(Double xAxisEndValue) For Bubble and Scatter charts only, the end value for the x-axis.setXAxisEndValue
(Date xAxisEndValue) For Bubble and Scatter charts only, the end value for the x-axis.setXAxisMetric
(String xAxisMetric) For scatter charts only, the "id" of the metric facet value to use for the x-axis.setXAxisStartValue
(Double xAxisStartValue) For Bubble and Scatter charts only, the start value for the x-axis.setXAxisStartValue
(Date 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.setYAxisLabelAlign
(Alignment yAxisLabelAlign) Horizontal alignment of y-axis labels, shown to the left of the chart.setYAxisLabelPadding
(int yAxisLabelPadding) Padding between each swatch and label pair.setYAxisMetric
(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.setZIndexMetric
(String zIndexMetric) Specifies the attribute in the metric facet that will define the z-ordering of the segments in a histogram chart.setZoomChartHeight
(double zoomChartHeight) Height of thezoomChart
.setZoomChartProperties
(FacetChart zoomChartProperties) Properties to further configure thezoomChart
.void
setZoomEndValue
(Object zoomEndValue) For azoomed chart
, end value of the data range shown in the main chart.setZoomLogScale
(Boolean zoomLogScale) setZoomMutePercent
(float zoomMutePercent) colorMutePercent
to use for thezoomChart
.setZoomSelectionChartProperties
(FacetChart zoomSelectionChartProperties) Properties to further configure thezoomSelectionChart
.setZoomShowSelection
(Boolean zoomShowSelection) Whether the selected range should be shown in a different style, which can be configured viazoomSelectionChartProperties
.setZoomStartPosition
(ZoomStartPosition zoomStartPosition) For azoomed chart
, determines what portion of the overall dataset should be initially shown in the main chart.void
setZoomStartValue
(Object zoomStartValue) For azoomed chart
, start value of the data range shown in the main chart.void
transferRecords
(Record[] records, Record targetRecord, Integer index, Canvas sourceWidget, TransferRecordsCallback callback) Transfer a list ofRecord
s from another component (does not have to be a databound component) into this component.void
Simulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction.void
transferSelectedData
(DataBoundComponent source, int index) Simulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction.void
Methods inherited from class com.smartgwt.client.widgets.drawing.DrawPane
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
Methods inherited from class com.smartgwt.client.widgets.Canvas
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, dataContextChanged, 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, getAriaStateDefaults, getAutoMaskComponents, getAutoParent, getAutoPopulateData, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBorderRadius, 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, getDataContext, getDataPath, getDefaultHeight, getDefaultWidth, getDefiningProperty, getDefiningPropertyName, getDefiningPropertyNameOptions, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragTargetAsString, getDragType, getDropTarget, getDropTargetAsString, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFloatingScrollbars, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupPadding, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverPersist, getHoverScreen, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlElementAsString, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeaveGroupLabelSpace, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateByIDOnly, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMatchElementHeight, getMatchElementWidth, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNativeAutoHideScrollbars, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPendingMarkerStyle, getPendingMarkerVisible, getPercentBox, getPercentSource, getPersistentMatchElement, getPointerSettings, getPointerTarget, getPointerTargetAsString, 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, getShowPointer, 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, getTestDataContext, getTestInstance, getTooltip, getTop, getTopAsString, getTopElement, getUISummary, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getWorkflows, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, initComplete, 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, resizeControlsTo, resizeFonts, resizeFonts, resizeFonts, resizeFontsTo, 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, setAutoPopulateData, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorderRadius, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataContext, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDefiningProperty, setDefiningPropertyNameOptions, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragTarget, setDragType, setDropTarget, setDropTarget, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setFloatingScrollbars, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupPadding, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverPersist, setHoverScreen, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeaveGroupLabelSpace, setLeavePageSpace, setLeft, setLeft, setLocateByIDOnly, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLocatorParent, setLocatorParent, setLogicalStructure, setMargin, setMatchElement, setMatchElementHeight, setMatchElementWidth, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNativeAutoHideScrollbars, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPendingMarkerStyle, setPendingMarkerVisible, setPercentBox, setPercentSource, setPersistentMatchElement, setPointerSettings, setPointerTarget, 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, setShowPointer, 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, setTestDataContext, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setWorkflows, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPendingMarker, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, startDebuggingOverflow, stopDebuggingOverflow, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDrop
Methods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, addDynamicProperty, 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
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.smartgwt.client.widgets.DataBoundComponent
getOrCreateJsObj
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
Constructor Details
-
FacetChart
public FacetChart() -
FacetChart
-
-
Method Details
-
getOrCreateRef
-
changeAutoChildDefaults
Changes the defaults for Canvas AutoChildren namedautoChildName
.- Parameters:
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, seeSGWTProperties
.- See Also:
-
changeAutoChildDefaults
Changes the defaults for FormItem AutoChildren namedautoChildName
.- Parameters:
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, seeSGWTProperties
.- See Also:
-
create
-
setAllowBubbleGradients
public FacetChart setAllowBubbleGradients(boolean allowBubbleGradients) throws IllegalStateException Setting this flag tofalse
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.- Parameters:
allowBubbleGradients
- New allowBubbleGradients value. Default value is !(isc.Browser.isIE && isc.Browser.version <= 8)- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getAllowBubbleGradients
public boolean getAllowBubbleGradients()Setting this flag tofalse
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.- Returns:
- Current allowBubbleGradients value. Default value is !(isc.Browser.isIE && isc.Browser.version <= 8)
- See Also:
-
setAllowedChartTypes
Otherchart 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 eithercanZoom
is enabled, or if the chart ismulti-axis
.- Parameters:
allowedChartTypes
- New allowedChartTypes value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls
-
getAllowedChartTypes
Otherchart 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 eithercanZoom
is enabled, or if the chart ismulti-axis
.- Returns:
- Current allowedChartTypes value. Default value is null
-
setAutoRotateLabels
Deprecated.As of Smart GWT 9.0 this property is replaced by the propertyrotateLabels
. Setting rotateLabels to "auto" is equivalent to setting autoRotateLabels totrue
. Setting rotateLabels to "never" is equivalent to setting autoRotateLabels tofalse
.Whether to automatically rotate labels if needed in order to make them legible and non-overlapping.- Parameters:
autoRotateLabels
- New autoRotateLabels value. Default value is true- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getAutoRotateLabels
Deprecated.As of Smart GWT 9.0 this property is replaced by the propertyrotateLabels
. Setting rotateLabels to "auto" is equivalent to setting autoRotateLabels totrue
. Setting rotateLabels to "never" is equivalent to setting autoRotateLabels tofalse
.Whether to automatically rotate labels if needed in order to make them legible and non-overlapping.- Returns:
- Current autoRotateLabels value. Default value is true
-
setAutoScrollContent
When set to true, introduces scrollbars when this widget is smaller than the specified chart-content minimumwidth
orheight
. 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: SetsautoScrollContent
and updates the chart.- Parameters:
autoScrollContent
- whether the chart should automatically show scrollbars when it's size is smaller than the minimum contentwidth
orheight
. Default value is false- Returns:
FacetChart
instance, for chaining setter calls
-
getAutoScrollContent
public boolean getAutoScrollContent()When set to true, introduces scrollbars when this widget is smaller than the specified chart-content minimumwidth
orheight
. 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.- Returns:
- Current autoScrollContent value. Default value is false
-
setAutoScrollData
For somechart-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 theminimum 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" ifautoScrollData
has been set. If any of the other properties have non-default values, a warning will be logged andautoScrollData
will be disabled. The factors used to drive expansion can be limited by settingAutoScrollDataApproach
. You can also enforce a minimum size for the chart-content, and scrollbars will be introduced if this widget shrinks below that size. SeeautoScrollContent
, along withminContentWidth
andminContentHeight
.
If this method is called after the component has been drawn/initialized: SetsautoScrollData
and updates the chart.- Parameters:
autoScrollData
- whether chart should automatically expand and show scrollbars to accommodate content. Default value is false- Returns:
FacetChart
instance, for chaining setter calls- See Also:
-
setCanZoom(java.lang.Boolean)
setRotateLabels(com.smartgwt.client.types.LabelRotationMode)
LabelCollapseMode
com.smartgwt.client.widgets.chart.FacetChart#getMinClusterSize
DrawPane.setCanDragScroll(boolean)
-
getAutoScrollData
public boolean getAutoScrollData()For somechart-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 theminimum 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" ifautoScrollData
has been set. If any of the other properties have non-default values, a warning will be logged andautoScrollData
will be disabled. The factors used to drive expansion can be limited by settingAutoScrollDataApproach
. You can also enforce a minimum size for the chart-content, and scrollbars will be introduced if this widget shrinks below that size. SeeautoScrollContent
, along withminContentWidth
andminContentHeight
.- Returns:
- Current autoScrollData value. Default value is false
- See Also:
-
getCanZoom()
getRotateLabels()
LabelCollapseMode
com.smartgwt.client.widgets.chart.FacetChart#getMinClusterSize
DrawPane.getCanDragScroll()
-
setAutoScrollDataApproach
If set, overrides the default behavior ofautoScrollData
, 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 setminLabelGap
to gain more control over the separation.)
If this method is called after the component has been drawn/initialized: SetsAutoScrollDataApproach
and updates the chart.- Parameters:
autoScrollDataApproach
- what should drive horizontal expansion of the chart?. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- See Also:
-
getAutoScrollDataApproach
If set, overrides the default behavior ofautoScrollData
, 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 setminLabelGap
to gain more control over the separation.)- Returns:
- Current autoScrollDataApproach value. Default value is null
- See Also:
-
setAutoSortBubblePoints
public FacetChart setAutoSortBubblePoints(boolean autoSortBubblePoints) throws IllegalStateException Whether to draw data points in order of descendingpoint size
so that small values are less likely to be completely occluded by larger values. Set this tofalse
to draw the data points in the same order that they appear in the data.- Parameters:
autoSortBubblePoints
- New autoSortBubblePoints value. Default value is true- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getAutoSortBubblePoints
public boolean getAutoSortBubblePoints()Whether to draw data points in order of descendingpoint size
so that small values are less likely to be completely occluded by larger values. Set this tofalse
to draw the data points in the same order that they appear in the data.- Returns:
- Current autoSortBubblePoints value. Default value is true
- See Also:
-
setAxisEndValue
End value for the primary axis of the chart.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 viaMetricSettings.xAxisEndValue
. For Scatter charts, thexAxisEndValue
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.- Parameters:
axisEndValue
- New axisEndValue value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getAxisEndValue
End value for the primary axis of the chart.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 viaMetricSettings.xAxisEndValue
. For Scatter charts, thexAxisEndValue
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.- Returns:
- Current axisEndValue value. Default value is null
-
setAxisStartValue
Start value for the primary axis of the chart.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 viaMetricSettings.axisStartValue
. For Scatter charts, thexAxisStartValue
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.- Parameters:
axisStartValue
- New axisStartValue value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getAxisStartValue
Start value for the primary axis of the chart.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 viaMetricSettings.axisStartValue
. For Scatter charts, thexAxisStartValue
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.- Returns:
- Current axisStartValue value. Default value is null
-
setBackgroundBandProperties
public FacetChart setBackgroundBandProperties(DrawRect backgroundBandProperties) throws IllegalStateException Properties for background band- Parameters:
backgroundBandProperties
- New backgroundBandProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getBackgroundBandProperties
Properties for background band- Returns:
- Current backgroundBandProperties value. Default value is null
-
setBandedBackground
Whether to show alternating color bands in the background of chart. SeebackgroundBandProperties
.- Parameters:
bandedBackground
- New bandedBackground value. Default value is true- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getBandedBackground
Whether to show alternating color bands in the background of chart. SeebackgroundBandProperties
.- Returns:
- Current bandedBackground value. Default value is true
-
setBandedStandardDeviations
public FacetChart setBandedStandardDeviations(Boolean bandedStandardDeviations) throws IllegalStateException Whether to show color bands between thestandard deviation
lines.Standard deviation bands are not available for pie or radar charts.
- Parameters:
bandedStandardDeviations
- New bandedStandardDeviations value. Default value is false- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getBandedStandardDeviations
Whether to show color bands between thestandard deviation
lines.Standard deviation bands are not available for pie or radar charts.
- Returns:
- Current bandedStandardDeviations value. Default value is false
- See Also:
-
com.smartgwt.client.widgets.chart.FacetChart#getStandardDeviationBandProperties
-
setBarMargin
Distance between bars. May be reduced if bars would be smaller thanminBarThickness
.- Parameters:
barMargin
- New barMargin value. Default value is 4- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getBarMargin
public int getBarMargin()Distance between bars. May be reduced if bars would be smaller thanminBarThickness
.- Returns:
- Current barMargin value. Default value is 4
-
setBarProperties
Properties for bar- Parameters:
barProperties
- New barProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- See Also:
-
getBarProperties
Properties for bar- Returns:
- Current barProperties value. Default value is null
-
setBrightenAllOnHover
WhenhighlightDataValues
is true, should the whole draw-area of the data-value be brightened bya percentage
, or just its border?By default, only the border around the draw-area is brightened.
Only affects Bar, Column, Pie and Doughnut
chart-types
.- Parameters:
brightenAllOnHover
- New brightenAllOnHover value. Default value is false- Returns:
FacetChart
instance, for chaining setter calls
-
getBrightenAllOnHover
WhenhighlightDataValues
is true, should the whole draw-area of the data-value be brightened bya percentage
, or just its border?By default, only the border around the draw-area is brightened.
Only affects Bar, Column, Pie and Doughnut
chart-types
.- Returns:
- Current brightenAllOnHover value. Default value is false
-
setBrightenPercent
WhenhighlightDataValues
is true, sets the percentage by which to brighten filled data-shapes in somechart-types
as the mouse is moved over the chart. Affects Bar, Column, Pie and Doughnut charts, and will brighten either the shape's fill-color or its border-color, depending on the value ofbrightenAllOnHover
.Valid values are between 0 and 100, inclusive.
The property default may vary based on the currently loaded skin.
- Parameters:
brightenPercent
- New brightenPercent value. Default value is 30- Returns:
FacetChart
instance, for chaining setter calls- See Also:
-
getBrightenPercent
public int getBrightenPercent()WhenhighlightDataValues
is true, sets the percentage by which to brighten filled data-shapes in somechart-types
as the mouse is moved over the chart. Affects Bar, Column, Pie and Doughnut charts, and will brighten either the shape's fill-color or its border-color, depending on the value ofbrightenAllOnHover
.Valid values are between 0 and 100, inclusive.
The property default may vary based on the currently loaded skin.
- Returns:
- Current brightenPercent value. Default value is 30
- See Also:
-
setBubbleHoverMaxDistance
public FacetChart setBubbleHoverMaxDistance(int bubbleHoverMaxDistance) throws IllegalStateException Maximum distance from the *outer radius* of the nearest bubble when hover will be shown.- Parameters:
bubbleHoverMaxDistance
- New bubbleHoverMaxDistance value. Default value is 50- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getBubbleHoverMaxDistance
public int getBubbleHoverMaxDistance()Maximum distance from the *outer radius* of the nearest bubble when hover will be shown.- Returns:
- Current bubbleHoverMaxDistance value. Default value is 50
- See Also:
-
setBubbleProperties
Properties for the shapes displayed around the data points (for example, in a bubble chart).When either the
pointSizeMetric
or thecolorScaleMetric
is active the defaultbubbleProperties
displays each data points with a linear gradient.- Parameters:
bubbleProperties
- New bubbleProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getBubbleProperties
Properties for the shapes displayed around the data points (for example, in a bubble chart).When either the
pointSizeMetric
or thecolorScaleMetric
is active the defaultbubbleProperties
displays each data points with a linear gradient.- Returns:
- Current bubbleProperties value. Default value is null
- See Also:
-
setCanMoveAxes
Whether the positions of value axes can be changed. The default is true for charts with three or more vertical, value axes.- Parameters:
canMoveAxes
- New canMoveAxes value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getCanMoveAxes
Whether the positions of value axes can be changed. The default is true for charts with three or more vertical, value axes.- Returns:
- Current canMoveAxes value. Default value is null
- See Also:
-
setCanZoom
Enables "zooming" on the X axis, specifically, only a portion of the overall dataset is shown in the main chart, and asecond 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.- Parameters:
canZoom
- New canZoom value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getCanZoom
Enables "zooming" on the X axis, specifically, only a portion of the overall dataset is shown in the main chart, and asecond 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.- Returns:
- Current canZoom value. Default value is null
-
setCenterLegend
Deprecated.Alignment of legend and title elements is now always relative to the visible chart-width, and not the full scrollable-width, so that both elements are always on-screen for any alignmentWhether to place thechart legend
with respect to the full, scrollable width of the chart whenautoScrollData
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.
- Parameters:
centerLegend
- New centerLegend value. Default value is false- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getCenterLegend
Deprecated.Alignment of legend and title elements is now always relative to the visible chart-width, and not the full scrollable-width, so that both elements are always on-screen for any alignmentWhether to place thechart legend
with respect to the full, scrollable width of the chart whenautoScrollData
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.
- Returns:
- Current centerLegend value. Default value is false
- See Also:
-
setCenterTitle
Deprecated.Alignment of title and legend elements is now always relative to the visible chart-width, and not the full scrollable-width, so that both elements are always on-screen for any alignmentWhether to place thechart title
with respect to the full, scrollable width of the chart whenautoScrollData
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
.- Parameters:
centerTitle
- New centerTitle value. Default value is false- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getCenterTitle
Deprecated.Alignment of title and legend elements is now always relative to the visible chart-width, and not the full scrollable-width, so that both elements are always on-screen for any alignmentWhether to place thechart title
with respect to the full, scrollable width of the chart whenautoScrollData
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
.- Returns:
- Current centerTitle value. Default value is false
- See Also:
-
setChartRectMargin
Margin around the main chart rect: between title and chart, between chart and axis labels, and chart rect and right edge of chart.- Parameters:
chartRectMargin
- New chartRectMargin value. Default value is 5- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getChartRectMargin
public 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.- Returns:
- Current chartRectMargin value. Default value is 5
-
setChartRectProperties
Properties for chart rect. By default,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. SetpadChartRectByCornerRadius
tofalse
to change this default.- Parameters:
chartRectProperties
- New chartRectProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- See Also:
-
getChartRectProperties
Properties for chart rect. By default,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. SetpadChartRectByCornerRadius
tofalse
to change this default.- Returns:
- Current chartRectProperties value. Default value is null
-
setChartType
SeeChartType
for a list of known types - Column, Bar, Line, Pie, Doughnut, Area, Radar, and Histogram charts are supported.
If this method is called after the component has been drawn/initialized: Method to change the currentchartType
. Will redraw the chart if drawn. Will use default settings for the new chart type forstacked
andfilled
if those values are null.Note that for
multi-axis
charts this method changes thechartType
for the main value axis only.- Parameters:
chartType
- new chart type. Default value is "Column"- Returns:
FacetChart
instance, for chaining setter calls
-
getChartType
SeeChartType
for a list of known types - Column, Bar, Line, Pie, Doughnut, Area, Radar, and Histogram charts are supported.- Returns:
- Current chartType value. Default value is "Column"
-
setClusterMarginRatio
For clustered charts, ratio between margins between individual bars and margins between clusters.- Parameters:
clusterMarginRatio
- New clusterMarginRatio value. Default value is 4- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getClusterMarginRatio
public float getClusterMarginRatio()For clustered charts, ratio between margins between individual bars and margins between clusters.- Returns:
- Current clusterMarginRatio value. Default value is 4
- See Also:
-
setColorMutePercent
Should be set to a number between -100 and 100. If set, all colors in the chart are "muted" by this percentage by shifting them toward white (or for negative numbers, toward black).- Parameters:
colorMutePercent
- New colorMutePercent value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getColorMutePercent
Should be set to a number between -100 and 100. If set, all colors in the chart are "muted" by this percentage by shifting them toward white (or for negative numbers, toward black).- Returns:
- Current colorMutePercent value. Default value is null
-
setColorScaleMetric
For charts whereshowDataPoints
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 fromscaleStartColor
toscaleEndColor
based on a linear scale over the values of this metric. Log-scaling for color scale is also supported withlogScalePointColor
.- Parameters:
colorScaleMetric
- New colorScaleMetric value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getColorScaleMetric
For charts whereshowDataPoints
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 fromscaleStartColor
toscaleEndColor
based on a linear scale over the values of this metric. Log-scaling for color scale is also supported withlogScalePointColor
.- Returns:
- Current colorScaleMetric value. Default value is null
- See Also:
-
setDataAxisLabelDelimiter
Determines how inner and outer data axis labels are separated for charts that support multiple data label facets. See the discussion of "Three Facet Bar and Column Charts" in theoverview
.- Parameters:
dataAxisLabelDelimiter
- New dataAxisLabelDelimiter value. Default value is " / "- Returns:
FacetChart
instance, for chaining setter calls
-
getDataAxisLabelDelimiter
Determines how inner and outer data axis labels are separated for charts that support multiple data label facets. See the discussion of "Three Facet Bar and Column Charts" in theoverview
.- Returns:
- Current dataAxisLabelDelimiter value. Default value is " / "
-
setDataAxisLabelProperties
Properties for labels of data axis.- Parameters:
dataAxisLabelProperties
- New dataAxisLabelProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- See Also:
-
getDataAxisLabelProperties
Properties for labels of data axis.- Returns:
- Current dataAxisLabelProperties value. Default value is null
-
setDataColors
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.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 fordataColors
.- Parameters:
dataColors
- New set of data colors. Default value is see below- Returns:
FacetChart
instance, for chaining setter calls- See Also:
-
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.Colors must be in the format of a leading hash (#) plus 6 hexadecimal digits, for example, "#FFFFFF" is white, "#FF0000" is pure red.
- Returns:
- Current dataColors value. Default value is see below
- See Also:
-
setDataFetchMode
FacetCharts do not yet support paging, and will fetch all records that meet the criteria.- Specified by:
setDataFetchMode
in interfaceDataBoundComponent
- Parameters:
dataFetchMode
- New dataFetchMode value. Default value is "basic"- Returns:
FacetChart
instance, for chaining setter calls- See Also:
-
getDataFetchMode
FacetCharts do not yet support paging, and will fetch all records that meet the criteria.- Specified by:
getDataFetchMode
in interfaceDataBoundComponent
- Returns:
- Current dataFetchMode value. Default value is "basic"
- See Also:
-
setDataLabelFacetsMargin
Determines separation between the set of inner data labels and the set of outer data labels for charts that support multiple data label facets. See the discussion of "Three Facet Bar and Column Charts" in theoverview
.- Parameters:
dataLabelFacetsMargin
- New dataLabelFacetsMargin value. Default value is 5- Returns:
FacetChart
instance, for chaining setter calls
-
getDataLabelFacetsMargin
Determines separation between the set of inner data labels and the set of outer data labels for charts that support multiple data label facets. See the discussion of "Three Facet Bar and Column Charts" in theoverview
.- Returns:
- Current dataLabelFacetsMargin value. Default value is 5
-
setDataLabelProperties
Properties for data label- Parameters:
dataLabelProperties
- New dataLabelProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- See Also:
-
getDataLabelProperties
Properties for data label- Returns:
- Current dataLabelProperties value. Default value is null
-
setDataLabelToValueAxisMargin
public FacetChart setDataLabelToValueAxisMargin(int dataLabelToValueAxisMargin) throws IllegalStateException Margin between the edge of the chart and the data labels of the data label axis. This will default to thechart margin
if unset and should not exceed it. Setting this property to some valid non-null value has the impact of moving the data labels towards to chart, away from the axis label.- Parameters:
dataLabelToValueAxisMargin
- New dataLabelToValueAxisMargin value. Default value is varies- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getDataLabelToValueAxisMargin
public int getDataLabelToValueAxisMargin()Margin between the edge of the chart and the data labels of the data label axis. This will default to thechart margin
if unset and should not exceed it. Setting this property to some valid non-null value has the impact of moving the data labels towards to chart, away from the axis label.- Returns:
- Current dataLabelToValueAxisMargin value. Default value is varies
-
setDataLineProperties
Properties for lines that show data (as opposed to gradations or borders around the data area).- Parameters:
dataLineProperties
- New dataLineProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getDataLineProperties
Properties for lines that show data (as opposed to gradations or borders around the data area).- Returns:
- Current dataLineProperties value. Default value is null
-
setDataLineType
How to draw lines between adjacent data points in Line and Scatter charts. SeeDataLineType
.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 currentdataLineType
. Will redraw the chart if drawn.- Parameters:
dataLineType
- ow to draw lines between adjacent data points in Line and Scatter charts. Default value is null- Returns:
FacetChart
instance, for chaining setter calls
-
getDataLineType
How to draw lines between adjacent data points in Line and Scatter charts. SeeDataLineType
.Does not apply to boundary lines for shapes in Area or Radar plots.
- Returns:
- Current dataLineType value. Default value is null
-
setDataMargin
For rectangular charts (bar, column, line), margin around the inside of the main chart area, so that data elements are not flush to edge.- Parameters:
dataMargin
- New dataMargin value. Default value is 10- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getDataMargin
public 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.- Returns:
- Current dataMargin value. Default value is 10
-
setDataOutlineProperties
public FacetChart setDataOutlineProperties(DrawItem dataOutlineProperties) throws IllegalStateException Properties for lines that outline a data shape (in filled charts such as area or radar charts).- Parameters:
dataOutlineProperties
- New dataOutlineProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getDataOutlineProperties
Properties for lines that outline a data shape (in filled charts such as area or radar charts).- Returns:
- Current dataOutlineProperties value. Default value is null
-
setDataPointProperties
Common properties to apply for all data points (seeshowDataPoints
).- Parameters:
dataPointProperties
- New dataPointProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getDataPointProperties
Common properties to apply for all data points (seeshowDataPoints
).- Returns:
- Current dataPointProperties value. Default value is null
-
setDataPointSize
Size in pixels for data points drawn for line, area, radar and other chart types.- Parameters:
dataPointSize
- New dataPointSize value. Default value is 5- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getDataPointSize
public int getDataPointSize()Size in pixels for data points drawn for line, area, radar and other chart types.- Returns:
- Current dataPointSize value. Default value is 5
-
setDataShapeProperties
Properties for data shapes (filled areas in area or radar charts).- Parameters:
dataShapeProperties
- New dataShapeProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getDataShapeProperties
Properties for data shapes (filled areas in area or radar charts).- Returns:
- Current dataShapeProperties value. Default value is null
-
setDataSource
The DataSource that this component should bind to for default fields and for performingDataSource requests
.Can be specified as either a DataSource instance or the String ID of a DataSource.
- Specified by:
setDataSource
in interfaceDataBoundComponent
- Parameters:
dataSource
- New dataSource value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- See Also:
-
setDataSource
The DataSource that this component should bind to for default fields and for performingDataSource requests
.Can be specified as either a DataSource instance or the String ID of a DataSource.
- Specified by:
setDataSource
in interfaceDataBoundComponent
- Parameters:
dataSource
- New dataSource value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- See Also:
-
setDataValueHoverShadow
WhenhighlightDataValues
is true, this attribute can be set to aDrawItem shadow
to show around the draw-area of nearby filled data-value shapes as the mouse is moved around in Bar, Column, Pie and Doughnutchart-types
.- Parameters:
dataValueHoverShadow
- New dataValueHoverShadow value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls
-
getDataValueHoverShadow
WhenhighlightDataValues
is true, this attribute can be set to aDrawItem shadow
to show around the draw-area of nearby filled data-value shapes as the mouse is moved around in Bar, Column, Pie and Doughnutchart-types
.- Returns:
- Current dataValueHoverShadow value. Default value is null
-
setDecimalPrecision
Default precision used when formatting float numbers for axis labels- Parameters:
decimalPrecision
- New decimalPrecision value. Default value is 2- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getDecimalPrecision
public int getDecimalPrecision()Default precision used when formatting float numbers for axis labels- Returns:
- Current decimalPrecision value. Default value is 2
-
setDiscontinuousLines
Whether to treat non-numeric values in the dataset as indicating a break in the data line. If set tofalse
then null values are ignored. Defaults totrue
forfilled
charts and tofalse
for line charts.- Parameters:
discontinuousLines
- New discontinuousLines value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls
-
getDiscontinuousLines
Whether to treat non-numeric values in the dataset as indicating a break in the data line. If set tofalse
then null values are ignored. Defaults totrue
forfilled
charts and tofalse
for line charts.- Returns:
- Current discontinuousLines value. Default value is null
-
setDoughnutHoleProperties
Properties for doughnut hole- Parameters:
doughnutHoleProperties
- New doughnutHoleProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- See Also:
-
getDoughnutHoleProperties
Properties for doughnut hole- Returns:
- Current doughnutHoleProperties value. Default value is null
-
setDoughnutRatio
If showing a doughnut hole (seeshowDoughnut
), ratio of the size of the doughnut hole to the size of the overall pie chart, as a number between 0 to 1.- Parameters:
doughnutRatio
- New doughnutRatio value. Default value is 0.2- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getDoughnutRatio
public float getDoughnutRatio()If showing a doughnut hole (seeshowDoughnut
), ratio of the size of the doughnut hole to the size of the overall pie chart, as a number between 0 to 1.- Returns:
- Current doughnutRatio value. Default value is 0.2
-
setDrawLegendBoundary
Whether a boundary should be drawn above the Legend area for circumstances where the chart area already has an outer border. If the chart has no outer border, then thelegendRectProperties
settings should be used instead.- Parameters:
drawLegendBoundary
- New drawLegendBoundary value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getDrawLegendBoundary
Whether a boundary should be drawn above the Legend area for circumstances where the chart area already has an outer border. If the chart has no outer border, then thelegendRectProperties
settings should be used instead.- Returns:
- Current drawLegendBoundary value. Default value is null
-
setDrawTitleBackground
should a background color be set behind the Title. UsetitleBackgroundProperties
to set these values if this is true.- Parameters:
drawTitleBackground
- New drawTitleBackground value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls
-
getDrawTitleBackground
should a background color be set behind the Title. UsetitleBackgroundProperties
to set these values if this is true.- Returns:
- Current drawTitleBackground value. Default value is null
-
setDrawTitleBoundary
Whether a boundary should be drawn below the title area for circumstances where the chart area already has an outer border. If the chart has no outer border, then thetitleBackgroundProperties
settings should be used instead.- Parameters:
drawTitleBoundary
- New drawTitleBoundary value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls
-
getDrawTitleBoundary
Whether a boundary should be drawn below the title area for circumstances where the chart area already has an outer border. If the chart has no outer border, then thetitleBackgroundProperties
settings should be used instead.- Returns:
- Current drawTitleBoundary value. Default value is null
-
setEditProxyConstructor
Default class used to construct theEditProxy
for this component when the component isfirst placed into edit mode
.- Overrides:
setEditProxyConstructor
in classDrawPane
- Parameters:
editProxyConstructor
- New editProxyConstructor value. Default value is "FacetChartEditProxy"- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getEditProxyConstructor
Default class used to construct theEditProxy
for this component when the component isfirst placed into edit mode
.- Overrides:
getEditProxyConstructor
in classDrawPane
- Returns:
- Current editProxyConstructor value. Default value is "FacetChartEditProxy"
- See Also:
-
setEndValueMetric
Specifies the attribute in the metric facet that will define the end point of segments in a histogram chart. The start point is set via thevalueProperty
.- Parameters:
endValueMetric
- New endValueMetric value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getEndValueMetric
Specifies the attribute in the metric facet that will define the end point of segments in a histogram chart. The start point is set via thevalueProperty
.- Returns:
- Current endValueMetric value. Default value is null
- See Also:
-
setErrorBarColorMutePercent
public FacetChart setErrorBarColorMutePercent(float errorBarColorMutePercent) throws IllegalStateException This property helps specify the color of the error bars and its value must be a number between -100 and 100. Error bars have the same color as the data line, but the colors are actually "muted" by this percentage by shifting them toward white (or for negative numbers, toward black). The default is to darken the data colors by 60% to get the error bar colors.- Parameters:
errorBarColorMutePercent
- New errorBarColorMutePercent value. Default value is -60- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getErrorBarColorMutePercent
public float getErrorBarColorMutePercent()This property helps specify the color of the error bars and its value must be a number between -100 and 100. Error bars have the same color as the data line, but the colors are actually "muted" by this percentage by shifting them toward white (or for negative numbers, toward black). The default is to darken the data colors by 60% to get the error bar colors.- Returns:
- Current errorBarColorMutePercent value. Default value is -60
-
setErrorBarWidth
Width of the horizontal line of the "T"-shape portion of the error bar).- Parameters:
errorBarWidth
- New errorBarWidth value. Default value is 6- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getErrorBarWidth
public int getErrorBarWidth()Width of the horizontal line of the "T"-shape portion of the error bar).- Returns:
- Current errorBarWidth value. Default value is 6
-
setErrorLineProperties
Properties of the lines used to draw error bars (short, horizontal lines at the low and high metric values, and a vertical connecting line).Note that the
lineColor
property has no effect as the color of the error bars is derived from the color of the data line.- Parameters:
errorLineProperties
- New errorLineProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
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).Note that the
lineColor
property has no effect as the color of the error bars is derived from the color of the data line.- Returns:
- Current errorLineProperties value. Default value is null
- See Also:
-
setExpectedValueLineProperties
public FacetChart setExpectedValueLineProperties(DrawItem expectedValueLineProperties) throws IllegalStateException Properties for theline drawn at the mean value
.Note that for rectangular charts the properties are for a
DrawLine
, and for radar charts the properties are for aDrawOval
.- Parameters:
expectedValueLineProperties
- New expectedValueLineProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getExpectedValueLineProperties
Properties for theline drawn at the mean value
.Note that for rectangular charts the properties are for a
DrawLine
, and for radar charts the properties are for aDrawOval
.- Returns:
- Current expectedValueLineProperties value. Default value is null
-
setExtraAxisLabelAlign
Horizontal alignment of labels shown in extra y-axes, shown to the right of the chart.- Parameters:
extraAxisLabelAlign
- New extraAxisLabelAlign value. Default value is "left"- Returns:
FacetChart
instance, for chaining setter calls
-
getExtraAxisLabelAlign
Horizontal alignment of labels shown in extra y-axes, shown to the right of the chart.- Returns:
- Current extraAxisLabelAlign value. Default value is "left"
-
setExtraAxisMetrics
Defines the set of metrics that will be plotted as additional vertical axes. See the mainFacetChart
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 aFacetValue
of the inlinedFacet
(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 thevalueTitle
if the metric is thevalueProperty
).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).
- Parameters:
extraAxisMetrics
- New extraAxisMetrics value. Default value is []- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getExtraAxisMetrics
Defines the set of metrics that will be plotted as additional vertical axes. See the mainFacetChart
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 aFacetValue
of the inlinedFacet
(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 thevalueTitle
if the metric is thevalueProperty
).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).
- Returns:
- Current extraAxisMetrics value. Default value is []
- See Also:
-
setExtraAxisSettings
public FacetChart setExtraAxisSettings(MetricSettings... extraAxisSettings) throws IllegalStateException For charts will multiple vertical axes, optionally provides settings for how eachextra axis metric
is plotted. See the mainFacetChart
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 thechartType
s are left unspecified then by default the first metric will be drawn as columns and the remaining will be drawn as lines.- Parameters:
extraAxisSettings
- New extraAxisSettings value. Default value is []- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getExtraAxisSettings
For charts will multiple vertical axes, optionally provides settings for how eachextra axis metric
is plotted. See the mainFacetChart
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 thechartType
s are left unspecified then by default the first metric will be drawn as columns and the remaining will be drawn as lines.- Returns:
- Current extraAxisSettings value. Default value is []
- See Also:
-
setFacetFields
Specifies whatDataSource
fields to use as the chartfacets
for a databound chart. Iffacets
is also explicitly set,facetFields
is definitive butFacet
properties will be picked up fromfacets
also present in thefacetFields
.If neither this property nor
facets
is set, a databound chart will attempt to auto-derivefacetFields
from the DataSource fields. The first two text or text-derived fields in the DataSource will be assumed to be thefacetFields
.- Parameters:
facetFields
- New facetFields value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getFacetFields
Specifies whatDataSource
fields to use as the chartfacets
for a databound chart. Iffacets
is also explicitly set,facetFields
is definitive butFacet
properties will be picked up fromfacets
also present in thefacetFields
.If neither this property nor
facets
is set, a databound chart will attempt to auto-derivefacetFields
from the DataSource fields. The first two text or text-derived fields in the DataSource will be assumed to be thefacetFields
.- Returns:
- Current facetFields value. Default value is null
- See Also:
-
setFacetFields
Specifies whatDataSource
fields to use as the chartfacets
for a databound chart. Iffacets
is also explicitly set,facetFields
is definitive butFacet
properties will be picked up fromfacets
also present in thefacetFields
.If neither this property nor
facets
is set, a databound chart will attempt to auto-derivefacetFields
from the DataSource fields. The first two text or text-derived fields in the DataSource will be assumed to be thefacetFields
.- Parameters:
facetFields
- New facetFields value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getFacetFieldsAsString
Specifies whatDataSource
fields to use as the chartfacets
for a databound chart. Iffacets
is also explicitly set,facetFields
is definitive butFacet
properties will be picked up fromfacets
also present in thefacetFields
.If neither this property nor
facets
is set, a databound chart will attempt to auto-derivefacetFields
from the DataSource fields. The first two text or text-derived fields in the DataSource will be assumed to be thefacetFields
.- Returns:
- Current facetFields value. Default value is null
- See Also:
-
setFacets
An Array of facets, exactly analogous toCubeGrid.facets
, except that:- the "inlinedValues" property can be set on a facet to change data representation as described under Chart.data.
- for a non-inlined facet, Charts support auto-derivation of facetValues from the data.
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 thelegend facet
. They are named based on where thevalues
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.
In the case of
Bar and Column Charts
, up to three facets are supported, where the first two facets in that case are taken as the data label facets, and the third facet as the legend facet. This works by positioning both data label facets on the same axis, in a way that clearly shows which inner facet values are associated with each outer facet value.For databound charts,
facetFields
may be specified instead of this property. If both are provided,facetFields
is definitive butFacet
properties will be picked up fromfacets
also present in thefacetFields
.- Parameters:
facets
- New facets value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getFacets
An Array of facets, exactly analogous toCubeGrid.facets
, except that:- the "inlinedValues" property can be set on a facet to change data representation as described under Chart.data.
- for a non-inlined facet, Charts support auto-derivation of facetValues from the data.
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 thelegend facet
. They are named based on where thevalues
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.
In the case of
Bar and Column Charts
, up to three facets are supported, where the first two facets in that case are taken as the data label facets, and the third facet as the legend facet. This works by positioning both data label facets on the same axis, in a way that clearly shows which inner facet values are associated with each outer facet value.For databound charts,
facetFields
may be specified instead of this property. If both are provided,facetFields
is definitive butFacet
properties will be picked up fromfacets
also present in thefacetFields
.- Returns:
- Current facets value. Default value is null
-
setFacets
An Array of facets, exactly analogous toCubeGrid.facets
, except that:- the "inlinedValues" property can be set on a facet to change data representation as described under Chart.data.
- for a non-inlined facet, Charts support auto-derivation of facetValues from the data.
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 thelegend facet
. They are named based on where thevalues
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.
In the case of
Bar and Column Charts
, up to three facets are supported, where the first two facets in that case are taken as the data label facets, and the third facet as the legend facet. This works by positioning both data label facets on the same axis, in a way that clearly shows which inner facet values are associated with each outer facet value.For databound charts,
facetFields
may be specified instead of this property. If both are provided,facetFields
is definitive butFacet
properties will be picked up fromfacets
also present in thefacetFields
.- Parameters:
facets
- New facets value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getFacetsAsFacet
An Array of facets, exactly analogous toCubeGrid.facets
, except that:- the "inlinedValues" property can be set on a facet to change data representation as described under Chart.data.
- for a non-inlined facet, Charts support auto-derivation of facetValues from the data.
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 thelegend facet
. They are named based on where thevalues
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.
In the case of
Bar and Column Charts
, up to three facets are supported, where the first two facets in that case are taken as the data label facets, and the third facet as the legend facet. This works by positioning both data label facets on the same axis, in a way that clearly shows which inner facet values are associated with each outer facet value.For databound charts,
facetFields
may be specified instead of this property. If both are provided,facetFields
is definitive butFacet
properties will be picked up fromfacets
also present in thefacetFields
.- Returns:
- Current facets value. Default value is null
-
setFetchRequestProperties
public FacetChart setFetchRequestProperties(DSRequest fetchRequestProperties) throws IllegalStateException IfautoFetchData
istrue
, this attribute allows the developer to declaratively specifyDSRequest
properties for the initialfetchData()
call.Note that any properties governing more specific request attributes for the initial fetch (such as
autoFetchTextMatchStyle
) will be applied on top of this properties block.- Parameters:
fetchRequestProperties
- New fetchRequestProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getFetchRequestProperties
IfautoFetchData
istrue
, this attribute allows the developer to declaratively specifyDSRequest
properties for the initialfetchData()
call.Note that any properties governing more specific request attributes for the initial fetch (such as
autoFetchTextMatchStyle
) will be applied on top of this properties block.- Returns:
- Current fetchRequestProperties value. Default value is null
- See Also:
-
setFilled
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.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 changefilled
. Use null to apply a default value for the currentchartType
.- Parameters:
filled
- new value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls
-
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.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.
- Returns:
- Current filled value. Default value is null
-
setFormatStringFacetValueIds
Whether to callsetXAxisValueFormatter()
orformatFacetValueId()
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.- Parameters:
formatStringFacetValueIds
- New formatStringFacetValueIds value. Default value is true- Returns:
FacetChart
instance, for chaining setter calls- See Also:
-
getFormatStringFacetValueIds
Whether to callsetXAxisValueFormatter()
orformatFacetValueId()
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.- Returns:
- Current formatStringFacetValueIds value. Default value is true
- See Also:
-
setGradationGaps
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.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 forgradationGaps
.- Parameters:
gradationGaps
- newgradationGaps
value. Default value is [1, 2, 5]- Returns:
FacetChart
instance, for chaining setter calls- See Also:
-
getGradationGaps
public 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.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.- Returns:
- Current gradationGaps value. Default value is [1, 2, 5]
- See Also:
-
setGradationLabelPadding
Padding from edge of Y the Axis Label.- Parameters:
gradationLabelPadding
- New gradationLabelPadding value. Default value is 5- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getGradationLabelPadding
public int getGradationLabelPadding()Padding from edge of Y the Axis Label.- Returns:
- Current gradationLabelPadding value. Default value is 5
-
setGradationLabelProperties
public FacetChart setGradationLabelProperties(DrawLabel gradationLabelProperties) throws IllegalStateException Properties for gradation labels- Parameters:
gradationLabelProperties
- New gradationLabelProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getGradationLabelProperties
Properties for gradation labels- Returns:
- Current gradationLabelProperties value. Default value is null
-
setGradationLineProperties
public FacetChart setGradationLineProperties(DrawLine gradationLineProperties) throws IllegalStateException Properties for gradation lines- Parameters:
gradationLineProperties
- New gradationLineProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getGradationLineProperties
Properties for gradation lines- Returns:
- Current gradationLineProperties value. Default value is null
-
setGradationTickMarkLength
public FacetChart setGradationTickMarkLength(Integer gradationTickMarkLength) throws IllegalStateException Deprecated.usetickLength
instead- Parameters:
gradationTickMarkLength
- New gradationTickMarkLength value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getGradationTickMarkLength
Deprecated.usetickLength
instead- Returns:
- Current gradationTickMarkLength value. Default value is null
- See Also:
-
setGradationZeroLineProperties
public FacetChart setGradationZeroLineProperties(DrawLine gradationZeroLineProperties) throws IllegalStateException Properties for the gradation line drawn for zero (slightly thicker by default).- Parameters:
gradationZeroLineProperties
- New gradationZeroLineProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getGradationZeroLineProperties
Properties for the gradation line drawn for zero (slightly thicker by default).- Returns:
- Current gradationZeroLineProperties value. Default value is null
-
setHighErrorMetric
SeelowErrorMetric
.- Parameters:
highErrorMetric
- New highErrorMetric value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getHighErrorMetric
SeelowErrorMetric
.- Returns:
- Current highErrorMetric value. Default value is null
-
setHighlightDataValues
Should the draw-area of nearby filled data-value shapes be highlighted as the mouse is moved over somechart-types
?When set to true, data-shapes in Bar, Column, Pie and Doughnut charts can be highlighted by
brightening
their fill or border colors by apercentage
, and by applying ashadow
around them.- Parameters:
highlightDataValues
- New highlightDataValues value. Default value is true- Returns:
FacetChart
instance, for chaining setter calls
-
getHighlightDataValues
Should the draw-area of nearby filled data-value shapes be highlighted as the mouse is moved over somechart-types
?When set to true, data-shapes in Bar, Column, Pie and Doughnut charts can be highlighted by
brightening
their fill or border colors by apercentage
, and by applying ashadow
around them.- Returns:
- Current highlightDataValues value. Default value is true
-
setHoverLabelPadding
An extra amount of padding to show around thehoverLabel
whenshowValueOnHover
is enabled.Note : This is an advanced setting
- Parameters:
hoverLabelPadding
- New hoverLabelPadding value. Default value is 4- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getHoverLabelPadding
public int getHoverLabelPadding()An extra amount of padding to show around thehoverLabel
whenshowValueOnHover
is enabled.- Returns:
- Current hoverLabelPadding value. Default value is 4
- See Also:
-
setHoverLabelProperties
public FacetChart setHoverLabelProperties(DrawLabel hoverLabelProperties) throws IllegalStateException Properties for text in a floating label that represents the data value shown whenever the mouse moves withing the main chart area whenshowValueOnHover
is enabled.- Parameters:
hoverLabelProperties
- New hoverLabelProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getHoverLabelProperties
Properties for text in a floating label that represents the data value shown whenever the mouse moves withing the main chart area whenshowValueOnHover
is enabled.- Returns:
- Current hoverLabelProperties value. Default value is null
- See Also:
-
setHoverRectProperties
Properties for rectangle that draws behind of a floating hover label that represents the data value. SeeshowValueOnHover
for more details.- Parameters:
hoverRectProperties
- New hoverRectProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getHoverRectProperties
Properties for rectangle that draws behind of a floating hover label that represents the data value. SeeshowValueOnHover
for more details.- Returns:
- Current hoverRectProperties value. Default value is null
- See Also:
-
setLabelCollapseMode
public FacetChart setLabelCollapseMode(LabelCollapseMode labelCollapseMode) throws IllegalStateException 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 - seeLabelCollapseMode
.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 withsetXAxisValueFormatter()
will not be called on values for the x-axis. However, FacetChart uses theglobal array of abbreviated month names
for the time granularities of quarters, months, and weeks, uses thedefault short time format
to format labels for time granularities from minutes to hours, and uses thedefault 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 bysetFirstDayOfWeek()
.Note that if the labelCollapseMode is "time" or "numeric" then the
data
must be initially sorted with thedata label facet
's values in ascending order.- Parameters:
labelCollapseMode
- New labelCollapseMode value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
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 - seeLabelCollapseMode
.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 withsetXAxisValueFormatter()
will not be called on values for the x-axis. However, FacetChart uses theglobal array of abbreviated month names
for the time granularities of quarters, months, and weeks, uses thedefault short time format
to format labels for time granularities from minutes to hours, and uses thedefault 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 bysetFirstDayOfWeek()
.Note that if the labelCollapseMode is "time" or "numeric" then the
data
must be initially sorted with thedata label facet
's values in ascending order.- Returns:
- Current labelCollapseMode value. Default value is null
- See Also:
-
setLegendAlign
Horizontal alignment of the chart'slegend widget
.- Parameters:
legendAlign
- New legendAlign value. Default value is "center"- Returns:
FacetChart
instance, for chaining setter calls
-
getLegendAlign
Horizontal alignment of the chart'slegend widget
.- Returns:
- Current legendAlign value. Default value is "center"
-
setLegendBoundaryProperties
public FacetChart setLegendBoundaryProperties(DrawLine legendBoundaryProperties) throws IllegalStateException Properties for top boundary of the legend are, when there is already an outer container around the whole chart. seedrawLegendBoundary
- Parameters:
legendBoundaryProperties
- New legendBoundaryProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getLegendBoundaryProperties
Properties for top boundary of the legend are, when there is already an outer container around the whole chart. seedrawLegendBoundary
- Returns:
- Current legendBoundaryProperties value. Default value is null
-
setLegendItemPadding
Padding between each swatch and label pair.- Parameters:
legendItemPadding
- New legendItemPadding value. Default value is 5- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getLegendItemPadding
public int getLegendItemPadding()Padding between each swatch and label pair.- Returns:
- Current legendItemPadding value. Default value is 5
-
setLegendLabelProperties
public FacetChart setLegendLabelProperties(DrawLabel legendLabelProperties) throws IllegalStateException Properties for labels shown next to legend color swatches.- Parameters:
legendLabelProperties
- New legendLabelProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getLegendLabelProperties
Properties for labels shown next to legend color swatches.- Returns:
- Current legendLabelProperties value. Default value is null
-
setLegendMargin
Space between the legend and the chart rect or axis labels (whatever the legend is adjacent to.- Parameters:
legendMargin
- New legendMargin value. Default value is 10- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getLegendMargin
public int getLegendMargin()Space between the legend and the chart rect or axis labels (whatever the legend is adjacent to.- Returns:
- Current legendMargin value. Default value is 10
-
setLegendPadding
Padding around the legend as a whole.- Parameters:
legendPadding
- New legendPadding value. Default value is 5- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getLegendPadding
public int getLegendPadding()Padding around the legend as a whole.- Returns:
- Current legendPadding value. Default value is 5
-
setLegendRectHeight
If drawing a border around the legend, the height of the drawn Rectangle.- Parameters:
legendRectHeight
- New legendRectHeight value. Default value is 5- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getLegendRectHeight
public int getLegendRectHeight()If drawing a border around the legend, the height of the drawn Rectangle.- Returns:
- Current legendRectHeight value. Default value is 5
-
setLegendRectProperties
public FacetChart setLegendRectProperties(DrawRect legendRectProperties) throws IllegalStateException Properties for rectangle around the legend as a whole.- Parameters:
legendRectProperties
- New legendRectProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getLegendRectProperties
Properties for rectangle around the legend as a whole.- Returns:
- Current legendRectProperties value. Default value is null
-
setLegendSwatchProperties
public FacetChart setLegendSwatchProperties(DrawRect legendSwatchProperties) throws IllegalStateException Properties for the swatches of color shown in the legend.- Parameters:
legendSwatchProperties
- New legendSwatchProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getLegendSwatchProperties
Properties for the swatches of color shown in the legend.- Returns:
- Current legendSwatchProperties value. Default value is null
-
setLegendSwatchSize
Size of individual color swatches in legend.- Parameters:
legendSwatchSize
- New legendSwatchSize value. Default value is 16- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getLegendSwatchSize
public int getLegendSwatchSize()Size of individual color swatches in legend.- Returns:
- Current legendSwatchSize value. Default value is 16
-
setLegendTextPadding
Padding between color swatch and its label.- Parameters:
legendTextPadding
- New legendTextPadding value. Default value is 5- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getLegendTextPadding
public int getLegendTextPadding()Padding between color swatch and its label.- Returns:
- Current legendTextPadding value. Default value is 5
-
setLogBase
WhenuseLogGradations
, base value for logarithmic gradation lines. Gradation lines will be shown at every power of this value plus intervening values specified bylogGradations
.- Parameters:
logBase
- New logBase value. Default value is 10- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getLogBase
public int getLogBase()WhenuseLogGradations
, base value for logarithmic gradation lines. Gradation lines will be shown at every power of this value plus intervening values specified bylogGradations
.- Returns:
- Current logBase value. Default value is 10
-
setLogGradations
WhenuseLogGradations
is set, gradation lines to show in between powers, expressed as a series of integer or float values between 1 andlogBase
.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 quarters
Or base 2:[ 1 ] [ 1, 1.5 ]
- Parameters:
logGradations
- New logGradations value. Default value is [ 1,2,4,6,8 ]- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getLogGradations
public float[] getLogGradations()WhenuseLogGradations
is set, gradation lines to show in between powers, expressed as a series of integer or float values between 1 andlogBase
.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 quarters
Or base 2:[ 1 ] [ 1, 1.5 ]
- Returns:
- Current logGradations value. Default value is [ 1,2,4,6,8 ]
-
setLogScale
Whether to use logarithmic scaling for values.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).
- Parameters:
logScale
- New logScale value. Default value is false- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getLogScale
Whether to use logarithmic scaling for values.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).
- Returns:
- Current logScale value. Default value is false
-
setLogScalePointColor
Whether to use logarithmic scaling for thecolor scale
of the data points. Defaults to the value oflogScale
.- Parameters:
logScalePointColor
- New logScalePointColor value. Default value is false- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getLogScalePointColor
public boolean getLogScalePointColor()Whether to use logarithmic scaling for thecolor scale
of the data points. Defaults to the value oflogScale
.- Returns:
- Current logScalePointColor value. Default value is false
- See Also:
-
setLogScalePointSize
Whether to use logarithmic scaling for thedata point sizes
. Defaults to the value oflogScale
.- Parameters:
logScalePointSize
- New logScalePointSize value. Default value is false- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getLogScalePointSize
public boolean getLogScalePointSize()Whether to use logarithmic scaling for thedata point sizes
. Defaults to the value oflogScale
.- Returns:
- Current logScalePointSize value. Default value is false
- See Also:
-
setLowErrorMetric
lowErrorMetric
andhighErrorMetric
can be used to cause error bars to appear above and below the main data point.lowErrorMetric
andhighErrorMetric
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.
- Parameters:
lowErrorMetric
- New lowErrorMetric value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getLowErrorMetric
lowErrorMetric
andhighErrorMetric
can be used to cause error bars to appear above and below the main data point.lowErrorMetric
andhighErrorMetric
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.
- Returns:
- Current lowErrorMetric value. Default value is null
- See Also:
-
setMajorTickGradations
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). These numbers must be multiples ofgradationGaps
, 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 formajorTickGradations
.- Parameters:
majorTickGradations
- newmajorTickGradations
value. Default value is [1]- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getMajorTickGradations
public 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). These numbers must be multiples ofgradationGaps
, 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.- Returns:
- Current majorTickGradations value. Default value is [1]
-
setMajorTickTimeIntervals
When ticks are beingshown 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 formajorTickTimeIntervals
.- Parameters:
majorTickTimeIntervals
- newmajorTickTimeIntervals
value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls
-
getMajorTickTimeIntervals
When ticks are beingshown 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.
- Returns:
- Current majorTickTimeIntervals value. Default value is null
-
setMatchBarChartDataLineColor
Setting to define whether the border around the bar chart area should be the same color as the main chart area.- Parameters:
matchBarChartDataLineColor
- New matchBarChartDataLineColor value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls
-
getMatchBarChartDataLineColor
Setting to define whether the border around the bar chart area should be the same color as the main chart area.- Returns:
- Current matchBarChartDataLineColor value. Default value is null
-
setMaxBarThickness
Bars will not be drawn over this thickness, instead, margins will be increased.- Parameters:
maxBarThickness
- New maxBarThickness value. Default value is 150- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
com.smartgwt.client.widgets.chart.FacetChart#getMinClusterSize
-
getMaxBarThickness
public int getMaxBarThickness()Bars will not be drawn over this thickness, instead, margins will be increased.- Returns:
- Current maxBarThickness value. Default value is 150
- See Also:
-
com.smartgwt.client.widgets.chart.FacetChart#getMinClusterSize
-
setMaxDataPointSize
The maximum allowed data point size when controlled bypointSizeMetric
.- Parameters:
maxDataPointSize
- New maxDataPointSize value. Default value is 14- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getMaxDataPointSize
public double getMaxDataPointSize()The maximum allowed data point size when controlled bypointSizeMetric
.- Returns:
- Current maxDataPointSize value. Default value is 14
-
setMaxDataZIndex
Maximum allowed zIndex that can be specified throughzIndexMetric
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 currentDrawPane.drawingType
.- Parameters:
maxDataZIndex
- New maxDataZIndex value. Default value is 10000- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getMaxDataZIndex
Maximum allowed zIndex that can be specified throughzIndexMetric
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 currentDrawPane.drawingType
.- Returns:
- Current maxDataZIndex value. Default value is 10000
- See Also:
-
setMetricFacetId
Specifies the "id" of the default metric facet value. The default metric is used withlowErrorMetric
andhighErrorMetric
when showing error bars.- Parameters:
metricFacetId
- New metricFacetId value. Default value is "metric"- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getMetricFacetId
Specifies the "id" of the default metric facet value. The default metric is used withlowErrorMetric
andhighErrorMetric
when showing error bars.- Returns:
- Current metricFacetId value. Default value is "metric"
-
setMinBarThickness
If bars would be smaller than this size, margins are reduced until bars overlap.- Parameters:
minBarThickness
- New minBarThickness value. Default value is 4- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
com.smartgwt.client.widgets.chart.FacetChart#getMinClusterSize
-
getMinBarThickness
public int getMinBarThickness()If bars would be smaller than this size, margins are reduced until bars overlap.- Returns:
- Current minBarThickness value. Default value is 4
- See Also:
-
com.smartgwt.client.widgets.chart.FacetChart#getMinClusterSize
-
setMinChartHeight
Minimum height for this chart instance.- Parameters:
minChartHeight
- New minChartHeight value. Default value is 1- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getMinChartHeight
Minimum height for this chart instance.- Returns:
- Returns the
minimum height
for the chart body. Default value is 1
-
setMinChartWidth
Minimum width for this chart instance.- Parameters:
minChartWidth
- New minChartWidth value. Default value is 1- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getMinChartWidth
Minimum width for this chart instance.- Returns:
- Returns the
minimum width
for the chart body. Default value is 1
-
setMinContentHeight
WhenautoScrollContent
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. SeeminContentWidth
to affect the minimum horizontal content-size.- Parameters:
minContentHeight
- New minContentHeight value. Default value is 150- Returns:
FacetChart
instance, for chaining setter calls
-
getMinContentHeight
public int getMinContentHeight()WhenautoScrollContent
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. SeeminContentWidth
to affect the minimum horizontal content-size.- Returns:
- Returns the
minContentHeight
for this facet chart whenautoScrollContent
is enabled. Default value is 150
-
setMinContentWidth
WhenautoScrollContent
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. SeeminContentHeight
to affect the minimum vertical content-size.- Parameters:
minContentWidth
- New minContentWidth value. Default value is 150- Returns:
FacetChart
instance, for chaining setter calls
-
getMinContentWidth
public int getMinContentWidth()WhenautoScrollContent
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. SeeminContentHeight
to affect the minimum vertical content-size.- Returns:
- Returns the
minContentWidth
for this facet chart whenautoScrollContent
is enabled. Default value is 150
-
setMinDataPointSize
The minimum allowed data point size when controlled bypointSizeMetric
.- Parameters:
minDataPointSize
- New minDataPointSize value. Default value is 3- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getMinDataPointSize
public double getMinDataPointSize()The minimum allowed data point size when controlled bypointSizeMetric
.- Returns:
- Current minDataPointSize value. Default value is 3
-
setMinDataSpreadPercent
If all data values would be spread across less thanminDataSpreadPercent
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
oraxisEndValue
, disables this behavior, as does settingminDataSpreadPercent
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 propertyminXDataSpreadPercent
must be used to enable the corresponding feature for the x-axis.- Parameters:
minDataSpreadPercent
- New minDataSpreadPercent value. Default value is 30- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getMinDataSpreadPercent
public int getMinDataSpreadPercent()If all data values would be spread across less thanminDataSpreadPercent
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
oraxisEndValue
, disables this behavior, as does settingminDataSpreadPercent
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 propertyminXDataSpreadPercent
must be used to enable the corresponding feature for the x-axis.- Returns:
- Current minDataSpreadPercent value. Default value is 30
-
setMinLabelGap
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 thelabelCollapseMode
.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.
- Parameters:
minLabelGap
- New minLabelGap value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
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 thelabelCollapseMode
.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.
- Returns:
- Current minLabelGap value. Default value is null
-
setMinorTickLength
Length of minor ticks marks shown along axis, ifminor tick marks
are enabled.
If this method is called after the component has been drawn/initialized: Setter forminorTickLength
.- Parameters:
minorTickLength
- newminorTickLength
value. Default value is 2- Returns:
FacetChart
instance, for chaining setter calls- See Also:
-
getMinorTickLength
public int getMinorTickLength()Length of minor ticks marks shown along axis, ifminor tick marks
are enabled.- Returns:
- Current minorTickLength value. Default value is 2
- See Also:
-
setMinXDataSpreadPercent
For scatter charts only, if all data points would be spread across less thanminXDataSpreadPercent
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 settingminXDataSpreadPercent
to 0.- Parameters:
minXDataSpreadPercent
- New minXDataSpreadPercent value. Default value is 30- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getMinXDataSpreadPercent
public int getMinXDataSpreadPercent()For scatter charts only, if all data points would be spread across less thanminXDataSpreadPercent
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 settingminXDataSpreadPercent
to 0.- Returns:
- Current minXDataSpreadPercent value. Default value is 30
- See Also:
-
setOtherAxisGradationGaps
LikegradationGaps
, 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 forotherAxisGradationGaps
.- Parameters:
otherAxisGradationGaps
- newotherAxisGradationGaps
value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls
-
getOtherAxisGradationGaps
public float[] getOtherAxisGradationGaps()LikegradationGaps
, 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.- Returns:
- Current otherAxisGradationGaps value. Default value is null
-
setOtherAxisGradationTimes
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. Valid time units are "ms" (millisecond), "s" (second), "mn" (minute), "h" (hour), "d" (day), "w" (week), "m" (month), "q" (quarter, 3-months), "y" (year).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"]
If this method is called after the component has been drawn/initialized: Setter forotherAxisGradationTimes
.- Parameters:
otherAxisGradationTimes
- newotherAxisGradationTimes
value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- See Also:
-
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. Valid time units are "ms" (millisecond), "s" (second), "mn" (minute), "h" (hour), "d" (day), "w" (week), "m" (month), "q" (quarter, 3-months), "y" (year).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"]
- Returns:
- Current otherAxisGradationTimes value. Default value is null
- See Also:
-
setOtherAxisPixelsPerGradation
Ideal number of pixels to leave between each gradation on the x (horizontal axis), for Scatter plots only.Defaults to the value of
pixelsPerGradation
if unset.
If this method is called after the component has been drawn/initialized: Setter forotherAxisPixelsPerGradation
.- Parameters:
otherAxisPixelsPerGradation
- newotherAxisPixelsPerGradation
value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- See Also:
-
getOtherAxisPixelsPerGradation
Ideal number of pixels to leave between each gradation on the x (horizontal axis), for Scatter plots only.Defaults to the value of
pixelsPerGradation
if unset.- Returns:
- Current otherAxisPixelsPerGradation value. Default value is null
- See Also:
-
setOuterLabelFacetLineProperties
public FacetChart setOuterLabelFacetLineProperties(DrawLine outerLabelFacetLineProperties) throws IllegalStateException Properties for the lines drawn to show the span of outer data label facet values, if present.- Parameters:
outerLabelFacetLineProperties
- New outerLabelFacetLineProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getOuterLabelFacetLineProperties
Properties for the lines drawn to show the span of outer data label facet values, if present.- Returns:
- Current outerLabelFacetLineProperties value. Default value is null
-
setPadChartRectByCornerRadius
public FacetChart setPadChartRectByCornerRadius(boolean padChartRectByCornerRadius) throws IllegalStateException IfshowChartRect
is enabled and ifchartRectProperties
specifies a nonzerorounding
, whether the padding around the inside of the chart rect. should include at least the radius of the rounded corner.- Parameters:
padChartRectByCornerRadius
- New padChartRectByCornerRadius value. Default value is true- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getPadChartRectByCornerRadius
public boolean getPadChartRectByCornerRadius()IfshowChartRect
is enabled and ifchartRectProperties
specifies a nonzerorounding
, whether the padding around the inside of the chart rect. should include at least the radius of the rounded corner.- Returns:
- Current padChartRectByCornerRadius value. Default value is true
-
setPieBorderProperties
Properties for the border around a pie chart.- Parameters:
pieBorderProperties
- New pieBorderProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getPieBorderProperties
Properties for the border around a pie chart.- Returns:
- Current pieBorderProperties value. Default value is null
-
setPieLabelAngleStart
Angle where first label is placed in a Pie chart in stacked mode, in degrees.- Parameters:
pieLabelAngleStart
- New pieLabelAngleStart value. Default value is 20- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getPieLabelAngleStart
public int getPieLabelAngleStart()Angle where first label is placed in a Pie chart in stacked mode, in degrees.- Returns:
- Current pieLabelAngleStart value. Default value is 20
-
setPieLabelLineExtent
How far label lines stick out of the pie radius in a Pie chart in stacked mode.- Parameters:
pieLabelLineExtent
- New pieLabelLineExtent value. Default value is 7- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created
-
getPieLabelLineExtent
public int getPieLabelLineExtent()How far label lines stick out of the pie radius in a Pie chart in stacked mode.- Returns:
- Current pieLabelLineExtent value. Default value is 7
-
setPieLabelLineProperties
Properties for pie label line- Parameters:
pieLabelLineProperties
- New pieLabelLineProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- See Also:
-
getPieLabelLineProperties
Properties for pie label line- Returns:
- Current pieLabelLineProperties value. Default value is null
-
setPieRingBorderProperties
public FacetChart setPieRingBorderProperties(DrawOval pieRingBorderProperties) throws IllegalStateException Properties for pie ring border- Parameters:
pieRingBorderProperties
- New pieRingBorderProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getPieRingBorderProperties
Properties for pie ring border- Returns:
- Current pieRingBorderProperties value. Default value is null
-
setPieSliceProperties
Properties for pie slices- Parameters:
pieSliceProperties
- New pieSliceProperties value. Default value is null- Returns:
FacetChart
instance, for chaining setter calls- Throws:
IllegalStateException
- this property cannot be changed after the component has been created- See Also:
-
getPieSliceProperties
Properties for pie slices- Returns:
- Current pieSliceProperties value. Default value is null
-
setPieStartAngle
Default angle in degrees where pie charts start drawing sectors to represent data value
-
rotateLabels
.