Text

{
  "textElements": [
    {
      object (TextElement)
    }
  ],
  "lists": {
    string: {
      object (List)
    },
    ...
  }
}

object (TextElement)

The text contents broken down into its component parts, including styling information. This property is read-only.

map (key: string, value: object ( List))

The bulleted lists contained in this text, keyed by list ID.

{
  "startIndex": integer,
  "endIndex": integer,

  // Union field kind can be only one of the following:
  "paragraphMarker": {
    object (ParagraphMarker)
  },
  "textRun": {
    object (TextRun)
  },
  "autoText": {
    object (AutoText)
  }
  // End of list of possible types for union field kind.
}

integer

The zero-based start index of this text element, in Unicode code units.

integer

The zero-based end index of this text element, exclusive, in Unicode code units.

object (ParagraphMarker)

A marker representing the beginning of a new paragraph.

The startIndex and endIndex of this TextElement represent the range of the paragraph. Other TextElements with an index range contained inside this paragraph's range are considered to be part of this paragraph. The range of indices of two separate paragraphs will never overlap.

object (TextRun)

A TextElement representing a run of text where all of the characters in the run have the same TextStyle.

The startIndex and endIndex of TextRuns will always be fully contained in the index range of a single paragraphMarker TextElement. In other words, a TextRun will never span multiple paragraphs.

object (AutoText)

A TextElement representing a spot in the text that is dynamically replaced with content that can change over time.

{
  "style": {
    object (ParagraphStyle)
  },
  "bullet": {
    object (Bullet)
  }
}

object (ParagraphStyle)

The paragraph's style

object (Bullet)

The bullet for this paragraph. If not present, the paragraph does not belong to a list.

{
  "lineSpacing": number,
  "alignment": enum (Alignment),
  "indentStart": {
    object (Dimension)
  },
  "indentEnd": {
    object (Dimension)
  },
  "spaceAbove": {
    object (Dimension)
  },
  "spaceBelow": {
    object (Dimension)
  },
  "indentFirstLine": {
    object (Dimension)
  },
  "direction": enum (TextDirection),
  "spacingMode": enum (SpacingMode)
}

number

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.

enum (Alignment)

The text alignment for this paragraph.

object (Dimension)

The amount indentation for the paragraph on the side that corresponds to the start of the text, based on the current text direction. If unset, the value is inherited from the parent.

object (Dimension)

The amount indentation for the paragraph on the side that corresponds to the end of the text, based on the current text direction. If unset, the value is inherited from the parent.

object (Dimension)

The amount of extra space above the paragraph. If unset, the value is inherited from the parent.

object (Dimension)

The amount of extra space below the paragraph. If unset, the value is inherited from the parent.

object (Dimension)

The amount of indentation for the start of the first line of the paragraph. If unset, the value is inherited from the parent.

enum (TextDirection)

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

enum (SpacingMode)

The spacing mode for the paragraph.

{
  "listId": string,
  "nestingLevel": integer,
  "glyph": string,
  "bulletStyle": {
    object (TextStyle)
  }
}

string

The ID of the list this paragraph belongs to.

integer

The nesting level of this paragraph in the list.

string

The rendered bullet glyph for this paragraph.

object (TextStyle)

The paragraph specific text style applied to this bullet.

{
  "backgroundColor": {
    object (OptionalColor)
  },
  "foregroundColor": {
    object (OptionalColor)
  },
  "bold": boolean,
  "italic": boolean,
  "fontFamily": string,
  "fontSize": {
    object (Dimension)
  },
  "link": {
    object (Link)
  },
  "baselineOffset": enum (BaselineOffset),
  "smallCaps": boolean,
  "strikethrough": boolean,
  "underline": boolean,
  "weightedFontFamily": {
    object (WeightedFontFamily)
  }
}

object (OptionalColor)

The background color of the text. If set, the color is either opaque or transparent, depending on if the opaqueColor field in it is set.

object (OptionalColor)

The color of the text itself. If set, the color is either opaque or transparent, depending on if the opaqueColor field in it is set.

boolean

Whether or not the text is rendered as bold.

boolean

Whether or not the text is italicized.

string

The font family of the text.

The font family can be any font from the Font menu in Slides or from Google Fonts. If the font name is unrecognized, the text is rendered in Arial.

Some fonts can affect the weight of the text. If an update request specifies values for both fontFamily and bold, the explicitly-set bold value is used.

object (Dimension)

The size of the text's font. When read, the fontSize will specified in points.

object (Link)

The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text.

Changing the link in an update request causes some other changes to the text style of the range:

• When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults.
• Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL.
• Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as "ABC\n123", will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline.
• Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.

enum (BaselineOffset)

The text's vertical offset from its normal position.

Text with SUPERSCRIPT or SUBSCRIPT baseline offsets is automatically rendered in a smaller font size, computed based on the fontSize field. The fontSize itself is not affected by changes in this field.

boolean

Whether or not the text is in small capital letters.

boolean

Whether or not the text is struck through.

boolean

Whether or not the text is underlined.

object (WeightedFontFamily)

The font family and rendered weight of the text.

This field is an extension of fontFamily meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of weightedFontFamily#fontFamily will always be equal to that of fontFamily. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard "*"), their values are reconciled as follows:

• If fontFamily is set and weightedFontFamily is not, the value of fontFamily is applied with weight 400 ("normal").
• If both fields are set, the value of fontFamily must match that of weightedFontFamily#fontFamily. If so, the font family and weight of weightedFontFamily is applied. Otherwise, a 400 bad request error is returned.
• If weightedFontFamily is set and fontFamily is not, the font family and weight of weightedFontFamily is applied.
• If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other.

If an update request specifies values for both weightedFontFamily and bold, the weightedFontFamily is applied first, then bold.

If weightedFontFamily#weight is not set, it defaults to 400.

If weightedFontFamily is set, then weightedFontFamily#fontFamily must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.

{
  "opaqueColor": {
    object (OpaqueColor)
  }
}

object (OpaqueColor)

If set, this will be used as an opaque color. If unset, this represents a transparent color.

{
  "fontFamily": string,
  "weight": integer
}

string

The font family of the text.

The font family can be any font from the Font menu in Slides or from Google Fonts. If the font name is unrecognized, the text is rendered in Arial.

integer

The rendered weight of the text. This field can have any value that is a multiple of 100 between 100 and 900, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, section 15.6, with non-numerical values disallowed. Weights greater than or equal to 700 are considered bold, and weights less than 700 are not bold. The default value is 400 ("normal").

{
  "content": string,
  "style": {
    object (TextStyle)
  }
}

string

The text of this run.

object (TextStyle)

The styling applied to this run.

{
  "type": enum (Type),
  "content": string,
  "style": {
    object (TextStyle)
  }
}

enum (Type)

The type of this auto text.

string

The rendered content of this auto text, if available.

object (TextStyle)

The styling applied to this auto text.

{
  "listId": string,
  "nestingLevel": {
    integer: {
      object (NestingLevel)
    },
    ...
  }
}

string

The ID of the list.

map (key: integer, value: object ( NestingLevel))

A map of nesting levels to the properties of bullets at the associated level. A list has at most nine levels of nesting, so the possible values for the keys of this map are 0 through 8, inclusive.

{
  "bulletStyle": {
    object (TextStyle)
  }
}

object (TextStyle)

The style of a bullet at this level of nesting.