GoogleApi.Sheets.V4.Model.ChartSpec (google_api_sheets v0.35.0)

View Source

The specifications of a chart.

Attributes

  • altText (type: String.t, default: nil) - The alternative text that describes the chart. This is often used for accessibility.
  • backgroundColor (type: GoogleApi.Sheets.V4.Model.Color.t, default: nil) - The background color of the entire chart. Not applicable to Org charts. Deprecated: Use background_color_style.
  • backgroundColorStyle (type: GoogleApi.Sheets.V4.Model.ColorStyle.t, default: nil) - The background color of the entire chart. Not applicable to Org charts. If background_color is also set, this field takes precedence.
  • basicChart (type: GoogleApi.Sheets.V4.Model.BasicChartSpec.t, default: nil) - A basic chart specification, can be one of many kinds of charts. See BasicChartType for the list of all charts this supports.
  • bubbleChart (type: GoogleApi.Sheets.V4.Model.BubbleChartSpec.t, default: nil) - A bubble chart specification.
  • candlestickChart (type: GoogleApi.Sheets.V4.Model.CandlestickChartSpec.t, default: nil) - A candlestick chart specification.
  • dataSourceChartProperties (type: GoogleApi.Sheets.V4.Model.DataSourceChartProperties.t, default: nil) - If present, the field contains data source chart specific properties.
  • filterSpecs (type: list(GoogleApi.Sheets.V4.Model.FilterSpec.t), default: nil) - The filters applied to the source data of the chart. Only supported for data source charts.
  • fontName (type: String.t, default: nil) - The name of the font to use by default for all chart text (e.g. title, axis labels, legend). If a font is specified for a specific part of the chart it will override this font name.
  • hiddenDimensionStrategy (type: String.t, default: nil) - Determines how the charts will use hidden rows or columns.
  • histogramChart (type: GoogleApi.Sheets.V4.Model.HistogramChartSpec.t, default: nil) - A histogram chart specification.
  • maximized (type: boolean(), default: nil) - True to make a chart fill the entire space in which it's rendered with minimum padding. False to use the default padding. (Not applicable to Geo and Org charts.)
  • orgChart (type: GoogleApi.Sheets.V4.Model.OrgChartSpec.t, default: nil) - An org chart specification.
  • pieChart (type: GoogleApi.Sheets.V4.Model.PieChartSpec.t, default: nil) - A pie chart specification.
  • scorecardChart (type: GoogleApi.Sheets.V4.Model.ScorecardChartSpec.t, default: nil) - A scorecard chart specification.
  • sortSpecs (type: list(GoogleApi.Sheets.V4.Model.SortSpec.t), default: nil) - The order to sort the chart data by. Only a single sort spec is supported. Only supported for data source charts.
  • subtitle (type: String.t, default: nil) - The subtitle of the chart.
  • subtitleTextFormat (type: GoogleApi.Sheets.V4.Model.TextFormat.t, default: nil) - The subtitle text format. Strikethrough, underline, and link are not supported.
  • subtitleTextPosition (type: GoogleApi.Sheets.V4.Model.TextPosition.t, default: nil) - The subtitle text position. This field is optional.
  • title (type: String.t, default: nil) - The title of the chart.
  • titleTextFormat (type: GoogleApi.Sheets.V4.Model.TextFormat.t, default: nil) - The title text format. Strikethrough, underline, and link are not supported.
  • titleTextPosition (type: GoogleApi.Sheets.V4.Model.TextPosition.t, default: nil) - The title text position. This field is optional.
  • treemapChart (type: GoogleApi.Sheets.V4.Model.TreemapChartSpec.t, default: nil) - A treemap chart specification.
  • waterfallChart (type: GoogleApi.Sheets.V4.Model.WaterfallChartSpec.t, default: nil) - A waterfall chart specification.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Sheets.V4.Model.ChartSpec{
  altText: String.t() | nil,
  backgroundColor: GoogleApi.Sheets.V4.Model.Color.t() | nil,
  backgroundColorStyle: GoogleApi.Sheets.V4.Model.ColorStyle.t() | nil,
  basicChart: GoogleApi.Sheets.V4.Model.BasicChartSpec.t() | nil,
  bubbleChart: GoogleApi.Sheets.V4.Model.BubbleChartSpec.t() | nil,
  candlestickChart: GoogleApi.Sheets.V4.Model.CandlestickChartSpec.t() | nil,
  dataSourceChartProperties:
    GoogleApi.Sheets.V4.Model.DataSourceChartProperties.t() | nil,
  filterSpecs: [GoogleApi.Sheets.V4.Model.FilterSpec.t()] | nil,
  fontName: String.t() | nil,
  hiddenDimensionStrategy: String.t() | nil,
  histogramChart: GoogleApi.Sheets.V4.Model.HistogramChartSpec.t() | nil,
  maximized: boolean() | nil,
  orgChart: GoogleApi.Sheets.V4.Model.OrgChartSpec.t() | nil,
  pieChart: GoogleApi.Sheets.V4.Model.PieChartSpec.t() | nil,
  scorecardChart: GoogleApi.Sheets.V4.Model.ScorecardChartSpec.t() | nil,
  sortSpecs: [GoogleApi.Sheets.V4.Model.SortSpec.t()] | nil,
  subtitle: String.t() | nil,
  subtitleTextFormat: GoogleApi.Sheets.V4.Model.TextFormat.t() | nil,
  subtitleTextPosition: GoogleApi.Sheets.V4.Model.TextPosition.t() | nil,
  title: String.t() | nil,
  titleTextFormat: GoogleApi.Sheets.V4.Model.TextFormat.t() | nil,
  titleTextPosition: GoogleApi.Sheets.V4.Model.TextPosition.t() | nil,
  treemapChart: GoogleApi.Sheets.V4.Model.TreemapChartSpec.t() | nil,
  waterfallChart: GoogleApi.Sheets.V4.Model.WaterfallChartSpec.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.