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



3003
3004
3005
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3003

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:



2945
2946
2947
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2945

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:



2952
2953
2954
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2952

def column_break
  @column_break
end

#end_index ⇒ Fixnum

The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. Corresponds to the JSON property endIndex

Returns:

  • (Fixnum) 


2958
2959
2960
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2958

def end_index
  @end_index
end

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

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

Returns:



2964
2965
2966
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2964

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:



2971
2972
2973
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2971

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:



2977
2978
2979
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2977

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:



2983
2984
2985
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2983

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:



2990
2991
2992
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2990

def page_break
  @page_break
end

#start_index ⇒ Fixnum

The zero-based start index of this paragraph element, in UTF-16 code units. Corresponds to the JSON property startIndex

Returns:

  • (Fixnum) 


2995
2996
2997
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2995

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:



3001
3002
3003
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3001

def text_run
  @text_run
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3008

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