Class: Google::Apis::DocsV1::ParagraphStyle
- Inherits:
-
Object
- Object
- Google::Apis::DocsV1::ParagraphStyle
- 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
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.
Instance Attribute Summary collapse
-
#alignment ⇒ String
The text alignment for this paragraph.
-
#avoid_widow_and_orphan ⇒ Boolean
(also: #avoid_widow_and_orphan?)
Whether to avoid widows and orphans for the paragraph.
-
#border_between ⇒ Google::Apis::DocsV1::ParagraphBorder
A border around a paragraph.
-
#border_bottom ⇒ Google::Apis::DocsV1::ParagraphBorder
A border around a paragraph.
-
#border_left ⇒ Google::Apis::DocsV1::ParagraphBorder
A border around a paragraph.
-
#border_right ⇒ Google::Apis::DocsV1::ParagraphBorder
A border around a paragraph.
-
#border_top ⇒ Google::Apis::DocsV1::ParagraphBorder
A border around a paragraph.
-
#direction ⇒ String
The text direction of this paragraph.
-
#heading_id ⇒ String
The heading ID of the paragraph.
-
#indent_end ⇒ Google::Apis::DocsV1::Dimension
A magnitude in a single direction in the specified units.
-
#indent_first_line ⇒ Google::Apis::DocsV1::Dimension
A magnitude in a single direction in the specified units.
-
#indent_start ⇒ Google::Apis::DocsV1::Dimension
A magnitude in a single direction in the specified units.
-
#keep_lines_together ⇒ Boolean
(also: #keep_lines_together?)
Whether all lines of the paragraph should be laid out on the same page or column if possible.
-
#keep_with_next ⇒ Boolean
(also: #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.
-
#line_spacing ⇒ Float
The amount of space between lines, as a percentage of normal, where normal is represented as 100.0.
-
#named_style_type ⇒ String
The named style type of the paragraph.
-
#shading ⇒ Google::Apis::DocsV1::Shading
The shading of a paragraph.
-
#space_above ⇒ Google::Apis::DocsV1::Dimension
A magnitude in a single direction in the specified units.
-
#space_below ⇒ Google::Apis::DocsV1::Dimension
A magnitude in a single direction in the specified units.
-
#spacing_mode ⇒ String
The spacing mode for the paragraph.
-
#tab_stops ⇒ Array<Google::Apis::DocsV1::TabStop>
A list of the tab stops for this paragraph.
Instance Method Summary collapse
-
#initialize(**args) ⇒ ParagraphStyle
constructor
A new instance of ParagraphStyle.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ ParagraphStyle
Returns a new instance of ParagraphStyle
3198 3199 3200 |
# File 'generated/google/apis/docs_v1/classes.rb', line 3198 def initialize(**args) update!(**args) end |
Instance Attribute Details
#alignment ⇒ String
The text alignment for this paragraph.
Corresponds to the JSON property alignment
3079 3080 3081 |
# File 'generated/google/apis/docs_v1/classes.rb', line 3079 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
3085 3086 3087 |
# File 'generated/google/apis/docs_v1/classes.rb', line 3085 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
3091 3092 3093 |
# File 'generated/google/apis/docs_v1/classes.rb', line 3091 def border_between @border_between end |
#border_bottom ⇒ Google::Apis::DocsV1::ParagraphBorder
A border around a paragraph.
Corresponds to the JSON property borderBottom
3096 3097 3098 |
# File 'generated/google/apis/docs_v1/classes.rb', line 3096 def border_bottom @border_bottom end |
#border_left ⇒ Google::Apis::DocsV1::ParagraphBorder
A border around a paragraph.
Corresponds to the JSON property borderLeft
3101 3102 3103 |
# File 'generated/google/apis/docs_v1/classes.rb', line 3101 def border_left @border_left end |
#border_right ⇒ Google::Apis::DocsV1::ParagraphBorder
A border around a paragraph.
Corresponds to the JSON property borderRight
3106 3107 3108 |
# File 'generated/google/apis/docs_v1/classes.rb', line 3106 def border_right @border_right end |
#border_top ⇒ Google::Apis::DocsV1::ParagraphBorder
A border around a paragraph.
Corresponds to the JSON property borderTop
3111 3112 3113 |
# File 'generated/google/apis/docs_v1/classes.rb', line 3111 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
3118 3119 3120 |
# File 'generated/google/apis/docs_v1/classes.rb', line 3118 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
3125 3126 3127 |
# File 'generated/google/apis/docs_v1/classes.rb', line 3125 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
3130 3131 3132 |
# File 'generated/google/apis/docs_v1/classes.rb', line 3130 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
3135 3136 3137 |
# File 'generated/google/apis/docs_v1/classes.rb', line 3135 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
3140 3141 3142 |
# File 'generated/google/apis/docs_v1/classes.rb', line 3140 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
3146 3147 3148 |
# File 'generated/google/apis/docs_v1/classes.rb', line 3146 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
3154 3155 3156 |
# File 'generated/google/apis/docs_v1/classes.rb', line 3154 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
3161 3162 3163 |
# File 'generated/google/apis/docs_v1/classes.rb', line 3161 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
3169 3170 3171 |
# File 'generated/google/apis/docs_v1/classes.rb', line 3169 def named_style_type @named_style_type end |
#shading ⇒ Google::Apis::DocsV1::Shading
The shading of a paragraph.
Corresponds to the JSON property shading
3174 3175 3176 |
# File 'generated/google/apis/docs_v1/classes.rb', line 3174 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
3179 3180 3181 |
# File 'generated/google/apis/docs_v1/classes.rb', line 3179 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
3184 3185 3186 |
# File 'generated/google/apis/docs_v1/classes.rb', line 3184 def space_below @space_below end |
#spacing_mode ⇒ String
The spacing mode for the paragraph.
Corresponds to the JSON property spacingMode
3189 3190 3191 |
# File 'generated/google/apis/docs_v1/classes.rb', line 3189 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
3196 3197 3198 |
# File 'generated/google/apis/docs_v1/classes.rb', line 3196 def tab_stops @tab_stops end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 |
# File 'generated/google/apis/docs_v1/classes.rb', line 3203 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) @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 |