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



1257
1258
1259
 
# File 'generated/google/apis/slides_v1/classes.rb', line 1257

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:



1192
1193
1194
 
# File 'generated/google/apis/slides_v1/classes.rb', line 1192

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) 


1250
1251
1252
 
# File 'generated/google/apis/slides_v1/classes.rb', line 1250

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) 


1213
1214
1215
 
# File 'generated/google/apis/slides_v1/classes.rb', line 1213

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) 


1225
1226
1227
 
# File 'generated/google/apis/slides_v1/classes.rb', line 1225

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:



1242
1243
1244
 
# File 'generated/google/apis/slides_v1/classes.rb', line 1242

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:



1208
1209
1210
 
# File 'generated/google/apis/slides_v1/classes.rb', line 1208

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) 


1230
1231
1232
 
# File 'generated/google/apis/slides_v1/classes.rb', line 1230

def italic
  @italic
end

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

A hypertext link. Corresponds to the JSON property link

Returns:



1197
1198
1199
 
# File 'generated/google/apis/slides_v1/classes.rb', line 1197

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) 


1186
1187
1188
 
# File 'generated/google/apis/slides_v1/classes.rb', line 1186

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) 


1236
1237
1238
 
# File 'generated/google/apis/slides_v1/classes.rb', line 1236

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) 


1202
1203
1204
 
# File 'generated/google/apis/slides_v1/classes.rb', line 1202

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:



1255
1256
1257
 
# File 'generated/google/apis/slides_v1/classes.rb', line 1255

def weighted_font_family
  @weighted_font_family
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
 
# File 'generated/google/apis/slides_v1/classes.rb', line 1262

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