Class: Google::Apis::DocsV1::ParagraphElement

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

A ParagraphElement describes content within a Paragraph.

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

Returns a new instance of ParagraphElement



2943
2944
2945
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2943

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

Instance Attribute Details

#auto_text ⇒ Google::Apis::DocsV1::AutoText

A ParagraphElement representing a spot in the text that is dynamically replaced with content that can change over time, like a page number. Corresponds to the JSON property autoText

Returns:



2878
2879
2880
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2878

def auto_text
  @auto_text
end

#column_break ⇒ Google::Apis::DocsV1::ColumnBreak

A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. Corresponds to the JSON property columnBreak

Returns:



2885
2886
2887
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2885

def column_break
  @column_break
end

#end_index ⇒ Fixnum

The zero-base end index of this paragraph element, exclusive, in Unicode code units of the UTF-16 encoding. Unicode code units of the UTF-16 encoding means that surrogate pairs consume two indices. For example, the "GRINNING FACE" emoji would be represented as "\uD83D\uDE00" and would consume two indices. Corresponds to the JSON property endIndex

Returns:

  • (Fixnum) 


2894
2895
2896
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2894

def end_index
  @end_index
end

#equation ⇒ Google::Apis::DocsV1::Equation

A ParagraphElement representing an equation. Corresponds to the JSON property equation

Returns:



2900
2901
2902
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2900

def equation
  @equation
end

#footnote_reference ⇒ Google::Apis::DocsV1::FootnoteReference

A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. Corresponds to the JSON property footnoteReference

Returns:



2907
2908
2909
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2907

def footnote_reference
  @footnote_reference
end

#horizontal_rule ⇒ Google::Apis::DocsV1::HorizontalRule

A ParagraphElement representing a horizontal line. Corresponds to the JSON property horizontalRule

Returns:



2913
2914
2915
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2913

def horizontal_rule
  @horizontal_rule
end

#inline_object_element ⇒ Google::Apis::DocsV1::InlineObjectElement

A ParagraphElement that contains an InlineObject. Corresponds to the JSON property inlineObjectElement

Returns:



2919
2920
2921
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2919

def inline_object_element
  @inline_object_element
end

#page_break ⇒ Google::Apis::DocsV1::PageBreak

A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. Corresponds to the JSON property pageBreak

Returns:



2926
2927
2928
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2926

def page_break
  @page_break
end

#start_index ⇒ Fixnum

The zero-based start index of this paragraph element, in Unicode code units of the UTF-16 encoding. Unicode code units of the UTF-16 encoding means that surrogate pairs consume two indices. For example, the "GRINNING FACE" emoji would be represented as "\uD83D\uDE00" and would consume two indices. Corresponds to the JSON property startIndex

Returns:

  • (Fixnum) 


2935
2936
2937
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2935

def start_index
  @start_index
end

#text_run ⇒ Google::Apis::DocsV1::TextRun

A ParagraphElement that represents a run of text that all has the same styling. Corresponds to the JSON property textRun

Returns:



2941
2942
2943
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2941

def text_run
  @text_run
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2948

def update!(**args)
  @auto_text = args[:auto_text] if args.key?(:auto_text)
  @column_break = args[:column_break] if args.key?(:column_break)
  @end_index = args[:end_index] if args.key?(:end_index)
  @equation = args[:equation] if args.key?(:equation)
  @footnote_reference = args[:footnote_reference] if args.key?(:footnote_reference)
  @horizontal_rule = args[:horizontal_rule] if args.key?(:horizontal_rule)
  @inline_object_element = args[:inline_object_element] if args.key?(:inline_object_element)
  @page_break = args[:page_break] if args.key?(:page_break)
  @start_index = args[:start_index] if args.key?(:start_index)
  @text_run = args[:text_run] if args.key?(:text_run)
end