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



4255
4256
4257
# File 'generated/google/apis/slides_v1/classes.rb', line 4255

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

Instance Attribute Details

#background_colorGoogle::Apis::SlidesV1::OptionalColor

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



4184
4185
4186
# File 'generated/google/apis/slides_v1/classes.rb', line 4184

def background_color
  @background_color
end

#baseline_offsetString

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)


4192
4193
4194
# File 'generated/google/apis/slides_v1/classes.rb', line 4192

def baseline_offset
  @baseline_offset
end

#boldBoolean Also known as: bold?

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

Returns:

  • (Boolean)


4197
4198
4199
# File 'generated/google/apis/slides_v1/classes.rb', line 4197

def bold
  @bold
end

#font_familyString

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)


4209
4210
4211
# File 'generated/google/apis/slides_v1/classes.rb', line 4209

def font_family
  @font_family
end

#font_sizeGoogle::Apis::SlidesV1::Dimension

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



4214
4215
4216
# File 'generated/google/apis/slides_v1/classes.rb', line 4214

def font_size
  @font_size
end

#foreground_colorGoogle::Apis::SlidesV1::OptionalColor

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



4219
4220
4221
# File 'generated/google/apis/slides_v1/classes.rb', line 4219

def foreground_color
  @foreground_color
end

#italicBoolean Also known as: italic?

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

Returns:

  • (Boolean)


4224
4225
4226
# File 'generated/google/apis/slides_v1/classes.rb', line 4224

def italic
  @italic
end

A hypertext link. Corresponds to the JSON property link



4230
4231
4232
# File 'generated/google/apis/slides_v1/classes.rb', line 4230

def link
  @link
end

#small_capsBoolean Also known as: small_caps?

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

Returns:

  • (Boolean)


4235
4236
4237
# File 'generated/google/apis/slides_v1/classes.rb', line 4235

def small_caps
  @small_caps
end

#strikethroughBoolean Also known as: strikethrough?

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

Returns:

  • (Boolean)


4241
4242
4243
# File 'generated/google/apis/slides_v1/classes.rb', line 4241

def strikethrough
  @strikethrough
end

#underlineBoolean Also known as: underline?

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

Returns:

  • (Boolean)


4247
4248
4249
# File 'generated/google/apis/slides_v1/classes.rb', line 4247

def underline
  @underline
end

#weighted_font_familyGoogle::Apis::SlidesV1::WeightedFontFamily

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



4253
4254
4255
# File 'generated/google/apis/slides_v1/classes.rb', line 4253

def weighted_font_family
  @weighted_font_family
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
# File 'generated/google/apis/slides_v1/classes.rb', line 4260

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