div-text

Text.

JSON

{
  type*: "text",
  accessibility: {
    description: "string",
    hint: "string",
    mode: "string",
    mute_after_action: "bool_int",
    state_description: "string",
    type: "string"
  },
  action: {
    download_callbacks: {
      on_fail_actions: [ div-action, ... ],
      on_success_actions: [ div-action, ... ]
    },
    is_enabled: "bool_int",
    log_id*: "string",
    log_url: "string",
    menu_items: [
      {
        action: div-action,
        actions: [ div-action, ... ],
        text*: "string"
      },
      ...
    ],
    payload: "object",
    referer: "string",
    target: "string",
    typed: div-action-typed,
    url: "string"
  },
  action_animation: {
    duration: "int",
    end_value: "number",
    interpolator: "string",
    items: [ div-animation, ... ],
    name*: "string",
    repeat: div-count,
    start_delay: "int",
    start_value: "number"
  },
  actions: [
    {
      download_callbacks: {
        on_fail_actions: [ div-action, ... ],
        on_success_actions: [ div-action, ... ]
      },
      is_enabled: "bool_int",
      log_id*: "string",
      log_url: "string",
      menu_items: [
        {
          action: div-action,
          actions: [ div-action, ... ],
          text*: "string"
        },
        ...
      ],
      payload: "object",
      referer: "string",
      target: "string",
      typed: div-action-typed,
      url: "string"
    },
    ...
  ],
  alignment_horizontal: "string",
  alignment_vertical: "string",
  alpha: "number",
  auto_ellipsize: "bool_int",
  background: [ div-background, ... ],
  border: {
    corner_radius: "int",
    corners_radius: {
      bottom-left: "int",
      bottom-right: "int",
      top-left: "int",
      top-right: "int"
    },
    has_shadow: "bool_int",
    shadow: {
      alpha: "number",
      blur: "int",
      color: "string",
      offset*: {
        x*: {
          unit: "string",
          value*: "number"
        },
        y*: {
          unit: "string",
          value*: "number"
        }
      }
    },
    stroke: {
      color*: "string",
      unit: "string",
      width: "int"
    }
  },
  column_span: "int",
  disappear_actions: [
    {
      disappear_duration: "int",
      download_callbacks: {
        on_fail_actions: [
          {
            download_callbacks: div-download-callbacks,
            is_enabled: "bool_int",
            log_id*: "string",
            log_url: "string",
            menu_items: [
              {
                action: div-action,
                actions: [ div-action, ... ],
                text*: "string"
              },
              ...
            ],
            payload: "object",
            referer: "string",
            target: "string",
            typed: div-action-typed,
            url: "string"
          },
          ...
        ],
        on_success_actions: [
          {
            download_callbacks: div-download-callbacks,
            is_enabled: "bool_int",
            log_id*: "string",
            log_url: "string",
            menu_items: [
              {
                action: div-action,
                actions: [ div-action, ... ],
                text*: "string"
              },
              ...
            ],
            payload: "object",
            referer: "string",
            target: "string",
            typed: div-action-typed,
            url: "string"
          },
          ...
        ]
      },
      is_enabled: "bool_int",
      log_id*: "string",
      log_limit: "int",
      payload: "object",
      referer: "string",
      typed: div-action-typed,
      url: "string",
      visibility_percentage: "int"
    },
    ...
  ],
  doubletap_actions: [
    {
      download_callbacks: {
        on_fail_actions: [ div-action, ... ],
        on_success_actions: [ div-action, ... ]
      },
      is_enabled: "bool_int",
      log_id*: "string",
      log_url: "string",
      menu_items: [
        {
          action: div-action,
          actions: [ div-action, ... ],
          text*: "string"
        },
        ...
      ],
      payload: "object",
      referer: "string",
      target: "string",
      typed: div-action-typed,
      url: "string"
    },
    ...
  ],
  ellipsis: {
    actions: [
      {
        download_callbacks: {
          on_fail_actions: [ div-action, ... ],
          on_success_actions: [ div-action, ... ]
        },
        is_enabled: "bool_int",
        log_id*: "string",
        log_url: "string",
        menu_items: [
          {
            action: div-action,
            actions: [ div-action, ... ],
            text*: "string"
          },
          ...
        ],
        payload: "object",
        referer: "string",
        target: "string",
        typed: div-action-typed,
        url: "string"
      },
      ...
    ],
    images: [
      {
        height: {
          type*: "fixed",
          unit: "string",
          value*: "int"
        },
        preload_required: "bool_int",
        start*: "int",
        tint_color: "string",
        tint_mode: "string",
        url*: "string",
        width: {
          type*: "fixed",
          unit: "string",
          value*: "int"
        }
      },
      ...
    ],
    ranges: [
      {
        actions: [
          {
            download_callbacks: {
              on_fail_actions: [ div-action, ... ],
              on_success_actions: [ div-action, ... ]
            },
            is_enabled: "bool_int",
            log_id*: "string",
            log_url: "string",
            menu_items: [
              {
                action: div-action,
                actions: [ div-action, ... ],
                text*: "string"
              },
              ...
            ],
            payload: "object",
            referer: "string",
            target: "string",
            typed: div-action-typed,
            url: "string"
          },
          ...
        ],
        background: div-text-range-background,
        border: {
          corner_radius: "int",
          stroke: {
            color*: "string",
            unit: "string",
            width: "int"
          }
        },
        end*: "int",
        font_family: "string",
        font_size: "int",
        font_size_unit: "string",
        font_weight: "string",
        letter_spacing: "number",
        line_height: "int",
        start*: "int",
        strike: "string",
        text_color: "string",
        text_shadow: {
          alpha: "number",
          blur: "int",
          color: "string",
          offset*: {
            x*: {
              unit: "string",
              value*: "number"
            },
            y*: {
              unit: "string",
              value*: "number"
            }
          }
        },
        top_offset: "int",
        underline: "string"
      },
      ...
    ],
    text*: "string"
  },
  extensions: [
    {
      id*: "string",
      params: "object"
    },
    ...
  ],
  focus: {
    background: [ div-background, ... ],
    border: {
      corner_radius: "int",
      corners_radius: {
        bottom-left: "int",
        bottom-right: "int",
        top-left: "int",
        top-right: "int"
      },
      has_shadow: "bool_int",
      shadow: {
        alpha: "number",
        blur: "int",
        color: "string",
        offset*: {
          x*: {
            unit: "string",
            value*: "number"
          },
          y*: {
            unit: "string",
            value*: "number"
          }
        }
      },
      stroke: {
        color*: "string",
        unit: "string",
        width: "int"
      }
    },
    next_focus_ids: {
      down: "string",
      forward: "string",
      left: "string",
      right: "string",
      up: "string"
    },
    on_blur: [
      {
        download_callbacks: {
          on_fail_actions: [ div-action, ... ],
          on_success_actions: [ div-action, ... ]
        },
        is_enabled: "bool_int",
        log_id*: "string",
        log_url: "string",
        menu_items: [
          {
            action: div-action,
            actions: [ div-action, ... ],
            text*: "string"
          },
          ...
        ],
        payload: "object",
        referer: "string",
        target: "string",
        typed: div-action-typed,
        url: "string"
      },
      ...
    ],
    on_focus: [
      {
        download_callbacks: {
          on_fail_actions: [ div-action, ... ],
          on_success_actions: [ div-action, ... ]
        },
        is_enabled: "bool_int",
        log_id*: "string",
        log_url: "string",
        menu_items: [
          {
            action: div-action,
            actions: [ div-action, ... ],
            text*: "string"
          },
          ...
        ],
        payload: "object",
        referer: "string",
        target: "string",
        typed: div-action-typed,
        url: "string"
      },
      ...
    ]
  },
  focused_text_color: "string",
  font_family: "string",
  font_size: "int",
  font_size_unit: "string",
  font_weight: "string",
  height: div-size,
  id: "string",
  images: [
    {
      height: {
        type*: "fixed",
        unit: "string",
        value*: "int"
      },
      preload_required: "bool_int",
      start*: "int",
      tint_color: "string",
      tint_mode: "string",
      url*: "string",
      width: {
        type*: "fixed",
        unit: "string",
        value*: "int"
      }
    },
    ...
  ],
  letter_spacing: "number",
  line_height: "int",
  longtap_actions: [
    {
      download_callbacks: {
        on_fail_actions: [ div-action, ... ],
        on_success_actions: [ div-action, ... ]
      },
      is_enabled: "bool_int",
      log_id*: "string",
      log_url: "string",
      menu_items: [
        {
          action: div-action,
          actions: [ div-action, ... ],
          text*: "string"
        },
        ...
      ],
      payload: "object",
      referer: "string",
      target: "string",
      typed: div-action-typed,
      url: "string"
    },
    ...
  ],
  margins: {
    bottom: "int",
    end: "int",
    left: "int",
    right: "int",
    start: "int",
    top: "int",
    unit: "string"
  },
  max_lines: "int",
  min_hidden_lines: "int",
  paddings: {
    bottom: "int",
    end: "int",
    left: "int",
    right: "int",
    start: "int",
    top: "int",
    unit: "string"
  },
  ranges: [
    {
      actions: [
        {
          download_callbacks: {
            on_fail_actions: [ div-action, ... ],
            on_success_actions: [ div-action, ... ]
          },
          is_enabled: "bool_int",
          log_id*: "string",
          log_url: "string",
          menu_items: [
            {
              action: div-action,
              actions: [ div-action, ... ],
              text*: "string"
            },
            ...
          ],
          payload: "object",
          referer: "string",
          target: "string",
          typed: div-action-typed,
          url: "string"
        },
        ...
      ],
      background: div-text-range-background,
      border: {
        corner_radius: "int",
        stroke: {
          color*: "string",
          unit: "string",
          width: "int"
        }
      },
      end*: "int",
      font_family: "string",
      font_size: "int",
      font_size_unit: "string",
      font_weight: "string",
      letter_spacing: "number",
      line_height: "int",
      start*: "int",
      strike: "string",
      text_color: "string",
      text_shadow: {
        alpha: "number",
        blur: "int",
        color: "string",
        offset*: {
          x*: {
            unit: "string",
            value*: "number"
          },
          y*: {
            unit: "string",
            value*: "number"
          }
        }
      },
      top_offset: "int",
      underline: "string"
    },
    ...
  ],
  row_span: "int",
  selectable: "bool_int",
  selected_actions: [
    {
      download_callbacks: {
        on_fail_actions: [ div-action, ... ],
        on_success_actions: [ div-action, ... ]
      },
      is_enabled: "bool_int",
      log_id*: "string",
      log_url: "string",
      menu_items: [
        {
          action: div-action,
          actions: [ div-action, ... ],
          text*: "string"
        },
        ...
      ],
      payload: "object",
      referer: "string",
      target: "string",
      typed: div-action-typed,
      url: "string"
    },
    ...
  ],
  strike: "string",
  text*: "string",
  text_alignment_horizontal: "string",
  text_alignment_vertical: "string",
  text_color: "string",
  text_gradient: div-text-gradient,
  text_shadow: {
    alpha: "number",
    blur: "int",
    color: "string",
    offset*: {
      x*: {
        unit: "string",
        value*: "number"
      },
      y*: {
        unit: "string",
        value*: "number"
      }
    }
  },
  tooltips: [
    {
      animation_in: {
        duration: "int",
        end_value: "number",
        interpolator: "string",
        items: [ div-animation, ... ],
        name*: "string",
        repeat: div-count,
        start_delay: "int",
        start_value: "number"
      },
      animation_out: {
        duration: "int",
        end_value: "number",
        interpolator: "string",
        items: [ div-animation, ... ],
        name*: "string",
        repeat: div-count,
        start_delay: "int",
        start_value: "number"
      },
      div*: div,
      duration: "int",
      id*: "string",
      offset: {
        x*: {
          unit: "string",
          value*: "number"
        },
        y*: {
          unit: "string",
          value*: "number"
        }
      },
      position*: "string"
    },
    ...
  ],
  transform: {
    pivot_x: div-pivot,
    pivot_y: div-pivot,
    rotation: "number"
  },
  transition_change: div-change-transition,
  transition_in: div-appearance-transition,
  transition_out: div-appearance-transition,
  transition_triggers: [ "string", ... ],
  truncate: "string",
  underline: "string",
  visibility: "string",
  visibility_action: {
    download_callbacks: {
      on_fail_actions: [
        {
          download_callbacks: div-download-callbacks,
          is_enabled: "bool_int",
          log_id*: "string",
          log_url: "string",
          menu_items: [
            {
              action: div-action,
              actions: [ div-action, ... ],
              text*: "string"
            },
            ...
          ],
          payload: "object",
          referer: "string",
          target: "string",
          typed: div-action-typed,
          url: "string"
        },
        ...
      ],
      on_success_actions: [
        {
          download_callbacks: div-download-callbacks,
          is_enabled: "bool_int",
          log_id*: "string",
          log_url: "string",
          menu_items: [
            {
              action: div-action,
              actions: [ div-action, ... ],
              text*: "string"
            },
            ...
          ],
          payload: "object",
          referer: "string",
          target: "string",
          typed: div-action-typed,
          url: "string"
        },
        ...
      ]
    },
    is_enabled: "bool_int",
    log_id*: "string",
    log_limit: "int",
    payload: "object",
    referer: "string",
    typed: div-action-typed,
    url: "string",
    visibility_duration: "int",
    visibility_percentage: "int"
  },
  visibility_actions: [
    {
      download_callbacks: {
        on_fail_actions: [
          {
            download_callbacks: div-download-callbacks,
            is_enabled: "bool_int",
            log_id*: "string",
            log_url: "string",
            menu_items: [
              {
                action: div-action,
                actions: [ div-action, ... ],
                text*: "string"
              },
              ...
            ],
            payload: "object",
            referer: "string",
            target: "string",
            typed: div-action-typed,
            url: "string"
          },
          ...
        ],
        on_success_actions: [
          {
            download_callbacks: div-download-callbacks,
            is_enabled: "bool_int",
            log_id*: "string",
            log_url: "string",
            menu_items: [
              {
                action: div-action,
                actions: [ div-action, ... ],
                text*: "string"
              },
              ...
            ],
            payload: "object",
            referer: "string",
            target: "string",
            typed: div-action-typed,
            url: "string"
          },
          ...
        ]
      },
      is_enabled: "bool_int",
      log_id*: "string",
      log_limit: "int",
      payload: "object",
      referer: "string",
      typed: div-action-typed,
      url: "string",
      visibility_duration: "int",
      visibility_percentage: "int"
    },
    ...
  ],
  width: div-size
}

Parameters

ParametersDescription
accessibility

object

Accessibility settings.

The value has the type div-accessibility.

action

object

One action when clicking on an element. Not used if the actions parameter is set.

The value has the type div-action.

action_animation

object

Click animation. The web only supports the following values: fade, scale, native, no_animation and set.

The value has the type div-animation.

Default value: {"name": "fade", "start_value": 1, "end_value": 0.6, "duration": 100 }.

actions

array

Multiple actions when clicking on an element.

An array must not be empty.

alignment_horizontal

string

Horizontal alignment of an element inside the parent element.

Possible values: left, center, right, start, end.

alignment_vertical

string

Vertical alignment of an element inside the parent element.

Possible values: top, center, bottom, baseline.

alpha

number

Sets transparency of the entire element: 0 — completely transparent, 1 — opaque.

Restriction for the value x: x >= 0.0 && x <= 1.0.

Default value: 1.0.

auto_ellipsize

bool_int

Automatic text cropping to fit the container size.

Available platforms: Android, web.

background

array

Element background. It can contain multiple layers.

An array must not be empty.

border

object

Element stroke.

The value has the type div-border.

column_span

int

Merges cells in a column of the grid element.

Restriction for the value x: x >= 0.

disappear_actions

array

Actions when an element disappears from the screen.

An array must not be empty.

doubletap_actions

array

Action when double-clicking on an element.

An array must not be empty.

ellipsis

object

Text cropping marker. It is displayed when text size exceeds the limit on the number of lines.

The value has the type ellipsis.

Available platforms: Android, iOS.

extensions

array

Extensions for additional processing of an element. The list of extensions is given in DivExtension.

An array must not be empty.

focus

object

Parameters when focusing on an element or losing focus.

The value has the type div-focus.

focused_text_color

string

Text color when focusing on the element.

Valid formats: #RGB, #ARGB, #RRGGBB, #AARRGGBB.

Available platforms: Android, web.

font_family

string

Font family:
  • text — a standard text font;
  • display — a family of fonts with a large font size.
  • font_size

    int

    Font size.

    Restriction for the value x: x >= 0.

    Default value: 12.

    font_size_unit

    string

    Possible values: dp, sp, px.

    Default value: sp.

    Available platforms: Android, iOS.

    font_weight

    string

    Style.

    Possible values: light, medium, regular, bold.

    Default value: regular.

    height

    object

    Element height. For Android: if there is text in this or in a child element, specify height in sp to scale the element together with the text. To learn more about units of size measurement, see Layout inside the card.

    The value has the type div-size.

    Default value: {"type": "wrap_content"}.

    id

    string

    Element ID. It must be unique within the root element. It is used as accessibilityIdentifier on iOS.

    images

    array

    Images embedded in text.

    An array must not be empty.

    letter_spacing

    number

    Spacing between characters.

    Default value: 0.

    line_height

    int

    Line spacing of the text.

    Restriction for the value x: x >= 0.

    longtap_actions

    array

    Action when long-clicking an element. Doesn't work on devices that don't support touch gestures.

    An array must not be empty.

    margins

    object

    External margins from the element stroke.

    The value has the type div-edge-insets.

    max_lines

    int

    Maximum number of lines not to be cropped when breaking the limits.

    Restriction for the value x: x >= 0.

    min_hidden_lines

    int

    Minimum number of cropped lines when breaking the limits.

    Restriction for the value x: x >= 0.

    Available platforms: Android, iOS.

    paddings

    object

    Internal margins from the element stroke.

    The value has the type div-edge-insets.

    ranges

    array

    A character range in which additional style parameters can be set. Defined by mandatory start and end fields.

    An array must not be empty.

    row_span

    int

    Merges cells in a string of the grid element.

    Restriction for the value x: x >= 0.

    selectable

    bool_int

    Ability to select and copy text.

    Default value: false.

    selected_actions

    array

    List of actions to be executed when selecting an element in pager.

    An array must not be empty.

    strike

    string

    Strikethrough.

    Possible values: none, single.

    Default value: none.

    text

    string

    Required parameter.

    Text.

    text_alignment_horizontal

    string

    Horizontal text alignment.

    Possible values: left, center, right, start, end.

    Default value: start.

    text_alignment_vertical

    string

    Vertical text alignment.

    Possible values: top, center, bottom, baseline.

    Default value: top.

    text_color

    string

    Text color. Not used if the text_gradient parameter is set.

    Valid formats: #RGB, #ARGB, #RRGGBB, #AARRGGBB.

    Default value: #FF000000.

    text_gradient

    object

    Gradient text color.

    The value has the type div-text-gradient.

    text_shadow

    object

    Parameters of the shadow applied to the text.

    The value has the type div-shadow.

    Available platforms: Android, web.

    tooltips

    array

    Tooltips linked to an element. A tooltip can be shown by div-action://show_tooltip?id=, hidden by div-action://hide_tooltip?id= where id — tooltip id.

    An array must not be empty.

    transform

    object

    Applies the passed transformation to the element. Content that doesn't fit into the original view area is cut off.

    The value has the type div-transform.

    transition_change

    object

    Change animation. It is played when the position or size of an element changes in the new layout.

    The value has the type div-change-transition.

    transition_in

    object

    Appearance animation. It is played when an element with a new ID appears. To learn more about the concept of transitions, see Animated transitions.

    The value has the type div-appearance-transition.

    transition_out

    object

    Disappearance animation. It is played when an element disappears in the new layout.

    The value has the type div-appearance-transition.

    transition_triggers

    array

    Animation starting triggers. Default value: [state_change, visibility_change].

    An array must not be empty.

    truncate

    string

    Parameter is deprecated.

    Text cropping method. Use ellipsis instead.

    Possible values: none, start, end, middle.

    Default value: end.

    type

    string

    Required parameter.

    The value must always be text.

    underline

    string

    Underline.

    Possible values: none, single.

    Default value: none.

    visibility

    string

    Element visibility.

    Possible values: visible, invisible, gone.

    Default value: visible.

    visibility_action

    object

    Tracking visibility of a single element. Not used if the visibility_actions parameter is set.

    The value has the type div-visibility-action.

    visibility_actions

    array

    Actions when an element appears on the screen.

    An array must not be empty.

    width

    object

    Element width.

    The value has the type div-size.

    Default value: {"type": "match_parent"}.

    ParametersDescription
    accessibility

    object

    Accessibility settings.

    The value has the type div-accessibility.

    action

    object

    One action when clicking on an element. Not used if the actions parameter is set.

    The value has the type div-action.

    action_animation

    object

    Click animation. The web only supports the following values: fade, scale, native, no_animation and set.

    The value has the type div-animation.

    Default value: {"name": "fade", "start_value": 1, "end_value": 0.6, "duration": 100 }.

    actions

    array

    Multiple actions when clicking on an element.

    An array must not be empty.

    alignment_horizontal

    string

    Horizontal alignment of an element inside the parent element.

    Possible values: left, center, right, start, end.

    alignment_vertical

    string

    Vertical alignment of an element inside the parent element.

    Possible values: top, center, bottom, baseline.

    alpha

    number

    Sets transparency of the entire element: 0 — completely transparent, 1 — opaque.

    Restriction for the value x: x >= 0.0 && x <= 1.0.

    Default value: 1.0.

    auto_ellipsize

    bool_int

    Automatic text cropping to fit the container size.

    Available platforms: Android, web.

    background

    array

    Element background. It can contain multiple layers.

    An array must not be empty.

    border

    object

    Element stroke.

    The value has the type div-border.

    column_span

    int

    Merges cells in a column of the grid element.

    Restriction for the value x: x >= 0.

    disappear_actions

    array

    Actions when an element disappears from the screen.

    An array must not be empty.

    doubletap_actions

    array

    Action when double-clicking on an element.

    An array must not be empty.

    ellipsis

    object

    Text cropping marker. It is displayed when text size exceeds the limit on the number of lines.

    The value has the type ellipsis.

    Available platforms: Android, iOS.

    extensions

    array

    Extensions for additional processing of an element. The list of extensions is given in DivExtension.

    An array must not be empty.

    focus

    object

    Parameters when focusing on an element or losing focus.

    The value has the type div-focus.

    focused_text_color

    string

    Text color when focusing on the element.

    Valid formats: #RGB, #ARGB, #RRGGBB, #AARRGGBB.

    Available platforms: Android, web.

    font_family

    string

    Font family:
  • text — a standard text font;
  • display — a family of fonts with a large font size.
  • font_size

    int

    Font size.

    Restriction for the value x: x >= 0.

    Default value: 12.

    font_size_unit

    string

    Possible values: dp, sp, px.

    Default value: sp.

    Available platforms: Android, iOS.

    font_weight

    string

    Style.

    Possible values: light, medium, regular, bold.

    Default value: regular.

    height

    object

    Element height. For Android: if there is text in this or in a child element, specify height in sp to scale the element together with the text. To learn more about units of size measurement, see Layout inside the card.

    The value has the type div-size.

    Default value: {"type": "wrap_content"}.

    id

    string

    Element ID. It must be unique within the root element. It is used as accessibilityIdentifier on iOS.

    images

    array

    Images embedded in text.

    An array must not be empty.

    letter_spacing

    number

    Spacing between characters.

    Default value: 0.

    line_height

    int

    Line spacing of the text.

    Restriction for the value x: x >= 0.

    longtap_actions

    array

    Action when long-clicking an element. Doesn't work on devices that don't support touch gestures.

    An array must not be empty.

    margins

    object

    External margins from the element stroke.

    The value has the type div-edge-insets.

    max_lines

    int

    Maximum number of lines not to be cropped when breaking the limits.

    Restriction for the value x: x >= 0.

    min_hidden_lines

    int

    Minimum number of cropped lines when breaking the limits.

    Restriction for the value x: x >= 0.

    Available platforms: Android, iOS.

    paddings

    object

    Internal margins from the element stroke.

    The value has the type div-edge-insets.

    ranges

    array

    A character range in which additional style parameters can be set. Defined by mandatory start and end fields.

    An array must not be empty.

    row_span

    int

    Merges cells in a string of the grid element.

    Restriction for the value x: x >= 0.

    selectable

    bool_int

    Ability to select and copy text.

    Default value: false.

    selected_actions

    array

    List of actions to be executed when selecting an element in pager.

    An array must not be empty.

    strike

    string

    Strikethrough.

    Possible values: none, single.

    Default value: none.

    text

    string

    Required parameter.

    Text.

    text_alignment_horizontal

    string

    Horizontal text alignment.

    Possible values: left, center, right, start, end.

    Default value: start.

    text_alignment_vertical

    string

    Vertical text alignment.

    Possible values: top, center, bottom, baseline.

    Default value: top.

    text_color

    string

    Text color. Not used if the text_gradient parameter is set.

    Valid formats: #RGB, #ARGB, #RRGGBB, #AARRGGBB.

    Default value: #FF000000.

    text_gradient

    object

    Gradient text color.

    The value has the type div-text-gradient.

    text_shadow

    object

    Parameters of the shadow applied to the text.

    The value has the type div-shadow.

    Available platforms: Android, web.

    tooltips

    array

    Tooltips linked to an element. A tooltip can be shown by div-action://show_tooltip?id=, hidden by div-action://hide_tooltip?id= where id — tooltip id.

    An array must not be empty.

    transform

    object

    Applies the passed transformation to the element. Content that doesn't fit into the original view area is cut off.

    The value has the type div-transform.

    transition_change

    object

    Change animation. It is played when the position or size of an element changes in the new layout.

    The value has the type div-change-transition.

    transition_in

    object

    Appearance animation. It is played when an element with a new ID appears. To learn more about the concept of transitions, see Animated transitions.

    The value has the type div-appearance-transition.

    transition_out

    object

    Disappearance animation. It is played when an element disappears in the new layout.

    The value has the type div-appearance-transition.

    transition_triggers

    array

    Animation starting triggers. Default value: [state_change, visibility_change].

    An array must not be empty.

    truncate

    string

    Parameter is deprecated.

    Text cropping method. Use ellipsis instead.

    Possible values: none, start, end, middle.

    Default value: end.

    type

    string

    Required parameter.

    The value must always be text.

    underline

    string

    Underline.

    Possible values: none, single.

    Default value: none.

    visibility

    string

    Element visibility.

    Possible values: visible, invisible, gone.

    Default value: visible.

    visibility_action

    object

    Tracking visibility of a single element. Not used if the visibility_actions parameter is set.

    The value has the type div-visibility-action.

    visibility_actions

    array

    Actions when an element appears on the screen.

    An array must not be empty.

    width

    object

    Element width.

    The value has the type div-size.

    Default value: {"type": "match_parent"}.

    range

    ParametersDescription
    actions

    array

    Action when clicking on text.

    An array must not be empty.

    background

    object

    Character range background.

    The value has the type div-text-range-background.

    List of possible values:
  • div-solid-background
  • border

    object

    Character range border.

    The value has the type div-text-range-border.

    end

    int

    Required parameter.

    Ordinal number of the last character to be included in the range.

    Restriction for the value x: x > 0.

    font_family

    string

    Font family:
  • text — a standard text font;
  • display — a family of fonts with a large font size.
  • font_size

    int

    Font size.

    Restriction for the value x: x >= 0.

    font_size_unit

    string

    Unit of measurement:
  • px — a physical pixel.
  • dp — a logical pixel that doesn't depend on screen density.
  • sp — a logical pixel that depends on the font size on a device. Specify height in sp. Only available on Android.
  • Possible values: dp, sp, px.

    Default value: sp.

    Available platforms: Android, iOS.

    font_weight

    string

    Style.

    Possible values: light, medium, regular, bold.

    letter_spacing

    number

    Spacing between characters.

    line_height

    int

    Line spacing of the text. Units specified in font_size_unit.

    Restriction for the value x: x >= 0.

    start

    int

    Required parameter.

    Ordinal number of a character which the range begins from. The first character has a number 0.

    Restriction for the value x: x >= 0.

    strike

    string

    Strikethrough.

    Possible values: none, single.

    text_color

    string

    Text color.

    Valid formats: #RGB, #ARGB, #RRGGBB, #AARRGGBB.

    text_shadow

    object

    Parameters of the shadow applied to the character range.

    The value has the type div-shadow.

    Available platforms: Android, web.

    top_offset

    int

    Top margin of the character range. Units specified in font_size_unit.

    Restriction for the value x: x >= 0.

    underline

    string

    Underline.

    Possible values: none, single.

    ParametersDescription
    actions

    array

    Action when clicking on text.

    An array must not be empty.

    background

    object

    Character range background.

    The value has the type div-text-range-background.

    List of possible values:
  • div-solid-background
  • border

    object

    Character range border.

    The value has the type div-text-range-border.

    end

    int

    Required parameter.

    Ordinal number of the last character to be included in the range.

    Restriction for the value x: x > 0.

    font_family

    string

    Font family:
  • text — a standard text font;
  • display — a family of fonts with a large font size.
  • font_size

    int

    Font size.

    Restriction for the value x: x >= 0.

    font_size_unit

    string

    Unit of measurement:
  • px — a physical pixel.
  • dp — a logical pixel that doesn't depend on screen density.
  • sp — a logical pixel that depends on the font size on a device. Specify height in sp. Only available on Android.
  • Possible values: dp, sp, px.

    Default value: sp.

    Available platforms: Android, iOS.

    font_weight

    string

    Style.

    Possible values: light, medium, regular, bold.

    letter_spacing

    number

    Spacing between characters.

    line_height

    int

    Line spacing of the text. Units specified in font_size_unit.

    Restriction for the value x: x >= 0.

    start

    int

    Required parameter.

    Ordinal number of a character which the range begins from. The first character has a number 0.

    Restriction for the value x: x >= 0.

    strike

    string

    Strikethrough.

    Possible values: none, single.

    text_color

    string

    Text color.

    Valid formats: #RGB, #ARGB, #RRGGBB, #AARRGGBB.

    text_shadow

    object

    Parameters of the shadow applied to the character range.

    The value has the type div-shadow.

    Available platforms: Android, web.

    top_offset

    int

    Top margin of the character range. Units specified in font_size_unit.

    Restriction for the value x: x >= 0.

    underline

    string

    Underline.

    Possible values: none, single.

    image

    ParametersDescription
    height

    object

    Image height.

    The value has the type div-fixed-size.

    Default value: {"type": "fixed","value":20}.

    preload_required

    bool_int

    Background image must be loaded before the display.

    Default value: false.

    Available platforms: web.

    start

    int

    Required parameter.

    A symbol to insert prior to an image. To insert an image at the end of the text, specify the number of the last character plus one.

    Restriction for the value x: x >= 0.

    tint_color

    string

    New color of a contour image.

    Valid formats: #RGB, #ARGB, #RRGGBB, #AARRGGBB.

    tint_mode

    string

    Blend mode of the color specified in tint_color.

    Possible values: source_in, source_atop, darken, lighten, multiply, screen.

    Default value: source_in.

    Available platforms: Android, web.

    url

    string

    Required parameter.

    Image URL.

    The value must be a valid URL.

    width

    object

    Image width.

    The value has the type div-fixed-size.

    Default value: {"type": "fixed","value":20}.

    ParametersDescription
    height

    object

    Image height.

    The value has the type div-fixed-size.

    Default value: {"type": "fixed","value":20}.

    preload_required

    bool_int

    Background image must be loaded before the display.

    Default value: false.

    Available platforms: web.

    start

    int

    Required parameter.

    A symbol to insert prior to an image. To insert an image at the end of the text, specify the number of the last character plus one.

    Restriction for the value x: x >= 0.

    tint_color

    string

    New color of a contour image.

    Valid formats: #RGB, #ARGB, #RRGGBB, #AARRGGBB.

    tint_mode

    string

    Blend mode of the color specified in tint_color.

    Possible values: source_in, source_atop, darken, lighten, multiply, screen.

    Default value: source_in.

    Available platforms: Android, web.

    url

    string

    Required parameter.

    Image URL.

    The value must be a valid URL.

    width

    object

    Image width.

    The value has the type div-fixed-size.

    Default value: {"type": "fixed","value":20}.

    ellipsis

    ParametersDescription
    actions

    array

    Actions when clicking on a crop marker.

    An array must not be empty.

    images

    array

    Images embedded in a crop marker.

    An array must not be empty.

    ranges

    array

    Character ranges inside a crop marker with different text styles.

    An array must not be empty.

    text

    string

    Required parameter.

    Marker text.

    ParametersDescription
    actions

    array

    Actions when clicking on a crop marker.

    An array must not be empty.

    images

    array

    Images embedded in a crop marker.

    An array must not be empty.

    ranges

    array

    Character ranges inside a crop marker with different text styles.

    An array must not be empty.

    text

    string

    Required parameter.

    Marker text.