Package com.smartgwt.client.widgets.chart

Class ChartExportSettings

java.lang.Object
com.smartgwt.client.core.JsObject
com.smartgwt.client.core.DataClass
com.smartgwt.client.widgets.chart.ChartExportSettings
All Implemented Interfaces:
HasHandlers
public class ChartExportSettings extends DataClass
Per-chart configuration for the table a FacetChart contributes to Canvas.exportDescendantData(), set as FacetChart.chartExportSettings.

A chart exports the table that matches its reader's takeaway — its export shape: a ranked share-of-whole table for magnitude charts, a chronological table with change-over-period columns for time series, raw point tuples for scatter plots, and a category × series matrix for two-facet charts. By default the shape and every column toggle are inferred from the chart itself (chart type, facet field types, and what the measure's aggregation makes valid); each property here overrides one aspect of that inference. Toggles left null are decided by the resolved shape, so {shape: "trend"} is a complete override.

Settings choose among valid tables only: a toggle the measure's aggregation makes invalid (a summed Total over averages, a running total of minimums) is ignored with a warning.

See Also:

  • Constructor Details

    • ChartExportSettings

      public ChartExportSettings()

    • ChartExportSettings

      public ChartExportSettings(JavaScriptObject jsObj)

  • Method Details

    • getOrCreateRef

      public static ChartExportSettings getOrCreateRef(JavaScriptObject jsObj)

    • setIncludeCodes

      public ChartExportSettings setIncludeCodes(Boolean includeCodes)
      Comparison only: the raw Code column retained beside resolved labels (for joins and pivots against the source data). Only emitted when labels actually differ from the stored values.
      Parameters:
      includeCodes - New includeCodes value. Default value is null
      Returns:
      ChartExportSettings instance, for chaining setter calls
      See Also:

    • getIncludeCodes

      public Boolean getIncludeCodes()
      Comparison only: the raw Code column retained beside resolved labels (for joins and pivots against the source data). Only emitted when labels actually differ from the stored values.
      Returns:
      Current includeCodes value. Default value is null
      See Also:

    • setIncludeCumulative

      public ChartExportSettings setIncludeCumulative(Boolean includeCumulative)
      Distribution only: the Cumulative % column.
      Parameters:
      includeCumulative - New includeCumulative value. Default value is null
      Returns:
      ChartExportSettings instance, for chaining setter calls
      See Also:

    • getIncludeCumulative

      public Boolean getIncludeCumulative()
      Distribution only: the Cumulative % column.
      Returns:
      Current includeCumulative value. Default value is null
      See Also:

    • setIncludeDelta

      public ChartExportSettings setIncludeDelta(Boolean includeDelta)
      Trend only: the change-vs-prior-period columns (absolute and percent).
      Parameters:
      includeDelta - New includeDelta value. Default value is null
      Returns:
      ChartExportSettings instance, for chaining setter calls
      See Also:

    • getIncludeDelta

      public Boolean getIncludeDelta()
      Trend only: the change-vs-prior-period columns (absolute and percent).
      Returns:
      Current includeDelta value. Default value is null
      See Also:

    • setIncludeIdentity

      public ChartExportSettings setIncludeIdentity(Boolean includeIdentity)
      Correlation only: a leading identity column naming each point's record (from the DataSource's title field), so outlying points can be identified.
      Parameters:
      includeIdentity - New includeIdentity value. Default value is null
      Returns:
      ChartExportSettings instance, for chaining setter calls
      See Also:

    • getIncludeIdentity

      public Boolean getIncludeIdentity()
      Correlation only: a leading identity column naming each point's record (from the DataSource's title field), so outlying points can be identified.
      Returns:
      Current includeIdentity value. Default value is null
      See Also:

    • setIncludePercentages

      public ChartExportSettings setIncludePercentages(Boolean includePercentages)
      Percentage columns: "% of Total" for a comparison or distribution, the percentage block (each cell's percent of its row's Total) for a stacked matrix.
      Parameters:
      includePercentages - New includePercentages value. Default value is null
      Returns:
      ChartExportSettings instance, for chaining setter calls
      See Also:

    • getIncludePercentages

      public Boolean getIncludePercentages()
      Percentage columns: "% of Total" for a comparison or distribution, the percentage block (each cell's percent of its row's Total) for a stacked matrix.
      Returns:
      Current includePercentages value. Default value is null
      See Also:

    • setIncludeRank

      public ChartExportSettings setIncludeRank(Boolean includeRank)
      Comparison only: the Rank column.
      Parameters:
      includeRank - New includeRank value. Default value is null
      Returns:
      ChartExportSettings instance, for chaining setter calls
      See Also:

    • getIncludeRank

      public Boolean getIncludeRank()
      Comparison only: the Rank column.
      Returns:
      Current includeRank value. Default value is null
      See Also:

    • setIncludeRunningTotal

      public ChartExportSettings setIncludeRunningTotal(Boolean includeRunningTotal)
      Trend only: the Running Total column. Valid only for summed or counted measures.
      Parameters:
      includeRunningTotal - New includeRunningTotal value. Default value is null
      Returns:
      ChartExportSettings instance, for chaining setter calls
      See Also:

    • getIncludeRunningTotal

      public Boolean getIncludeRunningTotal()
      Trend only: the Running Total column. Valid only for summed or counted measures.
      Returns:
      Current includeRunningTotal value. Default value is null
      See Also:

    • setIncludeSummaryRow

      public ChartExportSettings setIncludeSummaryRow(Boolean includeSummaryRow)
      The bottom summary row. What it shows follows the measure's aggregation: a Total for summed or counted measures, an Average for averaged ones; for minimums and maximums no summary row is valid and this setting is ignored.
      Parameters:
      includeSummaryRow - New includeSummaryRow value. Default value is null
      Returns:
      ChartExportSettings instance, for chaining setter calls
      See Also:

    • getIncludeSummaryRow

      public Boolean getIncludeSummaryRow()
      The bottom summary row. What it shows follows the measure's aggregation: a Total for summed or counted measures, an Average for averaged ones; for minimums and maximums no summary row is valid and this setting is ignored.
      Returns:
      Current includeSummaryRow value. Default value is null
      See Also:

    • setIncludeTotalColumn

      public ChartExportSettings setIncludeTotalColumn(Boolean includeTotalColumn)
      Matrix only: the per-row Total column — the denominator of the matrix's percentage block.
      Parameters:
      includeTotalColumn - New includeTotalColumn value. Default value is null
      Returns:
      ChartExportSettings instance, for chaining setter calls
      See Also:

    • getIncludeTotalColumn

      public Boolean getIncludeTotalColumn()
      Matrix only: the per-row Total column — the denominator of the matrix's percentage block.
      Returns:
      Current includeTotalColumn value. Default value is null
      See Also:

    • setMovingAverage

      public ChartExportSettings setMovingAverage(Integer movingAverage)
      Trend only: when set, adds a moving-average column computed over this many periods.
      Parameters:
      movingAverage - New movingAverage value. Default value is null
      Returns:
      ChartExportSettings instance, for chaining setter calls
      See Also:

    • getMovingAverage

      public Integer getMovingAverage()
      Trend only: when set, adds a moving-average column computed over this many periods.
      Returns:
      Current movingAverage value. Default value is null
      See Also:

    • setShape

      public ChartExportSettings setShape(ChartExportShape shape)
      The export shape. When "auto", the shape is inferred from the chart -- see ChartExportShape for the shapes and ChartExportSettings for how the inference works.
      Parameters:
      shape - New shape value. Default value is "auto"
      Returns:
      ChartExportSettings instance, for chaining setter calls
      See Also:

    • getShape

      public ChartExportShape getShape()
      The export shape. When "auto", the shape is inferred from the chart -- see ChartExportShape for the shapes and ChartExportSettings for how the inference works.
      Returns:
      Current shape value. Default value is "auto"
      See Also:

    • setSort

      public ChartExportSettings setSort(ChartExportSortMode sort)
      Row order, overriding the resolved shape's natural order.
      Parameters:
      sort - New sort value. Default value is "auto"
      Returns:
      ChartExportSettings instance, for chaining setter calls
      See Also:

    • getSort

      public ChartExportSortMode getSort()
      Row order, overriding the resolved shape's natural order.
      Returns:
      Current sort value. Default value is "auto"
      See Also: