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
nulls. 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:
Zoomingisn't supportedInline labelsaren't supported- The only mode supported for
label collapsingis "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.InvalidDrawingTypeExceptionNested 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, scClassNameFields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX -
Constructor Summary
Constructors -
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.voidConvenience 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.voidConvenience 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 voidchangeAutoChildDefaults(String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren namedautoChildName.static voidchangeAutoChildDefaults(String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren namedautoChildName.protected JavaScriptObjectcreate()void
 Deselect all records

voiddeselectRecord(int record) Deselect aRecordpassed in explicitly, or by index.voiddeselectRecord(Record record) Deselect aRecordpassed in explicitly, or by index.voiddeselectRecords(int[] records) Deselect a list ofRecords passed in explicitly, or by index.voiddeselectRecords(Record[] records) Deselect a list ofRecords passed in explicitly, or by index.voiddisableHilite(String hiliteID) Disable a hilite

voidDisable all hilites.

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

voidenableHilite(String hiliteID, boolean enable) Enable / disable ahilites

voidEnable all hilites.

voidenableHiliting(boolean enable) Enable all hilites.

voidvoidexportData(DSRequest requestProperties) voidexportData(DSRequest requestProperties, RPCCallback callback) Uses a "fetch" operation on the currentDataSourceto 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.voidRetrieves data from the DataSource that matches the specified criteria.voidRetrieves data from the DataSource that matches the specified criteria.voidfetchData(Criteria criteria, DSCallback callback) Retrieves data from the DataSource that matches the specified criteria.voidfetchData(Criteria criteria, DSCallback callback, DSRequest requestProperties) Retrieves data from the DataSource that matches the specified criteria.voidfetchRelatedData(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.voidfetchRelatedData(ListGridRecord record, Canvas schema, DSCallback callback) voidfetchRelatedData(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.voidRetrieves data that matches the provided criteria and displays the matching data in this component.voidfilterData(Criteria criteria) Retrieves data that matches the provided criteria and displays the matching data in this component.voidfilterData(Criteria criteria, DSCallback callback) Retrieves data that matches the provided criteria and displays the matching data in this component.voidfilterData(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 passedintfindIndex(AdvancedCriteria adCriteria) Finds the index of the first Record that matches with the AdvacendCriteria passed.intfindNextIndex(int startIndex, AdvancedCriteria adCriteria) LikeRecordList.findIndex(java.util.Map), but considering the startIndex parameter.intfindNextIndex(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 forchartTypes 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 fieldoperationIdthis component should use when performing add operations.Text for a menu item allowing users to add a formula fieldbooleanSetting this flag tofalseprevents the chart from drawing fill gradients into the bubbles of each data point.Otherchart typesthat 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().IfautoFetchDataistrue, this attribute allows the developer to specify a textMatchStyle for the initialDataBoundComponent.fetchData()call.Deprecated.booleanbooleanFor 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.booleanWhether to draw data points in order of descendingpoint sizeso 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 deviationlines.intDistance between bars.Properties for barWhenhighlightDataValuesis true, should the whole draw-area of the data-value be brightened bya percentage, or just its border?intWhenhighlightDataValuesis true, sets the percentage by which to brighten filled data-shapes in somechart-typesas the mouse is moved over the chart.intMaximum 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 chartappears 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.floatgetChartHeight(boolean recalc) Deprecated.doublegetChartHeightAsDouble(boolean recalc) Get the height the central chart area, where data elements appear.floatDeprecated.doubleGet the left margin of the central chart area, where data elements appear.floatDeprecated.doubleReturns the radius for radar charts and pie charts.intMargin 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.floatDeprecated.doubleGet the top coordinate of the central chart area, where data elements appear.SeeChartTypefor a list of known types - Column, Bar, Line, Pie, Doughnut, Area, Radar, and Histogram charts are supported.floatgetChartWidth(boolean recalc) Deprecated.doublegetChartWidthAsDouble(boolean recalc) Get the width of the central chart area, where data elements appear.floatFor clustered charts, ratio between margins between individual bars and margins between clusters.Should be set to a number between -100 and 100.For charts whereshowDataPointsis 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 thedataColorsArray.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 labelintMargin 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.intFor 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).intWhen usingdata paging, how many records to fetch at a time.Common properties to apply for all data points (seeshowDataPoints).intSize 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.WhenhighlightDataValuesis true, this attribute can be set to aDrawItem shadowto show around the draw-area of nearby filled data-value shapes as the mouse is moved around in Bar, Column, Pie and Doughnutchart-types.intDefault 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 holefloatIf 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 aDrawnValueobject 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 aDrawnValueobject 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 ofDrawnValueobjects 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 ofDrawnValueobjects 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, andaddDropValuesis 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
preventDuplicatesis enabled.Text for a menu item allowing users to edit a formula fieldDefault class used to construct theEditProxyfor 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.floatThis property helps specify the color of the error bars and its value must be a number between -100 and 100.intWidth 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 metricis plotted.Get a facet definition by facetId.String[]Specifies whatDataSourcefields to use as the chartfacetsfor a databound chart.Specifies whatDataSourcefields to use as the chartfacetsfor 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.IfautoFetchDataistrue, this attribute allows the developer to declaratively specifyDSRequestproperties for the initialfetchData()call.Returna an array of field alignments for this gridintReturn 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.intPadding 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.usetickLengthinsteadProperties 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.intAn extra amount of padding to show around thehoverLabelwhenshowValueOnHoveris enabled.Properties for text in a floating label that represents the data value shown whenever the mouse moves withing the main chart area whenshowValueOnHoveris 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.intPadding between each swatch and label pair.Properties for labels shown next to legend color swatches.intSpace between the legend and the chart rect or axis labels (whatever the legend is adjacent to.intPadding around the legend as a whole.intIf 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.intSize of individual color swatches in legend.intPadding between color swatch and its label.intWhenuseLogGradations, base value for logarithmic gradation lines.float[]WhenuseLogGradationsis set, gradation lines to show in between powers, expressed as a series of integer or float values between 1 andlogBase.Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.Whether to use logarithmic scaling for values.booleanWhether to use logarithmic scaling for thecolor scaleof the data points.booleanWhether to use logarithmic scaling for thedata point sizes.lowErrorMetricandhighErrorMetriccan 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 axisfor 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.intBars will not be drawn over this thickness, instead, margins will be increased.doubleThe maximum allowed data point size when controlled bypointSizeMetric.Maximum allowed zIndex that can be specified throughzIndexMetricin 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.intIf 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.intWhenautoScrollContentis true, limits the minimum height of the chart-content, including data, labels, title and legends.intWhenautoScrollContentis true, limits the minimum width of the chart-content, including data, labels, titles and legends.doubleThe minimum allowed data point size when controlled bypointSizeMetric.intIf all data values would be spread across less thanminDataSpreadPercentof 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.intLength of minor ticks marks shown along axis, ifminor tick marksare enabled.intFor scatter charts only, if all data points would be spread across less thanminXDataSpreadPercentof 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 aDrawnValueobject.getNearestDrawnValue(Integer x, Integer y, String metric) Returns rendering information for the data value that is shown nearest to the passed coordinates, as aDrawnValueobject.Returns an array ofDrawnValueobjects containing rendering information for the data values having each metric that are shown nearest to the passed coordinates.Returns an array ofDrawnValueobjects 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 FacetChartgetOrCreateRef(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.booleanIfshowChartRectis enabled and ifchartRectPropertiesspecifies 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.intAngle where first label is placed in a Pie chart in stacked mode, in degrees.intHow 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.intIdeal number of pixels to leave between each gradation on the primary axis, which is typically the y (vertical) axis except for Bar charts.WhenlogScalePointColoristrue, this property specifies the base value for logarithmiccolor scale metricvalues.For charts whereshowDataPointsis enabled, this property specifies an array of geometric shapes to draw for the data points of each series.When apoint size legendis shown, this property controls the number of gradations of thepointSizeMetricthat the chart tries to display.WhenlogScalePointSizeis true, base value for logarithmic point size metric values.float[]WhenusePointSizeLogGradationsis set, this property specifies thepointSizeMetricvalue gradations to show in thepoint size legendin between powers, expressed as a series of integer or float values between 1 andpointSizeLogBase.For charts whereshowDataPointsis enabled, this property specifies an additional metric (i.e.voidFor 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.voidvoidgetPolynomialRegressionFunction(Integer degree, String xMetric) voidgetPolynomialRegressionFunction(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.booleanShould thezoom chartbe 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 dataprogressivelyFor 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 facetof radar orstackedpie 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.intgetRecordIndex(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.intFor scatter plots only, specify the degree of polynomial to use for any polynomial regression that is calculated.operationIdthis 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.booleanWhether 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).booleanIf 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.booleanDeprecated.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 rotationwhere supported.ThisDataBoundComponentproperty 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:truewhen 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.booleanIfticksare 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.booleanWhether to associate saved searches by default with the currentDataSourceof a component when asavedSearchIdis not provided.Whether to draw lines between adjacent data points in "Scatter" plots.Whether to automatically show shadows for various charts.Display multiplestandard deviationsaway from the mean as lines.If set, themean line,standard deviation lines,standard deviation bands, andregression curvesare 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.booleanWhen set, ticks are shown for the X (horizontal) axis for Scatter plots or Bar charts.booleanWhen set, ticks are shown for the Y (vertical) axis if it's a value axis.voidFor 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.voidgetSimpleLinearRegressionFunction(String xMetric) voidgetSimpleLinearRegressionFunction(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 currentSortSpecifiersfor 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[]WhenshowStandardDeviationLinesis 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.intLength of the tick marks used when eithershowXTicksorshowYTicksis enabled, or whenextra value axesare in use.intMargin between the tick marks and the labels of theextra value axes.getTitle()Title for the chart as a whole.Horizontal alignment of the chart'stitlewith 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 checktitleFieldfor 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
intif 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.intThe height of the bordered rect around the title - defaults to 0 (assuming no border)operationIdthis 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.fieldsacting 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 indataColorsbut specify chart-specific gradients based on the primary data color per chart type.TheuseFlatFieldsflag 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 thepointSizeMetricvalues displayed in thepoint size legend.Whether to display both the positive and negative of thestandard deviations.Properties for labels of value axis.intMargin 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.floatgetXCoord(double value) Returns the X coordinate where the passed data value either was or would be drawn.floatgetXCoord(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.intPadding between each swatch and label pair.For scatter charts only, the "id" of the metric facet value to use for the y-axis.floatgetYCoord(double value) Returns the Y coordinate where the passed data value either was or would be drawn.floatgetYCoord(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 whencanZoomis enabled.doubleHeight of thezoomChart.Properties to further configure thezoomChart.Slider controls shown on the mini-chart which is created whencanZoomis enabled.For azoomed chart, end value of the data range shown in the main chart.floatcolorMutePercentto use for thezoomChart.Mini-chart created whencanZoomis 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.voidInvalidate the current data cache for this databound component via a call to the dataset'sinvalidateCache()method, for example,ResultSet.invalidateCache().voidSelect all records

voidselectRecord(int record) Select/deselect aRecordpassed in explicitly, or by index.voidselectRecord(int record, boolean newState) Select/deselect aRecordpassed in explicitly, or by index.voidselectRecord(Record record) Select/deselect aRecordpassed in explicitly, or by index.voidselectRecord(Record record, boolean newState) Select/deselect aRecordpassed in explicitly, or by index.voidselectRecords(int[] records) Select/deselect a list ofRecords passed in explicitly, or by index.voidselectRecords(int[] records, boolean newState) Select/deselect a list ofRecords passed in explicitly, or by index.voidselectRecords(Record[] records) Select/deselect a list ofRecords passed in explicitly, or by index.voidselectRecords(Record[] records, boolean newState) Select/deselect a list ofRecords 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) operationIdthis 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 tofalseprevents the chart from drawing fill gradients into the bubbles of each data point.setAllowedChartTypes(ChartType... allowedChartTypes) Otherchart typesthat 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) IfautoFetchDataistrue, 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 sizeso 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.voidsetAxisValueFormatter(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 deviationlines.setBarMargin(int barMargin) Distance between bars.setBarProperties(DrawRect barProperties) Properties for barsetBrightenAllOnHover(Boolean brightenAllOnHover) WhenhighlightDataValuesis true, should the whole draw-area of the data-value be brightened bya percentage, or just its border?setBrightenPercent(int brightenPercent) WhenhighlightDataValuesis true, sets the percentage by which to brighten filled data-shapes in somechart-typesas 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 chartappears 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) SeeChartTypefor 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 whereshowDataPointsis enabled, this property specifies an additional metric (i.e.voidDataset for this chart.
voidsetData(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.voidsetDataColorMapper(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.voidsetDataGradientMapper(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.voidsetDataLabelHoverHTMLCustomizer(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.voidsetDataLineColorMapper(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.voidsetDataLineWidthMapper(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.voidsetDataValueFormatter(ValueFormatter formatter) Formatter to apply to values displayed in the hover labels and other value labelssetDataValueHoverShadow(Shadow dataValueHoverShadow) WhenhighlightDataValuesis true, this attribute can be set to aDrawItem shadowto 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 voidsetDefaultProperties(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, andaddDropValuesis 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
preventDuplicatesis enabled.setEditFormulaFieldText(String editFormulaFieldText) Text for a menu item allowing users to edit a formula fieldsetEditProxyConstructor(String editProxyConstructor) Default class used to construct theEditProxyfor 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 metricis plotted.setFacetFields(String facetFields) Specifies whatDataSourcefields to use as the chartfacetsfor a databound chart.setFacetFields(String... facetFields) Specifies whatDataSourcefields to use as the chartfacetsfor 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) IfautoFetchDataistrue, this attribute allows the developer to declaratively specifyDSRequestproperties 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.usetickLengthinsteadsetGradationZeroLineProperties(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 thehoverLabelwhenshowValueOnHoveris 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 whenshowValueOnHoveris 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.voidsetLegendHoverCustomizer(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) WhenuseLogGradationsis set, gradation lines to show in between powers, expressed as a series of integer or float values between 1 andlogBase.Setter implementing theLogicalStructureinterface, 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 scaleof the data points.setLogScalePointSize(boolean logScalePointSize) Whether to use logarithmic scaling for thedata point sizes.setLowErrorMetric(String lowErrorMetric) lowErrorMetricandhighErrorMetriccan 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 axisfor 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 throughzIndexMetricin 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.voidsetMinClusterSizeMapper(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 facetvalue.setMinContentHeight(int minContentHeight) WhenautoScrollContentis true, limits the minimum height of the chart-content, including data, labels, title and legends.setMinContentWidth(int minContentWidth) WhenautoScrollContentis 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 thanminDataSpreadPercentof 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 marksare enabled.setMinXDataSpreadPercent(int minXDataSpreadPercent) For scatter charts only, if all data points would be spread across less thanminXDataSpreadPercentof 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) IfshowChartRectis enabled and ifchartRectPropertiesspecifies 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.voidApply a handler to fire whenshowDataPointsis true, and the user clicks on a point.setPointColorLogBase(Integer pointColorLogBase) WhenlogScalePointColoristrue, this property specifies the base value for logarithmiccolor scale metricvalues.voidsetPointHoverCustomizer(ChartPointHoverCustomizer hoverCustomizer) Display custom HTML whenshowDataPointsis true and the mouse hovers over a point.setPointShapes(PointShape... pointShapes) For charts whereshowDataPointsis enabled, this property specifies an array of geometric shapes to draw for the data points of each series.setPointSizeGradations(Integer pointSizeGradations) When apoint size legendis shown, this property controls the number of gradations of thepointSizeMetricthat the chart tries to display.setPointSizeLogBase(Integer pointSizeLogBase) WhenlogScalePointSizeis true, base value for logarithmic point size metric values.setPointSizeLogGradations(float... pointSizeLogGradations) WhenusePointSizeLogGradationsis set, this property specifies thepointSizeMetricvalue gradations to show in thepoint size legendin between powers, expressed as a series of integer or float values between 1 andpointSizeLogBase.setPointSizeMetric(String pointSizeMetric) For charts whereshowDataPointsis 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 chartbe 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 dataprogressivelysetProportional(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 facetof radar orstackedpie 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) operationIdthis 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 rotationwhere supported.setShowDetailFields(Boolean showDetailFields) ThisDataBoundComponentproperty 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:truewhen 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) Ifticksare 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 currentDataSourceof a component when asavedSearchIdis 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 deviationsaway from the mean as lines.setShowStatisticsOverData(Boolean showStatisticsOverData) If set, themean line,standard deviation lines,standard deviation bands, andregression curvesare 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) WhenshowStandardDeviationLinesis set, the number of standard deviation lines drawn and their respective standard deviation away from the mean are specified by this property.voidsetStyleName(String styleName) Default styleName for the chart.setTickLength(int tickLength) Length of the tick marks used when eithershowXTicksorshowYTicksis enabled, or whenextra value axesare in use.setTickMarkToValueAxisMargin(int tickMarkToValueAxisMargin) Margin between the tick marks and the labels of theextra value axes.voidTitle for the chart as a whole.setTitleAlign(TitleAlign titleAlign) Horizontal alignment of the chart'stitlewith 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) operationIdthis 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.fieldsacting 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 indataColorsbut specify chart-specific gradients based on the primary data color per chart type.setUseFlatFields(Boolean useFlatFields) TheuseFlatFieldsflag 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 thepointSizeMetricvalues 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.voidsetXAxisValueFormatter(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.voidsetYAxisValueFormatter(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.voidsetZoomEndValue(Object zoomEndValue) For azoomed chart, end value of the data range shown in the main chart.setZoomLogScale(Boolean zoomLogScale) setZoomMutePercent(float zoomMutePercent) colorMutePercentto 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.voidsetZoomStartValue(Object zoomStartValue) For azoomed chart, start value of the data range shown in the main chart.voidtransferRecords(Record[] records, Record targetRecord, Integer index, Canvas sourceWidget, TransferRecordsCallback callback) Transfer a list ofRecords from another component (does not have to be a databound component) into this component.voidSimulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction.voidtransferSelectedData(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.voidMethods 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, getViewPortRectInViewBoxCoords, getZoomLevel, getZoomLevelAsDouble, refreshNow, removeGradient, rotate, scaleAndCenter, scaleAndCenterBezier, setAutoChildProperties, setCanDragScroll, setDefaultProperties, setDrawingHeight, setDrawingType, setDrawingWidth, setDrawItems, setGradients, setLogicalStructure, setRotation, setRotation, setTranslate, setZoomLevel, setZoomLevel, zoom, zoomMethods 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, doValueDictation, doVoiceCommand, 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, 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, supportsValueDictation, supportsVoiceCommands, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDropMethods 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, toStringMethods 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, unsinkEventsMethods 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, sinkBitlessEventMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.smartgwt.client.widgets.DataBoundComponent
getOrCreateJsObjMethods 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 tofalseprevents 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:
FacetChartinstance, 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 tofalseprevents 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 typesthat 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 eithercanZoomis enabled, or if the chart ismulti-axis.- Parameters:
allowedChartTypes- New allowedChartTypes value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls
-
getAllowedChartTypes
Otherchart typesthat 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 eithercanZoomis 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:
FacetChartinstance, 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 minimumwidthorheight. These minimum sizes limit all chart-content, including data and labels, titles and legends.See
autoScrollDatafor a means to introduce scrolling according to the data being displayed.
If this method is called after the component has been drawn/initialized: SetsautoScrollContentand updates the chart.- Parameters:
autoScrollContent- whether the chart should automatically show scrollbars when it's size is smaller than the minimum contentwidthorheight. Default value is false- Returns:
FacetChartinstance, for chaining setter calls
-
getAutoScrollContent
public boolean getAutoScrollContent()When set to true, introduces scrollbars when this widget is smaller than the specified chart-content minimumwidthorheight. These minimum sizes limit all chart-content, including data and labels, titles and legends.See
autoScrollDatafor 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 thicknessesor the margins between them.When true for a Bar chart, expansion and scrollbar are vertical, and also make space for the
minimum configured bar thicknessesor 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)canDragScrollcanZoom
rotateLabelsis set to "auto" it will be treated as "never" ifautoScrollDatahas been set. If any of the other properties have non-default values, a warning will be logged andautoScrollDatawill 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 withminContentWidthandminContentHeight.
If this method is called after the component has been drawn/initialized: SetsautoScrollDataand updates the chart.- Parameters:
autoScrollData- whether chart should automatically expand and show scrollbars to accommodate content. Default value is false- Returns:
FacetChartinstance, for chaining setter calls- See Also:
-
setCanZoom(java.lang.Boolean)setRotateLabels(com.smartgwt.client.types.LabelRotationMode)LabelCollapseModecom.smartgwt.client.widgets.chart.FacetChart#getMinClusterSizeDrawPane.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 thicknessesor the margins between them.When true for a Bar chart, expansion and scrollbar are vertical, and also make space for the
minimum configured bar thicknessesor 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)canDragScrollcanZoom
rotateLabelsis set to "auto" it will be treated as "never" ifautoScrollDatahas been set. If any of the other properties have non-default values, a warning will be logged andautoScrollDatawill 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 withminContentWidthandminContentHeight.- Returns:
- Current autoScrollData value. Default value is false
- See Also:
-
getCanZoom()getRotateLabels()LabelCollapseModecom.smartgwt.client.widgets.chart.FacetChart#getMinClusterSizeDrawPane.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 setminLabelGapto gain more control over the separation.)
If this method is called after the component has been drawn/initialized: SetsAutoScrollDataApproachand updates the chart.- Parameters:
autoScrollDataApproach- what should drive horizontal expansion of the chart?. Default value is null- Returns:
FacetChartinstance, 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 setminLabelGapto 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 sizeso that small values are less likely to be completely occluded by larger values. Set this tofalseto draw the data points in the same order that they appear in the data.- Parameters:
autoSortBubblePoints- New autoSortBubblePoints value. Default value is true- Returns:
FacetChartinstance, 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 sizeso that small values are less likely to be completely occluded by larger values. Set this tofalseto 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.axisEndValueaffects 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, thexAxisEndValueproperty 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
discontinuousLinesto true in this case.- Parameters:
axisEndValue- New axisEndValue value. Default value is null- Returns:
FacetChartinstance, 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.axisEndValueaffects 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, thexAxisEndValueproperty 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
discontinuousLinesto 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.axisStartValueaffects 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, thexAxisStartValueproperty 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
discontinuousLinesto true in this case.- Parameters:
axisStartValue- New axisStartValue value. Default value is null- Returns:
FacetChartinstance, 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.axisStartValueaffects 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, thexAxisStartValueproperty 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
discontinuousLinesto 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:
FacetChartinstance, 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:
FacetChartinstance, 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 deviationlines.Standard deviation bands are not available for pie or radar charts.
- Parameters:
bandedStandardDeviations- New bandedStandardDeviations value. Default value is false- Returns:
FacetChartinstance, 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 deviationlines.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:
FacetChartinstance, 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:
FacetChartinstance, for chaining setter calls- See Also:
-
getBarProperties
Properties for bar- Returns:
- Current barProperties value. Default value is null
-
setBrightenAllOnHover
WhenhighlightDataValuesis 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:
FacetChartinstance, for chaining setter calls
-
getBrightenAllOnHover
WhenhighlightDataValuesis 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
WhenhighlightDataValuesis true, sets the percentage by which to brighten filled data-shapes in somechart-typesas 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:
FacetChartinstance, for chaining setter calls- See Also:
-
getBrightenPercent
public int getBrightenPercent()WhenhighlightDataValuesis true, sets the percentage by which to brighten filled data-shapes in somechart-typesas 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:
FacetChartinstance, 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
pointSizeMetricor thecolorScaleMetricis active the defaultbubblePropertiesdisplays each data points with a linear gradient.- Parameters:
bubbleProperties- New bubbleProperties value. Default value is null- Returns:
FacetChartinstance, 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
pointSizeMetricor thecolorScaleMetricis active the defaultbubblePropertiesdisplays 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:
FacetChartinstance, 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 chartappears with slider controls allowing a range to be selected for display in the main chart.A
labelCollapseModeis 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:
FacetChartinstance, 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 chartappears with slider controls allowing a range to be selected for display in the main chart.A
labelCollapseModeis 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 legendwith respect to the full, scrollable width of the chart whenautoScrollDatais 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:
FacetChartinstance, 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 legendwith respect to the full, scrollable width of the chart whenautoScrollDatais 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 titlewith respect to the full, scrollable width of the chart whenautoScrollDatais 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:
FacetChartinstance, 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 titlewith respect to the full, scrollable width of the chart whenautoScrollDatais 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:
FacetChartinstance, 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,roundingof the chart rect. causes the gradation lines to be automatically inset from the edge so that they do not run right along the curve. SetpadChartRectByCornerRadiustofalseto change this default.- Parameters:
chartRectProperties- New chartRectProperties value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- See Also:
-
getChartRectProperties
Properties for chart rect. By default,roundingof the chart rect. causes the gradation lines to be automatically inset from the edge so that they do not run right along the curve. SetpadChartRectByCornerRadiustofalseto change this default.- Returns:
- Current chartRectProperties value. Default value is null
-
setChartType
SeeChartTypefor 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 forstackedandfilledif those values are null.Note that for
multi-axischarts this method changes thechartTypefor the main value axis only.- Parameters:
chartType- new chart type. Default value is "Column"- Returns:
FacetChartinstance, for chaining setter calls
-
getChartType
SeeChartTypefor 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:
FacetChartinstance, 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:
FacetChartinstance, 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 whereshowDataPointsis enabled, this property specifies an additional metric (i.e. an "id" of a metric facet value) that causes the data points to be colored fromscaleStartColortoscaleEndColorbased 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:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getColorScaleMetric
For charts whereshowDataPointsis enabled, this property specifies an additional metric (i.e. an "id" of a metric facet value) that causes the data points to be colored fromscaleStartColortoscaleEndColorbased 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
setDataFetchModein interfaceDataBoundComponent- Parameters:
dataFetchMode- New dataFetchMode value. Default value is "basic"- Returns:
FacetChartinstance, for chaining setter calls- See Also:
-
getDataFetchMode
FacetCharts do not yet support paging, and will fetch all records that meet the criteria.- Specified by:
getDataFetchModein 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:
FacetChartinstance, 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:
FacetChartinstance, 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 marginif 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:
FacetChartinstance, 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 marginif 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
setDataSourcein interfaceDataBoundComponent- Parameters:
dataSource- New dataSource value. Default value is null- Returns:
FacetChartinstance, 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:
setDataSourcein interfaceDataBoundComponent- Parameters:
dataSource- New dataSource value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- See Also:
-
setDataValueHoverShadow
WhenhighlightDataValuesis true, this attribute can be set to aDrawItem shadowto 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:
FacetChartinstance, for chaining setter calls
-
getDataValueHoverShadow
WhenhighlightDataValuesis true, this attribute can be set to aDrawItem shadowto 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:
FacetChartinstance, 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 tofalsethen null values are ignored. Defaults totrueforfilledcharts and tofalsefor line charts.- Parameters:
discontinuousLines- New discontinuousLines value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls
-
getDiscontinuousLines
Whether to treat non-numeric values in the dataset as indicating a break in the data line. If set tofalsethen null values are ignored. Defaults totrueforfilledcharts and tofalsefor 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:
FacetChartinstance, 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:
FacetChartinstance, 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 thelegendRectPropertiessettings should be used instead.- Parameters:
drawLegendBoundary- New drawLegendBoundary value. Default value is null- Returns:
FacetChartinstance, 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 thelegendRectPropertiessettings should be used instead.- Returns:
- Current drawLegendBoundary value. Default value is null
-
setDrawTitleBackground
should a background color be set behind the Title. UsetitleBackgroundPropertiesto set these values if this is true.- Parameters:
drawTitleBackground- New drawTitleBackground value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls
-
getDrawTitleBackground
should a background color be set behind the Title. UsetitleBackgroundPropertiesto 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 thetitleBackgroundPropertiessettings should be used instead.- Parameters:
drawTitleBoundary- New drawTitleBoundary value. Default value is null- Returns:
FacetChartinstance, 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 thetitleBackgroundPropertiessettings should be used instead.- Returns:
- Current drawTitleBoundary value. Default value is null
-
setEditProxyConstructor
Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.- Overrides:
setEditProxyConstructorin classDrawPane- Parameters:
editProxyConstructor- New editProxyConstructor value. Default value is "FacetChartEditProxy"- Returns:
FacetChartinstance, 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 theEditProxyfor this component when the component isfirst placed into edit mode.- Overrides:
getEditProxyConstructorin 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
FacetChartinstance, 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
lineColorproperty 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:
FacetChartinstance, 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
lineColorproperty 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:
FacetChartinstance, 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:
FacetChartinstance, 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 mainFacetChartdocs 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
valuePropertyor the "id" of aFacetValueof 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
extraAxisSettingsproperty.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.titleof each metric's FacetValue (or thevalueTitleif 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:
FacetChartinstance, 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 mainFacetChartdocs 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
valuePropertyor the "id" of aFacetValueof 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
extraAxisSettingsproperty.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.titleof each metric's FacetValue (or thevalueTitleif 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 metricis plotted. See the mainFacetChartdocs 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
extraAxisMetricsarray. If thechartTypes 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:
FacetChartinstance, 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 metricis plotted. See the mainFacetChartdocs 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
extraAxisMetricsarray. If thechartTypes 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 whatDataSourcefields to use as the chartfacetsfor a databound chart. Iffacetsis also explicitly set,facetFieldsis definitive butFacetproperties will be picked up fromfacetsalso present in thefacetFields.If neither this property nor
facetsis set, a databound chart will attempt to auto-derivefacetFieldsfrom 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:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getFacetFields
Specifies whatDataSourcefields to use as the chartfacetsfor a databound chart. Iffacetsis also explicitly set,facetFieldsis definitive butFacetproperties will be picked up fromfacetsalso present in thefacetFields.If neither this property nor
facetsis set, a databound chart will attempt to auto-derivefacetFieldsfrom 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 whatDataSourcefields to use as the chartfacetsfor a databound chart. Iffacetsis also explicitly set,facetFieldsis definitive butFacetproperties will be picked up fromfacetsalso present in thefacetFields.If neither this property nor
facetsis set, a databound chart will attempt to auto-derivefacetFieldsfrom 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:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getFacetFieldsAsString
Specifies whatDataSourcefields to use as the chartfacetsfor a databound chart. Iffacetsis also explicitly set,facetFieldsis definitive butFacetproperties will be picked up fromfacetsalso present in thefacetFields.If neither this property nor
facetsis set, a databound chart will attempt to auto-derivefacetFieldsfrom 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 facetand thelegend facet. They are named based on where thevaluesof 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,
facetFieldsmay be specified instead of this property. If both are provided,facetFieldsis definitive butFacetproperties will be picked up fromfacetsalso present in thefacetFields.- Parameters:
facets- New facets value. Default value is null- Returns:
FacetChartinstance, 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 facetand thelegend facet. They are named based on where thevaluesof 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,
facetFieldsmay be specified instead of this property. If both are provided,facetFieldsis definitive butFacetproperties will be picked up fromfacetsalso 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 facetand thelegend facet. They are named based on where thevaluesof 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,
facetFieldsmay be specified instead of this property. If both are provided,facetFieldsis definitive butFacetproperties will be picked up fromfacetsalso present in thefacetFields.- Parameters:
facets- New facets value. Default value is null- Returns:
FacetChartinstance, 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 facetand thelegend facet. They are named based on where thevaluesof 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,
facetFieldsmay be specified instead of this property. If both are provided,facetFieldsis definitive butFacetproperties will be picked up fromfacetsalso present in thefacetFields.- Returns:
- Current facets value. Default value is null
-
setFetchRequestProperties
public FacetChart setFetchRequestProperties(DSRequest fetchRequestProperties) throws IllegalStateException IfautoFetchDataistrue, this attribute allows the developer to declaratively specifyDSRequestproperties for the initialfetchData()call.Note that any properties governing more specific request attributes for the initial fetch (such as
autoFetchTextMatchStyleand initial sort specifiers) will be applied on top of this properties block.- Parameters:
fetchRequestProperties- New fetchRequestProperties value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getFetchRequestProperties
IfautoFetchDataistrue, this attribute allows the developer to declaratively specifyDSRequestproperties for the initialfetchData()call.Note that any properties governing more specific request attributes for the initial fetch (such as
autoFetchTextMatchStyleand initial sort specifiers) 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:
FacetChartinstance, 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:
FacetChartinstance, 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
pixelsPerGradationsetting 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- newgradationGapsvalue. Default value is [1, 2, 5]- Returns:
FacetChartinstance, 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
pixelsPerGradationsetting 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
FacetChartinstance, 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.usetickLengthinstead- Parameters:
gradationTickMarkLength- New gradationTickMarkLength value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getGradationTickMarkLength
Deprecated.usetickLengthinstead- 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:
FacetChartinstance, 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:
FacetChartinstance, 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
brighteningtheir fill or border colors by apercentage, and by applying ashadowaround them.- Parameters:
highlightDataValues- New highlightDataValues value. Default value is true- Returns:
FacetChartinstance, 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
brighteningtheir fill or border colors by apercentage, and by applying ashadowaround them.- Returns:
- Current highlightDataValues value. Default value is true
-
setHoverLabelPadding
An extra amount of padding to show around thehoverLabelwhenshowValueOnHoveris enabled.Note : This is an advanced setting
- Parameters:
hoverLabelPadding- New hoverLabelPadding value. Default value is 4- Returns:
FacetChartinstance, 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 thehoverLabelwhenshowValueOnHoveris 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 whenshowValueOnHoveris enabled.- Parameters:
hoverLabelProperties- New hoverLabelProperties value. Default value is null- Returns:
FacetChartinstance, 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 whenshowValueOnHoveris 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. SeeshowValueOnHoverfor more details.- Parameters:
hoverRectProperties- New hoverRectProperties value. Default value is null- Returns:
FacetChartinstance, 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. SeeshowValueOnHoverfor 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
formatmethod for any setter applied withsetXAxisValueFormatter()will not be called on values for the x-axis. However, FacetChart uses theglobal array of abbreviated month namesfor the time granularities of quarters, months, and weeks, uses thedefault short time formatto format labels for time granularities from minutes to hours, and uses thedefault time formatto 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
datamust be initially sorted with thedata label facet's values in ascending order.- Parameters:
labelCollapseMode- New labelCollapseMode value. Default value is null- Returns:
FacetChartinstance, 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
formatmethod for any setter applied withsetXAxisValueFormatter()will not be called on values for the x-axis. However, FacetChart uses theglobal array of abbreviated month namesfor the time granularities of quarters, months, and weeks, uses thedefault short time formatto format labels for time granularities from minutes to hours, and uses thedefault time formatto 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
datamust 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
FacetChartinstance, 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
WhenuseLogGradationsis 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 quartersOr base 2:[ 1 ] [ 1, 1.5 ]- Parameters:
logGradations- New logGradations value. Default value is [ 1,2,4,6,8 ]- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getLogGradations
public float[] getLogGradations()WhenuseLogGradationsis 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 quartersOr 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:
FacetChartinstance, 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 scaleof the data points. Defaults to the value oflogScale.- Parameters:
logScalePointColor- New logScalePointColor value. Default value is false- Returns:
FacetChartinstance, 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 scaleof 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:
FacetChartinstance, 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
lowErrorMetricandhighErrorMetriccan be used to cause error bars to appear above and below the main data point.lowErrorMetricandhighErrorMetricprovide 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:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getLowErrorMetric
lowErrorMetricandhighErrorMetriccan be used to cause error bars to appear above and below the main data point.lowErrorMetricandhighErrorMetricprovide 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
gradationGapssetting 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
majorTickTimeIntervalsfor 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- newmajorTickGradationsvalue. Default value is [1]- Returns:
FacetChartinstance, 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
gradationGapssetting 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
majorTickTimeIntervalsfor 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 axisfor 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- newmajorTickTimeIntervalsvalue. Default value is null- Returns:
FacetChartinstance, for chaining setter calls
-
getMajorTickTimeIntervals
When ticks are beingshown on the X axisfor 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
FacetChartinstance, 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 throughzIndexMetricin 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:
FacetChartinstance, 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 throughzIndexMetricin 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 withlowErrorMetricandhighErrorMetricwhen showing error bars.- Parameters:
metricFacetId- New metricFacetId value. Default value is "metric"- Returns:
FacetChartinstance, 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 withlowErrorMetricandhighErrorMetricwhen 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:
FacetChartinstance, 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:
FacetChartinstance, 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 heightfor the chart body. Default value is 1
-
setMinChartWidth
Minimum width for this chart instance.- Parameters:
minChartWidth- New minChartWidth value. Default value is 1- Returns:
FacetChartinstance, 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 widthfor the chart body. Default value is 1
-
setMinContentHeight
WhenautoScrollContentis 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. SeeminContentWidthto affect the minimum horizontal content-size.- Parameters:
minContentHeight- New minContentHeight value. Default value is 150- Returns:
FacetChartinstance, for chaining setter calls
-
getMinContentHeight
public int getMinContentHeight()WhenautoScrollContentis 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. SeeminContentWidthto affect the minimum horizontal content-size.- Returns:
- Returns the
minContentHeightfor this facet chart whenautoScrollContentis enabled. Default value is 150
-
setMinContentWidth
WhenautoScrollContentis 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. SeeminContentHeightto affect the minimum vertical content-size.- Parameters:
minContentWidth- New minContentWidth value. Default value is 150- Returns:
FacetChartinstance, for chaining setter calls
-
getMinContentWidth
public int getMinContentWidth()WhenautoScrollContentis 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. SeeminContentHeightto affect the minimum vertical content-size.- Returns:
- Returns the
minContentWidthfor this facet chart whenautoScrollContentis 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:
FacetChartinstance, 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 thanminDataSpreadPercentof 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
minDataSpreadPercentsetting 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
axisStartValueoraxisEndValue, disables this behavior, as does settingminDataSpreadPercentto 0.For multi-axis charts, use
MetricSettings.minDataSpreadPercentfor per-axis settings.For Bubble and Scatter charts,
minDataSpreadPercentaffects only the y-axis of the chart. The propertyminXDataSpreadPercentmust be used to enable the corresponding feature for the x-axis.- Parameters:
minDataSpreadPercent- New minDataSpreadPercent value. Default value is 30- Returns:
FacetChartinstance, 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 thanminDataSpreadPercentof 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
minDataSpreadPercentsetting 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
axisStartValueoraxisEndValue, disables this behavior, as does settingminDataSpreadPercentto 0.For multi-axis charts, use
MetricSettings.minDataSpreadPercentfor per-axis settings.For Bubble and Scatter charts,
minDataSpreadPercentaffects only the y-axis of the chart. The propertyminXDataSpreadPercentmust 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:
FacetChartinstance, 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 marksare enabled.
If this method is called after the component has been drawn/initialized: Setter forminorTickLength.- Parameters:
minorTickLength- newminorTickLengthvalue. Default value is 2- Returns:
FacetChartinstance, for chaining setter calls- See Also:
-
getMinorTickLength
public int getMinorTickLength()Length of minor ticks marks shown along axis, ifminor tick marksare 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 thanminXDataSpreadPercentof the x-axis, the start value of x-axis will be automatically adjusted to make better use of space.Setting an explicit
xAxisStartValuedisables this behavior, as does settingminXDataSpreadPercentto 0.- Parameters:
minXDataSpreadPercent- New minXDataSpreadPercent value. Default value is 30- Returns:
FacetChartinstance, 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 thanminXDataSpreadPercentof the x-axis, the start value of x-axis will be automatically adjusted to make better use of space.Setting an explicit
xAxisStartValuedisables this behavior, as does settingminXDataSpreadPercentto 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
otherAxisGradationTimesfor control of gradations when the X axis is time-valued.Defaults to the value of
pixelsPerGradationif unset.
If this method is called after the component has been drawn/initialized: Setter forotherAxisGradationGaps.- Parameters:
otherAxisGradationGaps- newotherAxisGradationGapsvalue. Default value is null- Returns:
FacetChartinstance, 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
otherAxisGradationTimesfor control of gradations when the X axis is time-valued.Defaults to the value of
pixelsPerGradationif 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
otherAxisGradationGapsto 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- newotherAxisGradationTimesvalue. Default value is null- Returns:
FacetChartinstance, 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
otherAxisGradationGapsto 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
pixelsPerGradationif unset.
If this method is called after the component has been drawn/initialized: Setter forotherAxisPixelsPerGradation.- Parameters:
otherAxisPixelsPerGradation- newotherAxisPixelsPerGradationvalue. Default value is null- Returns:
FacetChartinstance, 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
pixelsPerGradationif 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:
FacetChartinstance, 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 IfshowChartRectis enabled and ifchartRectPropertiesspecifies 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:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getPadChartRectByCornerRadius
public boolean getPadChartRectByCornerRadius()IfshowChartRectis enabled and ifchartRectPropertiesspecifies 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
FacetChartinstance, 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:
FacetChartinstance, 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 values. Default of 0 places the first value starting from the "east" position. Use 270 or -90 for north.- Parameters:
pieStartAngle- New pieStartAngle value. Default value is 0- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getPieStartAngle
Default angle in degrees where pie charts start drawing sectors to represent data values. Default of 0 places the first value starting from the "east" position. Use 270 or -90 for north.- Returns:
- Current pieStartAngle value. Default value is 0
-
setPixelsPerGradation
Ideal number of pixels to leave between each gradation on the primary axis, which is typically the y (vertical) axis except for Bar charts.The chart will detect the range of values being displayed and available pixels on the vertical axis, and generate gradations that are spaced approximately
pixelsPerGradationsapart. Note that the Framework will attempt to approach the specified target gap from above - the chart will never be drawn with gradations spaced closer thanpixelsPerGradation.
If this method is called after the component has been drawn/initialized: Setter forpixelsPerGradation.- Parameters:
pixelsPerGradation- newpixelsPerGradationvalue. Default value is 28- Returns:
FacetChartinstance, for chaining setter calls- See Also:
-
getPixelsPerGradation
public int getPixelsPerGradation()Ideal number of pixels to leave between each gradation on the primary axis, which is typically the y (vertical) axis except for Bar charts.The chart will detect the range of values being displayed and available pixels on the vertical axis, and generate gradations that are spaced approximately
pixelsPerGradationsapart. Note that the Framework will attempt to approach the specified target gap from above - the chart will never be drawn with gradations spaced closer thanpixelsPerGradation.- Returns:
- Current pixelsPerGradation value. Default value is 28
- See Also:
-
setPointColorLogBase
WhenlogScalePointColoristrue, this property specifies the base value for logarithmiccolor scale metricvalues.- Parameters:
pointColorLogBase- New pointColorLogBase value. Default value is 10- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getPointColorLogBase
WhenlogScalePointColoristrue, this property specifies the base value for logarithmiccolor scale metricvalues.- Returns:
- Current pointColorLogBase value. Default value is 10
-
setPointShapes
For charts whereshowDataPointsis enabled, this property specifies an array of geometric shapes to draw for the data points of each series.- Parameters:
pointShapes- New pointShapes value. Default value is ["Oval", "Square", "Diamond", "Triangle"]- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getPointShapes
For charts whereshowDataPointsis enabled, this property specifies an array of geometric shapes to draw for the data points of each series.- Returns:
- Current pointShapes value. Default value is ["Oval", "Square", "Diamond", "Triangle"]
-
setPointSizeGradations
When apoint size legendis shown, this property controls the number of gradations of thepointSizeMetricthat the chart tries to display.Note that if
usePointSizeLogGradationsis set then the number of gradations is not given by this property but rather by the entries ofpointSizeLogGradations.- Parameters:
pointSizeGradations- New pointSizeGradations value. Default value is 5- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getPointSizeGradations
When apoint size legendis shown, this property controls the number of gradations of thepointSizeMetricthat the chart tries to display.Note that if
usePointSizeLogGradationsis set then the number of gradations is not given by this property but rather by the entries ofpointSizeLogGradations.- Returns:
- Current pointSizeGradations value. Default value is 5
-
setPointSizeLogBase
WhenlogScalePointSizeis true, base value for logarithmic point size metric values.- Parameters:
pointSizeLogBase- New pointSizeLogBase value. Default value is 10- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getPointSizeLogBase
WhenlogScalePointSizeis true, base value for logarithmic point size metric values.- Returns:
- Current pointSizeLogBase value. Default value is 10
-
setPointSizeLogGradations
public FacetChart setPointSizeLogGradations(float... pointSizeLogGradations) throws IllegalStateException WhenusePointSizeLogGradationsis set, this property specifies thepointSizeMetricvalue gradations to show in thepoint size legendin between powers, expressed as a series of integer or float values between 1 andpointSizeLogBase.- Parameters:
pointSizeLogGradations- New pointSizeLogGradations value. Default value is [1, 5]- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getPointSizeLogGradations
public float[] getPointSizeLogGradations()WhenusePointSizeLogGradationsis set, this property specifies thepointSizeMetricvalue gradations to show in thepoint size legendin between powers, expressed as a series of integer or float values between 1 andpointSizeLogBase.- Returns:
- Current pointSizeLogGradations value. Default value is [1, 5]
- See Also:
-
setPointSizeMetric
For charts whereshowDataPointsis enabled, this property specifies an additional metric (i.e. an "id" of a metric facet value) that determines the size of the data points drawn. For example, when a circle is drawn to represent a data point then the size of the data point is the diameter of the circle, in pixels.The size is calculated by linearly scaling the value of the
pointSizeMetricof the point between theminDataPointSizeandmaxDataPointSize. The data point that has the lowest value for thepointSizeMetricwill be drawn as a shapeminDataPointSizepixels in size, and the data point that has the highest value for thepointSizeMetricwill be drawn as a shapemaxDataPointSizepixels in size.Using a log-scale to calulate the size of the data points is achieved by enabling
logScalePointSize.If the
ChartTypeis"Bubble"then the defaultpointSizeMetricis"pointSize".Note that setting
pointSizeMetricto non-nullimplicitly enablesshowDataPoints.- Parameters:
pointSizeMetric- New pointSizeMetric value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getPointSizeMetric
For charts whereshowDataPointsis enabled, this property specifies an additional metric (i.e. an "id" of a metric facet value) that determines the size of the data points drawn. For example, when a circle is drawn to represent a data point then the size of the data point is the diameter of the circle, in pixels.The size is calculated by linearly scaling the value of the
pointSizeMetricof the point between theminDataPointSizeandmaxDataPointSize. The data point that has the lowest value for thepointSizeMetricwill be drawn as a shapeminDataPointSizepixels in size, and the data point that has the highest value for thepointSizeMetricwill be drawn as a shapemaxDataPointSizepixels in size.Using a log-scale to calulate the size of the data points is achieved by enabling
logScalePointSize.If the
ChartTypeis"Bubble"then the defaultpointSizeMetricis"pointSize".Note that setting
pointSizeMetricto non-nullimplicitly enablesshowDataPoints.- Returns:
- Current pointSizeMetric value. Default value is null
- See Also:
-
setPrintZoomChart
Should thezoom chartbe printed with thisFacetChart? Iftrue, then the SVG string returned byDrawPane.getSvgString()will include the zoom chart's SVG as well.Note : This is an advanced setting
- Parameters:
printZoomChart- New printZoomChart value. Default value is true- Returns:
FacetChartinstance, for chaining setter calls- See Also:
-
getPrintZoomChart
public boolean getPrintZoomChart()Should thezoom chartbe printed with thisFacetChart? Iftrue, then the SVG string returned byDrawPane.getSvgString()will include the zoom chart's SVG as well.- Returns:
- Current printZoomChart value. Default value is true
- See Also:
-
setProbabilityMetric
The "id" of the metric facet value that assigns a probability to each combination of facets and their values. Each probability must be a non-negative number. These probabilities are used by all methods of FacetChart that calculate statistical values (e.g.getMean()andgetStdDev()). The default value of this property is null which causes the FacetChart to assign probabilities to the data records according to a uniform probability distribution.Note that the FacetChart handles cases where the sum total of all probabilities in the
datais not exactly one by scaling the assigned probabilities.- Parameters:
probabilityMetric- New probabilityMetric value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getProbabilityMetric
The "id" of the metric facet value that assigns a probability to each combination of facets and their values. Each probability must be a non-negative number. These probabilities are used by all methods of FacetChart that calculate statistical values (e.g.getMean()andgetStdDev()). The default value of this property is null which causes the FacetChart to assign probabilities to the data records according to a uniform probability distribution.Note that the FacetChart handles cases where the sum total of all probabilities in the
datais not exactly one by scaling the assigned probabilities.- Returns:
- Current probabilityMetric value. Default value is null
- See Also:
-
setProportional
For multi-facet charts, render data values as a proportion of the sum of all data values that have the same label.Gradation labels will be switched to show percentage instead of absolute values.
This setting is valid only for Column, Bar, Area and Radar chart types and only in
stackedmode. Stacked columns will be as tall as the chart rect and stacked bars will be as wide as the chart rect. Area and Radar charts will be completely filled except for facet values where all values are 0.
If this method is called after the component has been drawn/initialized: Setter forproportional.- Parameters:
proportional- Whether the chart should now use proportional mode. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- See Also:
-
getProportional
For multi-facet charts, render data values as a proportion of the sum of all data values that have the same label.Gradation labels will be switched to show percentage instead of absolute values.
This setting is valid only for Column, Bar, Area and Radar chart types and only in
stackedmode. Stacked columns will be as tall as the chart rect and stacked bars will be as wide as the chart rect. Area and Radar charts will be completely filled except for facet values where all values are 0.- Returns:
- Current proportional value. Default value is null
- See Also:
-
setProportionalAxisLabel
public FacetChart setProportionalAxisLabel(String proportionalAxisLabel) throws IllegalStateException Default title for the value axis label when the chart is inproportional rendering mode. This title will be used unless thelegend facetdefines aproportionalTitle.- Parameters:
proportionalAxisLabel- New proportionalAxisLabel value. Default value is "Percent"- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getProportionalAxisLabel
Default title for the value axis label when the chart is inproportional rendering mode. This title will be used unless thelegend facetdefines aproportionalTitle.- Returns:
- Current proportionalAxisLabel value. Default value is "Percent"
-
setRadarBackgroundProperties
public FacetChart setRadarBackgroundProperties(DrawOval radarBackgroundProperties) throws IllegalStateException Properties for radar background- Parameters:
radarBackgroundProperties- New radarBackgroundProperties value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getRadarBackgroundProperties
Properties for radar background- Returns:
- Current radarBackgroundProperties value. Default value is null
-
setRadarRotateLabels
public FacetChart setRadarRotateLabels(LabelRotationMode radarRotateLabels) throws IllegalStateException This property controls whether to rotate the labels on thedata label facetof radar orstackedpie charts so that each label is parallel to its radial gradation (these are the labels that appear around the perimeter). For now, "auto" means the same thing as "always" - but this may change in the future if heuristics are added to determine when the affected labels are likely to overlap and not be legible. If rotateLabels is "never" then the labels will not be rotated.- Parameters:
radarRotateLabels- New radarRotateLabels value. Default value is "auto"- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getRadarRotateLabels
This property controls whether to rotate the labels on thedata label facetof radar orstackedpie charts so that each label is parallel to its radial gradation (these are the labels that appear around the perimeter). For now, "auto" means the same thing as "always" - but this may change in the future if heuristics are added to determine when the affected labels are likely to overlap and not be legible. If rotateLabels is "never" then the labels will not be rotated.- Returns:
- Current radarRotateLabels value. Default value is "auto"
- See Also:
-
setRadialLabelOffset
Distance in pixels that radial labels are offset from the outside of the circle. Default can vary depending uponChartTypeandradarRotateLabels.- Parameters:
radialLabelOffset- New radialLabelOffset value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getRadialLabelOffset
Distance in pixels that radial labels are offset from the outside of the circle. Default can vary depending uponChartTypeandradarRotateLabels.- Returns:
- Current radialLabelOffset value. Default value is null
-
setRegressionLineProperties
public FacetChart setRegressionLineProperties(DrawLine regressionLineProperties) throws IllegalStateException Properties for theregression line.- Parameters:
regressionLineProperties- New regressionLineProperties value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getRegressionLineProperties
Properties for theregression line.- Returns:
- Current regressionLineProperties value. Default value is null
-
setRegressionLineType
Regression algorithm used for theregression line.
If this method is called after the component has been drawn/initialized: Setter forRegressionLineType.- Parameters:
regressionLineType- New value for this.regressionLineType. Default value is "line"- Returns:
FacetChartinstance, for chaining setter calls
-
getRegressionLineType
Regression algorithm used for theregression line.- Returns:
- Current regressionLineType value. Default value is "line"
-
setRegressionPolynomialDegree
For scatter plots only, specify the degree of polynomial to use for any polynomial regression that is calculated.
If this method is called after the component has been drawn/initialized: Setter forregressionPolynomialDegree.- Parameters:
regressionPolynomialDegree- New value for this.regressionPolynomialDegree. Default value is 3- Returns:
FacetChartinstance, for chaining setter calls
-
getRegressionPolynomialDegree
public int getRegressionPolynomialDegree()For scatter plots only, specify the degree of polynomial to use for any polynomial regression that is calculated.- Returns:
- Current regressionPolynomialDegree value. Default value is 3
-
setRotateDataValues
This property controls whether to rotate the labels shown for data-values inColumn-type charts. "auto" will rotate all data-values if any of them are wider than their columns. In all cases, whether rotated or not, data-values are hidden and instead shown in hovers if any of them exceed their bar's width.- Parameters:
rotateDataValues- New rotateDataValues value. Default value is "auto"- Returns:
FacetChartinstance, for chaining setter calls- See Also:
-
getRotateDataValues
This property controls whether to rotate the labels shown for data-values inColumn-type charts. "auto" will rotate all data-values if any of them are wider than their columns. In all cases, whether rotated or not, data-values are hidden and instead shown in hovers if any of them exceed their bar's width.- Returns:
- Current rotateDataValues value. Default value is "auto"
- See Also:
-
setRotateLabels
This property controls whether to rotate the labels on the X-axis. If rotateLabels is "always" then all of the data labels will be rotated by 90 degrees. If rotateLabels is "auto" (the default) then the labels will only be rotated if it is required in order for the labels to be legible and non-overlapping. If rotateLabels is "never" then the labels will not be rotated.Note that automatic rotation is incompatible with setting a cluster-size-minimum customizer using
FacetChart.setMinClusterSizeMapper(), so thatLabelRotationMode.AUTOwill be treated asLabelRotationMode.NEVERif that method has been specified on a column, bar, or histogram chart.- Parameters:
rotateLabels- New rotateLabels value. Default value is "auto"- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getRotateLabels
This property controls whether to rotate the labels on the X-axis. If rotateLabels is "always" then all of the data labels will be rotated by 90 degrees. If rotateLabels is "auto" (the default) then the labels will only be rotated if it is required in order for the labels to be legible and non-overlapping. If rotateLabels is "never" then the labels will not be rotated.Note that automatic rotation is incompatible with setting a cluster-size-minimum customizer using
FacetChart.setMinClusterSizeMapper(), so thatLabelRotationMode.AUTOwill be treated asLabelRotationMode.NEVERif that method has been specified on a column, bar, or histogram chart.- Returns:
- Current rotateLabels value. Default value is "auto"
- See Also:
-
setScaleEndColor
The ending color of the color scale when the data points are colored according to acolor scale metric. If neither this property nor thescaleStartColoris set then the whole color range is used by default.Note that using CSS color shortcuts (e.g. "lightblue") is not allowed for this property.
If this method is called after the component has been drawn/initialized: Setter forscaleEndColor.- Parameters:
scaleEndColor- The new end color for the color scale. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- See Also:
-
getScaleEndColor
The ending color of the color scale when the data points are colored according to acolor scale metric. If neither this property nor thescaleStartColoris set then the whole color range is used by default.Note that using CSS color shortcuts (e.g. "lightblue") is not allowed for this property.
- Returns:
- Current scaleEndColor value. Default value is null
- See Also:
-
setScaleStartColor
The starting color of the color scale when the data points are colored according to acolor scale metric. If neither this property nor thescaleEndColoris set then the whole color range is used by default.Note that using CSS color shortcuts (e.g. "lightblue") is not allowed for this property.
If this method is called after the component has been drawn/initialized: Setter forscaleStartColor.- Parameters:
scaleStartColor- The new start color for the color scale. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- See Also:
-
getScaleStartColor
The starting color of the color scale when the data points are colored according to acolor scale metric. If neither this property nor thescaleEndColoris set then the whole color range is used by default.Note that using CSS color shortcuts (e.g. "lightblue") is not allowed for this property.
- Returns:
- Current scaleStartColor value. Default value is null
- See Also:
-
setShadowProperties
Properties for shadows.- Parameters:
shadowProperties- New shadowProperties value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getShadowProperties
Properties for shadows.- Returns:
- Current shadowProperties value. Default value is null
- See Also:
-
setShowBubbleLegendPerShape
public FacetChart setShowBubbleLegendPerShape(boolean showBubbleLegendPerShape) throws IllegalStateException Whether to draw multiple bubble legends horizontally stacked to the right of the chart, one per shape type.Note that this setting has no effect if
useMultiplePointShapesis disabled.- Parameters:
showBubbleLegendPerShape- New showBubbleLegendPerShape value. Default value is false- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowBubbleLegendPerShape
public boolean getShowBubbleLegendPerShape()Whether to draw multiple bubble legends horizontally stacked to the right of the chart, one per shape type.Note that this setting has no effect if
useMultiplePointShapesis disabled.- Returns:
- Current showBubbleLegendPerShape value. Default value is false
-
setShowChartRect
Whether to show a rectangular shape around the area of the chart where data is plotted.- Parameters:
showChartRect- New showChartRect value. Default value is false- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowChartRect
Whether to show a rectangular shape around the area of the chart where data is plotted.- Returns:
- Current showChartRect value. Default value is false
-
setShowColorScaleLegend
public FacetChart setShowColorScaleLegend(Boolean showColorScaleLegend) throws IllegalStateException Whether to show an additional legend underneath the chart to indicate color values. The default istrueif a validcolorScaleMetricis specified.- Parameters:
showColorScaleLegend- New showColorScaleLegend value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getShowColorScaleLegend
Whether to show an additional legend underneath the chart to indicate color values. The default istrueif a validcolorScaleMetricis specified.- Returns:
- Current showColorScaleLegend value. Default value is null
- See Also:
-
setShowDataAxisLabel
Whether to show a label for the data axis as a whole (the data axis is where labels for each data point appear). If true,Facet.titlefor the data label facet will be shown as the label.Automatically disabled for non-rectangular charts (eg Pie, Radar).
- Parameters:
showDataAxisLabel- New showDataAxisLabel value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowDataAxisLabel
Whether to show a label for the data axis as a whole (the data axis is where labels for each data point appear). If true,Facet.titlefor the data label facet will be shown as the label.Automatically disabled for non-rectangular charts (eg Pie, Radar).
- Returns:
- Current showDataAxisLabel value. Default value is null
-
setShowDataLabels
If set tofalse, data labels for values are entirely omitted.This property would generally only be set to
falseif several small charts are shown together and the data labels are drawn elsewhere on the screen (above an entire stack of charts, for instance) or are otherwise implicit.- Parameters:
showDataLabels- New showDataLabels value. Default value is true- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowDataLabels
public boolean getShowDataLabels()If set tofalse, data labels for values are entirely omitted.This property would generally only be set to
falseif several small charts are shown together and the data labels are drawn elsewhere on the screen (above an entire stack of charts, for instance) or are otherwise implicit.- Returns:
- Current showDataLabels value. Default value is true
-
setShowDataPoints
For Line, Area, Radar, Scatter or Bubble charts, whether to show data points for each individual data value.If shown, the
pointClick()andgetPointHoverHTML()APIs can be used to create interactivity.- Parameters:
showDataPoints- New showDataPoints value. Default value is false- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowDataPoints
For Line, Area, Radar, Scatter or Bubble charts, whether to show data points for each individual data value.If shown, the
pointClick()andgetPointHoverHTML()APIs can be used to create interactivity.- Returns:
- Current showDataPoints value. Default value is false
-
setShowDataValues
Deprecated.in favor ofshowDataValuesMode, a compound setting that supports showing data-values in the chart and in hovers in various combinations. The equivalent to showDataValues:true isShowDataValuesMode.inChartOnlyorShowDataValuesMode.inChartOrHoverif showValueOnHover was also set to true.Should data values be shown as text labels near the shape representing the value, for example, above columns of a column chart, or adjacent to points in a line chart?If set to false, then data values will not be shown.
If set to true, data values will be shown unless the data density is high enough that labels will potentially overlap, in which case, data values will not be shown and hovers will be shown instead, in the same way as
showValueOnHovershows hovers.- Parameters:
showDataValues- New showDataValues value. Default value is false- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowDataValues
public boolean getShowDataValues()Deprecated.in favor ofshowDataValuesMode, a compound setting that supports showing data-values in the chart and in hovers in various combinations. The equivalent to showDataValues:true isShowDataValuesMode.inChartOnlyorShowDataValuesMode.inChartOrHoverif showValueOnHover was also set to true.Should data values be shown as text labels near the shape representing the value, for example, above columns of a column chart, or adjacent to points in a line chart?If set to false, then data values will not be shown.
If set to true, data values will be shown unless the data density is high enough that labels will potentially overlap, in which case, data values will not be shown and hovers will be shown instead, in the same way as
showValueOnHovershows hovers.- Returns:
- Current showDataValues value. Default value is false
-
setShowDataValuesMode
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 rotationwhere supported.Depending on the chart type, there are different options for showing data-values - eg,
stacked-chartscannot show values inline in the chart-body; column-charts can, and they can rotate titles if they're wider than their columns; pie charts can show some data-values in the chart but not others; all the types can show values in hovers.If set to never, then data-values will never be shown; inChartOnly allows data-values in the chart-body, where supported and where they will fit, but suppresses them in hovers and inHoverOnly always shows all data-values in hovers.
If set to auto, first try to show values in the chart, where the chart-type supports it, and where they'll fit. If they don't all fit, show the ones that do, including rotating them if necessary, if the chart-type allows it, and then switch on hovers as well, as needed. This mode is particularly useful in situations where the chart-type can be changed by the user.
- Parameters:
showDataValuesMode- New showDataValuesMode value. Default value is "never"- Returns:
FacetChartinstance, for chaining setter calls
-
getShowDataValuesMode
Strategy for determining whether and when to show data-values - either in the chart, near the shape representing a value (above columns of a column chart for example, or adjacent to points in a line chart), in hovers, or some combination of both, includingautomatic rotationwhere supported.Depending on the chart type, there are different options for showing data-values - eg,
stacked-chartscannot show values inline in the chart-body; column-charts can, and they can rotate titles if they're wider than their columns; pie charts can show some data-values in the chart but not others; all the types can show values in hovers.If set to never, then data-values will never be shown; inChartOnly allows data-values in the chart-body, where supported and where they will fit, but suppresses them in hovers and inHoverOnly always shows all data-values in hovers.
If set to auto, first try to show values in the chart, where the chart-type supports it, and where they'll fit. If they don't all fit, show the ones that do, including rotating them if necessary, if the chart-type allows it, and then switch on hovers as well, as needed. This mode is particularly useful in situations where the chart-type can be changed by the user.
- Returns:
- Current showDataValuesMode value. Default value is "never"
-
setShowDetailFields
ThisDataBoundComponentproperty is not applicable to charts.- Specified by:
setShowDetailFieldsin interfaceDataBoundComponent- Parameters:
showDetailFields- New showDetailFields value. Default value is false- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowDetailFields
ThisDataBoundComponentproperty is not applicable to charts.- Specified by:
getShowDetailFieldsin interfaceDataBoundComponent- Returns:
- Current showDetailFields value. Default value is false
-
setShowDoughnut
Whether to show a "doughnut hole" in the middle of pie charts. Defaults to whether chartType is set to "Doughnut" (shown) vs "Pie" (not shown) but can be forced on or off viashowDoughnut.- Parameters:
showDoughnut- New showDoughnut value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowDoughnut
Whether to show a "doughnut hole" in the middle of pie charts. Defaults to whether chartType is set to "Doughnut" (shown) vs "Pie" (not shown) but can be forced on or off viashowDoughnut.- Returns:
- Current showDoughnut value. Default value is null
-
setShowExpectedValueLine
public FacetChart setShowExpectedValueLine(Boolean showExpectedValueLine) throws IllegalStateException Display a line at themean value.Note that this expected value is computed using all of the data points, pooled across all facets. The computation relies only on the values of the main value axis metric and the
probability metric.- Parameters:
showExpectedValueLine- New showExpectedValueLine value. Default value is false- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowExpectedValueLine
Display a line at themean value.Note that this expected value is computed using all of the data points, pooled across all facets. The computation relies only on the values of the main value axis metric and the
probability metric.- Returns:
- Current showExpectedValueLine value. Default value is false
-
setShowGradationsOverData
public FacetChart setShowGradationsOverData(Boolean showGradationsOverData) throws IllegalStateException If set, gradation lines are drawn on top of data rather than underneath.- Parameters:
showGradationsOverData- New showGradationsOverData value. Default value is false- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowGradationsOverData
If set, gradation lines are drawn on top of data rather than underneath.- Returns:
- Current showGradationsOverData value. Default value is false
-
setShowInlineLabels
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. Also causes the last label to be skipped (nowhere to place it).- Parameters:
showInlineLabels- New showInlineLabels value. Default value is false- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowInlineLabels
Causes labels for the X axis to be shown above the axis and to the right of the gradation line they label, making for a vertically more compact chart at the risk of gradation labels being partially obscured by data values. Also causes the last label to be skipped (nowhere to place it).- Returns:
- Current showInlineLabels value. Default value is false
-
setShowLegend
The legend is automatically shown for charts that need it (generally, multi-series charts) but can be forced off by setting showLegend to false.- Parameters:
showLegend- New showLegend value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowLegend
The legend is automatically shown for charts that need it (generally, multi-series charts) but can be forced off by setting showLegend to false.- Returns:
- Current showLegend value. Default value is null
-
setShowMinorTicks
Ifticksare being shown, controls whether a distinction is made between major and minor tick marks.If minor ticks are used, by default, major ticks are used for powers of 10 and minor ticks are used for other gradations. See
majorTickGradationsfor control over which ticks are rendered as major vs minor ticks.
If this method is called after the component has been drawn/initialized: Setter forshowMinorTicks.- Parameters:
showMinorTicks- newshowMinorTicksvalue. Default value is true- Returns:
FacetChartinstance, for chaining setter calls
-
getShowMinorTicks
public boolean getShowMinorTicks()Ifticksare being shown, controls whether a distinction is made between major and minor tick marks.If minor ticks are used, by default, major ticks are used for powers of 10 and minor ticks are used for other gradations. See
majorTickGradationsfor control over which ticks are rendered as major vs minor ticks.- Returns:
- Current showMinorTicks value. Default value is true
-
setShowPointSizeLegend
Whether to show an additional legend to the right of the chart to indicatepoint size. The default istruefor bubble charts andfalsefor all other chart types.- Parameters:
showPointSizeLegend- New showPointSizeLegend value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getShowPointSizeLegend
Whether to show an additional legend to the right of the chart to indicatepoint size. The default istruefor bubble charts andfalsefor all other chart types.- Returns:
- Current showPointSizeLegend value. Default value is null
- See Also:
-
setShowRadarGradationLabels
public FacetChart setShowRadarGradationLabels(Boolean showRadarGradationLabels) throws IllegalStateException Whether to show gradation labels in radar charts.- Parameters:
showRadarGradationLabels- New showRadarGradationLabels value. Default value is true- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowRadarGradationLabels
Whether to show gradation labels in radar charts.- Returns:
- Current showRadarGradationLabels value. Default value is true
-
setShowRegressionLine
For scatter plots only, whether to display a regression curve that best fits the data of the two metric facet values.The type of regression curve used depends on the
RegressionLineTypeproperty, which can be:- "line" – to draw a linear regression curve, or
- "polynomial" –
to draw a polynomial regression curve (of degree
regressionPolynomialDegree).
Note that the regression is computed using all of the data points and it does not depend on the values of any non-metric facets. For example, adding a legend facet will not change the regression curve.
See http://en.wikipedia.org/wiki/Simple_linear_regression. See http://en.wikipedia.org/wiki/Polynomial_regression.
If this method is called after the component has been drawn/initialized: Setter forshowRegressionLine.- Parameters:
showRegressionLine- New value for this.showRegressionLine. Default value is false- Returns:
FacetChartinstance, for chaining setter calls- See Also:
-
getShowRegressionLine
For scatter plots only, whether to display a regression curve that best fits the data of the two metric facet values.The type of regression curve used depends on the
RegressionLineTypeproperty, which can be:- "line" – to draw a linear regression curve, or
- "polynomial" –
to draw a polynomial regression curve (of degree
regressionPolynomialDegree).
Note that the regression is computed using all of the data points and it does not depend on the values of any non-metric facets. For example, adding a legend facet will not change the regression curve.
See http://en.wikipedia.org/wiki/Simple_linear_regression. See http://en.wikipedia.org/wiki/Polynomial_regression.
- Returns:
- Current showRegressionLine value. Default value is false
- See Also:
-
setShowScatterLines
Whether to draw lines between adjacent data points in "Scatter" plots. See alsoDataLineTypefor enabling smoothing.
If this method is called after the component has been drawn/initialized: Method to change the currentshowScatterLines. Will redraw the chart if drawn.- Parameters:
showScatterLines- whether to draw lines between adjacent data points in "Scatter" plots. Default value is false- Returns:
FacetChartinstance, for chaining setter calls- See Also:
-
getShowScatterLines
Whether to draw lines between adjacent data points in "Scatter" plots. See alsoDataLineTypefor enabling smoothing.- Returns:
- Current showScatterLines value. Default value is false
- See Also:
-
setShowShadows
Whether to automatically show shadows for various charts.- Parameters:
showShadows- New showShadows value. Default value is true- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getShowShadows
Whether to automatically show shadows for various charts.- Returns:
- Current showShadows value. Default value is true
- See Also:
-
setShowStandardDeviationLines
public FacetChart setShowStandardDeviationLines(Boolean showStandardDeviationLines) throws IllegalStateException Display multiplestandard deviationsaway from the mean as lines. The exact deviations to display can be customized withstandardDeviations.Note that these standard deviations are computed using all of the data points, pooled across all facets. The computation relies only on the values of the main value axis metric and the
probability metric.- Parameters:
showStandardDeviationLines- New showStandardDeviationLines value. Default value is false- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowStandardDeviationLines
Display multiplestandard deviationsaway from the mean as lines. The exact deviations to display can be customized withstandardDeviations.Note that these standard deviations are computed using all of the data points, pooled across all facets. The computation relies only on the values of the main value axis metric and the
probability metric.- Returns:
- Current showStandardDeviationLines value. Default value is false
-
setShowStatisticsOverData
public FacetChart setShowStatisticsOverData(Boolean showStatisticsOverData) throws IllegalStateException If set, themean line,standard deviation lines,standard deviation bands, andregression curvesare drawn on top of the data rather than underneath.- Parameters:
showStatisticsOverData- New showStatisticsOverData value. Default value is false- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowStatisticsOverData
If set, themean line,standard deviation lines,standard deviation bands, andregression curvesare drawn on top of the data rather than underneath.- Returns:
- Current showStatisticsOverData value. Default value is false
-
setShowTitle
Whether to show a title.- Parameters:
showTitle- New showTitle value. Default value is true- Returns:
FacetChartinstance, for chaining setter calls
-
getShowTitle
Whether to show a title.- Returns:
- Current showTitle value. Default value is true
-
setShowValueAxisLabel
Whether to show thevalueTitle(or, in the case ofproportional rendering mode, theproportionalAxisLabel) as a label on the value axis.Automatically disabled for non-rectangular charts (eg Pie, Radar).
- Parameters:
showValueAxisLabel- New showValueAxisLabel value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowValueAxisLabel
Whether to show thevalueTitle(or, in the case ofproportional rendering mode, theproportionalAxisLabel) as a label on the value axis.Automatically disabled for non-rectangular charts (eg Pie, Radar).
- Returns:
- Current showValueAxisLabel value. Default value is null
-
setShowValueOnHover
Deprecated.in favor ofshowDataValuesMode, a compound setting that supports showing data-values in the chart and in hovers in various combinations. The equivalent to showValueOnHover:true is ShowDataValuesMode.inHoverOnly.Shows the value of the nearest data value in a floating label whenever the mouse moves within the main chart area. The visual element representing the data value will also be emphasized by brightening or highlighting it (appearance differs by chart type).Calculates nearest value based on
getNearestDrawnValue().The data value will be formatted using
setDataValueFormatter(). The label's appearance is controlled byhoverLabelProperties.- Parameters:
showValueOnHover- New showValueOnHover value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getShowValueOnHover
Deprecated.in favor ofshowDataValuesMode, a compound setting that supports showing data-values in the chart and in hovers in various combinations. The equivalent to showValueOnHover:true is ShowDataValuesMode.inHoverOnly.Shows the value of the nearest data value in a floating label whenever the mouse moves within the main chart area. The visual element representing the data value will also be emphasized by brightening or highlighting it (appearance differs by chart type).Calculates nearest value based on
getNearestDrawnValue().The data value will be formatted using
setDataValueFormatter(). The label's appearance is controlled byhoverLabelProperties.- Returns:
- Current showValueOnHover value. Default value is null
- See Also:
-
setShowXTicks
When set, ticks are shown for the X (horizontal) axis for Scatter plots or Bar charts.
If this method is called after the component has been drawn/initialized: Setter forshowXTicks.- Parameters:
showXTicks- newshowXTicksvalue. Default value is false- Returns:
FacetChartinstance, for chaining setter calls- See Also:
-
getShowXTicks
public boolean getShowXTicks()When set, ticks are shown for the X (horizontal) axis for Scatter plots or Bar charts.- Returns:
- Current showXTicks value. Default value is false
- See Also:
-
setShowYTicks
When set, ticks are shown for the Y (vertical) axis if it's a value axis.Normally, ticks are not shown for the primary axis, since
gradation linesshow value demarcations. Gradation lines are always show forextra value axesin multi-axis charts (since there are no gradation lines for the additional axes).showXTickscan be used to control whether ticks are shown for the horizontal axis, for certain chart types. See alsomajorTickGradationsfor control of which ticks are shown as major vs minor ticks.
If this method is called after the component has been drawn/initialized: Setter forshowYTicks.- Parameters:
showYTicks- newshowYTicksvalue. Default value is false- Returns:
FacetChartinstance, for chaining setter calls
-
getShowYTicks
public boolean getShowYTicks()When set, ticks are shown for the Y (vertical) axis if it's a value axis.Normally, ticks are not shown for the primary axis, since
gradation linesshow value demarcations. Gradation lines are always show forextra value axesin multi-axis charts (since there are no gradation lines for the additional axes).showXTickscan be used to control whether ticks are shown for the horizontal axis, for certain chart types. See alsomajorTickGradationsfor control of which ticks are shown as major vs minor ticks.- Returns:
- Current showYTicks value. Default value is false
-
setStacked
Whether to use stacking for charts where this makes sense (column, area, pie, line and radar charts). If stacked is not set and two facets are supplied, clustering is assumed. If null (the default), line charts will be unstacked, and others will be stacked.
If this method is called after the component has been drawn/initialized: Method to changestacked. Use null to apply a default value for the currentchartType.- Parameters:
stacked- new value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls
-
getStacked
Whether to use stacking for charts where this makes sense (column, area, pie, line and radar charts). If stacked is not set and two facets are supplied, clustering is assumed. If null (the default), line charts will be unstacked, and others will be stacked.- Returns:
- Current stacked value. Default value is null
-
setStandardDeviationBandProperties
public FacetChart setStandardDeviationBandProperties(DrawItem... standardDeviationBandProperties) throws IllegalStateException An Array of DrawRect properties to specify the bands between thestandard deviation lines. The length of the Array must be one less than the length of thestandardDeviationsArray.Having no band between certain standard deviations from the mean can be specified by having a null element at the corresponding index of this Array.
Note that if
useSymmetricStandardDeviationsis set then for each standard deviation band that is drawn a corresponding band will also be drawn on the opposite side of the mean line.- Parameters:
standardDeviationBandProperties- New standardDeviationBandProperties value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
setStandardDeviationLineProperties
public FacetChart setStandardDeviationLineProperties(DrawItem standardDeviationLineProperties) throws IllegalStateException Properties for thestandard deviation lines.Note that for rectangular charts the properties are for a
DrawLine, and for radar charts the properties are for aDrawOval.- Parameters:
standardDeviationLineProperties- New standardDeviationLineProperties value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getStandardDeviationLineProperties
Properties for thestandard deviation lines.Note that for rectangular charts the properties are for a
DrawLine, and for radar charts the properties are for aDrawOval.- Returns:
- Current standardDeviationLineProperties value. Default value is null
-
setStandardDeviations
WhenshowStandardDeviationLinesis set, the number of standard deviation lines drawn and their respective standard deviation away from the mean are specified by this property. The default is to display lines corresponding to the mean plus or minus one standard deviation.Note that having zero in this list of standard deviations is identical to drawing a line at the mean.
For example assume that chart1 and chart2 both plot data with mean 1 and standard deviation 0.1. chart1 will draw a blue line at the value 1 and two red lines at the values 0.7 and 1.2. chart2 will draw three red lines at values 0.9, 1.0, and 1.1.
DrawLine blueLine = new DrawLine(), redLine = new DrawLine(); blueLine.setLineColor("blue"); redLine.setLineColor("red"); FacetChart chart1 = new FacetChart(); chart1.setID("chart1"); chart1.setStandardDeviations(new Float[] { -3f, 2f }); chart1.setShowExpectedValueLine(true); chart1.setShowStandardDeviationLines(true); chart1.setExpectedValueLineProperties(blueLine); chart1.setStandardDeviationLineProperties(redLine); chart1.setUseSymmetricStandardDeviations(false); // ... FacetChart chart2 = new FacetChart(); chart2.setID("chart2"); chart2.setStandardDeviations(new Float[] { -1f, 0f, 1f }); chart2.setShowExpectedValueLine(false); chart2.setShowStandardDeviationLines(true); chart2.setExpectedValueLineProperties(blueLine); chart2.setStandardDeviationLineProperties(redLine); chart2.setUseSymmetricStandardDeviations(false); // ... chart1.draw(); chart2.draw();- Parameters:
standardDeviations- New standardDeviations value. Default value is [-1, 1]- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getStandardDeviations
public float[] getStandardDeviations()WhenshowStandardDeviationLinesis set, the number of standard deviation lines drawn and their respective standard deviation away from the mean are specified by this property. The default is to display lines corresponding to the mean plus or minus one standard deviation.Note that having zero in this list of standard deviations is identical to drawing a line at the mean.
For example assume that chart1 and chart2 both plot data with mean 1 and standard deviation 0.1. chart1 will draw a blue line at the value 1 and two red lines at the values 0.7 and 1.2. chart2 will draw three red lines at values 0.9, 1.0, and 1.1.
DrawLine blueLine = new DrawLine(), redLine = new DrawLine(); blueLine.setLineColor("blue"); redLine.setLineColor("red"); FacetChart chart1 = new FacetChart(); chart1.setID("chart1"); chart1.setStandardDeviations(new Float[] { -3f, 2f }); chart1.setShowExpectedValueLine(true); chart1.setShowStandardDeviationLines(true); chart1.setExpectedValueLineProperties(blueLine); chart1.setStandardDeviationLineProperties(redLine); chart1.setUseSymmetricStandardDeviations(false); // ... FacetChart chart2 = new FacetChart(); chart2.setID("chart2"); chart2.setStandardDeviations(new Float[] { -1f, 0f, 1f }); chart2.setShowExpectedValueLine(false); chart2.setShowStandardDeviationLines(true); chart2.setExpectedValueLineProperties(blueLine); chart2.setStandardDeviationLineProperties(redLine); chart2.setUseSymmetricStandardDeviations(false); // ... chart1.draw(); chart2.draw();- Returns:
- Current standardDeviations value. Default value is [-1, 1]
-
setStyleName
Default styleName for the chart.- Overrides:
setStyleNamein classCanvas- Parameters:
styleName- New styleName value. Default value is "scChart"- See Also:
-
getStyleName
Default styleName for the chart.- Overrides:
getStyleNamein classCanvas- Returns:
- Current styleName value. Default value is "scChart"
- See Also:
-
setTickLength
Length of the tick marks used when eithershowXTicksorshowYTicksis enabled, or whenextra value axesare in use.If minor tick marks are also shown, their length is controlled by
minorTickLength.
If this method is called after the component has been drawn/initialized: Setter fortickLength.- Parameters:
tickLength- newtickLengthvalue. Default value is 5- Returns:
FacetChartinstance, for chaining setter calls
-
getTickLength
public int getTickLength()Length of the tick marks used when eithershowXTicksorshowYTicksis enabled, or whenextra value axesare in use.If minor tick marks are also shown, their length is controlled by
minorTickLength.- Returns:
- Current tickLength value. Default value is 5
-
setTickMarkToValueAxisMargin
public FacetChart setTickMarkToValueAxisMargin(int tickMarkToValueAxisMargin) throws IllegalStateException Margin between the tick marks and the labels of theextra value axes.- Parameters:
tickMarkToValueAxisMargin- New tickMarkToValueAxisMargin value. Default value is 7- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getTickMarkToValueAxisMargin
public int getTickMarkToValueAxisMargin()Margin between the tick marks and the labels of theextra value axes.- Returns:
- Current tickMarkToValueAxisMargin value. Default value is 7
-
setTitle
Title for the chart as a whole. -
getTitle
Title for the chart as a whole. -
setTitleAlign
Horizontal alignment of the chart'stitlewith respect to the the visible chart-width.- Parameters:
titleAlign- New titleAlign value. Default value is "center"- Returns:
FacetChartinstance, for chaining setter calls
-
getTitleAlign
Horizontal alignment of the chart'stitlewith respect to the the visible chart-width.- Returns:
- Current titleAlign value. Default value is "center"
-
setTitleBackgroundProperties
Properties for title background (if being drawn).- Parameters:
titleBackgroundProperties- New titleBackgroundProperties value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- See Also:
-
getTitleBackgroundProperties
Properties for title background (if being drawn).- Returns:
- Current titleBackgroundProperties value. Default value is null
-
setTitleBoundaryProperties
public FacetChart setTitleBoundaryProperties(DrawLine titleBoundaryProperties) throws IllegalStateException Properties for bottom boundary of the title area, when there is already an outer container around the whole chart. seedrawTitleBoundary- Parameters:
titleBoundaryProperties- New titleBoundaryProperties value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getTitleBoundaryProperties
Properties for bottom boundary of the title area, when there is already an outer container around the whole chart. seedrawTitleBoundary- Returns:
- Current titleBoundaryProperties value. Default value is null
-
setTitlePadding
if aligning the title left or right, the amount of space before (for left aligned) or after (for right aligned) to pad the title from the border edge- Parameters:
titlePadding- New titlePadding value. Default value is 0- Returns:
FacetChartinstance, for chaining setter calls
-
getTitlePadding
public int getTitlePadding()if aligning the title left or right, the amount of space before (for left aligned) or after (for right aligned) to pad the title from the border edge- Returns:
- Current titlePadding value. Default value is 0
-
setTitleProperties
Properties for title label.- Parameters:
titleProperties- New titleProperties value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- See Also:
-
getTitleProperties
Properties for title label.- Returns:
- Current titleProperties value. Default value is null
-
setTitleRectHeight
The height of the bordered rect around the title - defaults to 0 (assuming no border)- Parameters:
titleRectHeight- New titleRectHeight value. Default value is 0- Returns:
FacetChartinstance, for chaining setter calls
-
getTitleRectHeight
public int getTitleRectHeight()The height of the bordered rect around the title - defaults to 0 (assuming no border)- Returns:
- Current titleRectHeight value. Default value is 0
-
setUseAutoGradients
Causes the chart to use the colors specified indataColorsbut specify chart-specific gradients based on the primary data color per chart type.- Parameters:
useAutoGradients- New useAutoGradients value. Default value is true- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getUseAutoGradients
Causes the chart to use the colors specified indataColorsbut specify chart-specific gradients based on the primary data color per chart type.- Returns:
- Current useAutoGradients value. Default value is true
-
setUseLogGradations
Whether to use classic logarithmic gradations, where each order of magnitude is shown as a gradation as well as a few intervening lines. Gradations also begin and end on an order of magnitude. For example, 1,2,4,6,8,10,20,40,60,80,100.Default gradations can be overridden via
logBaseandlogGradations.- Parameters:
useLogGradations- New useLogGradations value. Default value is false- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getUseLogGradations
Whether to use classic logarithmic gradations, where each order of magnitude is shown as a gradation as well as a few intervening lines. Gradations also begin and end on an order of magnitude. For example, 1,2,4,6,8,10,20,40,60,80,100.Default gradations can be overridden via
logBaseandlogGradations.- Returns:
- Current useLogGradations value. Default value is false
-
setUseMultiplePointShapes
Whether the chart should use multiple shapes to show data points. If set totruethen the chart is allowed to use allsupported shapes: circles, squares, diamonds, and triangles. If set tofalsethen just the first supported shape (circles, for example) will be used. The default isfalsefor bubble charts andcolor scale chartsandtruefor all other chart types.
If this method is called after the component has been drawn/initialized: Setter foruseMultiplePointShapes.- Parameters:
useMultiplePointShapes- Whether the chart should now use multiple shapes to show data points. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- See Also:
-
getUseMultiplePointShapes
Whether the chart should use multiple shapes to show data points. If set totruethen the chart is allowed to use allsupported shapes: circles, squares, diamonds, and triangles. If set tofalsethen just the first supported shape (circles, for example) will be used. The default isfalsefor bubble charts andcolor scale chartsandtruefor all other chart types.- Returns:
- Current useMultiplePointShapes value. Default value is null
- See Also:
-
setUsePointSizeLogGradations
public FacetChart setUsePointSizeLogGradations(Boolean usePointSizeLogGradations) throws IllegalStateException Whether to use classic logarithmic gradations, where each order of magnitude is shown as a gradation as well as a few intervening values, for thepointSizeMetricvalues displayed in thepoint size legend. Gradations also begin and end on an order of magnitude. For example, 1, 2, 4, 6, 8, 10, 20, 40, 60, 80, 100.Default gradations can be overridden via
pointSizeLogBaseandpointSizeLogGradations.- Parameters:
usePointSizeLogGradations- New usePointSizeLogGradations value. Default value is false- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getUsePointSizeLogGradations
Whether to use classic logarithmic gradations, where each order of magnitude is shown as a gradation as well as a few intervening values, for thepointSizeMetricvalues displayed in thepoint size legend. Gradations also begin and end on an order of magnitude. For example, 1, 2, 4, 6, 8, 10, 20, 40, 60, 80, 100.Default gradations can be overridden via
pointSizeLogBaseandpointSizeLogGradations.- Returns:
- Current usePointSizeLogGradations value. Default value is false
- See Also:
-
setUseSymmetricStandardDeviations
public FacetChart setUseSymmetricStandardDeviations(Boolean useSymmetricStandardDeviations) throws IllegalStateException Whether to display both the positive and negative of thestandard deviations.- Parameters:
useSymmetricStandardDeviations- New useSymmetricStandardDeviations value. Default value is true- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getUseSymmetricStandardDeviations
Whether to display both the positive and negative of thestandard deviations.- Returns:
- Current useSymmetricStandardDeviations value. Default value is true
-
setValueAxisLabelProperties
Properties for labels of value axis.- Parameters:
valueAxisLabelProperties- New valueAxisLabelProperties value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- See Also:
-
getValueAxisLabelProperties
Properties for labels of value axis.- Returns:
- Current valueAxisLabelProperties value. Default value is null
-
setValueAxisMargin
Margin betweenmultiple value axes.- Parameters:
valueAxisMargin- New valueAxisMargin value. Default value is 10- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getValueAxisMargin
public int getValueAxisMargin()Margin betweenmultiple value axes.- Returns:
- Current valueAxisMargin value. Default value is 10
- See Also:
-
setValueLineProperties
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.- Parameters:
valueLineProperties- New valueLineProperties value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getValueLineProperties
Properties for a "value line" - a line shows where a particular discrete value is placed, eg, vertical lines connecting points of a line chart to the X axis, or radial lines in a Radar chart.- Returns:
- Current valueLineProperties value. Default value is null
-
setValueProperty
Property in each record that holds a data value. For databound charts, ifvaluePropertyisn't set in the chart instance, it will be auto-derived from theDataSourcefields. The first numeric-typed DataSource field will be assumed to be thevalueProperty.Not used if there is an inline facet, see Chart.data.
- Parameters:
valueProperty- New valueProperty value. Default value is "_value"- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getValueProperty
Property in each record that holds a data value. For databound charts, ifvaluePropertyisn't set in the chart instance, it will be auto-derived from theDataSourcefields. The first numeric-typed DataSource field will be assumed to be thevalueProperty.Not used if there is an inline facet, see Chart.data.
- Returns:
- Current valueProperty value. Default value is "_value"
- See Also:
-
setValueTitle
A label for the data values, such as "Sales in Thousands", typically used as the label for the value axis.- Parameters:
valueTitle- New valueTitle value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getValueTitle
A label for the data values, such as "Sales in Thousands", typically used as the label for the value axis.- Returns:
- Current valueTitle value. Default value is null
-
setXAxisEndValue
For Bubble and Scatter charts only, the end value for the x-axis.If set to an explicit value, this will be respected. If unset, the axis end value will default to a value large enough to show the largest data point.
If the x-axis metric is date-valued, this value should be a date (typically applies to Scatter charts only).
- Parameters:
xAxisEndValue- New xAxisEndValue value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getXAxisEndValue
For Bubble and Scatter charts only, the end value for the x-axis.If set to an explicit value, this will be respected. If unset, the axis end value will default to a value large enough to show the largest data point.
If the x-axis metric is date-valued, this value should be a date (typically applies to Scatter charts only).
- Returns:
- Current xAxisEndValue value. Default value is null
- See Also:
-
setXAxisEndValue
For Bubble and Scatter charts only, the end value for the x-axis.If set to an explicit value, this will be respected. If unset, the axis end value will default to a value large enough to show the largest data point.
If the x-axis metric is date-valued, this value should be a date (typically applies to Scatter charts only).
- Parameters:
xAxisEndValue- New xAxisEndValue value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getXAxisEndValueAsDate
For Bubble and Scatter charts only, the end value for the x-axis.If set to an explicit value, this will be respected. If unset, the axis end value will default to a value large enough to show the largest data point.
If the x-axis metric is date-valued, this value should be a date (typically applies to Scatter charts only).
- Returns:
- Current xAxisEndValue value. Default value is null
- See Also:
-
setXAxisMetric
For scatter charts only, the "id" of the metric facet value to use for the x-axis.The default x-axis metric is the second value of the metric facet.
- Parameters:
xAxisMetric- New xAxisMetric value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getXAxisMetric
For scatter charts only, the "id" of the metric facet value to use for the x-axis.The default x-axis metric is the second value of the metric facet.
- Returns:
- Current xAxisMetric value. Default value is null
-
setXAxisStartValue
For Bubble and Scatter charts only, the start value for the x-axis.Defaults to 0, or to a value that makes good use of horizontal space based on
minXDataSpreadPercent.If the x-axis metric is date-valued, this value should be a date (typically applies to Scatter charts only).
- Parameters:
xAxisStartValue- New xAxisStartValue value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getXAxisStartValue
For Bubble and Scatter charts only, the start value for the x-axis.Defaults to 0, or to a value that makes good use of horizontal space based on
minXDataSpreadPercent.If the x-axis metric is date-valued, this value should be a date (typically applies to Scatter charts only).
- Returns:
- Current xAxisStartValue value. Default value is null
- See Also:
-
setXAxisStartValue
For Bubble and Scatter charts only, the start value for the x-axis.Defaults to 0, or to a value that makes good use of horizontal space based on
minXDataSpreadPercent.If the x-axis metric is date-valued, this value should be a date (typically applies to Scatter charts only).
- Parameters:
xAxisStartValue- New xAxisStartValue value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getXAxisStartValueAsDate
For Bubble and Scatter charts only, the start value for the x-axis.Defaults to 0, or to a value that makes good use of horizontal space based on
minXDataSpreadPercent.If the x-axis metric is date-valued, this value should be a date (typically applies to Scatter charts only).
- Returns:
- Current xAxisStartValue value. Default value is null
- See Also:
-
setYAxisLabelAlign
Horizontal alignment of y-axis labels, shown to the left of the chart.- Parameters:
yAxisLabelAlign- New yAxisLabelAlign value. Default value is "right"- Returns:
FacetChartinstance, for chaining setter calls
-
getYAxisLabelAlign
Horizontal alignment of y-axis labels, shown to the left of the chart.- Returns:
- Current yAxisLabelAlign value. Default value is "right"
-
setYAxisLabelPadding
Padding between each swatch and label pair.- Parameters:
yAxisLabelPadding- New yAxisLabelPadding value. Default value is 5- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getYAxisLabelPadding
public int getYAxisLabelPadding()Padding between each swatch and label pair.- Returns:
- Current yAxisLabelPadding value. Default value is 5
-
setYAxisMetric
For scatter charts only, the "id" of the metric facet value to use for the y-axis.The default y-axis metric is the first value of the metric facet.
- Parameters:
yAxisMetric- New yAxisMetric value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getYAxisMetric
For scatter charts only, the "id" of the metric facet value to use for the y-axis.The default y-axis metric is the first value of the metric facet.
- Returns:
- Current yAxisMetric value. Default value is null
-
setZIndexMetric
Specifies the attribute in the metric facet that will define the z-ordering of the segments in a histogram chart. If the z-ordering isn't specified, it will be assigned based on data order, with the last data point ordered above the first. Relative z-ordering is only important between segments within the same data label facet, since segments that differ in their data label facet value should never overlap,Note that zIndex values should be integers between 0 and
maxDataZIndex, inclusive, and don't directly map to theDrawItem.zIndexvalues of the underlyingDrawRects. This allows the Framework to use automatic z-ordering in the chart logic without any additional sorting or overhead that would otherwise be required.
If this method is called after the component has been drawn/initialized: Method to change the currentzIndexMetric- see property for more details. Will redraw the chart if drawn.- Parameters:
zIndexMetric- name of zIndex metric. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- See Also:
-
getZIndexMetric
Specifies the attribute in the metric facet that will define the z-ordering of the segments in a histogram chart. If the z-ordering isn't specified, it will be assigned based on data order, with the last data point ordered above the first. Relative z-ordering is only important between segments within the same data label facet, since segments that differ in their data label facet value should never overlap,Note that zIndex values should be integers between 0 and
maxDataZIndex, inclusive, and don't directly map to theDrawItem.zIndexvalues of the underlyingDrawRects. This allows the Framework to use automatic z-ordering in the chart logic without any additional sorting or overhead that would otherwise be required.- Returns:
- Current zIndexMetric value. Default value is null
- See Also:
-
getZoomChart
Mini-chart created to allow zooming whencanZoomis enabled.This chart automatically has certain visual tweaks applied, including
showInlineLabels,muted colorsandlogarithmic scaling. It can be further configured viazoomChartProperties.The selected range from this chart defaults to being shown with distinct styling as well (if
zoomShowSelectionis set), which can be controlled viazoomSelectionChartProperties.This component is an AutoChild named "zoomChart". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current zoomChart value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setZoomChartHeight
Height of thezoomChart. The zoomChart is always as wide as the main chart.- Parameters:
zoomChartHeight- New zoomChartHeight value. Default value is 100- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getZoomChartHeight
public double getZoomChartHeight()Height of thezoomChart. The zoomChart is always as wide as the main chart.- Returns:
- Current zoomChartHeight value. Default value is 100
-
setZoomChartProperties
public FacetChart setZoomChartProperties(FacetChart zoomChartProperties) throws IllegalStateException Properties to further configure thezoomChart.- Parameters:
zoomChartProperties- New zoomChartProperties value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getZoomChartProperties
Properties to further configure thezoomChart.- Returns:
- Current zoomChartProperties value. Default value is null
-
getZoomChartSlider
Slider controls shown on the mini-chart which is created whencanZoomis enabled.This component is an AutoChild named "zoomChartSlider". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current zoomChartSlider value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setZoomLogScale
By default whencanZoomis enabled, thezoomChartuses logarithmic scaling so that spikes in the data don't result in a zoomed chart that is mostly a flat line.Logarithmic scaling is automatically disabled if the dataset spans zero (eg, has negative and positive values) as this can't be shown in a logarithmic scale.
Set
zoomLogScaleto explicitly enable or disable logarithmic scaling.- Parameters:
zoomLogScale- New zoomLogScale value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getZoomLogScale
By default whencanZoomis enabled, thezoomChartuses logarithmic scaling so that spikes in the data don't result in a zoomed chart that is mostly a flat line.Logarithmic scaling is automatically disabled if the dataset spans zero (eg, has negative and positive values) as this can't be shown in a logarithmic scale.
Set
zoomLogScaleto explicitly enable or disable logarithmic scaling.- Returns:
- Current zoomLogScale value. Default value is null
-
setZoomMutePercent
colorMutePercentto use for thezoomChart.- Parameters:
zoomMutePercent- New zoomMutePercent value. Default value is -35- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getZoomMutePercent
public float getZoomMutePercent()colorMutePercentto use for thezoomChart.- Returns:
- Current zoomMutePercent value. Default value is -35
-
getZoomSelectionChart
Mini-chart created whencanZoomis enabled. This chart represents the currently selected range of data shown in the main chart.This component is an AutoChild named "zoomSelectionChart". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current zoomSelectionChart value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setZoomSelectionChartProperties
public FacetChart setZoomSelectionChartProperties(FacetChart zoomSelectionChartProperties) throws IllegalStateException Properties to further configure thezoomSelectionChart.- Parameters:
zoomSelectionChartProperties- New zoomSelectionChartProperties value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getZoomSelectionChartProperties
Properties to further configure thezoomSelectionChart.- Returns:
- Current zoomSelectionChartProperties value. Default value is null
-
setZoomShowSelection
Whether the selected range should be shown in a different style, which can be configured viazoomSelectionChartProperties. This has performance consequences and makes the rendering of the mini-chart slightly slower.- Parameters:
zoomShowSelection- New zoomShowSelection value. Default value is true- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getZoomShowSelection
Whether the selected range should be shown in a different style, which can be configured viazoomSelectionChartProperties. This has performance consequences and makes the rendering of the mini-chart slightly slower.- Returns:
- Current zoomShowSelection value. Default value is true
-
setZoomStartPosition
public FacetChart setZoomStartPosition(ZoomStartPosition zoomStartPosition) throws IllegalStateException For azoomed chart, determines what portion of the overall dataset should be initially shown in the main chart.Default is to show the end of the dataset if the X axis shows time and includes today's date, otherwise to show the start of the dataset.
Set this property to override this default, or use
zoomStartValueandzoomEndValueto start with a particular range.- Parameters:
zoomStartPosition- New zoomStartPosition value. Default value is null- Returns:
FacetChartinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getZoomStartPosition
For azoomed chart, determines what portion of the overall dataset should be initially shown in the main chart.Default is to show the end of the dataset if the X axis shows time and includes today's date, otherwise to show the start of the dataset.
Set this property to override this default, or use
zoomStartValueandzoomEndValueto start with a particular range.- Returns:
- Current zoomStartPosition value. Default value is null
-
addChartBackgroundDrawnHandler
Add a chartBackgroundDrawn handler.Called when most elements of the chart other than data data have been drawn, including gradations and legend.
This notification will be fired each time the chart is redrawn (due to resize, data change, etc). If you want to draw additional information on the chart using
DrawPane(FacetChart's superclass) and variousDrawItems, you should do in response to this notification. Due to auto-sizing, APIs that are typically used to position custom DrawItems (such asFacetChart.getChartLeft()) may return bad values if called at other times.Additional DrawItems added in this method will appear underneath data elements such as bars or columns. See
FacetChart.chartDrawn()for placing DrawItems on top of data elements.- Specified by:
addChartBackgroundDrawnHandlerin interfaceHasChartBackgroundDrawnHandlers- Parameters:
handler- the chartBackgroundDrawn handler- Returns:
HandlerRegistrationused to remove this handler
-
addChartDrawnHandler
Add a chartDrawn handler.Called when all elements of the chart (data lines / shapes, gradations, legend, labels etc) have completed drawing.
See
FacetChart.chartBackgroundDrawn()for usage information.- Specified by:
addChartDrawnHandlerin interfaceHasChartDrawnHandlers- Parameters:
handler- the chartDrawn handler- Returns:
HandlerRegistrationused to remove this handler
-
addDataLabelClickHandler
Add a dataLabelClick handler.Fires when the user clicks on a data label, that is, a text label showing values from the first facet. For example, the labels underneath the X-axis of a column chart, labelling each column.
- Specified by:
addDataLabelClickHandlerin interfaceHasDataLabelClickHandlers- Parameters:
handler- the dataLabelClick handler- Returns:
HandlerRegistrationused to remove this handler
-
addDataLabelHoverHandler
Add a dataLabelHover handler.Fires when the mouse hovers over a data label, that is, a text label showing values from the first facet. For example, the labels underneath the X-axis of a column chart, labelling each column.
- Specified by:
addDataLabelHoverHandlerin interfaceHasDataLabelHoverHandlers- Parameters:
handler- the dataLabelHover handler- Returns:
HandlerRegistrationused to remove this handler
-
drawnValueContainsPoint
Returns whether a givenDrawnValuecontains a point. The point's X and Y coordinates may be passed into this method, or, if unspecified, the coordinates used are the current mouse event coordinates.For Area, Bubble, Line, Radar, and Scatter charts, a DrawnValue is considered to contain a point if the Euclidean distance from the DrawnValue's center (
x,y) to the point is less thanthis.dataPointSize. For Pie charts, the DrawnValue is considered to contain a point if the point is within the pie slice. Similarly, for Doughnut charts, the DrawnValue is considered to contain a point if the point is within the pie slice and not in the doughnut hole. For Bar and Column charts, the DrawnValue is considered to contain a point if the point is within the bar or column, respectively. Note that for stacked Bar and Column charts, the point must also be in the stacked portion as opposed to anywhere within the bar or column.- Parameters:
drawnValue- the DrawnValue to check. The DrawnValue must be a valid DrawnValue from this chart.- Returns:
- true if the DrawnValue contains the point at the given X, Y coordinates (or current mouse event coordinates); false if the DrawnValue does not contain the point; null for invalid parameters.
-
drawnValueContainsPoint
-
drawnValueContainsPoint
Returns whether a givenDrawnValuecontains a point. The point's X and Y coordinates may be passed into this method, or, if unspecified, the coordinates used are the current mouse event coordinates.For Area, Bubble, Line, Radar, and Scatter charts, a DrawnValue is considered to contain a point if the Euclidean distance from the DrawnValue's center (
x,y) to the point is less thanthis.dataPointSize. For Pie charts, the DrawnValue is considered to contain a point if the point is within the pie slice. Similarly, for Doughnut charts, the DrawnValue is considered to contain a point if the point is within the pie slice and not in the doughnut hole. For Bar and Column charts, the DrawnValue is considered to contain a point if the point is within the bar or column, respectively. Note that for stacked Bar and Column charts, the point must also be in the stacked portion as opposed to anywhere within the bar or column.- Parameters:
drawnValue- the DrawnValue to check. The DrawnValue must be a valid DrawnValue from this chart.x- X coordinate of the point. If this parameter is specified, thenyis a required parameter.y- Y coordinate of the point- Returns:
- true if the DrawnValue contains the point at the given X, Y coordinates (or current mouse event coordinates); false if the DrawnValue does not contain the point; null for invalid parameters.
-
fetchRelatedData
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.Relationships between DataSources are declared via
DataSourceField.foreignKey.For example, given two related DataSources "orders" and "orderItems", where we want to fetch the "orderItems" that belong to a given "order". "orderItems" should declare a field that is a
foreignKeyto the "orders" table (for example, it might be named "orderId" with foreignKey="orders.id"). Then, to load the records related to a given "order", call fetchRelatedData() on the component bound to "orderItems", pass the "orders" DataSource as the "schema" and pass a record from the "orders" DataSource as the "record" argument.Note that multiple foreign keys into the schema are supported by this method.
- Parameters:
record- DataSource recordschema- schema of the DataSource record, or DataBoundComponent already bound to that schema- See Also:
-
fetchRelatedData
-
fetchRelatedData
public 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.Relationships between DataSources are declared via
DataSourceField.foreignKey.For example, given two related DataSources "orders" and "orderItems", where we want to fetch the "orderItems" that belong to a given "order". "orderItems" should declare a field that is a
foreignKeyto the "orders" table (for example, it might be named "orderId" with foreignKey="orders.id"). Then, to load the records related to a given "order", call fetchRelatedData() on the component bound to "orderItems", pass the "orders" DataSource as the "schema" and pass a record from the "orders" DataSource as the "record" argument.Note that multiple foreign keys into the schema are supported by this method.
- Parameters:
record- DataSource recordschema- schema of the DataSource record, or DataBoundComponent already bound to that schemacallback- callback to invoke on completionrequestProperties- additional properties to set on the DSRequest that will be issued- See Also:
-
formatFacetValueId
Return the text string to display for facet value labels that appear in chart legends or as labels forchartTypes that have circumference or non-axis labels, such as for example "Pie" or "Radar" charts.- Parameters:
value- raw value of the metricfacet- facet containing the value- Returns:
- the text to display.
- See Also:
-
formatSegmentLabel
Defines the format of the label for a segment in a histogram chart. By default, it simply returns a label of the form "Y1 to Y2" describing the start and end values, applyingsetDataValueFormatter()to format the values.Note that this method has no impact on the facet value labels appearing on the horizontal axis of the histogram chart.
- Parameters:
startValue- raw start value of the segmentendValue- raw end value of the segment- Returns:
- the text to display.
-
getChartCenter
Returns the centerpoint for radar charts and pie charts.Note that unstacked pie charts draw multiple pies, each with their own centers.
This is only allowed to be called when
FacetChart.chartDrawn()fires.- Returns:
- the centerpoint for radar charts and pie charts.
-
getChartHeight
public float getChartHeight(boolean recalc) Deprecated.Get the height the central chart area, where data elements appear.This is only allowed to be called when
FacetChart.chartDrawn()fires.- Parameters:
recalc- if false then cached value will be returned, otherwise will be recalculated.- Returns:
- the width of the central chart area.
-
getChartHeightAsDouble
public double getChartHeightAsDouble(boolean recalc) Get the height the central chart area, where data elements appear.This is only allowed to be called when
FacetChart.chartDrawn()fires.- Parameters:
recalc- if false then cached value will be returned, otherwise will be recalculated.- Returns:
- the width of the central chart area.
-
getChartLeft
public float getChartLeft()Deprecated.Get the left margin of the central chart area, where data elements appear.This is only allowed to be called when
FacetChart.chartDrawn()fires.- Returns:
- left margin of the central chart area
-
getChartLeftAsDouble
public double getChartLeftAsDouble()Get the left margin of the central chart area, where data elements appear.This is only allowed to be called when
FacetChart.chartDrawn()fires.- Returns:
- left margin of the central chart area
-
getChartRadius
public float getChartRadius()Deprecated.Returns the radius for radar charts and pie charts. For stacked pie charts this is radius of the outermost pie.Note that unstacked pie charts draw multiple pies, each with their own radii.
This is only allowed to be called when
FacetChart.chartDrawn()fires.- Returns:
- the radius for radar charts and pie charts.
-
getChartRadiusAsDouble
public double getChartRadiusAsDouble()Returns the radius for radar charts and pie charts. For stacked pie charts this is radius of the outermost pie.Note that unstacked pie charts draw multiple pies, each with their own radii.
This is only allowed to be called when
FacetChart.chartDrawn()fires.- Returns:
- the radius for radar charts and pie charts.
-
getChartTop
public float getChartTop()Deprecated.Get the top coordinate of the central chart area, where data elements appear.This is only allowed to be called when
FacetChart.chartDrawn()fires.- Returns:
- The top coordinate of the central chart area
-
getChartTopAsDouble
public double getChartTopAsDouble()Get the top coordinate of the central chart area, where data elements appear.This is only allowed to be called when
FacetChart.chartDrawn()fires.- Returns:
- The top coordinate of the central chart area
-
getChartWidth
public float getChartWidth(boolean recalc) Deprecated.Get the width of the central chart area, where data elements appear.This is only allowed to be called when
FacetChart.chartDrawn()fires.- Parameters:
recalc- if false then cached value will be returned, otherwise will be recalculated.- Returns:
- the width of the central chart area.
-
getChartWidthAsDouble
public double getChartWidthAsDouble(boolean recalc) Get the width of the central chart area, where data elements appear.This is only allowed to be called when
FacetChart.chartDrawn()fires.- Parameters:
recalc- if false then cached value will be returned, otherwise will be recalculated.- Returns:
- the width of the central chart area.
-
getDataLabelFacet
Returns theFacetin the list offacetswhosevaluesare rendered as labels along the data axis of the chart or in the main chart area.Most single-facet charts and all multi-facet charts have the data label facet as their first facet. The exceptions are that single-facet Pie/Doughnut charts and Bubble and Scatter charts do not have data label facets.
Note that the user may swap the data label facet and the
legend facetin most chart types using the context menu.- Returns:
- the data label facet, or
nullif there is no such facet - See Also:
-
getDataLabelHoverHTML
Called when the mouse hovers over a data label, that is, a text label showing values from the first facet. For example, the labels underneath the X-axis of a column chart, labelling each column.- Parameters:
facetValue- facetValue that was hovered- Returns:
- hover text to be shown. Return null to avoid a hover being shown.
See
HTMLString - See Also:
-
getDrawnValue
Returns rendering information for the data value specified by the passed facet values.If called before
FacetChart.chartDrawn(), logs a warning and returns null.- Parameters:
facetValues- facet values of desired data value- Returns:
- the drawn value, or null for invalid arguments / incorrect timing of call
-
getDrawnValueAtPoint
Returns aDrawnValueobject for the data value that is shown nearest to the passed coordinates only if it's under the given coordinates, or under the current mouse event coordinates if no coordinates are passed. This method is similar togetNearestDrawnValue(), but the DrawnValue is only returned if it's under the coordinates.See
drawnValueContainsPoint()for the criteria that determine whether a DrawnValue is under (contains) the coordinates.- Returns:
- the nearest drawn value if under the given coordinates (or current mouse event coordinates) or null if not under the coordinates, or for invalid arguments / incorrect timing of call.
-
getDrawnValueAtPoint
- See Also:
-
getDrawnValueAtPoint
- See Also:
-
getDrawnValueAtPoint
Returns aDrawnValueobject for the data value that is shown nearest to the passed coordinates only if it's under the given coordinates, or under the current mouse event coordinates if no coordinates are passed. This method is similar togetNearestDrawnValue(), but the DrawnValue is only returned if it's under the coordinates.See
drawnValueContainsPoint()for the criteria that determine whether a DrawnValue is under (contains) the coordinates.- Parameters:
x- X coordinate. If this parameter is specified, thenyis a required parameter.y- Y coordinatemetric- metric over which to determine the drawn value- Returns:
- the nearest drawn value if under the given coordinates (or current mouse event coordinates) or null if not under the coordinates, or for invalid arguments / incorrect timing of call.
-
getDrawnValues
Returns rendering information for the data values specified by the passed facet values.If called before
FacetChart.chartDrawn(), logs a warning and returns null.- Returns:
- the DrawnValues, or null for invalid arguments / incorrect timing of call
-
getDrawnValues
Returns rendering information for the data values specified by the passed facet values.If called before
FacetChart.chartDrawn(), logs a warning and returns null.- Parameters:
facetValues- facet values of desired DrawnValues. If no FacetValueMap is provided, then all DrawnValues are returned.- Returns:
- the DrawnValues, or null for invalid arguments / incorrect timing of call
-
getDrawnValuesAtPoint
Returns an array ofDrawnValueobjects for the data values of each metric that are shown nearest to the passed coordinates, but only if they're under the given coordinates, or under the current mouse event coordinates if no coordinates are passed. This method is similar togetNearestDrawnValues(), but DrawnValues are only included in the returned array if they're under the coordinates.See
drawnValueContainsPoint()for the criteria that determine whether a DrawnValue is under (contains) the coordinates.- Returns:
- the nearest DrawnValues that are under the given coordinates (or current mouse event coordinates), or null for invalid arguments / incorrect timing of call.
-
getDrawnValuesAtPoint
- See Also:
-
getDrawnValuesAtPoint
Returns an array ofDrawnValueobjects for the data values of each metric that are shown nearest to the passed coordinates, but only if they're under the given coordinates, or under the current mouse event coordinates if no coordinates are passed. This method is similar togetNearestDrawnValues(), but DrawnValues are only included in the returned array if they're under the coordinates.See
drawnValueContainsPoint()for the criteria that determine whether a DrawnValue is under (contains) the coordinates.- Parameters:
x- X coordinate. If this parameter is specified, thenyis a required parameter.y- Y coordinate- Returns:
- the nearest DrawnValues that are under the given coordinates (or current mouse event coordinates), or null for invalid arguments / incorrect timing of call.
-
getFacet
Get a facet definition by facetId.- Parameters:
facetId- the id of the facet to retrieve- Returns:
- the Facet if found, or null
- See Also:
-
getFacetValue
Get facet value definition by facetId and facetValueId.- Parameters:
facetId- the id of the facet to retrievefacetValueId- the id of the facet value to retrieve- Returns:
- the FacetValue if found, or null
- See Also:
-
getGradations
public float[] getGradations()Return an array of the gradation values used in the current chart. Pass these values togetXCoord()/getYCoord()(depending on the orientation of the chart) to discover the coordinates where gradations are drawn.This is only allowed to be called when
FacetChart.chartDrawn()fires.- Returns:
- an array of gradation values used in the current chart.
-
getLegendFacet
Returns theFacetin the list offacetswhosevaluesare rendered in the chart's legend.Most single-facet charts do not have a legend facet. The exceptions are that single-facet Pie/Doughnut charts have a legend facet as the first facet and Bubble and Scatter charts may optionally have a legend facet as the second facet, after the metric facet.
In all multi-facet charts, the legend facet is the second facet.
Note that the user may swap the legend facet and the
data label facetin most chart types using the context menu.- Returns:
- the legend facet, or
nullif there is no such facet - See Also:
-
getLegendHoverHTML
Called when the mouse hovers over a color swatch or its label in the legend area of the chart.The
FacetValuethat the user is hovering over is provided. If the chart is amulti-axis chart, theFacetValuefor the hovered-over metric will also be provided.- Parameters:
facetValue- facetValue that the mouse is overmetricFacetValue- for a multi-axis chart, facetValue representing the hovered-over metric. Null if chart is not multi-axis- Returns:
- hover text to be shown. Return null to avoid a hover being shown.
See
HTMLString - See Also:
-
getNearestDrawnValue
Returns rendering information for the data value that is shown nearest to the passed coordinates, as aDrawnValueobject.Passed X and Y coordinates should be relative to the FacetChart. If neither an X or Y coordinate is passed, both X and Y will use the current
Canvas.getOffsetX()andCanvas.getOffsetY().If called before
FacetChart.chartDrawn(), logs a warning and returns null. For a chart with multiple vertical axes, returns the nearest point from the first metric only (seeFacetChart overview). For scatter charts, returns a DrawnValue where thevalueis from they-axis metric.To get the nearest DrawnValue only if it contains the given coordinates, you can either use the
getDrawnValueAtPoint()API or calldrawnValueContainsPoint()on the return value.Behavior for different chart types is as follows:
Bar / Column
Returns the centerpoint of the end of the nearest bar or column by considering the Y coordinate (bar) or X coordinate (column) only.
Line / Area
Returns the nearest point based on which data label is nearest to the passed X coordinate. For multi-series charts, if Y coordinate is not passed the data point returned is from the series that has the highest value at the data label.
Radar
Returns the data point nearest the passed coordinates by straight line distance. Passing only one coordinate will cause a warning to be logged and null to be returned; passing neither coordinate is allowed (
getOffsetX/Ywill be used).Pie
Returns the data point for the segment that would be hit if a line were drawn from the passed coordinates to the center of the pie.
If there are multiple stacked pies, uses the pie that contains the passed coordinates, otherwise the outermost pie.
If there are multiple non-stacked pies, uses the pie that is nearest the passed coordinates by straight-line distance to the center of the pie.
Passing only one coordinate will cause a warning to be logged and null to be returned; passing neither coordinate is allowed (
getOffsetX/Ywill be used).If the chart is a
multi-axis chartthen this method takes an optional parameter,metric, which causes this method to return aDrawnValuefrom the specified metric. If a metric is not passed then the first metric of the metric facet will be used (or just thevaluePropertyif there is no metric facet).- Returns:
- the nearest drawn value, or null for invalid arguments / incorrect timing of call
- See Also:
-
getNearestDrawnValue
- See Also:
-
getNearestDrawnValue
- See Also:
-
getNearestDrawnValue
Returns rendering information for the data value that is shown nearest to the passed coordinates, as aDrawnValueobject.Passed X and Y coordinates should be relative to the FacetChart. If neither an X or Y coordinate is passed, both X and Y will use the current
Canvas.getOffsetX()andCanvas.getOffsetY().If called before
FacetChart.chartDrawn(), logs a warning and returns null. For a chart with multiple vertical axes, returns the nearest point from the first metric only (seeFacetChart overview). For scatter charts, returns a DrawnValue where thevalueis from they-axis metric.To get the nearest DrawnValue only if it contains the given coordinates, you can either use the
getDrawnValueAtPoint()API or calldrawnValueContainsPoint()on the return value.Behavior for different chart types is as follows:
Bar / Column
Returns the centerpoint of the end of the nearest bar or column by considering the Y coordinate (bar) or X coordinate (column) only.
Line / Area
Returns the nearest point based on which data label is nearest to the passed X coordinate. For multi-series charts, if Y coordinate is not passed the data point returned is from the series that has the highest value at the data label.
Radar
Returns the data point nearest the passed coordinates by straight line distance. Passing only one coordinate will cause a warning to be logged and null to be returned; passing neither coordinate is allowed (
getOffsetX/Ywill be used).Pie
Returns the data point for the segment that would be hit if a line were drawn from the passed coordinates to the center of the pie.
If there are multiple stacked pies, uses the pie that contains the passed coordinates, otherwise the outermost pie.
If there are multiple non-stacked pies, uses the pie that is nearest the passed coordinates by straight-line distance to the center of the pie.
Passing only one coordinate will cause a warning to be logged and null to be returned; passing neither coordinate is allowed (
getOffsetX/Ywill be used).If the chart is a
multi-axis chartthen this method takes an optional parameter,metric, which causes this method to return aDrawnValuefrom the specified metric. If a metric is not passed then the first metric of the metric facet will be used (or just thevaluePropertyif there is no metric facet).- Parameters:
x- X coordinate. If this parameter is specified, thenyis a required parameter.y- Y coordinatemetric- metric over which to determine the drawn value- Returns:
- the nearest drawn value, or null for invalid arguments / incorrect timing of call
- See Also:
-
getNearestDrawnValues
Returns an array ofDrawnValueobjects containing rendering information for the data values having each metric that are shown nearest to the passed coordinates.Passed X and Y coordinates should be relative to the FacetChart. If neither an X or Y coordinate is passed, both X and Y will use the current
Canvas.getOffsetX()andCanvas.getOffsetY().The behavior for different chart types is the same as
getNearestDrawnValue(). This method also logs a warning and returns null if called beforeFacetChart.chartDrawn().To get the nearest DrawnValues only if they contain the given coordinates, you can either use the
getDrawnValuesAtPoint()API or check whether each DrawnValue in the returned array contains the point by callingdrawnValueContainsPoint().- Returns:
- the nearest drawn values for each metric, or null for invalid arguments / incorrect timing of call
- See Also:
-
getNearestDrawnValues
- See Also:
-
getNearestDrawnValues
Returns an array ofDrawnValueobjects containing rendering information for the data values having each metric that are shown nearest to the passed coordinates.Passed X and Y coordinates should be relative to the FacetChart. If neither an X or Y coordinate is passed, both X and Y will use the current
Canvas.getOffsetX()andCanvas.getOffsetY().The behavior for different chart types is the same as
getNearestDrawnValue(). This method also logs a warning and returns null if called beforeFacetChart.chartDrawn().To get the nearest DrawnValues only if they contain the given coordinates, you can either use the
getDrawnValuesAtPoint()API or check whether each DrawnValue in the returned array contains the point by callingdrawnValueContainsPoint().- Parameters:
x- X coordinate. If this parameter is specified, thenyis a required parameter.y- Y coordinate- Returns:
- the nearest drawn values for each metric, or null for invalid arguments / incorrect timing of call
- See Also:
-
getNumDataPoints
Count the number of data points.- Returns:
- the number of data values
-
getNumDataPoints
Count the number of data points.- Parameters:
criteria- a set of facetValues describing a slice of the data- Returns:
- the number of data values
-
getPolynomialRegressionFunction
public void getPolynomialRegressionFunction()For scatter plots only, get a Function from the specified independent variable X to the specified dependent variable Y that defines the polynomial that best fits the data. See http://en.wikipedia.org/wiki/Polynomial_regression. -
getPolynomialRegressionFunction
- See Also:
-
getPolynomialRegressionFunction
- See Also:
-
getPolynomialRegressionFunction
For scatter plots only, get a Function from the specified independent variable X to the specified dependent variable Y that defines the polynomial that best fits the data. See http://en.wikipedia.org/wiki/Polynomial_regression.- Parameters:
degree- the degree of the polynomial. Defaults toregressionPolynomialDegree.xMetric- ID of an inlined facet value to use as the independent variable. Defaults to thex-axis metric.yMetric- ID of an inlined facet value to use as the dependent variable. Defaults to they-axis metric.
-
getSimpleLinearRegressionFunction
public void getSimpleLinearRegressionFunction()For scatter plots only, get a Function from the specified independent variable X to the specified dependent variable Y that defines the line that best fits the data. See http://en.wikipedia.org/wiki/Simple_linear_regression. -
getSimpleLinearRegressionFunction
- See Also:
-
getSimpleLinearRegressionFunction
For scatter plots only, get a Function from the specified independent variable X to the specified dependent variable Y that defines the line that best fits the data. See http://en.wikipedia.org/wiki/Simple_linear_regression.- Parameters:
xMetric- ID of an inlined facet value to use as the independent variable. Defaults to thex-axis metric.yMetric- ID of an inlined facet value to use as the dependent variable. Defaults to they-axis metric.
-
getXCoord
public float getXCoord(double value) Returns the X coordinate where the passed data value either was or would be drawn. For example, this would be the X coordinate where a bar would end in a bar chart.This is only allowed to be called after
FacetChart.chartDrawn()fires.If the
chartTypeisChartType.BAR,ChartType.BUBBLE, orChartType.SCATTERthen thevalueargument should be a number. For other rectangular charts, this method expects aFacetValueMapthat uniquely identifies the data cell whose X-axis coordinate is to be retrieved.Note that when
canZoomis enabled, this API is valid only for data values betweenzoomStartValueandzoomEndValue.- Parameters:
value- the value to be drawn.- Returns:
- the X coordinate where the passed data value would be drawn; or null if the passed
FacetValueMapdoes not identify a currently-drawn data cell.
-
getXCoord
Returns the X coordinate where the passed data value either was or would be drawn. For example, this would be the X coordinate where a bar would end in a bar chart.This is only allowed to be called after
FacetChart.chartDrawn()fires.If the
chartTypeisChartType.BAR,ChartType.BUBBLE, orChartType.SCATTERthen thevalueargument should be a number. For other rectangular charts, this method expects aFacetValueMapthat uniquely identifies the data cell whose X-axis coordinate is to be retrieved.Note that when
canZoomis enabled, this API is valid only for data values betweenzoomStartValueandzoomEndValue.- Parameters:
value- the value to be drawn.- Returns:
- the X coordinate where the passed data value would be drawn; or null if the passed
FacetValueMapdoes not identify a currently-drawn data cell.
-
getYCoord
public float getYCoord(double value) Returns the Y coordinate where the passed data value either was or would be drawn. For example, this would be the Y coordinate that a line would pass through on a line chart, or the top of a column on a column chart.This is only allowed to be called after
FacetChart.chartDrawn()fires.If the
chartTypeisChartType.AREA,ChartType.BUBBLE,ChartType.COLUMN,ChartType.HISTOGRAM,ChartType.LINE, orChartType.SCATTERthen thevalueargument should be a number. ForChartType.BARcharts this method expects aFacetValueMapthat uniquely identifies the data cell whose Y-axis coordinate is to be retrieved.- Parameters:
value- the value to be drawn.- Returns:
- the Y coordinate where the passed data value would be drawn.
-
getYCoord
Returns the Y coordinate where the passed data value either was or would be drawn. For example, this would be the Y coordinate that a line would pass through on a line chart, or the top of a column on a column chart.This is only allowed to be called after
FacetChart.chartDrawn()fires.If the
chartTypeisChartType.AREA,ChartType.BUBBLE,ChartType.COLUMN,ChartType.HISTOGRAM,ChartType.LINE, orChartType.SCATTERthen thevalueargument should be a number. ForChartType.BARcharts this method expects aFacetValueMapthat uniquely identifies the data cell whose Y-axis coordinate is to be retrieved.- Parameters:
value- the value to be drawn.- Returns:
- the Y coordinate where the passed data value would be drawn.
-
addLegendClickHandler
Add a legendClick handler.Fires when the user clicks on the legend area of the chart.
If the user specifically clicks on a color swatch or it's label, the
FacetValueclicked on will be provided.If the chart is a
multi-axis chart, theFacetValuefor the clicked-on metric will also be provided.- Specified by:
addLegendClickHandlerin interfaceHasLegendClickHandlers- Parameters:
handler- the legendClick handler- Returns:
HandlerRegistrationused to remove this handler
-
addLegendHoverHandler
Add a legendHover handler.Fires when the mouse hovers over a color swatch or its label in the legend area of the chart.
The
FacetValuethat the user is hovering over is provided. If the chart is amulti-axis chart, theFacetValuefor the hovered-over metric will also be provided.- Specified by:
addLegendHoverHandlerin interfaceHasLegendHoverHandlers- Parameters:
handler- the legendHover handler- Returns:
HandlerRegistrationused to remove this handler
-
addValueClickHandler
Add a valueClick handler.Fires when a data value is clicked, and provides information about the data value that was clicked as a
DrawnValueobject.Specifically, this fires for clicks on pie slices, bars or columns, areas, lines or points (in a Bubble or Scatter plot).
If there are multiple data values at the clicked position, you can use
FacetChart.getNearestDrawnValues()to discover the full list of values at the current coordinate (pass ingetOffsetX/Y()for the coordinates).If you want to create behaviors for clicking or moving near shapes without requiring a direct hit, implement a standard
Canvas.click()handler on the FacetChart as a whole and useFacetChart.getNearestDrawnValue()to discover the nearest data values.- Specified by:
addValueClickHandlerin interfaceHasValueClickHandlers- Parameters:
handler- the valueClick handler- Returns:
HandlerRegistrationused to remove this handler
-
addZoomChangedHandler
Add a zoomChanged handler.Fires when the end user changes the zoom position in a
zoomed chart.- Specified by:
addZoomChangedHandlerin interfaceHasZoomChangedHandlers- Parameters:
handler- the zoomChanged handler- Returns:
HandlerRegistrationused to remove this handler
-
zoomTo
- Parameters:
startValue- starting value for the data range shown in the main chartendValue- ending value for the data range shown in the main chart
-
setDefaultProperties
Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
- Parameters:
facetChartProperties- properties that should be used as new defaults when instances of this class are created- See Also:
-
setData
Dataset for this chart.
Data should be specified as an array of Records where each record contains one data value. Each record also contains a property named after each facetId
 whose value is a facetValueId from that facet.


 For example, with a facet with id "regions" and facetValues "west", "north" and "east", and
 with
valuePropertywith it's default value "_value", thedataproperty could be:FacetChart chart = new FacetChart(); chart.setFacets(new Facet("regions")); Record[] records = new Record[3]; records[0] = new Record(); records[0].setAttribute("regions", "west"); records[0].setAttribute("_value", 4); records[1] = new Record(); records[1].setAttribute("regions", "north"); records[1].setAttribute("_value", 2); records[2] = new Record(); records[2].setAttribute("regions", "east"); records[2].setAttribute("_value", 5); chart.setData(records);If there were a second facet with id "product" and facetValues "cars" and "trucks", a Chart with a complete set of values would be:FacetChart chart = new FacetChart(); chart.setFacets(new Facet("regions"), new Facet("product")); Record[] records = new Record[6]; records[0] = new Record(); records[0].setAttribute("product", "cars"); records[0].setAttribute("regions", "west"); records[0].setAttribute("_value", 4); records[1] = new Record(); records[1].setAttribute("product", "cars"); records[1].setAttribute("regions", "north"); records[1].setAttribute("_value", 2); records[2] = new Record(); records[2].setAttribute("product", "cars"); records[2].setAttribute("regions", "east"); records[2].setAttribute("_value", 5); records[3] = new Record(); records[3].setAttribute("product", "trucks"); records[3].setAttribute("regions", "west"); records[3].setAttribute("_value", 1); records[4] = new Record(); records[4].setAttribute("product", "trucks"); records[4].setAttribute("regions", "north"); records[4].setAttribute("_value", 9); records[5] = new Record(); records[5].setAttribute("product", "trucks"); records[5].setAttribute("regions", "east"); records[5].setAttribute("_value", 3); chart.setData(records);This 2 facet (or "2 dimensional") dataset, if rendered as a bar chart, would use stacked or
 clustered bars and a legend.
- Parameters:
data- data Default value is null
-
setData
-
getRecords
-
getDataAsRecordList
-
setPointHoverCustomizer
Display custom HTML whenshowDataPointsis true and the mouse hovers over a point.- Parameters:
hoverCustomizer-
-
setDataLabelHoverHTMLCustomizer
Called when the mouse hovers over a data label, that is, a text label showing values from the first facet. For example, the labels underneath the X-axis of a column chart, labelling each column.- Parameters:
dataLabelHoverHTMLCustomizer-
-
setLegendHoverCustomizer
Called when the mouse hovers over a color swatch or its label in the legend area of the chart.The
FacetValuethat the user is hovering over is provided. If the chart is amulti-axis chart, theFacetValuefor the hovered-over metric will also be provided.- Parameters:
facetValue- (FacetValue) facetValue that the mouse is overmetricFacetValue- (FacetValue) for a multi-axis chart, facetValue representing the hovered-over metric. Null if chart is not multi-axis
-
setPointClickHandler
Apply a handler to fire whenshowDataPointsis true, and the user clicks on a point.- Parameters:
handler-
-
getPrintHTML
Retrieves printable HTML for this component and all printable subcomponents.By default any Canvas with children will simply collect the printable HTML of its children by calling getPrintHTML() on each child that is considered
printable.If overriding this method for a custom component, you should either return a String of printable HTML string directly or return null, and fire the callback (if provided).
To return an empty print representation, return an empty string ("") rather than null.
The
printPropertiesargument, if passed, must be passed to any subcomponents on whichgetPrintHTML()is called.Notes on printing
To print a
FacetChartfor export on IE8 and earlier, it isPrintPropertieswithprintForExport:true:final PrintProperties pp = new PrintProperties(); pp.setPrintForExport(true); final String exportHTML = chart.getPrintHTML(pp, null);
Note: this is an override point.
- Overrides:
getPrintHTMLin classDrawPane- Parameters:
printProperties- properties to configure printing behavior - may be null.callback- optional callback to fire. Generated HTML should be passed to thePrintHTMLCallback.setHTML(String)method of the callback.- Returns:
- null if the print HTML is being generated asynchronously and/or a callback is provided; otherwise, the direct print HTML for this component (but note that returning direct print HTML is a deprecated feature).
- See Also:
-
setZoomStartValue
For azoomed chart, start value of the data range shown in the main chart. IfzoomEndValueis not also set, the range shown will be fromzoomStartValueto the end of the dataset.The value provided should be a value in the range of the facet for the X axis, for example, for a time-based axis, a Date instance, for a numeric axis, a Number, for an axis that just has text labels (such as city names), a String.
If this method is called after the component has been drawn/initialized: Setter forzoomStartValue.Note that the
zoomStartValueandzoomEndValuemay be set simultaneously usingFacetChart.zoomTo.- Parameters:
zoomStartValue- New start value for the data range shown in the main chart. Default value is null
-
getZoomStartValue
For azoomed chart, start value of the data range shown in the main chart. IfzoomEndValueis not also set, the range shown will be fromzoomStartValueto the end of the dataset.The value provided should be a value in the range of the facet for the X axis, for example, for a time-based axis, a Date instance, for a numeric axis, a Number, for an axis that just has text labels (such as city names), a String.
- Returns:
- Object
-
setZoomEndValue
For azoomed chart, end value of the data range shown in the main chart. IfzoomStartValueis not also set, the range shown will be from the beginning of the dataset up tozoomEndValueThe value provided should be a value in the range of the facet for the X axis, for example, for a time-based axis, a Date instance, for a numeric axis, a Number, for an axis that just has text labels (such as city names), a String.
If this method is called after the component has been drawn/initialized: Setter forzoomEndValue.Note that the
zoomStartValueandzoomEndValuemay be set simultaneously usingFacetChart.zoomTo.- Parameters:
zoomEndValue- New end value for the data range shown in the main chart. Default value is null
-
getZoomEndValue
For azoomed chart, end value of the data range shown in the main chart. IfzoomStartValueis not also set, the range shown will be from the beginning of the dataset up tozoomEndValueThe value provided should be a value in the range of the facet for the X axis, for example, for a time-based axis, a Date instance, for a numeric axis, a Number, for an axis that just has text labels (such as city names), a String.
- Returns:
- Object
-
setAxisValueFormatter
Formatter to apply to values displayed in the gradation labels.- Parameters:
formatter- Formatter to apply to values displayed in the gradation labels
-
setXAxisValueFormatter
Formatter to apply to values displayed in the gradation labels on the x-axis. Some documentation directing here may also relate tosetYAxisValueFormatter().Note that the installed formatter will only be called if the x-axis has gradation labels, meaning labels drawn at regular intervals not associated with any particular facet value. So, it will not be called if the labels on the x-axis are merely facet value ids. In that case, you may wish to build an array of
FacetValuesfor the x-axis facet, as a FacetValue constructor is available to set a separate facet id and title, and then callFacet.setValues().- Parameters:
formatter- Formatter to apply to values displayed in the gradation labels
-
setYAxisValueFormatter
Formatter to apply to values displayed in the gradation labels on the y-axis. See also the similar settersetXAxisValueFormatter()for the other axis.- Parameters:
formatter- Formatter to apply to values displayed in the gradation labels
-
setDataValueFormatter
Formatter to apply to values displayed in the hover labels and other value labels- Parameters:
formatter- Formatter to apply to values displayed in the hover labels and other value labels
-
getMean
Calculate the mean, or expected value, of the data over a single metric. See http://en.wikipedia.org/wiki/Expected_value.The first argument, criteria, determines which metric is used to calculate the mean. The criteria may be a String that is the "id" of some
FacetValueof the metric facet, or aFacetValueMapthat contains an entry for the metric facet, or null to use thevalueProperty. A FacetValueMap criteria may also be used to restrict the calculation to a slice of the data.- Parameters:
criteria- the "id" of a metric facet value, or a set of mappings describing the data over which to calculate, or null- Returns:
- the mean of the data values
-
getMean
Calculate the mean, or expected value, of the data over a single metric. See http://en.wikipedia.org/wiki/Expected_value.The first argument, criteria, determines which metric is used to calculate the mean. The criteria may be a String that is the "id" of some
FacetValueof the metric facet, or aFacetValueMapthat contains an entry for the metric facet, or null to use thevalueProperty. A FacetValueMap criteria may also be used to restrict the calculation to a slice of the data.- Parameters:
criteria- the "id" of a metric facet value, or a set of mappings describing the data over which to calculate, or null- Returns:
- the mean of the data values
-
getMedian
Calculate the median of the data over a single metric. See http://en.wikipedia.org/wiki/Median.The first argument, criteria, determines which metric is used to calculate the median. The criteria may be a String that is the "id" of some
FacetValueof the metric facet, or aFacetValueMapthat contains an entry for the metric facet, or null to use thevalueProperty. A FacetValueMap criteria may also be used to restrict the calculation to a slice of the data.- Parameters:
criteria- the "id" of a metric facet value, or a set of mappings describing the data over which to calculate, or null- Returns:
- the median of the data values
-
getMedian
Calculate the median of the data over a single metric. See http://en.wikipedia.org/wiki/Median.The first argument, criteria, determines which metric is used to calculate the median. The criteria may be a String that is the "id" of some
FacetValueof the metric facet, or aFacetValueMapthat contains an entry for the metric facet, or null to use thevalueProperty. A FacetValueMap criteria may also be used to restrict the calculation to a slice of the data.- Parameters:
criteria- the "id" of a metric facet value, or a set of mappings describing the data over which to calculate, or null- Returns:
- the median of the data values
-
getPercentile
Calculate a percentile of the data over a single metric. See http://en.wikipedia.org/wiki/Percentile.The first argument, criteria, determines which metric is used to calculate a percentile. The criteria may be a String that is the "id" of some
FacetValueof the metric facet, or aFacetValueMapthat contains an entry for the metric facet, or null to use thevalueProperty. A FacetValueMap criteria may also be used to restrict the calculation to a slice of the data.The second argument is the percentile to calculate and it must be a number from 0 to 100.
- Parameters:
criteria- the "id" of a metric facet value, or a set of mappings describing the data over which to calculate, or nullpercentile- the percentile to calculate- Returns:
- a percentile of the data values
-
getPercentile
Calculate a percentile of the data over a single metric. See http://en.wikipedia.org/wiki/Percentile.The first argument, criteria, determines which metric is used to calculate a percentile. The criteria may be a String that is the "id" of some
FacetValueof the metric facet, or aFacetValueMapthat contains an entry for the metric facet, or null to use thevalueProperty. A FacetValueMap criteria may also be used to restrict the calculation to a slice of the data.The second argument is the percentile to calculate and it must be a number from 0 to 100.
- Parameters:
criteria- the "id" of a metric facet value, or a set of mappings describing the data over which to calculate, or nullpercentile- the percentile to calculate- Returns:
- a percentile of the data values
-
getRange
Calculate the range of the data from a single metric.The first argument, criteria, determines which metric is used to calculate the range. The criteria may be a String that is the "id" of some
FacetValueof the metric facet, or aFacetValueMapthat contains an entry for the metric facet, or null to use thevalueProperty. A FacetValueMap criteria may also be used to restrict the calculation to a slice of the data.- Parameters:
criteria- the "id" of a metric facet value, or a set of mappings describing the data over which to calculate, or null- Returns:
- the range of the data values
-
getRange
Calculate the range of the data from a single metric.The first argument, criteria, determines which metric is used to calculate the range. The criteria may be a String that is the "id" of some
FacetValueof the metric facet, or aFacetValueMapthat contains an entry for the metric facet, or null to use thevalueProperty. A FacetValueMap criteria may also be used to restrict the calculation to a slice of the data.- Parameters:
criteria- the "id" of a metric facet value, or a set of mappings describing the data over which to calculate, or null- Returns:
- the range of the data values
-
getStdDev
Calculate the standard deviation of the data from a single metric. See http://en.wikipedia.org/wiki/Standard_deviation.The first argument, criteria, determines which metric is used to calculate the standard deviation. The criteria may be a String that is the "id" of some
FacetValueof the metric facet, or aFacetValueMapthat contains an entry for the metric facet, or null to use thevalueProperty. A FacetValueMap criteria may also be used to restrict the calculation to a slice of the data.- Parameters:
criteria- the "id" of a metric facet value, or a set of mappings describing the data over which to calculate, or nullpopulation- false to calculate a sample standard deviation, true to calculate a population standard deviation- Returns:
- the standard deviation of the data values
-
getStdDev
Calculate the standard deviation of the data from a single metric. See http://en.wikipedia.org/wiki/Standard_deviation.The first argument, criteria, determines which metric is used to calculate the standard deviation. The criteria may be a String that is the "id" of some
FacetValueof the metric facet, or aFacetValueMapthat contains an entry for the metric facet, or null to use thevalueProperty. A FacetValueMap criteria may also be used to restrict the calculation to a slice of the data.- Parameters:
criteria- the "id" of a metric facet value, or a set of mappings describing the data over which to calculate, or nullpopulation- false to calculate a sample standard deviation, true to calculate a population standard deviation- Returns:
- the standard deviation of the data values
-
getVariance
Calculate the variance of the data from a single metric. See http://en.wikipedia.org/wiki/Variance.The first argument, criteria, determines which metric is used to calculate the variance. The criteria may be a String that is the "id" of some
FacetValueof the metric facet, or aFacetValueMapthat contains an entry for the metric facet, or null to use thevalueProperty. A FacetValueMap criteria may also be used to restrict the calculation to a slice of the data.- Parameters:
criteria- the "id" of a metric facet value, or a set of mappings describing the data over which to calculate, or nullpopulation- false to calculate a sample variance, true to calculate a population variance- Returns:
- the variance of the data values
-
getVariance
Calculate the variance of the data from a single metric. See http://en.wikipedia.org/wiki/Variance.The first argument, criteria, determines which metric is used to calculate the variance. The criteria may be a String that is the "id" of some
FacetValueof the metric facet, or aFacetValueMapthat contains an entry for the metric facet, or null to use thevalueProperty. A FacetValueMap criteria may also be used to restrict the calculation to a slice of the data.- Parameters:
criteria- the "id" of a metric facet value, or a set of mappings describing the data over which to calculate, or nullpopulation- false to calculate a sample variance, true to calculate a population variance- Returns:
- the variance of the data values
-
getMax
Calculate the maximum of the data from a single metric.The first argument, criteria, determines which metric is used to calculate the maximum. The criteria may be a String that is the "id" of some
FacetValueof the metric facet, or aFacetValueMapthat contains an entry for the metric facet, or null to use thevalueProperty. A FacetValueMap criteria may also be used to restrict the calculation to a slice of the data.- Parameters:
criteria- the "id" of a metric facet value, or a set of mappings describing the data over which to calculate, or null- Returns:
- the maximum of the data values
-
getMax
Calculate the maximum of the data from a single metric.The first argument, criteria, determines which metric is used to calculate the maximum. The criteria may be a String that is the "id" of some
FacetValueof the metric facet, or aFacetValueMapthat contains an entry for the metric facet, or null to use thevalueProperty. A FacetValueMap criteria may also be used to restrict the calculation to a slice of the data.- Parameters:
criteria- the "id" of a metric facet value, or a set of mappings describing the data over which to calculate, or null- Returns:
- the maximum of the data values
-
getMin
Calculate the minimum of the data from a single metric.The first argument, criteria, determines which metric is used to calculate the minimum. The criteria may be a String that is the "id" of some
FacetValueof the metric facet, or aFacetValueMapthat contains an entry for the metric facet, or null to use thevalueProperty. A FacetValueMap criteria may also be used to restrict the calculation to a slice of the data.- Parameters:
criteria- the "id" of a metric facet value, or a set of mappings describing the data over which to calculate, or null- Returns:
- the minimum of the data values
-
getMin
Calculate the minimum of the data from a single metric.The first argument, criteria, determines which metric is used to calculate the minimum. The criteria may be a String that is the "id" of some
FacetValueof the metric facet, or aFacetValueMapthat contains an entry for the metric facet, or null to use thevalueProperty. A FacetValueMap criteria may also be used to restrict the calculation to a slice of the data.- Parameters:
criteria- the "id" of a metric facet value, or a set of mappings describing the data over which to calculate, or null- Returns:
- the minimum of the data values
-
getDataColor
Get a color from thedataColorsArray. The colors returned by this method define what colors are used for the data in the chart.This is not an override point, but you can provide your own function by setting a customizer with
setDataColorMapper().- Parameters:
index- index of the visual element to be coloredfacetValueId- id of the facet value to be coloredpurpose- purpose for the requested color - such as "legend", "line", "area", "points", etc.- Returns:
- chosen color
- See Also:
-
getDataColor
-
getDataColor
-
getDataColor
-
getDataColor
-
setDataColorMapper
Sets a customizer to redefine what colors are used when rendering the chart data.- Parameters:
colorMapper- the customizer redefining what colors are used for chart data- See Also:
-
setDataLineColorMapper
Sets a customizer to redefine what colors are used when rendering lines for the chart data. No default implementation. If not defined or null is returned, the Framework will default to using the data color - eithergetDataColor()or theColorMapperinstalled bysetDataColorMapper()if one has been provided.- Parameters:
colorMapper- the customizer redefining what line colors are used for chart data- See Also:
-
setDataGradientMapper
Sets a customizer to redefine what gradients are used when rendering the chart data.- Parameters:
gradientMapper- the customizer redefining what gradients are used for chart data- See Also:
-
setDataLineWidthMapper
Sets a customizer to define what widths to use for data lines in the chart. No default implementation. If not defined or null is returned, the line width will be determined by the appropriate chart properties, such asdataLineProperties,barProperties, orbubbleProperties.- Parameters:
lineWidthMapper- the customizer defining what line widths are used for chart data- See Also:
-
setMinClusterSizeMapper
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 facetvalue. Only applicable to a column, bar, or histogram chart. There is no default customizer in place - only the chart-wideminBarThickness.Both this minimum and
minBarThicknessare used together to determine the effective minimum of the cluster or bar stack.Per-facet-value minimum cluster sizes aren't supported for
multi-axischarts, in which multiple chart types are overlaid onto the same chart.- Parameters:
clusterSizeMapper- customizer defining the minimum size for each cluster
-
setDataPageSize
Description copied from interface:DataBoundComponentWhen usingdata paging, how many records to fetch at a time. If set to a positive integer,dataPageSizewill override the defaultresultSizefor ResultSets automatically created when you callfetchData()(and similarly for theresultSizeof ResultTrees). The default of 0 means to just use the default page size of the data container.Note that regardless of the
dataPageSizesetting, a component will always fetch all of data that it needs to draw. Settings such asshowAllRecords:true,drawAllMaxCellsanddrawAheadRatiocan cause more rows than the configureddataPageSizeto be fetched.- Specified by:
setDataPageSizein interfaceDataBoundComponent- Parameters:
dataPageSize- dataPageSize Default value is 0- Returns:
DataBoundComponentinstance, for chaining setter calls- See Also:
-
getDataPageSize
public int getDataPageSize()Description copied from interface:DataBoundComponentWhen usingdata paging, how many records to fetch at a time. If set to a positive integer,dataPageSizewill override the defaultresultSizefor ResultSets automatically created when you callfetchData()(and similarly for theresultSizeof ResultTrees). The default of 0 means to just use the default page size of the data container.Note that regardless of the
dataPageSizesetting, a component will always fetch all of data that it needs to draw. Settings such asshowAllRecords:true,drawAllMaxCellsanddrawAheadRatiocan cause more rows than the configureddataPageSizeto be fetched.- Specified by:
getDataPageSizein interfaceDataBoundComponent- Returns:
- int
- See Also:
-
setUseAllDataSourceFields
Description copied from interface:DataBoundComponentIf true, the set of fields given by the "default binding" (see 
fields) is used, with any fields specified in
component.fieldsacting 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.

 If
component.fieldscontains fields that are not found in the DataSource,
 they will be shown after the most recently referred to DataSource field. If the new
 fields appear first, they will be shown first.- Specified by:
setUseAllDataSourceFieldsin interfaceDataBoundComponent- Parameters:
useAllDataSourceFields- useAllDataSourceFields Default value is false- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getUseAllDataSourceFields
Description copied from interface:DataBoundComponentIf true, the set of fields given by the "default binding" (see 
fields) is used, with any fields specified in
component.fieldsacting 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.

 If
component.fieldscontains fields that are not found in the DataSource,
 they will be shown after the most recently referred to DataSource field. If the new
 fields appear first, they will be shown first.- Specified by:
getUseAllDataSourceFieldsin interfaceDataBoundComponent- Returns:
- Boolean
-
setSparseFieldState
Description copied from interface:DataBoundComponentIf true,ListGrid.getFieldState()andListGrid.setFieldState(java.lang.String)will omit state information for hidden fields by default.- Specified by:
setSparseFieldStatein interfaceDataBoundComponent- Parameters:
sparseFieldState- sparseFieldState Default value is false- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getSparseFieldState
Description copied from interface:DataBoundComponentIf true,ListGrid.getFieldState()andListGrid.setFieldState(java.lang.String)will omit state information for hidden fields by default.- Specified by:
getSparseFieldStatein interfaceDataBoundComponent- Returns:
- Boolean
-
setShowHiddenFields
Description copied from interface:DataBoundComponentWhether to show fields markedhidden:truewhen a DataBoundComponent is given a
 DataSource but nocomponent.fields.

 The
hiddenproperty is used on DataSource fields to mark fields that are
 never of meaning to an end user.- Specified by:
setShowHiddenFieldsin interfaceDataBoundComponent- Parameters:
showHiddenFields- showHiddenFields Default value is false- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getShowHiddenFields
Description copied from interface:DataBoundComponentWhether to show fields markedhidden:truewhen a DataBoundComponent is given a
 DataSource but nocomponent.fields.

 The
hiddenproperty is used on DataSource fields to mark fields that are
 never of meaning to an end user.- Specified by:
getShowHiddenFieldsin interfaceDataBoundComponent- Returns:
- Boolean
-
setShowComplexFields
Description copied from interface:DataBoundComponentWhether to show fields of non-atomic types when a DataBoundComponent is given a
 DataSource but nocomponent.fields.

 If true, the component will show fields that declare a complex type, for example, a
 field 'shippingAddress' that declares type 'Address', where 'Address' is the ID of a
 DataSource that declares the fields of a shipping address (city, street name, etc).


 Such fields may need custom formatters or editors in order to create a usable interface,
 for example, an Address field in a ListGrid might use a custom formatter to combine the
 relevant fields of an address into one column, and might use a pop-up dialog for
 editing.
Note : This is an advanced setting
- Specified by:
setShowComplexFieldsin interfaceDataBoundComponent- Parameters:
showComplexFields- showComplexFields Default value is true- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getShowComplexFields
Description copied from interface:DataBoundComponentWhether to show fields of non-atomic types when a DataBoundComponent is given a
 DataSource but nocomponent.fields.

 If true, the component will show fields that declare a complex type, for example, a
 field 'shippingAddress' that declares type 'Address', where 'Address' is the ID of a
 DataSource that declares the fields of a shipping address (city, street name, etc).


 Such fields may need custom formatters or editors in order to create a usable interface,
 for example, an Address field in a ListGrid might use a custom formatter to combine the
 relevant fields of an address into one column, and might use a pop-up dialog for
 editing.
- Specified by:
getShowComplexFieldsin interfaceDataBoundComponent- Returns:
- Boolean
-
setFetchOperation
Description copied from interface:DataBoundComponentOperation ID this component should use when performing fetch operations.- Specified by:
setFetchOperationin interfaceDataBoundComponent- Parameters:
fetchOperation- fetchOperation Default value is null- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getFetchOperation
Description copied from interface:DataBoundComponentOperation ID this component should use when performing fetch operations.- Specified by:
getFetchOperationin interfaceDataBoundComponent- Returns:
- String
-
setUpdateOperation
Description copied from interface:DataBoundComponentoperationIdthis component should use when performing update operations.- Specified by:
setUpdateOperationin interfaceDataBoundComponent- Parameters:
updateOperation- Default value is null- Returns:
DataBoundComponentinstance, for chaining setter calls- See Also:
-
getUpdateOperation
Description copied from interface:DataBoundComponentoperationIdthis component should use when performing update operations.- Specified by:
getUpdateOperationin interfaceDataBoundComponent- Returns:
- String
- See Also:
-
setAddOperation
Description copied from interface:DataBoundComponentoperationIdthis component should use when performing add operations.- Specified by:
setAddOperationin interfaceDataBoundComponent- Parameters:
addOperation- Default value is null- Returns:
DataBoundComponentinstance, for chaining setter calls- See Also:
-
getAddOperation
Description copied from interface:DataBoundComponentoperationIdthis component should use when performing add operations.- Specified by:
getAddOperationin interfaceDataBoundComponent- Returns:
- String
- See Also:
-
setRemoveOperation
Description copied from interface:DataBoundComponentoperationIdthis component should use when performing remove operations.- Specified by:
setRemoveOperationin interfaceDataBoundComponent- Parameters:
removeOperation- Default value is null- Returns:
DataBoundComponentinstance, for chaining setter calls- See Also:
-
getRemoveOperation
Description copied from interface:DataBoundComponentoperationIdthis component should use when performing remove operations.- Specified by:
getRemoveOperationin interfaceDataBoundComponent- Returns:
- String
- See Also:
-
setExportFields
Description copied from interface:DataBoundComponentThe list of field-names to export. If provided, the field-list in the exported output is 
 limited and sorted as per the list.

 If exportFields is not provided, the exported output includes all visible fields 
 from this component, sorted as they appear.
- Specified by:
setExportFieldsin interfaceDataBoundComponent- Parameters:
exportFields- exportFields Default value is null- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getExportFields
Description copied from interface:DataBoundComponentThe list of field-names to export. If provided, the field-list in the exported output is 
 limited and sorted as per the list.

 If exportFields is not provided, the exported output includes all visible fields 
 from this component, sorted as they appear.
- Specified by:
getExportFieldsin interfaceDataBoundComponent- Returns:
- the list of field-names to export.
-
setExportAll
Description copied from interface:DataBoundComponentSetting exportAll to true prevents the component from passing its list of fields to the 
 export call. The result is the export of all visible fields fromfields.

 If exportAll is false, an export operation will first consider 

exportFields, if it's set, and fall back on all visible fields from
fieldsotherwise.- Specified by:
setExportAllin interfaceDataBoundComponent- Parameters:
exportAll- exportAll Default value is false- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getExportAll
Description copied from interface:DataBoundComponentSetting exportAll to true prevents the component from passing its list of fields to the 
 export call. The result is the export of all visible fields fromfields.

 If exportAll is false, an export operation will first consider 

exportFields, if it's set, and fall back on all visible fields from
fieldsotherwise.- Specified by:
getExportAllin interfaceDataBoundComponent- Returns:
- Boolean
-
setExportIncludeSummaries
Description copied from interface:DataBoundComponentIf Summary rows exist for this component, whether to include them when exporting client data. Defaults to true if not set- Specified by:
setExportIncludeSummariesin interfaceDataBoundComponent- Parameters:
exportIncludeSummaries- exportIncludeSummaries Default value is true- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getExportIncludeSummaries
Description copied from interface:DataBoundComponentIf Summary rows exist for this component, whether to include them when exporting client data. Defaults to true if not set- Specified by:
getExportIncludeSummariesin interfaceDataBoundComponent- Returns:
- Boolean
-
setPreventDuplicates
Description copied from interface:DataBoundComponentIf 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). When a duplicate transfer is detected,
 a dialog will appear showing theduplicateDragMessage.

 If the component either does not have a
DataSourceor has a DataSource with no
primaryKeydeclared, duplicate checking is off by
 default. If duplicate checking is enabled, it looks for an existing record in the dataset
 that has all of the properties of the dragged record, and considers that a duplicate.

 For
DragDataAction:"copy" where the target DataSource is related to the source
 DataSource by foreignKey, a duplicate means that the target list, as filtered by the current
 criteria, already has a record whose value for the foreignKey field matches the
 primaryKey of the record being transferred.

 For example, consider dragging "employees" to "teams", where "teams" has a field
 "teams.employeeId" which is a foreignKey pointing to "employees.id", and the target
 grid has search criteria causing it to show all the members of one team. A duplicate -
 adding an employee to the same team twice - is when the target grid's dataset contains an
 record with "employeeId" matching the "id" field of the dropped employee.
- Specified by:
setPreventDuplicatesin interfaceDataBoundComponent- Parameters:
preventDuplicates- preventDuplicates Default value is null- Returns:
DataBoundComponentinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getPreventDuplicates
Description copied from interface:DataBoundComponentIf 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). When a duplicate transfer is detected,
 a dialog will appear showing theduplicateDragMessage.

 If the component either does not have a
DataSourceor has a DataSource with no
primaryKeydeclared, duplicate checking is off by
 default. If duplicate checking is enabled, it looks for an existing record in the dataset
 that has all of the properties of the dragged record, and considers that a duplicate.

 For
DragDataAction:"copy" where the target DataSource is related to the source
 DataSource by foreignKey, a duplicate means that the target list, as filtered by the current
 criteria, already has a record whose value for the foreignKey field matches the
 primaryKey of the record being transferred.

 For example, consider dragging "employees" to "teams", where "teams" has a field
 "teams.employeeId" which is a foreignKey pointing to "employees.id", and the target
 grid has search criteria causing it to show all the members of one team. A duplicate -
 adding an employee to the same team twice - is when the target grid's dataset contains an
 record with "employeeId" matching the "id" field of the dropped employee.
- Specified by:
getPreventDuplicatesin interfaceDataBoundComponent- Returns:
- Boolean
-
setDuplicateDragMessage
Description copied from interface:DataBoundComponentMessage to show when a user attempts to transfer duplicate records into this component, and
preventDuplicatesis enabled. If set to null, duplicates will not be reported and the dragged duplicates will not be saved.- Specified by:
setDuplicateDragMessagein interfaceDataBoundComponent- Parameters:
duplicateDragMessage- duplicateDragMessage Default value is "Duplicates not allowed"- Returns:
DataBoundComponentinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getDuplicateDragMessage
Description copied from interface:DataBoundComponentMessage to show when a user attempts to transfer duplicate records into this component, and
preventDuplicatesis enabled. If set to null, duplicates will not be reported and the dragged duplicates will not be saved.- Specified by:
getDuplicateDragMessagein interfaceDataBoundComponent- Returns:
- String
-
setAddDropValues
Description copied from interface:DataBoundComponentIndicates 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. "Drop values" are properties of the dropped item that you wish to change (and persist) as a result of the item being dropped on this grid.If this value is true and this component is databound,
DataBoundComponent.getDropValues()will be called for every databound item dropped on this grid, and an update performed on the item- Specified by:
setAddDropValuesin interfaceDataBoundComponent- Parameters:
addDropValues- addDropValues Default value is true- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getAddDropValues
Description copied from interface:DataBoundComponentIndicates 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. "Drop values" are properties of the dropped item that you wish to change (and persist) as a result of the item being dropped on this grid.If this value is true and this component is databound,
DataBoundComponent.getDropValues()will be called for every databound item dropped on this grid, and an update performed on the item- Specified by:
getAddDropValuesin interfaceDataBoundComponent- Returns:
- Boolean
-
setDropValues
Description copied from interface:DataBoundComponentWhen an item is dropped on this component, andaddDropValuesis 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.If this property is not defined, Smart GWT defaults to returning the selection criteria currently in place for this component. Thus, any databound items (for example, rows from other grids bound to the same DataSource) dropped on the grid will, by default, be subjected to an update that makes them conform to the grid's current filter criteria.
Note : This is an advanced setting
- Specified by:
setDropValuesin interfaceDataBoundComponent- Parameters:
dropValues- dropValues Default value is null- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getDropValues
Description copied from interface:DataBoundComponentWhen an item is dropped on this component, andaddDropValuesis 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.If this property is not defined, Smart GWT defaults to returning the selection criteria currently in place for this component. Thus, any databound items (for example, rows from other grids bound to the same DataSource) dropped on the grid will, by default, be subjected to an update that makes them conform to the grid's current filter criteria.
Note : This is an advanced setting
- Specified by:
getDropValuesin interfaceDataBoundComponent- Returns:
- Returns the "drop values" to apply to a record dropped on this component prior to update. Only
 applicable to databound components - see
dropValuesfor more details. If multiple records 
 are being dropped, this method is called for each of them in turn.

 This method returns the following:

- 

- Nothing, if
addDropValuesis false 
 - dropValues, if that property is set. If the component's criteria object is applicable (as explained
 in the next item), it is merged into dropValues, with properties in dropValues taking precedence. 

- The component's criteria object, if the most recent textMatchStyle for the component was "exact" 
 and it is simple criteria (ie, not an AdvancedCriteria object) 

- Otherwise nothing 


 You can override this method if you need more complex setting of drop values than can be 
 provided by simply supplying a dropValues object.
 

- Nothing, if
-
setProgressiveLoading
Indicates whether or not this component will load its dataprogressively- Parameters:
progressiveLoading-- Returns:
DataBoundComponentinstance, for chaining setter calls- See Also:
-
getProgressiveLoading
Indicates whether or not this component will load its dataprogressively- Returns:
- See Also:
-
setUseFlatFields
Description copied from interface:DataBoundComponentTheuseFlatFieldsflag causes all simple type fields anywhere in a nested
 set of DataSources to be exposed as a flat list for form binding. 


useFlatFieldsis typically used with imported metadata, such as 
XMLTools.loadXMLSchema(java.lang.String, com.smartgwt.client.data.XSDLoadCallback)from a 
XMLTools.loadWSDL(java.lang.String, com.smartgwt.client.data.WSDLLoadCallback), as a means of eliminating levels of XML
 nesting that aren't meaningful in a user interface, without the cumbersome and fragile
 process of mapping form fields to XML structures.

 For example, having called
WebService.getInputDS(java.lang.String)to retrieve the input message
 schema for a web service operation whose input message looks like this:

 <FindServices>
 <searchFor>search text</searchFor>
 <Options>
 <caseSensitive>false</caseSensitive>
 </Options>
 <IncludeInSearch>
 <serviceName>true</serviceName>
 <documentation>true</documentation>
 <keywords>true</keywords>
 </IncludeInSearch>
 </FindServices>


 SettinguseFlatFieldson aDynamicFormthat is bound to this input
 message schema would result in 5FormItemreflecting the 5 simple type
 fields in the message.

 For this form, the result of
DynamicForm.getValues()might look
 like:


{
 searchFor: "search text",
 caseSensitive: false,
 serviceName: true,
 documentation : true,
 keywords : true
 }
 When contacting aWebService, these values can be automatically
 mapped to the structure of the input message for a web service operation by setting
 {@link com.smartgwt.client..WSRequest#getUseFlatFields useFlatFields} (for use withWebService.callOperation(java.lang.String, java.util.Map, java.lang.String, com.smartgwt.client.data.WebServiceCallback)) or by setting
useFlatFields(for use with aDataSourcethat is
'bound to a WSDL web service'via
wsOperation). 

 Using these two facilities in conjunction (component.useFlatFields and
 request.useFlatFields) allows gratuitous nesting to be consistently bypassed in both the user
 presentation and when providing the data for XML messages.


 You can also set
useFlatFieldsto automatically enable 
 "flattened" XML serialization (request.useFlatFields) for all DataSource requests of a
 particular operationType.

 Note that
useFlatFieldsis not generally recommended for use with structures
 where multiple simple type fields exist with the same name, however if used with such a
 structure, the first field to use a given name wins. "first" means the first field
 encountered in a depth first search. "wins" means only the first field will be present as a
 field when data binding.- Specified by:
setUseFlatFieldsin interfaceDataBoundComponent- Parameters:
useFlatFields- useFlatFields Default value is null- Returns:
DataBoundComponentinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getUseFlatFields
Description copied from interface:DataBoundComponentTheuseFlatFieldsflag causes all simple type fields anywhere in a nested
 set of DataSources to be exposed as a flat list for form binding. 


useFlatFieldsis typically used with imported metadata, such as 
XMLTools.loadXMLSchema(java.lang.String, com.smartgwt.client.data.XSDLoadCallback)from a 
XMLTools.loadWSDL(java.lang.String, com.smartgwt.client.data.WSDLLoadCallback), as a means of eliminating levels of XML
 nesting that aren't meaningful in a user interface, without the cumbersome and fragile
 process of mapping form fields to XML structures.

 For example, having called
WebService.getInputDS(java.lang.String)to retrieve the input message
 schema for a web service operation whose input message looks like this:

 <FindServices>
 <searchFor>search text</searchFor>
 <Options>
 <caseSensitive>false</caseSensitive>
 </Options>
 <IncludeInSearch>
 <serviceName>true</serviceName>
 <documentation>true</documentation>
 <keywords>true</keywords>
 </IncludeInSearch>
 </FindServices>


 SettinguseFlatFieldson aDynamicFormthat is bound to this input
 message schema would result in 5FormItemreflecting the 5 simple type
 fields in the message.

 For this form, the result of
DynamicForm.getValues()might look
 like:


{
 searchFor: "search text",
 caseSensitive: false,
 serviceName: true,
 documentation : true,
 keywords : true
 }
 When contacting aWebService, these values can be automatically
 mapped to the structure of the input message for a web service operation by setting
 {@link com.smartgwt.client..WSRequest#getUseFlatFields useFlatFields} (for use withWebService.callOperation(java.lang.String, java.util.Map, java.lang.String, com.smartgwt.client.data.WebServiceCallback)) or by setting
useFlatFields(for use with aDataSourcethat is
'bound to a WSDL web service'via
wsOperation). 

 Using these two facilities in conjunction (component.useFlatFields and
 request.useFlatFields) allows gratuitous nesting to be consistently bypassed in both the user
 presentation and when providing the data for XML messages.


 You can also set
useFlatFieldsto automatically enable 
 "flattened" XML serialization (request.useFlatFields) for all DataSource requests of a
 particular operationType.

 Note that
useFlatFieldsis not generally recommended for use with structures
 where multiple simple type fields exist with the same name, however if used with such a
 structure, the first field to use a given name wins. "first" means the first field
 encountered in a depth first search. "wins" means only the first field will be present as a
 field when data binding.- Specified by:
getUseFlatFieldsin interfaceDataBoundComponent- Returns:
- Boolean
-
setHiliteProperty
Description copied from interface:DataBoundComponentMarker that can be set on a record to flag that record as hilited. Should be set to a value
 that matches {@link com.smartgwt.client..Hilite#getId id} for a hilite defined on this component.- Specified by:
setHilitePropertyin interfaceDataBoundComponent- Parameters:
hiliteProperty- hiliteProperty Default value is "_hilite"- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getHiliteProperty
Description copied from interface:DataBoundComponentMarker that can be set on a record to flag that record as hilited. Should be set to a value
 that matches {@link com.smartgwt.client..Hilite#getId id} for a hilite defined on this component.- Specified by:
getHilitePropertyin interfaceDataBoundComponent- Returns:
- String
-
editFields
public void editFields()Shows a FieldPicker interface allowing end-users to rearrange the order and visibiility of the fields in the associated DataBoundComponent. -
editHilites
public void editHilites()Description copied from interface:DataBoundComponentShows a HiliteEditor interface allowing end-users to edit the data-hilites currently in use by this DataBoundComponent.- Specified by:
editHilitesin interfaceDataBoundComponent
-
getHiliteState
Description copied from interface:DataBoundComponentGet the current hilites encoded as a String, for saving.- Specified by:
getHiliteStatein interfaceDataBoundComponent- Returns:
- the hilite state
-
setHiliteState
Description copied from interface:DataBoundComponentSet the current hilites based on a hiliteState String previously returned from getHilitesState.- Specified by:
setHiliteStatein interfaceDataBoundComponent- Parameters:
hiliteState- hilites state encoded as a String- Returns:
DataBoundComponentinstance, for chaining setter calls
-
setHilites
Description copied from interface:DataBoundComponentAccepts an array of hilite objects and applies them to this DataBoundComponent. See alsogetHilitesfor a method of retrieving the hilite array for storage, including hilites manually added by the user.NOTE: This is only supported on
ListGridfor now.- Specified by:
setHilitesin interfaceDataBoundComponent- Parameters:
hilites- array of hilite objects- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getHilites
Description copied from interface:DataBoundComponentReturn the set of hilite-objects currently applied to this DataBoundComponent. These can be saved for storage and then restored to a component later via setHilites().- Specified by:
getHilitesin interfaceDataBoundComponent- Returns:
- array of hilite objects
-
setDragDataAction
Description copied from interface:DataBoundComponentIndicates what to do with data dragged into another DataBoundComponent. See
 DragDataAction type for details.- Specified by:
setDragDataActionin interfaceDataBoundComponent- Parameters:
dragDataAction- dragDataAction Default value is Canvas.MOVE- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getDragDataAction
Description copied from interface:DataBoundComponentIndicates what to do with data dragged into another DataBoundComponent. See
 DragDataAction type for details.- Specified by:
getDragDataActionin interfaceDataBoundComponent- Returns:
- DragDataAction
-
setDragTrackerStyle
Description copied from interface:DataBoundComponentCSS Style to apply to the drag tracker when dragging occurs on this component.- Specified by:
setDragTrackerStylein interfaceDataBoundComponent- Parameters:
dragTrackerStyle- dragTrackerStyle Default value is "gridDragTracker"- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getDragTrackerStyle
Description copied from interface:DataBoundComponentCSS Style to apply to the drag tracker when dragging occurs on this component.- Specified by:
getDragTrackerStylein interfaceDataBoundComponent- Returns:
- String
-
setCanAddFormulaFields
Description copied from interface:DataBoundComponentAdds 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}.

 User-added formula fields can be persisted via
ListGrid.getFieldState()and 
ListGrid.setFieldState(java.lang.String).- Specified by:
setCanAddFormulaFieldsin interfaceDataBoundComponent- Parameters:
canAddFormulaFields- canAddFormulaFields Default value is false- Returns:
DataBoundComponentinstance, for chaining setter calls
-
addSummaryField
public void addSummaryField()Description copied from interface:DataBoundComponentConvenience method to display a {@link com.smartgwt.client..SummaryBuilder} to create a new Summary Field. This 
 is equivalent to callingDataBoundComponentGen#editSummaryFieldwith 
 no parameter.

- Specified by:
addSummaryFieldin interfaceDataBoundComponent
-
addFormulaField
public void addFormulaField()Description copied from interface:DataBoundComponentConvenience method to display a {@link com.smartgwt.client..FormulaBuilder} to create a new Formula Field. This 
 is equivalent to callingDataBoundComponentGen#editFormulaFieldwith 
 no parameter.

- Specified by:
addFormulaFieldin interfaceDataBoundComponent
-
getCanAddFormulaFields
Description copied from interface:DataBoundComponentAdds 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}.

 User-added formula fields can be persisted via
ListGrid.getFieldState()and 
ListGrid.setFieldState(java.lang.String).- Specified by:
getCanAddFormulaFieldsin interfaceDataBoundComponent- Returns:
- Boolean
-
setAddFormulaFieldText
Description copied from interface:DataBoundComponentText for a menu item allowing users to add a formula field- Specified by:
setAddFormulaFieldTextin interfaceDataBoundComponent- Parameters:
addFormulaFieldText- addFormulaFieldText Default value is "Add formula column..."- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getAddFormulaFieldText
Description copied from interface:DataBoundComponentText for a menu item allowing users to add a formula field- Specified by:
getAddFormulaFieldTextin interfaceDataBoundComponent- Returns:
- String
-
setEditFormulaFieldText
Description copied from interface:DataBoundComponentText for a menu item allowing users to edit a formula field- Specified by:
setEditFormulaFieldTextin interfaceDataBoundComponent- Parameters:
editFormulaFieldText- editFormulaFieldText Default value is "Edit formula..."- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getEditFormulaFieldText
Description copied from interface:DataBoundComponentText for a menu item allowing users to edit a formula field- Specified by:
getEditFormulaFieldTextin interfaceDataBoundComponent- Returns:
- String
-
setCanAddSummaryFields
Description copied from interface:DataBoundComponentAdds 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}.

 User-added summary fields can be persisted via
ListGrid.getFieldState()and 
ListGrid.setFieldState(java.lang.String).- Specified by:
setCanAddSummaryFieldsin interfaceDataBoundComponent- Parameters:
canAddSummaryFields- canAddSummaryFields Default value is false- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getCanAddSummaryFields
Description copied from interface:DataBoundComponentAdds 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}.

 User-added summary fields can be persisted via
ListGrid.getFieldState()and 
ListGrid.setFieldState(java.lang.String).- Specified by:
getCanAddSummaryFieldsin interfaceDataBoundComponent- Returns:
- Boolean
-
setAddSummaryFieldText
Description copied from interface:DataBoundComponentText for a menu item allowing users to add a formula field- Specified by:
setAddSummaryFieldTextin interfaceDataBoundComponent- Parameters:
addSummaryFieldText- addSummaryFieldText Default value is "Add summary column..."- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getAddSummaryFieldText
Description copied from interface:DataBoundComponentText for a menu item allowing users to add a formula field- Specified by:
getAddSummaryFieldTextin interfaceDataBoundComponent- Returns:
- String
-
setEditSummaryFieldText
Description copied from interface:DataBoundComponentText for a menu item allowing users to edit the formatter for a field- Specified by:
setEditSummaryFieldTextin interfaceDataBoundComponent- Parameters:
editSummaryFieldText- editSummaryFieldText Default value is "Edit summary format..."- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getEditSummaryFieldText
Description copied from interface:DataBoundComponentText for a menu item allowing users to edit the formatter for a field- Specified by:
getEditSummaryFieldTextin interfaceDataBoundComponent- Returns:
- String
-
setSavedSearchId
Description copied from interface:DataBoundComponentOptional identifier for saved searches that should be applied to this component.By default
SavedSearchesare associated with a component via itslocal IDandDataSource ID. This property allows developers to override this behavior and explicitly associate a component with a set of saved searches. This can provide a couple of benefits:
Firstly this ensures that saved searches will be unambiguously associated with the particular component even if the page changes such that a stored minimal locator would no longer applied to the component, without requiring an explicitCanvas.ID.
Secondly this allows the same set of saved searches to be applied to more than one component on a page. This may be valueable for cases where the same information from the same dataSource is presented to users in multiple places.Note: This is an advanced setting.
- Specified by:
setSavedSearchIdin interfaceDataBoundComponent- Parameters:
savedSearchId- New savedSearchId value. Default value is null- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getSavedSearchId
Description copied from interface:DataBoundComponentOptional identifier for saved searches that should be applied to this component.By default
SavedSearchesare associated with a component via itslocal IDandDataSource ID. This property allows developers to override this behavior and explicitly associate a component with a set of saved searches. This can provide a couple of benefits:
Firstly this ensures that saved searches will be unambiguously associated with the particular component even if the page changes such that a stored minimal locator would no longer applied to the component, without requiring an explicitCanvas.ID.
Secondly this allows the same set of saved searches to be applied to more than one component on a page. This may be valueable for cases where the same information from the same dataSource is presented to users in multiple places.- Specified by:
getSavedSearchIdin interfaceDataBoundComponent- Returns:
- Current savedSearchId value. Default value is null
-
setShowSavedSearchesByDS
public FacetChart setShowSavedSearchesByDS(boolean showSavedSearchesByDS) throws IllegalStateException Description copied from interface:DataBoundComponentWhether to associate saved searches by default with the currentDataSourceof a component when asavedSearchIdis not provided. If this property is true, then when the DataSource is changed, existing saved searches will disappear and only be available if the DataSource is set back to its original value.If this property is false, saved searches will persist across DataSource changes so that searches that aren't applicable to the current DataSource might still be shown.
Note: This is an advanced setting
- Specified by:
setShowSavedSearchesByDSin interfaceDataBoundComponent- Parameters:
showSavedSearchesByDS- New showSavedSearchesByDS value. Default value is true- Returns:
DataBoundComponentinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowSavedSearchesByDS
public boolean getShowSavedSearchesByDS()Description copied from interface:DataBoundComponentWhether to associate saved searches by default with the currentDataSourceof a component when asavedSearchIdis not provided. If this property is true, then when the DataSource is changed, existing saved searches will disappear and only be available if the DataSource is set back to its original value.If this property is false, saved searches will persist across DataSource changes so that searches that aren't applicable to the current DataSource might still be shown.
- Specified by:
getShowSavedSearchesByDSin interfaceDataBoundComponent- Returns:
- Current showSavedSearchesByDS value. Default value is true
-
findAll
Filters all objects according to the AdvancedCriteria passed- Parameters:
adCriteria- AdvancedCriteria to use to filter results- Returns:
- all matching Objects or null if none found
-
find
Filters all objects according to the AdvancedCriteria passed and returns the first matching object or null if not found- Parameters:
adCriteria- AdvancedCriteria to use to filter results- Returns:
- first matching object or null if not found
-
findIndex
Finds the index of the first Record that matches with the AdvacendCriteria passed.- Parameters:
adCriteria- AdvancedCriteria to use to filter results- Returns:
- index of the first matching Record or -1 if not found
-
findNextIndex
LikeRecordList.findIndex(java.util.Map), but considering the startIndex and endIndex parameters.- Parameters:
startIndex- first index to consideradCriteria- AdvancedCriteria to use to filter resultsendIndex- last index to consider- Returns:
- index of the first matching Record or -1 if not found
-
findNextIndex
LikeRecordList.findIndex(java.util.Map), but considering the startIndex parameter.- Parameters:
startIndex- first index to consideradCriteria- AdvancedCriteria to use to filter results- Returns:
- index of the first matching Record or -1 if not found
-
selectRecord
Description copied from interface:DataBoundComponentSelect/deselect aRecordpassed in explicitly, or by index.- Specified by:
selectRecordin interfaceDataBoundComponent- Parameters:
record- record (or row number) to select
-
selectRecord
public void selectRecord(int record) Description copied from interface:DataBoundComponentSelect/deselect aRecordpassed in explicitly, or by index.- Specified by:
selectRecordin interfaceDataBoundComponent- Parameters:
record- record (or row number) to select
-
selectRecord
public void selectRecord(int record, boolean newState) Description copied from interface:DataBoundComponentSelect/deselect aRecordpassed in explicitly, or by index.- Specified by:
selectRecordin interfaceDataBoundComponent- Parameters:
record- record (or row number) to selectnewState- new selection state (if null, defaults to true)
-
selectRecord
Description copied from interface:DataBoundComponentSelect/deselect aRecordpassed in explicitly, or by index.- Specified by:
selectRecordin interfaceDataBoundComponent- Parameters:
record- record (or row number) to selectnewState- new selection state (if null, defaults to true)
-
selectRecords
public void selectRecords(int[] records) Description copied from interface:DataBoundComponentSelect/deselect a list ofRecords passed in explicitly, or by index.- Specified by:
selectRecordsin interfaceDataBoundComponent- Parameters:
records- records (or row numbers) to select
-
selectRecords
public void selectRecords(int[] records, boolean newState) Description copied from interface:DataBoundComponentSelect/deselect a list ofRecords passed in explicitly, or by index.- Specified by:
selectRecordsin interfaceDataBoundComponent- Parameters:
records- records (or row numbers) to selectnewState- new selection state
-
selectRecords
Description copied from interface:DataBoundComponentSelect/deselect a list ofRecords passed in explicitly, or by index.- Specified by:
selectRecordsin interfaceDataBoundComponent- Parameters:
records- records (or row numbers) to select
-
selectRecords
Description copied from interface:DataBoundComponentSelect/deselect a list ofRecords passed in explicitly, or by index.- Specified by:
selectRecordsin interfaceDataBoundComponent- Parameters:
records- records (or row numbers) to selectnewState- new selection state (if null, defaults to true)
-
deselectRecord
Description copied from interface:DataBoundComponentDeselect aRecordpassed in explicitly, or by index.Synonym for
selectRecord(record, false)- Specified by:
deselectRecordin interfaceDataBoundComponent- Parameters:
record- record (or row number) to deselect
-
deselectRecord
public void deselectRecord(int record) Description copied from interface:DataBoundComponentDeselect aRecordpassed in explicitly, or by index.Synonym for
selectRecord(record, false)- Specified by:
deselectRecordin interfaceDataBoundComponent- Parameters:
record- record (or row number) to deselect
-
deselectRecords
public void deselectRecords(int[] records) Description copied from interface:DataBoundComponentDeselect a list ofRecords passed in explicitly, or by index.Synonym for
selectRecords(records, false)- Specified by:
deselectRecordsin interfaceDataBoundComponent- Parameters:
records- records (or row numbers) to deselect
-
deselectRecords
Description copied from interface:DataBoundComponentDeselect a list ofRecords passed in explicitly, or by index.Synonym for
selectRecords(records, false)- Specified by:
deselectRecordsin interfaceDataBoundComponent- Parameters:
records- records (or row numbers) to deselect
-
selectAllRecords
public void selectAllRecords()Description copied from interface:DataBoundComponentSelect all records

- Specified by:
selectAllRecordsin interfaceDataBoundComponent
-
deselectAllRecords
public void deselectAllRecords()Description copied from interface:DataBoundComponent
 Deselect all records

- Specified by:
deselectAllRecordsin interfaceDataBoundComponent
-
anySelected
Description copied from interface:DataBoundComponentWhether at least one item is selected
- Specified by:
anySelectedin interfaceDataBoundComponent- Returns:
- true == at least one item is selected false == nothing at all is selected
-
enableHilite
Description copied from interface:DataBoundComponentEnable / disable ahilites

- Specified by:
enableHilitein interfaceDataBoundComponent- Parameters:
hiliteID- ID of hilite to enable
-
enableHilite
Description copied from interface:DataBoundComponentEnable / disable ahilites

- Specified by:
enableHilitein interfaceDataBoundComponent- Parameters:
hiliteID- ID of hilite to enableenable- new enabled state to apply - if null, defaults to true
-
disableHilite
Description copied from interface:DataBoundComponentDisable a hilite

- Specified by:
disableHilitein interfaceDataBoundComponent- Parameters:
hiliteID- ID of hilite to disable
-
enableHiliting
public void enableHiliting()Description copied from interface:DataBoundComponentEnable all hilites.

- Specified by:
enableHilitingin interfaceDataBoundComponent
-
enableHiliting
public void enableHiliting(boolean enable) Description copied from interface:DataBoundComponentEnable all hilites.

- Specified by:
enableHilitingin interfaceDataBoundComponent- Parameters:
enable- new enabled state to apply - if null, defaults to true
-
disableHiliting
public void disableHiliting()Description copied from interface:DataBoundComponentDisable all hilites.

- Specified by:
disableHilitingin interfaceDataBoundComponent
-
getDragData
Description copied from interface:DataBoundComponentDuring a drag-and-drop interaction, this method returns the set of records being dragged out of the component. In the default implementation, this is the list of currently selected records.This method is consulted by

ListGrid.willAcceptDrop().- Specified by:
getDragDatain interfaceDataBoundComponent- Returns:
- Array of
Records that are currently selected.
-
transferSelectedData
Description copied from interface:DataBoundComponentSimulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction. This method acts on the dropped records exactly as if they had been dropped in an actual drag / drop interaction, including any special databound behavior invoked by callingDataBoundComponent.getDropValues()for each dropped record.To transfer all data in, for example, a
ListGrid, call grid.selection.selectAll() first.Note that drag/drop type transfers of records between components are asynchronous operations: Smart GWT may need to perform server turnarounds to establish whether dropped records already exist in the target component. Therefore, it is possible to issue a call to
transferSelectedData()and/or thedrop()method of a databound component whilst a transfer is still active. When this happens, Smart GWT adds the second and subsequent transfer requests to a queue and runs them one after the other. If you want to be notified when a transfer process has actually completed, useHasDropCompleteHandlers.addDropCompleteHandler(com.smartgwt.client.widgets.events.DropCompleteHandler). See theDraggingdocumentation for an overview of list grid drag/drop data transfer.- Specified by:
transferSelectedDatain interfaceDataBoundComponent- Parameters:
source- source component from which the records will be tranferred
-
transferSelectedData
Description copied from interface:DataBoundComponentSimulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction. This method acts on the dropped records exactly as if they had been dropped in an actual drag / drop interaction, including any special databound behavior invoked by callingDataBoundComponent.getDropValues()for each dropped record.To transfer all data in, for example, a
ListGrid, call grid.selection.selectAll() first.Note that drag/drop type transfers of records between components are asynchronous operations: Smart GWT may need to perform server turnarounds to establish whether dropped records already exist in the target component. Therefore, it is possible to issue a call to
transferSelectedData()and/or thedrop()method of a databound component whilst a transfer is still active. When this happens, Smart GWT adds the second and subsequent transfer requests to a queue and runs them one after the other. If you want to be notified when a transfer process has actually completed, useHasDropCompleteHandlers.addDropCompleteHandler(com.smartgwt.client.widgets.events.DropCompleteHandler). See theDraggingdocumentation for an overview of list grid drag/drop data transfer.- Specified by:
transferSelectedDatain interfaceDataBoundComponent- Parameters:
source- source component from which the records will be transferredindex- target index (drop position) of the rows within this grid.
-
getRecordIndex
Description copied from interface:DataBoundComponentGet the index of the provided record.

 Override in subclasses to provide more specific behaviour, for instance, when data holds a
 large number of records


- Specified by:
getRecordIndexin interfaceDataBoundComponent- Parameters:
record- the record whose index is to be retrieved- Returns:
- indexindex of the record, or -1 if not found
-
getTitleFieldValue
Description copied from interface:DataBoundComponentGet the value of the titleField for the passed record

 Override in subclasses 


- Specified by:
getTitleFieldValuein interfaceDataBoundComponent- Parameters:
record- the record whose index is to be retrieved- Returns:
- valuethe value of the titleField for the passed record
-
setTitleField
Description copied from interface:DataBoundComponentSets the best field to use for a user-visible title for an individual record from this component.- Specified by:
setTitleFieldin interfaceDataBoundComponent- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getTitleField
Description copied from interface:DataBoundComponentMethod 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 checktitleFieldfor databound
 components.

 For non databound components returns the first defined field name of"title", 
"name", or"id". If we dont find any field-names that match these
 titles, the first field in the component will be used instead.
- Specified by:
getTitleFieldin interfaceDataBoundComponent- Returns:
- fieldName the title field for this component.
-
getDataSource
Description copied from interface:DataBoundComponentThe DataSource that this component should bind to for default fields and for performingDataSource requests.- Specified by:
getDataSourcein interfaceDataBoundComponent- Returns:
- DataSource
-
setAutoFetchData
Description copied from interface:DataBoundComponentIf true, when this component is first drawn, automatically callDataBoundComponent.fetchData()orDataBoundComponent.filterData()depending onDataBoundComponent.getAutoFetchAsFilter(). Criteria for this fetch may be picked up frominitialCriteriaand textMatchStyle may be specified viaDataBoundComponent.getAutoFetchTextMatchStyle().NOTE: If autoFetchData is set, calling ListGrid.fetchData() before draw will cause two requests to be issued, one from the manual call to fetchData() and one from the autoFetchData setting. The second request will use only
initialCriteriaand not any other criteria or settings from the first request. Generally, turn off autoFetchData if you are going to manually call fetchData() at any time.- Specified by:
setAutoFetchDatain interfaceDataBoundComponent- Parameters:
autoFetchData- autoFetchData- Returns:
DataBoundComponentinstance, for chaining setter calls- Throws:
IllegalStateException
-
getAutoFetchData
Description copied from interface:DataBoundComponentIf true, when this component is first drawn, automatically callDataBoundComponent.fetchData()orDataBoundComponent.filterData()depending onDataBoundComponent.getAutoFetchAsFilter(). Criteria for this fetch may be picked up frominitialCriteriaand textMatchStyle may be specified viaDataBoundComponent.getAutoFetchTextMatchStyle().NOTE: If autoFetchData is set, calling ListGrid.fetchData() before draw will cause two requests to be issued, one from the manual call to fetchData() and one from the autoFetchData setting. The second request will use only
initialCriteriaand not any other criteria or settings from the first request. Generally, turn off autoFetchData if you are going to manually call fetchData() at any time.- Specified by:
getAutoFetchDatain interfaceDataBoundComponent- Returns:
- autoFetchData autoFetchData
-
setAutoFetchTextMatchStyle
public FacetChart setAutoFetchTextMatchStyle(TextMatchStyle autoFetchTextMatchStyle) throws IllegalStateException Description copied from interface:DataBoundComponentIfautoFetchDataistrue, this attribute allows the developer to specify a textMatchStyle for the initialDataBoundComponent.fetchData()call.- Specified by:
setAutoFetchTextMatchStylein interfaceDataBoundComponent- Returns:
DataBoundComponentinstance, for chaining setter calls- Throws:
IllegalStateException
-
getAutoFetchTextMatchStyle
Description copied from interface:DataBoundComponentIfautoFetchDataistrue, this attribute allows the developer to specify a textMatchStyle for the initialDataBoundComponent.fetchData()call.- Specified by:
getAutoFetchTextMatchStylein interfaceDataBoundComponent- Returns:
- autoFetchTextMatchStyle autoFetchTextMatchStyle
-
setAutoFetchAsFilter
Description copied from interface:DataBoundComponentIfDataBoundComponent.setAutoFetchData(Boolean)is true, this attribute determines whether the initial fetch operation should be performed viaDataBoundComponent.fetchData()orDataBoundComponent.filterData()- Specified by:
setAutoFetchAsFilterin interfaceDataBoundComponent- Parameters:
autoFetchAsFilter- autoFetchAsFilter- Returns:
DataBoundComponentinstance, for chaining setter calls- Throws:
IllegalStateException
-
getAutoFetchAsFilter
Description copied from interface:DataBoundComponentIfDataBoundComponent.setAutoFetchData(Boolean)is true, this attribute determines whether the initial fetch operation should be performed viaDataBoundComponent.fetchData()orDataBoundComponent.filterData()- Specified by:
getAutoFetchAsFilterin interfaceDataBoundComponent- Returns:
- auto fetch as filter
-
setInitialCriteria
Description copied from interface:DataBoundComponentCriteria to use whenDataBoundComponent.setAutoFetchData(Boolean)is used.- Specified by:
setInitialCriteriain interfaceDataBoundComponent- Parameters:
initialCriteria- the initial criteria- Returns:
DataBoundComponentinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getInitialCriteria
Description copied from interface:DataBoundComponentCriteria to use whenDataBoundComponent.setAutoFetchData(Boolean)is used.- Specified by:
getInitialCriteriain interfaceDataBoundComponent- Returns:
- the criteria
-
setImplicitCriteria
Description copied from interface:DataBoundComponentCriteria that are never shown to or edited by the user and are cumulative with any criteria provided viaDataBoundComponent.initialCriteria,DataBoundComponent.setCriteria()etc.- Specified by:
setImplicitCriteriain interfaceDataBoundComponent- Parameters:
implicitCriteria- New implicitCriteria value. Default value is null- Returns:
DataBoundComponentinstance, for chaining setter calls
-
setImplicitCriteria
-
setImplicitCriteria
-
getImplicitCriteria
Description copied from interface:DataBoundComponentCriteria that are never shown to or edited by the user and are cumulative with any criteria provided viaDataBoundComponent.initialCriteria,DataBoundComponent.setCriteria()etc.- Specified by:
getImplicitCriteriain interfaceDataBoundComponent- Returns:
- Current implicitCriteria value. Default value is null
-
fetchData
public void fetchData()Description copied from interface:DataBoundComponentRetrieves data from the DataSource that matches the specified criteria.When
fetchData()is first called, if data has not already been provided viasetData(), this method will create aResultSet, which will be configured based on component settings such asfetchOperationanddataPageSize, as well as the general purposedataProperties. The created ResultSet will automatically send a DSRequest to retrieve data from the dataSource, and from then on will automatically manage paging through large datasets, as well as performing filtering and sorting operations inside the browser when possible - see the ResultSet docs for details.NOTE: do not use both
autoFetchDataand a call tofetchData()- this may result in two DSRequests to fetch data. Use eitherautoFetchDataandsetAutoFetchCriteria()or a manual call to fetchData() passing criteria.Whether a ResultSet was automatically created or provided via
setData(), subsequent calls to fetchData() will simply callresultSet.setCriteria().Changes to criteria may or may not result in a DSRequest to the server due to client-side filtering. You can call
willFetchData(criteria)to determine if new criteria will result in a server fetch.If you need to force data to be re-fetched, you can call
invalidateCache()and new data will automatically be fetched from the server using the current criteria and sort direction. NOTE: when usinginvalidateCache()there is no need to also callfetchData()and in fact this could produce unexpected results.This method takes an optional callback parameter (set to a
DSCallback) to fire when the fetch completes. Note that this callback will not fire if no server fetch is performed. In this case the data is updated synchronously, so as soon as this method completes you can interact with the new data. If necessary, you can useresultSet.willFetchData()to determine whether or not a server fetch will occur whenfetchData()is called with new criteria.In addition to the callback parameter for this method, developers can use
resultSet.addDataArrivedHandlerto be notified every time data is loaded.- Specified by:
fetchDatain interfaceDataBoundComponent
-
fetchData
Description copied from interface:DataBoundComponentRetrieves data from the DataSource that matches the specified criteria.When
fetchData()is first called, if data has not already been provided viasetData(), this method will create aResultSet, which will be configured based on component settings such asfetchOperationanddataPageSize, as well as the general purposedataProperties. The created ResultSet will automatically send a DSRequest to retrieve data from the dataSource, and from then on will automatically manage paging through large datasets, as well as performing filtering and sorting operations inside the browser when possible - see the ResultSet docs for details.NOTE: do not use both
autoFetchDataand a call tofetchData()- this may result in two DSRequests to fetch data. Use eitherautoFetchDataandsetAutoFetchCriteria()or a manual call to fetchData() passing criteria.Whether a ResultSet was automatically created or provided via
setData(), subsequent calls to fetchData() will simply callresultSet.setCriteria().Changes to criteria may or may not result in a DSRequest to the server due to client-side filtering. You can call
willFetchData(criteria)to determine if new criteria will result in a server fetch.If you need to force data to be re-fetched, you can call
invalidateCache()and new data will automatically be fetched from the server using the current criteria and sort direction. NOTE: when usinginvalidateCache()there is no need to also callfetchData()and in fact this could produce unexpected results.This method takes an optional callback parameter (set to a
DSCallback) to fire when the fetch completes. Note that this callback will not fire if no server fetch is performed. In this case the data is updated synchronously, so as soon as this method completes you can interact with the new data. If necessary, you can useresultSet.willFetchData()to determine whether or not a server fetch will occur whenfetchData()is called with new criteria.In addition to the callback parameter for this method, developers can use
resultSet.addDataArrivedHandlerto be notified every time data is loaded.- Specified by:
fetchDatain interfaceDataBoundComponent- Parameters:
criteria- Search criteria. If aDynamicFormis passed in as this argument instead of a raw criteria object, will be derived by callingDynamicForm.getValuesAsCriteria()
-
fetchData
Description copied from interface:DataBoundComponentRetrieves data from the DataSource that matches the specified criteria.When
fetchData()is first called, if data has not already been provided viasetData(), this method will create aResultSet, which will be configured based on component settings such asfetchOperationanddataPageSize, as well as the general purposedataProperties. The created ResultSet will automatically send a DSRequest to retrieve data from the dataSource, and from then on will automatically manage paging through large datasets, as well as performing filtering and sorting operations inside the browser when possible - see the ResultSet docs for details.NOTE: do not use both
autoFetchDataand a call tofetchData()- this may result in two DSRequests to fetch data. Use eitherautoFetchDataandsetAutoFetchCriteria()or a manual call to fetchData() passing criteria.Whether a ResultSet was automatically created or provided via
setData(), subsequent calls to fetchData() will simply callresultSet.setCriteria().Changes to criteria may or may not result in a DSRequest to the server due to client-side filtering. You can call
willFetchData(criteria)to determine if new criteria will result in a server fetch.If you need to force data to be re-fetched, you can call
invalidateCache()and new data will automatically be fetched from the server using the current criteria and sort direction. NOTE: when usinginvalidateCache()there is no need to also callfetchData()and in fact this could produce unexpected results.This method takes an optional callback parameter (set to a
DSCallback) to fire when the fetch completes. Note that this callback will not fire if no server fetch is performed. In this case the data is updated synchronously, so as soon as this method completes you can interact with the new data. If necessary, you can useresultSet.willFetchData()to determine whether or not a server fetch will occur whenfetchData()is called with new criteria.In addition to the callback parameter for this method, developers can use
resultSet.addDataArrivedHandlerto be notified every time data is loaded.- Specified by:
fetchDatain interfaceDataBoundComponent- Parameters:
criteria- Search criteria. If aDynamicFormis passed in as this argument instead of a raw criteria object, will be derived by callingDynamicForm.getValuesAsCriteria()callback- callback to invoke when a fetch is complete. Fires only if server contact was required
-
fetchData
Description copied from interface:DataBoundComponentRetrieves data from the DataSource that matches the specified criteria.When
fetchData()is first called, if data has not already been provided viasetData(), this method will create aResultSet, which will be configured based on component settings such asfetchOperationanddataPageSize, as well as the general purposedataProperties. The created ResultSet will automatically send a DSRequest to retrieve data from the dataSource, and from then on will automatically manage paging through large datasets, as well as performing filtering and sorting operations inside the browser when possible - see the ResultSet docs for details.NOTE: do not use both
autoFetchDataand a call tofetchData()- this may result in two DSRequests to fetch data. Use eitherautoFetchDataandsetAutoFetchCriteria()or a manual call to fetchData() passing criteria.Whether a ResultSet was automatically created or provided via
setData(), subsequent calls to fetchData() will simply callresultSet.setCriteria().Changes to criteria may or may not result in a DSRequest to the server due to client-side filtering. You can call
willFetchData(criteria)to determine if new criteria will result in a server fetch.If you need to force data to be re-fetched, you can call
invalidateCache()and new data will automatically be fetched from the server using the current criteria and sort direction. NOTE: when usinginvalidateCache()there is no need to also callfetchData()and in fact this could produce unexpected results.This method takes an optional callback parameter (set to a
DSCallback) to fire when the fetch completes. Note that this callback will not fire if no server fetch is performed. In this case the data is updated synchronously, so as soon as this method completes you can interact with the new data. If necessary, you can useresultSet.willFetchData()to determine whether or not a server fetch will occur whenfetchData()is called with new criteria.In addition to the callback parameter for this method, developers can use
resultSet.addDataArrivedHandlerto be notified every time data is loaded.- Specified by:
fetchDatain interfaceDataBoundComponent- Parameters:
criteria- Search criteria. If aDynamicFormis passed in as this argument instead of a raw criteria object, will be derived by callingDynamicForm.getValuesAsCriteria()callback- callback to invoke when a fetch is complete. Fires only if server contact was requiredrequestProperties- additional properties to set on the DSRequest that will be issued
-
filterData
public void filterData()Description copied from interface:DataBoundComponentRetrieves data that matches the provided criteria and displays the matching data in this component.This method behaves exactly like
ListGrid.fetchData()except thattextMatchStyleis automatically set to "substring" so that String-valued fields are matched by case-insensitive substring comparison.- Specified by:
filterDatain interfaceDataBoundComponent
-
filterData
Description copied from interface:DataBoundComponentRetrieves data that matches the provided criteria and displays the matching data in this component.This method behaves exactly like
ListGrid.fetchData()except thattextMatchStyleis automatically set to "substring" so that String-valued fields are matched by case-insensitive substring comparison.- Specified by:
filterDatain interfaceDataBoundComponent- Parameters:
criteria- Search criteria. If aDynamicFormis passed in as this argument instead of a raw criteria object, will be derived by callingDynamicForm.getValuesAsCriteria()
-
filterData
Description copied from interface:DataBoundComponentRetrieves data that matches the provided criteria and displays the matching data in this component.This method behaves exactly like
ListGrid.fetchData()except thattextMatchStyleis automatically set to "substring" so that String-valued fields are matched by case-insensitive substring comparison.- Specified by:
filterDatain interfaceDataBoundComponent- Parameters:
criteria- Search criteria. If aDynamicFormis passed in as this argument instead of a raw criteria object, will be derived by callingDynamicForm.getValuesAsCriteria()callback- callback to invoke when a fetch is complete. Fires only if server contact was required; seeDataBoundComponent.fetchData()for details
-
filterData
Description copied from interface:DataBoundComponentRetrieves data that matches the provided criteria and displays the matching data in this component.This method behaves exactly like
ListGrid.fetchData()except thattextMatchStyleis automatically set to "substring" so that String-valued fields are matched by case-insensitive substring comparison.- Specified by:
filterDatain interfaceDataBoundComponent- Parameters:
criteria- Search criteria. If aDynamicFormis passed in as this argument instead of a raw criteria object, will be derived by callingDynamicForm.getValuesAsCriteria()callback- callback to invoke when a fetch is complete. Fires only if server contact was required; seeDataBoundComponent.fetchData()for detailsrequestProperties- for databound components only - optional additional properties to set on the DSRequest that will be issued
-
invalidateCache
public void invalidateCache()Description copied from interface:DataBoundComponentInvalidate the current data cache for this databound component via a call to the dataset'sinvalidateCache()method, for example,ResultSet.invalidateCache().NOTE: there is no need to call
invalidateCache()when a save operation is performed on a DataSource. Automatic cache synchronization features will automatically update caches - seeResultSetfor details. If automatic cache synchronization isn't working, troubleshoot the problem using the steps suggested in the FAQ rather than just calling invalidateCache(). CallinginvalidateCache()unnecessarily causes extra server load and added code complexity.Calling
invalidateCache()will automatically cause a new fetch to be performed with the current set of criteria if data had been previously fetched and the component is currently drawn with data visible - there is no need to manually call fetchData() after invalidateCache() and this could result in duplicate fetches.While data is being re-loaded after a call to
invalidateCache(), the widget is in a state similar to initial data load - it doesn't know the total length of the dataset and any APIs that act on records or row indices will necessarily fail and should not be called. To detect that the widget is in this state, callResultSet.lengthIsKnown().invalidateCache()only has an effect if this component's dataset is a data manager class that manages a cache (eg ResultSet or ResultTree). If data was provided as a simple Array or List, invalidateCache() does nothing.- Specified by:
invalidateCachein interfaceDataBoundComponent- See Also:
-
getResultSet
Description copied from interface:DataBoundComponentReturn the underlying data of this DataBoundComponent as aResultSet.Note that this method should only be called after initial data has been fetched by this DataBoundComponent.
- Specified by:
getResultSetin interfaceDataBoundComponent- Returns:
- ResultSet, or null if the underlying data is not a ResultSet
- See Also:
-
getRecordList
Description copied from interface:DataBoundComponentReturn the underlying data of this DataBoundComponent as aRecordList.Depending on the component configuration, the actual JavaScript instance of the returned RecordList may be one of several types:
- If the component is not bound to a
DataSource, the instance is generally an Array ofRecord. - If the component is bound to a DataSource, the instance is a
ResultSet. - If the component is a grouped ListGrid, the instance is a
Tree. To access the ungrouped record list regardless of grouping status, useisGrouped() ? getOriginalRecordList() : getRecordList()
- If the component is a
TreeGrid, the instance is a ResultTree.
- Specified by:
getRecordListin interfaceDataBoundComponent- Returns:
- the RecordList
- If the component is not bound to a
-
getDataAsJSList
- Specified by:
getDataAsJSListin interfaceDataBoundComponent
-
exportData
public void exportData()Description copied from interface:DataBoundComponent- Specified by:
exportDatain interfaceDataBoundComponent
-
exportData
Description copied from interface:DataBoundComponent- Specified by:
exportDatain interfaceDataBoundComponent
-
exportData
Description copied from interface:DataBoundComponentUses a "fetch" operation on the currentDataSourceto 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.A variety of DSRequest settings, such as
exportAsandexportFilename, affect the exporting process: seeexportResultsfor further detail.Note that data exported via this method does not include any client-side formatting and relies on both the Smart GWT server and server-side DataSources. To export client-data with formatters applied, see
exportClientData, which still requires the Smart GWT server but does not rely on server-side DataSources.For more information on exporting data, see
DataSource.exportData.- Specified by:
exportDatain interfaceDataBoundComponent- Parameters:
requestProperties- additional properties to set on DSRequest that will be issuedcallback- Optional callback. Note that this parameter only applies if you specifyexportToClient: false in the request properties, because file downloads don't provide ordinary framework callbacks- See Also:
-
addFetchDataHandler
Add a fetchData handler.Notification function fired on fetchData() or filterData()
- Specified by:
addFetchDataHandlerin interfaceHasFetchDataHandlers- Parameters:
handler- the filterData handler- Returns:
HandlerRegistrationused to remove this handler
-
addDropCompleteHandler
Add acom.smartgwt.client.widgets.DropCompleteHandler. See that class's documentation for a definition of "drop complete", and how it differs from "drag complete" (com.smartgwt.client.widgets.DragCompleteHandler).- Specified by:
addDropCompleteHandlerin interfaceHasDropCompleteHandlers- Parameters:
handler- the DropCompleteHandler- Returns:
HandlerRegistrationused to remove this handler
-
addDragCompleteHandler
Add acom.smartgwt.client.widgets.DragCompleteHandler. See that class's documentation for a definition of "drag complete", and how it differs from "drop complete" (com.smartgwt.client.widgets.DropCompleteHandler).- Specified by:
addDragCompleteHandlerin interfaceHasDragCompleteHandlers- Parameters:
handler- the DropCompleteHandler- Returns:
HandlerRegistrationused to remove this handler
-
getFieldAlignments
Description copied from interface:DataBoundComponentReturna an array of field alignments for this grid- Specified by:
getFieldAlignmentsin interfaceDataBoundComponent- Returns:
- array of Alignments
-
getDeepCloneOnEdit
Description copied from interface:DataBoundComponentBefore we start editing values in this DataBoundComponent, should we perform a deep clone of the underlying values. SeeDataSource.getDeepCloneOnEdit()for details of what this means.If this value is not explicitly set, it defaults to the DataSource
deepCloneOnEditvalue. This value can also be overridden per-field withDataSourceField.setDeepCloneOnEdit(java.lang.Boolean).Like the other
deepCloneOnEditsettings, this flag only has an effect if you are editing a values object that contains nested objects or arrays, usingCanvas.setDataPath(java.lang.String)- Specified by:
getDeepCloneOnEditin interfaceDataBoundComponent
-
setDeepCloneOnEdit
Description copied from interface:DataBoundComponentBefore we start editing values in this DataBoundComponent, should we perform a deep clone of the underlying values. SeeDataSource.getDeepCloneOnEdit()for details of what this means.If this value is not explicitly set, it defaults to the DataSource
deepCloneOnEditvalue. This value can also be overridden per-field withDataSourceField.setDeepCloneOnEdit(java.lang.Boolean).Like the other
deepCloneOnEditsettings, this flag only has an effect if you are editing a values object that contains nested objects or arrays, usingCanvas.setDataPath(java.lang.String)- Specified by:
setDeepCloneOnEditin interfaceDataBoundComponent- Returns:
DataBoundComponentinstance, for chaining setter calls
-
setFields
Description copied from interface:DataBoundComponentField 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.FormItem,ListGridField, etc.) This is an advanced method and only for cases where you have the JavaScriptObject for each field but want to avoid having to create each associated SmartGWT Java wrapper.Note: use
toArray()to create a Java array of JavaScriptObject if you only have the array itself as a single JavaScriptObject.- Specified by:
setFieldsin interfaceDataBoundComponent- Parameters:
fields- the component fields- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getFieldsAsJavaScriptObjects
Description copied from interface:DataBoundComponentReturn the fields as JavaScriptObjects rather than as SmartGWT Java wrappers of the field class type (e.g.FormItem,ListGridField, etc.) This avoids building the SmartGWT Java wrappers for the fields in situations where they aren't needed - and for FormItems in particular - where there may not be enough information to determine the correct subclass, such as before the SmartClient instance underlying theDynamicFormhas been created.- Specified by:
getFieldsAsJavaScriptObjectsin interfaceDataBoundComponent- Returns:
- the component fields
-
getFieldCount
public int getFieldCount()Description copied from interface:DataBoundComponentReturn the number of fields.- Specified by:
getFieldCountin interfaceDataBoundComponent- Returns:
- the number of fields
-
transferRecords
public void transferRecords(Record[] records, Record targetRecord, Integer index, Canvas sourceWidget, TransferRecordsCallback callback) Description copied from interface:DataBoundComponentTransfer a list ofRecords from another component (does not have to be a databound component) into this component. This method is only applicable to list-type components, such asListGridorcom.smartgwt.client.widgets.tile.TileGridTileGrid. Notably, it does not apply toTreeGrid; the equivalent for treeGrids istransferNodes.This method implements the automatic drag-copy and drag-move behaviors of components like
ListGrid, and calling it is equivalent to completing a drag and drop of thedropRecords(the default record drop behavior is simply to calltransferRecords(), passing in the dropped nodes)Note that this method is asynchronous - it may need to perform server turnarounds to prevent duplicates in the target component's data. If you wish to be notified when the transfer process has completed, you can either pass a non-null callback to this method or add a
DropCompleteHandlerto this component.See also
transferSelectedData()- Specified by:
transferRecordsin interfaceDataBoundComponent- Parameters:
records- Recordss to transfer to this componenttargetRecord- The target record (eg, of a drop interaction), for contextindex- Insert point relative to the target record for the transferred recordssourceWidget- The databound or non-databound component from which the records are to be transferred.callback- optional TransferRecordsCallback to be fired when the transfer process has completed (pass null if your code does not need to be called back). The callback will be passed the list of records actually transferred to this component
-
setDragDataCustomizer
During a drag-and-drop interaction, this method returns the set of records being dragged out of the component. In the default implementation, this is the list of currently selected records.This method is consulted by
willAcceptDrop().- Parameters:
DragDataCustomizer- customizer- Returns:
DataBoundComponentinstance, for chaining setter calls
-
getSort
Description copied from interface:DataBoundComponentReturns the currentSortSpecifiersfor this component. Will return null if this component has never been sorted, or the underlying SmartClient widget does not exist.- Specified by:
getSortin interfaceDataBoundComponent- Returns:
- current sort specifiers for this component (null if unsorted or no SC widget)
-
setSort
Description copied from interface:DataBoundComponentSort the component on one or more fields.Pass in an array of
SortSpecifiers to have the component's data sorted by the fields in eachspecifier.propertyand in the directions specified. The component can be sorted by any combination of fields, including fields specified in the fields array andunused fields from the underlying dataSource, if there is one.If setSort() is called on a component which doesn't yet have a SmartClient widget, the widget will be created. If
autoFetchDatais set and aDataSourcehas been set, this will result in data being fetched.- Specified by:
setSortin interfaceDataBoundComponent- Parameters:
sortSpecifiers- Array ofSortSpecifierobjects
-
setLogicalStructure
Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility. -
getLogicalStructure
Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.- Specified by:
getLogicalStructurein interfaceLogicalStructure- Overrides:
getLogicalStructurein classDrawPane
-
rotateLabels.