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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ChartSpec

Returns a new instance of ChartSpec



2073
2074
2075
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2073

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

Instance Attribute Details

#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. Here are some examples: 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:



2051
2052
2053
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2051

def background_color
  @background_color
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:



2057
2058
2059
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2057

def basic_chart
  @basic_chart
end

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

A bubble chart. Corresponds to the JSON property bubbleChart

Returns:



1928
1929
1930
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1928

def bubble_chart
  @bubble_chart
end

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

A candlestick chart< /a>. Corresponds to the JSON property candlestickChart

Returns:

 


1923
1924
1925
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1923

def candlestick_chart
  @candlestick_chart
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) 


1935
1936
1937
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1935

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) 


1948
1949
1950
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1948

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:



1917
1918
1919
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1917

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) 


1942
1943
1944
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1942

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:



2071
2072
2073
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2071

def org_chart
  @org_chart
end

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

A pie chart. Corresponds to the JSON property pieChart

Returns:



1896
1897
1898
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1896

def pie_chart
  @pie_chart
end

#title ⇒ String

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

Returns:

  • (String) 


1907
1908
1909
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1907

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:



1902
1903
1904
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1902

def title_text_format
  @title_text_format
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 2078

def update!(**args)
  @pie_chart = args[:pie_chart] if args.key?(:pie_chart)
  @title_text_format = args[:title_text_format] if args.key?(:title_text_format)
  @title = args[:title] if args.key?(:title)
  @histogram_chart = args[:histogram_chart] if args.key?(:histogram_chart)
  @candlestick_chart = args[:candlestick_chart] if args.key?(:candlestick_chart)
  @bubble_chart = args[:bubble_chart] if args.key?(:bubble_chart)
  @font_name = args[:font_name] if args.key?(:font_name)
  @maximized = args[:maximized] if args.key?(:maximized)
  @hidden_dimension_strategy = args[:hidden_dimension_strategy] if args.key?(:hidden_dimension_strategy)
  @background_color = args[:background_color] if args.key?(:background_color)
  @basic_chart = args[:basic_chart] if args.key?(:basic_chart)
  @org_chart = args[:org_chart] if args.key?(:org_chart)
end