Package com.smartgwt.client.types

Enum ChartExportShape

java.lang.Object
java.lang.Enum<ChartExportShape>
com.smartgwt.client.types.ChartExportShape
All Implemented Interfaces:
ValueEnum, Serializable, Comparable<ChartExportShape>, Constable
public enum ChartExportShape extends Enum<ChartExportShape> implements ValueEnum
The table a chart contributes to Canvas.exportDescendantData() -- see ChartExportSettings for how the shape is chosen and controlled.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    AUTO
    Infer the shape from the chart: its type, its facets' field types, and what its measure's aggregation makes valid.
    COMPARISON
    Ranked share-of-whole: resolved labels, the measure, percent of total, rank, and a summary row, largest first.
    CORRELATION
    Raw point tuples: a leading record-identity column, then the unaggregated (X, Y[, size]) values.
    DISTRIBUTION
    The measure's fetched values bucketed into equal-width bins with frequency, percent and cumulative percent.
    MATRIX
    Category by series: one column per series value, a Total column, and for stacked charts a percentage block.
    RAW
    The fetched rows as a plain table, unreconstructed.
    TREND
    Change over time: chronological periods with change-vs-prior columns and, for additive measures, a running total.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getValue()
     
    static ChartExportShape
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static ChartExportShape[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • AUTO

      public static final ChartExportShape AUTO
      Infer the shape from the chart: its type, its facets' field types, and what its measure's aggregation makes valid. The default.

      If this enumerated value is used in a Component XML file or server-side DataSource descriptor (.ds.xml file), use the value "auto".

    • COMPARISON

      public static final ChartExportShape COMPARISON
      Ranked share-of-whole: resolved labels, the measure, percent of total, rank, and a summary row, largest first.

      If this enumerated value is used in a Component XML file or server-side DataSource descriptor (.ds.xml file), use the value "comparison".

    • TREND

      public static final ChartExportShape TREND
      Change over time: chronological periods with change-vs-prior columns and, for additive measures, a running total.

      If this enumerated value is used in a Component XML file or server-side DataSource descriptor (.ds.xml file), use the value "trend".

    • CORRELATION

      public static final ChartExportShape CORRELATION
      Raw point tuples: a leading record-identity column, then the unaggregated (X, Y[, size]) values.

      If this enumerated value is used in a Component XML file or server-side DataSource descriptor (.ds.xml file), use the value "correlation".

    • DISTRIBUTION

      public static final ChartExportShape DISTRIBUTION
      The measure's fetched values bucketed into equal-width bins with frequency, percent and cumulative percent.

      If this enumerated value is used in a Component XML file or server-side DataSource descriptor (.ds.xml file), use the value "distribution".

    • MATRIX

      public static final ChartExportShape MATRIX
      Category by series: one column per series value, a Total column, and for stacked charts a percentage block.

      If this enumerated value is used in a Component XML file or server-side DataSource descriptor (.ds.xml file), use the value "matrix".

    • RAW

      public static final ChartExportShape RAW
      The fetched rows as a plain table, unreconstructed.

      If this enumerated value is used in a Component XML file or server-side DataSource descriptor (.ds.xml file), use the value "raw".

  • Method Details

    • values

      public static ChartExportShape[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static ChartExportShape valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getValue

      public String getValue()
      Specified by:
      getValue in interface ValueEnum