Class: Google::Apis::DocsV1::TextStyle

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

Overview

Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined:

  • The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type.
  • The TextStyle on a named style inherits from the normal text named style.
  • The TextStyle of the normal text named style inherits from the default text style in the Docs editor.
  • The TextStyle on a Paragraph element that is contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs 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



5542
5543
5544
 
# File 'generated/google/apis/docs_v1/classes.rb', line 5542

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

Instance Attribute Details

#background_color ⇒ Google::Apis::DocsV1::OptionalColor

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

Returns:



5482
5483
5484
 
# File 'generated/google/apis/docs_v1/classes.rb', line 5482

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) 


5490
5491
5492
 
# File 'generated/google/apis/docs_v1/classes.rb', line 5490

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) 


5495
5496
5497
 
# File 'generated/google/apis/docs_v1/classes.rb', line 5495

def bold
  @bold
end

#font_size ⇒ Google::Apis::DocsV1::Dimension

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

Returns:



5501
5502
5503
 
# File 'generated/google/apis/docs_v1/classes.rb', line 5501

def font_size
  @font_size
end

#foreground_color ⇒ Google::Apis::DocsV1::OptionalColor

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

Returns:



5506
5507
5508
 
# File 'generated/google/apis/docs_v1/classes.rb', line 5506

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) 


5511
5512
5513
 
# File 'generated/google/apis/docs_v1/classes.rb', line 5511

def italic
  @italic
end

#link ⇒ Google::Apis::DocsV1::Link

A reference to another portion of a document or an external URL resource. Corresponds to the JSON property link

Returns:



5517
5518
5519
 
# File 'generated/google/apis/docs_v1/classes.rb', line 5517

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) 


5522
5523
5524
 
# File 'generated/google/apis/docs_v1/classes.rb', line 5522

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) 


5528
5529
5530
 
# File 'generated/google/apis/docs_v1/classes.rb', line 5528

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) 


5534
5535
5536
 
# File 'generated/google/apis/docs_v1/classes.rb', line 5534

def underline
  @underline
end

#weighted_font_family ⇒ Google::Apis::DocsV1::WeightedFontFamily

Represents a font family and weight of text. Corresponds to the JSON property weightedFontFamily

Returns:



5540
5541
5542
 
# File 'generated/google/apis/docs_v1/classes.rb', line 5540

def weighted_font_family
  @weighted_font_family
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
 
# File 'generated/google/apis/docs_v1/classes.rb', line 5547

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_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