Class: Google::Apis::DocsV1::StructuralElement

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 StructuralElement describes content that provides structure to the document.

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

Returns a new instance of StructuralElement.



4799
4800
4801
 
# File 'generated/google/apis/docs_v1/classes.rb', line 4799

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

Instance Attribute Details

#end_index ⇒ Fixnum

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

Returns:

  • (Fixnum) 


4762
4763
4764
 
# File 'generated/google/apis/docs_v1/classes.rb', line 4762

def end_index
  @end_index
end

#paragraph ⇒ Google::Apis::DocsV1::Paragraph

A StructuralElement representing a paragraph. A paragraph is a range of content that is terminated with a newline character. Corresponds to the JSON property paragraph

Returns:



4769
4770
4771
 
# File 'generated/google/apis/docs_v1/classes.rb', line 4769

def paragraph
  @paragraph
end

#section_break ⇒ Google::Apis::DocsV1::SectionBreak

A StructuralElement representing a section break. A section is a range of content which has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. Corresponds to the JSON property sectionBreak

Returns:



4779
4780
4781
 
# File 'generated/google/apis/docs_v1/classes.rb', line 4779

def section_break
  @section_break
end

#start_index ⇒ Fixnum

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

Returns:

  • (Fixnum) 


4785
4786
4787
 
# File 'generated/google/apis/docs_v1/classes.rb', line 4785

def start_index
  @start_index
end

#table ⇒ Google::Apis::DocsV1::Table

A StructuralElement representing a table. Corresponds to the JSON property table

Returns:



4791
4792
4793
 
# File 'generated/google/apis/docs_v1/classes.rb', line 4791

def table
  @table
end

#table_of_contents ⇒ Google::Apis::DocsV1::TableOfContents

A StructuralElement representing a table of contents. Corresponds to the JSON property tableOfContents

Returns:



4797
4798
4799
 
# File 'generated/google/apis/docs_v1/classes.rb', line 4797

def table_of_contents
  @table_of_contents
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4804
4805
4806
4807
4808
4809
4810
4811
 
# File 'generated/google/apis/docs_v1/classes.rb', line 4804

def update!(**args)
  @end_index = args[:end_index] if args.key?(:end_index)
  @paragraph = args[:paragraph] if args.key?(:paragraph)
  @section_break = args[:section_break] if args.key?(:section_break)
  @start_index = args[:start_index] if args.key?(:start_index)
  @table = args[:table] if args.key?(:table)
  @table_of_contents = args[:table_of_contents] if args.key?(:table_of_contents)
end