Class: Google::Apis::DocsV1::Paragraph

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 representing a paragraph. A paragraph is a range of content that is terminated with a newline character.

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

Returns a new instance of Paragraph



2815
2816
2817
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2815

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

Instance Attribute Details

#bullet ⇒ Google::Apis::DocsV1::Bullet

Describes the bullet of a paragraph. Corresponds to the JSON property bullet

Returns:



2768
2769
2770
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2768

def bullet
  @bullet
end

#elements ⇒ Array<Google::Apis::DocsV1::ParagraphElement>

The content of the paragraph broken down into its component parts. Corresponds to the JSON property elements

Returns:



2773
2774
2775
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2773

def elements
  @elements
end

#paragraph_style ⇒ Google::Apis::DocsV1::ParagraphStyle

Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined:

  • The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type.
  • The ParagraphStyle on a named style inherits from the normal text named style.
  • The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor.
  • The ParagraphStyle on a Paragraph element that is contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. Corresponds to the JSON property paragraphStyle

Returns:



2791
2792
2793
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2791

def paragraph_style
  @paragraph_style
end

#positioned_object_ids ⇒ Array<String>

The IDs of the positioned objects tethered to this paragraph. Corresponds to the JSON property positionedObjectIds

Returns:

  • (Array<String>) 


2796
2797
2798
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2796

def positioned_object_ids
  @positioned_object_ids
end

#suggested_bullet_changes ⇒ Hash<String,Google::Apis::DocsV1::SuggestedBullet>

The suggested changes to this paragraph's bullet. Corresponds to the JSON property suggestedBulletChanges

Returns:



2801
2802
2803
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2801

def suggested_bullet_changes
  @suggested_bullet_changes
end

#suggested_paragraph_style_changes ⇒ Hash<String,Google::Apis::DocsV1::SuggestedParagraphStyle>

The suggested paragraph style changes to this paragraph, keyed by suggestion ID. Corresponds to the JSON property suggestedParagraphStyleChanges

Returns:



2807
2808
2809
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2807

def suggested_paragraph_style_changes
  @suggested_paragraph_style_changes
end

#suggested_positioned_object_ids ⇒ Hash<String,Google::Apis::DocsV1::ObjectReferences>

The IDs of the positioned objects that are suggested to be attached to this paragraph, keyed by suggestion ID. Corresponds to the JSON property suggestedPositionedObjectIds

Returns:



2813
2814
2815
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2813

def suggested_positioned_object_ids
  @suggested_positioned_object_ids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2820
2821
2822
2823
2824
2825
2826
2827
2828
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2820

def update!(**args)
  @bullet = args[:bullet] if args.key?(:bullet)
  @elements = args[:elements] if args.key?(:elements)
  @paragraph_style = args[:paragraph_style] if args.key?(:paragraph_style)
  @positioned_object_ids = args[:positioned_object_ids] if args.key?(:positioned_object_ids)
  @suggested_bullet_changes = args[:suggested_bullet_changes] if args.key?(:suggested_bullet_changes)
  @suggested_paragraph_style_changes = args[:suggested_paragraph_style_changes] if args.key?(:suggested_paragraph_style_changes)
  @suggested_positioned_object_ids = args[:suggested_positioned_object_ids] if args.key?(:suggested_positioned_object_ids)
end