Class: Google::Apis::SheetsV4::ChartSpec

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/sheets_v4/classes.rb,
generated/google/apis/sheets_v4/representations.rb,
generated/google/apis/sheets_v4/representations.rb

Overview

The specifications of a chart.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ChartSpec

Returns a new instance of ChartSpec.



3098
3099
3100
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3098

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#alt_text ⇒ String

The alternative text that describes the chart. This is often used for accessibility. Corresponds to the JSON property altText

Returns:

  • (String) 


2912
2913
2914
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2912

def alt_text
  @alt_text
end

#background_color ⇒ Google::Apis::SheetsV4::Color

Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of "java.awt.Color" in Java; it can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" method in iOS; and, with just a little work, it can be easily formatted into a CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space. Note: when color equality needs to be decided, implementations, unless documented otherwise, will treat two colors to be equal if all their red, green, blue and alpha values each differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue( ), alpha); public static Color toProto(java.awt.Color color) float red = ( float) color.getRed(); float green = (float) color.getGreen(); float blue = ( float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); return resultBuilder.build(); // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) float red = [ protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if ( alpha_wrapper != nil) alpha = [alpha_wrapper value]; return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; static Color* toProto( UIColor* color) CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) return nil; Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue: blue]; if (alpha <= 0.9999) [result setAlpha:floatWrapperWithValue(alpha)]; [result autorelease]; return result; // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) return rgbToCssColor_(red, green, blue); var alphaFrac = rgb_color.alpha.value || 0. 0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ', ', alphaFrac, ')'].join('');; var rgbToCssColor_ = function(red, green, blue) var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) resultBuilder.push('0'); resultBuilder.push(hexString); return resultBuilder. join('');; // ... Corresponds to the JSON property backgroundColor

Returns:



2961
2962
2963
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2961

def background_color
  @background_color
end

#background_color_style ⇒ Google::Apis::SheetsV4::ColorStyle

A color value. Corresponds to the JSON property backgroundColorStyle

Returns:



2966
2967
2968
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2966

def background_color_style
  @background_color_style
end

#basic_chart ⇒ Google::Apis::SheetsV4::BasicChartSpec

The specification for a basic chart. See BasicChartType for the list of charts this supports. Corresponds to the JSON property basicChart

Returns:



2972
2973
2974
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2972

def basic_chart
  @basic_chart
end

#bubble_chart ⇒ Google::Apis::SheetsV4::BubbleChartSpec

A bubble chart. Corresponds to the JSON property bubbleChart

Returns:



2977
2978
2979
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2977

def bubble_chart
  @bubble_chart
end

#candlestick_chart ⇒ Google::Apis::SheetsV4::CandlestickChartSpec

A candlestick chart. Corresponds to the JSON property candlestickChart

Returns:



2982
2983
2984
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2982

def candlestick_chart
  @candlestick_chart
end

#data_source_chart_properties ⇒ Google::Apis::SheetsV4::DataSourceChartProperties

Properties of a data source chart. Corresponds to the JSON property dataSourceChartProperties

Returns:



2987
2988
2989
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2987

def data_source_chart_properties
  @data_source_chart_properties
end

#filter_specs ⇒ Array<Google::Apis::SheetsV4::FilterSpec>

The filters applied to the source data of the chart. Only supported for data source charts. Corresponds to the JSON property filterSpecs

Returns:



2993
2994
2995
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2993

def filter_specs
  @filter_specs
end

#font_name ⇒ String

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. Corresponds to the JSON property fontName

Returns:

  • (String) 


3000
3001
3002
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3000

def font_name
  @font_name
end

#hidden_dimension_strategy ⇒ String

Determines how the charts will use hidden rows or columns. Corresponds to the JSON property hiddenDimensionStrategy

Returns:

  • (String) 


3005
3006
3007
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3005

def hidden_dimension_strategy
  @hidden_dimension_strategy
end

#histogram_chart ⇒ Google::Apis::SheetsV4::HistogramChartSpec

A histogram chart. A histogram chart groups data items into bins, displaying each bin as a column of stacked items. Histograms are used to display the distribution of a dataset. Each column of items represents a range into which those items fall. The number of bins can be chosen automatically or specified explicitly. Corresponds to the JSON property histogramChart

Returns:



3014
3015
3016
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3014

def histogram_chart
  @histogram_chart
end

#maximized ⇒ Boolean Also known as: maximized?

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.) Corresponds to the JSON property maximized

Returns:

  • (Boolean) 


3021
3022
3023
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3021

def maximized
  @maximized
end

#org_chart ⇒ Google::Apis::SheetsV4::OrgChartSpec

An org chart. Org charts require a unique set of labels in labels and may optionally include parent_labels and tooltips. parent_labels contain, for each node, the label identifying the parent node. tooltips contain, for each node, an optional tooltip. For example, to describe an OrgChart with Alice as the CEO, Bob as the President (reporting to Alice) and Cathy as VP of Sales (also reporting to Alice), have labels contain "Alice", "Bob", "Cathy", parent_labels contain "", "Alice", "Alice" and tooltips contain "CEO", " President", "VP Sales". Corresponds to the JSON property orgChart

Returns:



3034
3035
3036
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3034

def org_chart
  @org_chart
end

#pie_chart ⇒ Google::Apis::SheetsV4::PieChartSpec

A pie chart. Corresponds to the JSON property pieChart

Returns:



3039
3040
3041
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3039

def pie_chart
  @pie_chart
end

#scorecard_chart ⇒ Google::Apis::SheetsV4::ScorecardChartSpec

A scorecard chart. Scorecard charts are used to highlight key performance indicators, known as KPIs, on the spreadsheet. A scorecard chart can represent things like total sales, average cost, or a top selling item. You can specify a single data value, or aggregate over a range of data. Percentage or absolute difference from a baseline value can be highlighted, like changes over time. Corresponds to the JSON property scorecardChart

Returns:



3048
3049
3050
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3048

def scorecard_chart
  @scorecard_chart
end

#sort_specs ⇒ Array<Google::Apis::SheetsV4::SortSpec>

The order to sort the chart data by. Only a single sort spec is supported. Only supported for data source charts. Corresponds to the JSON property sortSpecs

Returns:



3054
3055
3056
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3054

def sort_specs
  @sort_specs
end

#subtitle ⇒ String

The subtitle of the chart. Corresponds to the JSON property subtitle

Returns:

  • (String) 


3059
3060
3061
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3059

def subtitle
  @subtitle
end

#subtitle_text_format ⇒ Google::Apis::SheetsV4::TextFormat

The format of a run of text in a cell. Absent values indicate that the field isn't specified. Corresponds to the JSON property subtitleTextFormat

Returns:



3065
3066
3067
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3065

def subtitle_text_format
  @subtitle_text_format
end

#subtitle_text_position ⇒ Google::Apis::SheetsV4::TextPosition

Position settings for text. Corresponds to the JSON property subtitleTextPosition

Returns:



3070
3071
3072
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3070

def subtitle_text_position
  @subtitle_text_position
end

#title ⇒ String

The title of the chart. Corresponds to the JSON property title

Returns:

  • (String) 


3075
3076
3077
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3075

def title
  @title
end

#title_text_format ⇒ Google::Apis::SheetsV4::TextFormat

The format of a run of text in a cell. Absent values indicate that the field isn't specified. Corresponds to the JSON property titleTextFormat

Returns:



3081
3082
3083
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3081

def title_text_format
  @title_text_format
end

#title_text_position ⇒ Google::Apis::SheetsV4::TextPosition

Position settings for text. Corresponds to the JSON property titleTextPosition

Returns:



3086
3087
3088
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3086

def title_text_position
  @title_text_position
end

#treemap_chart ⇒ Google::Apis::SheetsV4::TreemapChartSpec

A Treemap chart. Corresponds to the JSON property treemapChart

Returns:



3091
3092
3093
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3091

def treemap_chart
  @treemap_chart
end

#waterfall_chart ⇒ Google::Apis::SheetsV4::WaterfallChartSpec

A waterfall chart. Corresponds to the JSON property waterfallChart

Returns:



3096
3097
3098
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3096

def waterfall_chart
  @waterfall_chart
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3103

def update!(**args)
  @alt_text = args[:alt_text] if args.key?(:alt_text)
  @background_color = args[:background_color] if args.key?(:background_color)
  @background_color_style = args[:background_color_style] if args.key?(:background_color_style)
  @basic_chart = args[:basic_chart] if args.key?(:basic_chart)
  @bubble_chart = args[:bubble_chart] if args.key?(:bubble_chart)
  @candlestick_chart = args[:candlestick_chart] if args.key?(:candlestick_chart)
  @data_source_chart_properties = args[:data_source_chart_properties] if args.key?(:data_source_chart_properties)
  @filter_specs = args[:filter_specs] if args.key?(:filter_specs)
  @font_name = args[:font_name] if args.key?(:font_name)
  @hidden_dimension_strategy = args[:hidden_dimension_strategy] if args.key?(:hidden_dimension_strategy)
  @histogram_chart = args[:histogram_chart] if args.key?(:histogram_chart)
  @maximized = args[:maximized] if args.key?(:maximized)
  @org_chart = args[:org_chart] if args.key?(:org_chart)
  @pie_chart = args[:pie_chart] if args.key?(:pie_chart)
  @scorecard_chart = args[:scorecard_chart] if args.key?(:scorecard_chart)
  @sort_specs = args[:sort_specs] if args.key?(:sort_specs)
  @subtitle = args[:subtitle] if args.key?(:subtitle)
  @subtitle_text_format = args[:subtitle_text_format] if args.key?(:subtitle_text_format)
  @subtitle_text_position = args[:subtitle_text_position] if args.key?(:subtitle_text_position)
  @title = args[:title] if args.key?(:title)
  @title_text_format = args[:title_text_format] if args.key?(:title_text_format)
  @title_text_position = args[:title_text_position] if args.key?(:title_text_position)
  @treemap_chart = args[:treemap_chart] if args.key?(:treemap_chart)
  @waterfall_chart = args[:waterfall_chart] if args.key?(:waterfall_chart)
end