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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/docs_v1/classes.rb,
lib/google/apis/docs_v1/representations.rb,
lib/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

Constructor Details

#initialize(**args) ⇒ StructuralElement

Returns a new instance of StructuralElement.



5244
5245
5246
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5244

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) 


5213
5214
5215
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5213

def end_index
  @end_index
end

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

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

Returns:



5219
5220
5221
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5219

def paragraph
  @paragraph
end

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

A StructuralElement representing a section break. A section is a range of content that 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:



5227
5228
5229
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5227

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) 


5232
5233
5234
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5232

def start_index
  @start_index
end

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

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

Returns:



5237
5238
5239
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5237

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:



5242
5243
5244
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5242

def table_of_contents
  @table_of_contents
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5249
5250
5251
5252
5253
5254
5255
5256
 
# File 'lib/google/apis/docs_v1/classes.rb', line 5249

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