Class: Google::Apis::DocsV1::ParagraphStyle

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

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's 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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ParagraphStyle

Returns a new instance of ParagraphStyle.



3642
3643
3644
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3642

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

Instance Attribute Details

#alignment ⇒ String

The text alignment for this paragraph. Corresponds to the JSON property alignment

Returns:

  • (String) 


3517
3518
3519
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3517

def alignment
  @alignment
end

#avoid_widow_and_orphan ⇒ Boolean Also known as: avoid_widow_and_orphan?

Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. Corresponds to the JSON property avoidWidowAndOrphan

Returns:

  • (Boolean) 


3523
3524
3525
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3523

def avoid_widow_and_orphan
  @avoid_widow_and_orphan
end

#border_between ⇒ Google::Apis::DocsV1::ParagraphBorder

A border around a paragraph. Corresponds to the JSON property borderBetween

Returns:



3529
3530
3531
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3529

def border_between
  @border_between
end

#border_bottom ⇒ Google::Apis::DocsV1::ParagraphBorder

A border around a paragraph. Corresponds to the JSON property borderBottom

Returns:



3534
3535
3536
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3534

def border_bottom
  @border_bottom
end

#border_left ⇒ Google::Apis::DocsV1::ParagraphBorder

A border around a paragraph. Corresponds to the JSON property borderLeft

Returns:



3539
3540
3541
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3539

def border_left
  @border_left
end

#border_right ⇒ Google::Apis::DocsV1::ParagraphBorder

A border around a paragraph. Corresponds to the JSON property borderRight

Returns:



3544
3545
3546
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3544

def border_right
  @border_right
end

#border_top ⇒ Google::Apis::DocsV1::ParagraphBorder

A border around a paragraph. Corresponds to the JSON property borderTop

Returns:



3549
3550
3551
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3549

def border_top
  @border_top
end

#direction ⇒ String

The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. Corresponds to the JSON property direction

Returns:

  • (String) 


3555
3556
3557
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3555

def direction
  @direction
end

#heading_id ⇒ String

The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. Corresponds to the JSON property headingId

Returns:

  • (String) 


3561
3562
3563
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3561

def heading_id
  @heading_id
end

#indent_end ⇒ Google::Apis::DocsV1::Dimension

A magnitude in a single direction in the specified units. Corresponds to the JSON property indentEnd

Returns:



3566
3567
3568
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3566

def indent_end
  @indent_end
end

#indent_first_line ⇒ Google::Apis::DocsV1::Dimension

A magnitude in a single direction in the specified units. Corresponds to the JSON property indentFirstLine

Returns:



3571
3572
3573
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3571

def indent_first_line
  @indent_first_line
end

#indent_start ⇒ Google::Apis::DocsV1::Dimension

A magnitude in a single direction in the specified units. Corresponds to the JSON property indentStart

Returns:



3576
3577
3578
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3576

def indent_start
  @indent_start
end

#keep_lines_together ⇒ Boolean Also known as: keep_lines_together?

Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. Corresponds to the JSON property keepLinesTogether

Returns:

  • (Boolean) 


3582
3583
3584
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3582

def keep_lines_together
  @keep_lines_together
end

#keep_with_next ⇒ Boolean Also known as: keep_with_next?

Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. Corresponds to the JSON property keepWithNext

Returns:

  • (Boolean) 


3590
3591
3592
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3590

def keep_with_next
  @keep_with_next
end

#line_spacing ⇒ Float

The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. Corresponds to the JSON property lineSpacing

Returns:

  • (Float) 


3597
3598
3599
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3597

def line_spacing
  @line_spacing
end

#named_style_type ⇒ String

The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. Corresponds to the JSON property namedStyleType

Returns:

  • (String) 


3604
3605
3606
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3604

def named_style_type
  @named_style_type
end

#page_break_before ⇒ Boolean Also known as: page_break_before?

Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. Corresponds to the JSON property pageBreakBefore

Returns:

  • (Boolean) 


3613
3614
3615
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3613

def page_break_before
  @page_break_before
end

#shading ⇒ Google::Apis::DocsV1::Shading

The shading of a paragraph. Corresponds to the JSON property shading

Returns:



3619
3620
3621
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3619

def shading
  @shading
end

#space_above ⇒ Google::Apis::DocsV1::Dimension

A magnitude in a single direction in the specified units. Corresponds to the JSON property spaceAbove

Returns:



3624
3625
3626
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3624

def space_above
  @space_above
end

#space_below ⇒ Google::Apis::DocsV1::Dimension

A magnitude in a single direction in the specified units. Corresponds to the JSON property spaceBelow

Returns:



3629
3630
3631
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3629

def space_below
  @space_below
end

#spacing_mode ⇒ String

The spacing mode for the paragraph. Corresponds to the JSON property spacingMode

Returns:

  • (String) 


3634
3635
3636
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3634

def spacing_mode
  @spacing_mode
end

#tab_stops ⇒ Array<Google::Apis::DocsV1::TabStop>

A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. Corresponds to the JSON property tabStops

Returns:



3640
3641
3642
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3640

def tab_stops
  @tab_stops
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3647

def update!(**args)
  @alignment = args[:alignment] if args.key?(:alignment)
  @avoid_widow_and_orphan = args[:avoid_widow_and_orphan] if args.key?(:avoid_widow_and_orphan)
  @border_between = args[:border_between] if args.key?(:border_between)
  @border_bottom = args[:border_bottom] if args.key?(:border_bottom)
  @border_left = args[:border_left] if args.key?(:border_left)
  @border_right = args[:border_right] if args.key?(:border_right)
  @border_top = args[:border_top] if args.key?(:border_top)
  @direction = args[:direction] if args.key?(:direction)
  @heading_id = args[:heading_id] if args.key?(:heading_id)
  @indent_end = args[:indent_end] if args.key?(:indent_end)
  @indent_first_line = args[:indent_first_line] if args.key?(:indent_first_line)
  @indent_start = args[:indent_start] if args.key?(:indent_start)
  @keep_lines_together = args[:keep_lines_together] if args.key?(:keep_lines_together)
  @keep_with_next = args[:keep_with_next] if args.key?(:keep_with_next)
  @line_spacing = args[:line_spacing] if args.key?(:line_spacing)
  @named_style_type = args[:named_style_type] if args.key?(:named_style_type)
  @page_break_before = args[:page_break_before] if args.key?(:page_break_before)
  @shading = args[:shading] if args.key?(:shading)
  @space_above = args[:space_above] if args.key?(:space_above)
  @space_below = args[:space_below] if args.key?(:space_below)
  @spacing_mode = args[:spacing_mode] if args.key?(:spacing_mode)
  @tab_stops = args[:tab_stops] if args.key?(:tab_stops)
end