Package smile.plot.vega

Class FormatConfig

java.lang.Object
smile.plot.vega.FormatConfig
public class FormatConfig extends Object
These config properties define the default number and time formats for text marks as well as axes, headers, tooltip, and legends.

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toPrettyString

      public String toPrettyString()
      Returns the specification in pretty print.
      Returns:
      the specification in pretty print.

    • numberFormat

      public FormatConfig numberFormat(String format)
      Sets custom number format.
      Parameters:
      format - custom number format.
      Returns:
      this object.

    • numberFormatType

      public FormatConfig numberFormatType(String formatType)
      Sets custom number format type.
      Parameters:
      formatType - custom number format type.
      Returns:
      this object.

    • normalizedNumberFormat

      public FormatConfig normalizedNumberFormat(String format)
      Sets custom normalized number format.
      Parameters:
      format - custom normalized number format.
      Returns:
      this object.

    • normalizedNumberFormatType

      public FormatConfig normalizedNumberFormatType(String formatType)
      Sets custom normalized number format type.
      Parameters:
      formatType - custom normalized number format type.
      Returns:
      this object.

    • timeFormat

      public FormatConfig timeFormat(String format)
      Sets custom time format.
      Parameters:
      format - the custom time format.
      Returns:
      this object.

    • timeFormatType

      public FormatConfig timeFormatType(String formatType)
      Sets custom time format type.
      Parameters:
      formatType - the custom time format type.
      Returns:
      this object.

    • customFormatTypes

      public FormatConfig customFormatTypes(boolean flag)
      Allow the formatType property for text marks and guides to accept a custom formatter function registered as a Vega expression.
      Parameters:
      flag - true if accepting custom format types.
      Returns:
      this object.