google_api_docs v0.8.0 GoogleApi.Docs.V1.Model.ParagraphStyle View Source

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.

Attributes

  • alignment (type: String.t, default: nil) - The text alignment for this paragraph.

  • avoidWidowAndOrphan (type: boolean(), default: nil) - Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.

  • borderBetween (type: GoogleApi.Docs.V1.Model.ParagraphBorder.t, default: nil) - The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent.

    The between border is rendered when the adjacent paragraph has the same border and indent properties.

    Paragraph borders cannot be partially updated. When making changes to a paragraph border the new border must be specified in its entirety.

  • borderBottom (type: GoogleApi.Docs.V1.Model.ParagraphBorder.t, default: nil) - The border at the bottom of this paragraph. If unset, the value is inherited from the parent.

    The bottom border is rendered when the paragraph below has different border and indent properties.

    Paragraph borders cannot be partially updated. When making changes to a paragraph border the new border must be specified in its entirety.

  • borderLeft (type: GoogleApi.Docs.V1.Model.ParagraphBorder.t, default: nil) - The border to the left of this paragraph. If unset, the value is inherited from the parent.

    Paragraph borders cannot be partially updated. When making changes to a paragraph border the new border must be specified in its entirety.

  • borderRight (type: GoogleApi.Docs.V1.Model.ParagraphBorder.t, default: nil) - The border to the right of this paragraph. If unset, the value is inherited from the parent.

    Paragraph borders cannot be partially updated. When making changes to a paragraph border the new border must be specified in its entirety.

  • borderTop (type: GoogleApi.Docs.V1.Model.ParagraphBorder.t, default: nil) - The border at the top of this paragraph. If unset, the value is inherited from the parent.

    The top border is rendered when the paragraph above has different border and indent properties.

    Paragraph borders cannot be partially updated. When making changes to a paragraph border the new border must be specified in its entirety.

  • direction (type: String.t, default: nil) - The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.

  • headingId (type: String.t, default: nil) - The heading ID of the paragraph. If empty, then this paragraph is not a heading.

    This property is read-only.

  • indentEnd (type: GoogleApi.Docs.V1.Model.Dimension.t, default: nil) - The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.

  • indentFirstLine (type: GoogleApi.Docs.V1.Model.Dimension.t, default: nil) - The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.

  • indentStart (type: GoogleApi.Docs.V1.Model.Dimension.t, default: nil) - The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.

  • keepLinesTogether (type: boolean(), default: nil) - 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.

  • keepWithNext (type: boolean(), default: nil) - 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.

  • lineSpacing (type: number(), default: nil) - 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.

  • namedStyleType (type: String.t, default: nil) - 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.

  • shading (type: GoogleApi.Docs.V1.Model.Shading.t, default: nil) - The shading of the paragraph. If unset, the value is inherited from the parent.

  • spaceAbove (type: GoogleApi.Docs.V1.Model.Dimension.t, default: nil) - The amount of extra space above the paragraph. If unset, the value is inherited from the parent.

  • spaceBelow (type: GoogleApi.Docs.V1.Model.Dimension.t, default: nil) - The amount of extra space below the paragraph. If unset, the value is inherited from the parent.

  • spacingMode (type: String.t, default: nil) - The spacing mode for the paragraph.

  • tabStops (type: list(GoogleApi.Docs.V1.Model.TabStop.t), default: nil) - A list of the tab stops for this paragraph. The list of tab stops is not inherited.

    This property is read-only.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t()

View Source
t() :: %GoogleApi.Docs.V1.Model.ParagraphStyle{
  alignment: String.t(),
  avoidWidowAndOrphan: boolean(),
  borderBetween: GoogleApi.Docs.V1.Model.ParagraphBorder.t(),
  borderBottom: GoogleApi.Docs.V1.Model.ParagraphBorder.t(),
  borderLeft: GoogleApi.Docs.V1.Model.ParagraphBorder.t(),
  borderRight: GoogleApi.Docs.V1.Model.ParagraphBorder.t(),
  borderTop: GoogleApi.Docs.V1.Model.ParagraphBorder.t(),
  direction: String.t(),
  headingId: String.t(),
  indentEnd: GoogleApi.Docs.V1.Model.Dimension.t(),
  indentFirstLine: GoogleApi.Docs.V1.Model.Dimension.t(),
  indentStart: GoogleApi.Docs.V1.Model.Dimension.t(),
  keepLinesTogether: boolean(),
  keepWithNext: boolean(),
  lineSpacing: number(),
  namedStyleType: String.t(),
  shading: GoogleApi.Docs.V1.Model.Shading.t(),
  spaceAbove: GoogleApi.Docs.V1.Model.Dimension.t(),
  spaceBelow: GoogleApi.Docs.V1.Model.Dimension.t(),
  spacingMode: String.t(),
  tabStops: [GoogleApi.Docs.V1.Model.TabStop.t()]
}

Link to this section Functions

Link to this function

decode(value, options)

View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.