Class: Google::Apis::DocsV1::NestingLevel

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

Contains properties describing the look and feel of a list bullet at a given level of nesting.

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

Returns a new instance of NestingLevel.



2960
2961
2962
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2960

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

Instance Attribute Details

#bullet_alignment ⇒ String

The alignment of the bullet within the space allotted for rendering the bullet. Corresponds to the JSON property bulletAlignment

Returns:

  • (String) 


2862
2863
2864
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2862

def bullet_alignment
  @bullet_alignment
end

#glyph_format ⇒ String

The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholder are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern %[nesting_level]. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern <prefix>%[nesting_level]<suffix>. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format %0. indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format %0. at nesting level 0 will result in a list with rendered glyphs

A.

B.

C. The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of %0. at nesting level 0 and a glyph format of %0.%1. at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs

1.

2.

2.1.

2.2.

3. For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list. Corresponds to the JSON property glyphFormat

Returns:

  • (String) 


2897
2898
2899
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2897

def glyph_format
  @glyph_format
end

#glyph_symbol ⇒ String

A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is %0, the rendered glyph would be the solid circle. Corresponds to the JSON property glyphSymbol

Returns:

  • (String) 


2908
2909
2910
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2908

def glyph_symbol
  @glyph_symbol
end

#glyph_type ⇒ String

The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is %0. and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder %0 in the glyph format with a number corresponding to list item's order within the list. Corresponds to the JSON property glyphType

Returns:

  • (String) 


2921
2922
2923
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2921

def glyph_type
  @glyph_type
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:



2926
2927
2928
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2926

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:



2931
2932
2933
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2931

def indent_start
  @indent_start
end

#start_number ⇒ Fixnum

The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and roman numeraled lists, i.e. for values of both 0 and 1, lettered and roman numeraled lists will begin at a and i respectively. This value is ignored for nesting levels with unordered glyphs. Corresponds to the JSON property startNumber

Returns:

  • (Fixnum) 


2940
2941
2942
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2940

def start_number
  @start_number
end

#text_style ⇒ Google::Apis::DocsV1::TextStyle

Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined:

  • The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type.
  • The TextStyle on a named style inherits from the normal text named style.
  • The TextStyle of the normal text named style inherits from the default text style in the Docs editor.
  • The TextStyle on a Paragraph element that is contained in a table may inherit its text style from the table style. If the text 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 textStyle

Returns:



2958
2959
2960
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2958

def text_style
  @text_style
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2965

def update!(**args)
  @bullet_alignment = args[:bullet_alignment] if args.key?(:bullet_alignment)
  @glyph_format = args[:glyph_format] if args.key?(:glyph_format)
  @glyph_symbol = args[:glyph_symbol] if args.key?(:glyph_symbol)
  @glyph_type = args[:glyph_type] if args.key?(:glyph_type)
  @indent_first_line = args[:indent_first_line] if args.key?(:indent_first_line)
  @indent_start = args[:indent_start] if args.key?(:indent_start)
  @start_number = args[:start_number] if args.key?(:start_number)
  @text_style = args[:text_style] if args.key?(:text_style)
end