Class: Google::Apis::SlidesV1::TextStyle

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

Overview

Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists:

  • A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder.
  • A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor.

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) ⇒ TextStyle

Returns a new instance of TextStyle



4176
4177
4178
 
# File 'generated/google/apis/slides_v1/classes.rb', line 4176

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

Instance Attribute Details

#background_color ⇒ Google::Apis::SlidesV1::OptionalColor

A color that can either be fully opaque or fully transparent. Corresponds to the JSON property backgroundColor

Returns:



4105
4106
4107
 
# File 'generated/google/apis/slides_v1/classes.rb', line 4105

def background_color
  @background_color
end

#baseline_offset ⇒ String

The text's vertical offset from its normal position. Text with SUPERSCRIPT or SUBSCRIPT baseline offsets is automatically rendered in a smaller font size, computed based on the font_size field. The font_size itself is not affected by changes in this field. Corresponds to the JSON property baselineOffset

Returns:

  • (String) 


4113
4114
4115
 
# File 'generated/google/apis/slides_v1/classes.rb', line 4113

def baseline_offset
  @baseline_offset
end

#bold ⇒ Boolean Also known as: bold?

Whether or not the text is rendered as bold. Corresponds to the JSON property bold

Returns:

  • (Boolean) 


4118
4119
4120
 
# File 'generated/google/apis/slides_v1/classes.rb', line 4118

def bold
  @bold
end

#font_family ⇒ String

The font family of the text. The font family can be any font from the Font menu in Slides or from Google Fonts. If the font name is unrecognized, the text is rendered in Arial. Some fonts can affect the weight of the text. If an update request specifies values for both font_family and bold, the explicitly-set bold value is used. Corresponds to the JSON property fontFamily

Returns:

  • (String) 


4130
4131
4132
 
# File 'generated/google/apis/slides_v1/classes.rb', line 4130

def font_family
  @font_family
end

#font_size ⇒ Google::Apis::SlidesV1::Dimension

A magnitude in a single direction in the specified units. Corresponds to the JSON property fontSize

Returns:



4135
4136
4137
 
# File 'generated/google/apis/slides_v1/classes.rb', line 4135

def font_size
  @font_size
end

#foreground_color ⇒ Google::Apis::SlidesV1::OptionalColor

A color that can either be fully opaque or fully transparent. Corresponds to the JSON property foregroundColor

Returns:



4140
4141
4142
 
# File 'generated/google/apis/slides_v1/classes.rb', line 4140

def foreground_color
  @foreground_color
end

#italic ⇒ Boolean Also known as: italic?

Whether or not the text is italicized. Corresponds to the JSON property italic

Returns:

  • (Boolean) 


4145
4146
4147
 
# File 'generated/google/apis/slides_v1/classes.rb', line 4145

def italic
  @italic
end

#link ⇒ Google::Apis::SlidesV1::Link

A hypertext link. Corresponds to the JSON property link

Returns:



4151
4152
4153
 
# File 'generated/google/apis/slides_v1/classes.rb', line 4151

def link
  @link
end

#small_caps ⇒ Boolean Also known as: small_caps?

Whether or not the text is in small capital letters. Corresponds to the JSON property smallCaps

Returns:

  • (Boolean) 


4156
4157
4158
 
# File 'generated/google/apis/slides_v1/classes.rb', line 4156

def small_caps
  @small_caps
end

#strikethrough ⇒ Boolean Also known as: strikethrough?

Whether or not the text is struck through. Corresponds to the JSON property strikethrough

Returns:

  • (Boolean) 


4162
4163
4164
 
# File 'generated/google/apis/slides_v1/classes.rb', line 4162

def strikethrough
  @strikethrough
end

#underline ⇒ Boolean Also known as: underline?

Whether or not the text is underlined. Corresponds to the JSON property underline

Returns:

  • (Boolean) 


4168
4169
4170
 
# File 'generated/google/apis/slides_v1/classes.rb', line 4168

def underline
  @underline
end

#weighted_font_family ⇒ Google::Apis::SlidesV1::WeightedFontFamily

Represents a font family and weight used to style a TextRun. Corresponds to the JSON property weightedFontFamily

Returns:



4174
4175
4176
 
# File 'generated/google/apis/slides_v1/classes.rb', line 4174

def weighted_font_family
  @weighted_font_family
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
 
# File 'generated/google/apis/slides_v1/classes.rb', line 4181

def update!(**args)
  @background_color = args[:background_color] if args.key?(:background_color)
  @baseline_offset = args[:baseline_offset] if args.key?(:baseline_offset)
  @bold = args[:bold] if args.key?(:bold)
  @font_family = args[:font_family] if args.key?(:font_family)
  @font_size = args[:font_size] if args.key?(:font_size)
  @foreground_color = args[:foreground_color] if args.key?(:foreground_color)
  @italic = args[:italic] if args.key?(:italic)
  @link = args[:link] if args.key?(:link)
  @small_caps = args[:small_caps] if args.key?(:small_caps)
  @strikethrough = args[:strikethrough] if args.key?(:strikethrough)
  @underline = args[:underline] if args.key?(:underline)
  @weighted_font_family = args[:weighted_font_family] if args.key?(:weighted_font_family)
end