View Source GoogleApi.Sheets.V4.Model.SortSpec (google_api_sheets v0.34.0)

A sort order associated with a specific column or row.

Attributes

backgroundColor (type: GoogleApi.Sheets.V4.Model.Color.t, default: nil) - The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color. Deprecated: Use background_color_style.
backgroundColorStyle (type: GoogleApi.Sheets.V4.Model.ColorStyle.t, default: nil) - The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color, and must be an RGB-type color. If background_color is also set, this field takes precedence.
dataSourceColumnReference (type: GoogleApi.Sheets.V4.Model.DataSourceColumnReference.t, default: nil) - Reference to a data source column.
dimensionIndex (type: integer(), default: nil) - The dimension the sort should be applied to.
foregroundColor (type: GoogleApi.Sheets.V4.Model.Color.t, default: nil) - The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color. Deprecated: Use foreground_color_style.
foregroundColorStyle (type: GoogleApi.Sheets.V4.Model.ColorStyle.t, default: nil) - The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color, and must be an RGB-type color. If foreground_color is also set, this field takes precedence.
sortOrder (type: String.t, default: nil) - The order data should be sorted.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Sheets.V4.Model.SortSpec{
  backgroundColor: GoogleApi.Sheets.V4.Model.Color.t() | nil,
  backgroundColorStyle: GoogleApi.Sheets.V4.Model.ColorStyle.t() | nil,
  dataSourceColumnReference:
    GoogleApi.Sheets.V4.Model.DataSourceColumnReference.t() | nil,
  dimensionIndex: integer() | nil,
  foregroundColor: GoogleApi.Sheets.V4.Model.Color.t() | nil,
  foregroundColorStyle: GoogleApi.Sheets.V4.Model.ColorStyle.t() | nil,
  sortOrder: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.