Class: Google::Apis::DocsV1::StructuralElement
- Inherits:
-
Object
- Object
- Google::Apis::DocsV1::StructuralElement
- 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
-
#end_index ⇒ Fixnum
The zero-based end index of this structural element, exclusive, in UTF-16 code units.
-
#paragraph ⇒ Google::Apis::DocsV1::Paragraph
A StructuralElement representing a paragraph.
-
#section_break ⇒ Google::Apis::DocsV1::SectionBreak
A StructuralElement representing a section break.
-
#start_index ⇒ Fixnum
The zero-based start index of this structural element, in UTF-16 code units.
-
#table ⇒ Google::Apis::DocsV1::Table
A StructuralElement representing a table.
-
#table_of_contents ⇒ Google::Apis::DocsV1::TableOfContents
A StructuralElement representing a table of contents.
Instance Method Summary collapse
-
#initialize(**args) ⇒ StructuralElement
constructor
A new instance of StructuralElement.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ StructuralElement
Returns a new instance of StructuralElement
4161 4162 4163 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4161 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
4124 4125 4126 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4124 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
4131 4132 4133 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4131 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
4141 4142 4143 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4141 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
4147 4148 4149 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4147 def start_index @start_index end |
#table ⇒ Google::Apis::DocsV1::Table
A StructuralElement representing a
table.
Corresponds to the JSON property table
4153 4154 4155 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4153 def table @table end |
#table_of_contents ⇒ Google::Apis::DocsV1::TableOfContents
A StructuralElement representing
a table of contents.
Corresponds to the JSON property tableOfContents
4159 4160 4161 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4159 def table_of_contents @table_of_contents end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4166 4167 4168 4169 4170 4171 4172 4173 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4166 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 |