div-gallery
Gallery. It contains a horizontal or vertical set of cards that can be scrolled.
JSON
{
type*: "gallery",
accessibility: {
description: "string",
hint: "string",
mode: "string",
mute_after_action: "bool_int",
state_description: "string",
type: "string"
},
alignment_horizontal: "string",
alignment_vertical: "string",
alpha: "number",
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_count: "int",
column_span: "int",
cross_content_alignment: "string",
cross_spacing: "int",
default_item: "int",
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, ... ]
},
log_id*: "string",
log_url: "string",
menu_items: [
{
action: div-action,
actions: [ div-action, ... ],
text*: "string"
},
...
],
payload: "object",
referer: "string",
target: "string",
url: "string"
},
...
],
on_focus: [
{
download_callbacks: {
on_fail_actions: [ div-action, ... ],
on_success_actions: [ div-action, ... ]
},
log_id*: "string",
log_url: "string",
menu_items: [
{
action: div-action,
actions: [ div-action, ... ],
text*: "string"
},
...
],
payload: "object",
referer: "string",
target: "string",
url: "string"
},
...
]
},
height: div-size,
id: "string",
item_spacing: "int",
items*: [ div, ... ],
margins: {
bottom: "int",
left: "int",
right: "int",
top: "int",
unit: "string"
},
orientation: "string",
paddings: {
bottom: "int",
left: "int",
right: "int",
top: "int",
unit: "string"
},
restrict_parent_scroll: "bool_int",
row_span: "int",
scroll_mode: "string",
selected_actions: [
{
download_callbacks: {
on_fail_actions: [ div-action, ... ],
on_success_actions: [ div-action, ... ]
},
log_id*: "string",
log_url: "string",
menu_items: [
{
action: div-action,
actions: [ div-action, ... ],
text*: "string"
},
...
],
payload: "object",
referer: "string",
target: "string",
url: "string"
},
...
],
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", ... ],
visibility: "string",
visibility_action: {
download_callbacks: {
on_fail_actions: [
{
download_callbacks: div-download-callbacks,
log_id*: "string",
log_url: "string",
menu_items: [
{
action: div-action,
actions: [ div-action, ... ],
text*: "string"
},
...
],
payload: "object",
referer: "string",
target: "string",
url: "string"
},
...
],
on_success_actions: [
{
download_callbacks: div-download-callbacks,
log_id*: "string",
log_url: "string",
menu_items: [
{
action: div-action,
actions: [ div-action, ... ],
text*: "string"
},
...
],
payload: "object",
referer: "string",
target: "string",
url: "string"
},
...
]
},
log_id*: "string",
log_limit: "int",
payload: "object",
referer: "string",
url: "string",
visibility_duration: "int",
visibility_percentage: "int"
},
visibility_actions: [
{
download_callbacks: {
on_fail_actions: [
{
download_callbacks: div-download-callbacks,
log_id*: "string",
log_url: "string",
menu_items: [
{
action: div-action,
actions: [ div-action, ... ],
text*: "string"
},
...
],
payload: "object",
referer: "string",
target: "string",
url: "string"
},
...
],
on_success_actions: [
{
download_callbacks: div-download-callbacks,
log_id*: "string",
log_url: "string",
menu_items: [
{
action: div-action,
actions: [ div-action, ... ],
text*: "string"
},
...
],
payload: "object",
referer: "string",
target: "string",
url: "string"
},
...
]
},
log_id*: "string",
log_limit: "int",
payload: "object",
referer: "string",
url: "string",
visibility_duration: "int",
visibility_percentage: "int"
},
...
],
width: div-size
}
Parameters
Parameters | Description |
---|---|
accessibility | object Accessibility settings. The value has the type |
alignment_horizontal | string Horizontal alignment of an element inside the parent element. Possible values: |
alignment_vertical | string Vertical alignment of an element inside the parent element. Possible values: |
alpha | number Sets transparency of the entire element: Restriction for the value Default value: |
background | array Element background. It can contain multiple layers. An array must not be empty. |
border | object Element stroke. The value has the type |
column_count | int Number of columns for block layout. Restriction for the value |
column_span | int Merges cells in a column of the grid element. Restriction for the value |
cross_content_alignment | string Aligning elements in the direction perpendicular to the scroll direction. In horizontal galleries: start — alignment to the top of the card;center — to the center;end — to the bottom.In vertical galleries: start — alignment to the left of the card;center — to the center;end — to the right.Possible values: Default value: |
cross_spacing | int Spacing between elements across the scroll axis. By default, the value set to Restriction for the value Available platforms: Android, browser. |
default_item | int Ordinal number of the gallery element to be scrolled to by default. For scroll_mode :default — the scroll position is set to the beginning of the element, without taking into account item_spacing ;paging — the scroll position is set to the center of the element.Restriction for the value Default value: |
extensions | array Extensions for additional processing of an element. The list of extensions is given in DivExtension. An array must not be empty. Available platforms: Android, iOS. |
focus | object Parameters when focusing on an element or losing focus. The value has the type Available platforms: Android. |
height | object Element height. For Android: if there is text in this or in a child element, specify height in The value has the type Default value: |
id | string Element ID. It must be unique within the root element. It is used as A string must not be empty. |
item_spacing | int Spacing between elements. Restriction for the value Default value: |
items | array Required parameter. Gallery elements. Scrolling to elements can be implemented using: div-action://set_current_item?id=&item= — scrolling to the element with an ordinal number item inside an element, with the specified id ;div-action://set_next_item?id=[&overflow={clamp|ring}] — scrolling to the next element inside an element, with the specified id ;div-action://set_previous_item?id=[&overflow={clamp|ring}] — scrolling to the previous element inside an element, with the specified id .The optional overflow parameter is used to set navigation when the first or last element is reached:clamp — transition will stop at the border element;ring — go to the beginning or end, depending on the current element.By default, An array must not be empty. |
margins | object External margins from the element stroke. The value has the type |
orientation | string Gallery orientation. Possible values: Default value: |
paddings | object Internal margins from the element stroke. The value has the type |
restrict_parent_scroll | bool_int If the parameter is enabled, the gallery won't transmit the scroll gesture to the parent element. Default value: Available platforms: Android, browser. |
row_span | int Merges cells in a string of the grid element. Restriction for the value |
scroll_mode | string Scroll type: Possible values: Default value: |
selected_actions | array List of actions to be executed when selecting an element in pager. An array must not be empty. |
tooltips | array Tooltips linked to an element. A tooltip can be shown by An array must not be empty. Available platforms: Android, iOS. |
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 Available platforms: Android, browser. |
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 List of possible values: |
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 List of possible values: |
transition_out | object Disappearance animation. It is played when an element disappears in the new layout. The value has the type List of possible values: |
transition_triggers | array Animation starting triggers. Default value: An array must not be empty. |
type | string Required parameter. The value must always be |
visibility | string Element visibility. Possible values: Default value: |
visibility_action | object Tracking visibility of a single element. Not used if the The value has the type |
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 Default value: |
Parameters | Description |
---|---|
accessibility | object Accessibility settings. The value has the type |
alignment_horizontal | string Horizontal alignment of an element inside the parent element. Possible values: |
alignment_vertical | string Vertical alignment of an element inside the parent element. Possible values: |
alpha | number Sets transparency of the entire element: Restriction for the value Default value: |
background | array Element background. It can contain multiple layers. An array must not be empty. |
border | object Element stroke. The value has the type |
column_count | int Number of columns for block layout. Restriction for the value |
column_span | int Merges cells in a column of the grid element. Restriction for the value |
cross_content_alignment | string Aligning elements in the direction perpendicular to the scroll direction. In horizontal galleries: start — alignment to the top of the card;center — to the center;end — to the bottom.In vertical galleries: start — alignment to the left of the card;center — to the center;end — to the right.Possible values: Default value: |
cross_spacing | int Spacing between elements across the scroll axis. By default, the value set to Restriction for the value Available platforms: Android, browser. |
default_item | int Ordinal number of the gallery element to be scrolled to by default. For scroll_mode :default — the scroll position is set to the beginning of the element, without taking into account item_spacing ;paging — the scroll position is set to the center of the element.Restriction for the value Default value: |
extensions | array Extensions for additional processing of an element. The list of extensions is given in DivExtension. An array must not be empty. Available platforms: Android, iOS. |
focus | object Parameters when focusing on an element or losing focus. The value has the type Available platforms: Android. |
height | object Element height. For Android: if there is text in this or in a child element, specify height in The value has the type Default value: |
id | string Element ID. It must be unique within the root element. It is used as A string must not be empty. |
item_spacing | int Spacing between elements. Restriction for the value Default value: |
items | array Required parameter. Gallery elements. Scrolling to elements can be implemented using: div-action://set_current_item?id=&item= — scrolling to the element with an ordinal number item inside an element, with the specified id ;div-action://set_next_item?id=[&overflow={clamp|ring}] — scrolling to the next element inside an element, with the specified id ;div-action://set_previous_item?id=[&overflow={clamp|ring}] — scrolling to the previous element inside an element, with the specified id .The optional overflow parameter is used to set navigation when the first or last element is reached:clamp — transition will stop at the border element;ring — go to the beginning or end, depending on the current element.By default, An array must not be empty. |
margins | object External margins from the element stroke. The value has the type |
orientation | string Gallery orientation. Possible values: Default value: |
paddings | object Internal margins from the element stroke. The value has the type |
restrict_parent_scroll | bool_int If the parameter is enabled, the gallery won't transmit the scroll gesture to the parent element. Default value: Available platforms: Android, browser. |
row_span | int Merges cells in a string of the grid element. Restriction for the value |
scroll_mode | string Scroll type: Possible values: Default value: |
selected_actions | array List of actions to be executed when selecting an element in pager. An array must not be empty. |
tooltips | array Tooltips linked to an element. A tooltip can be shown by An array must not be empty. Available platforms: Android, iOS. |
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 Available platforms: Android, browser. |
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 List of possible values: |
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 List of possible values: |
transition_out | object Disappearance animation. It is played when an element disappears in the new layout. The value has the type List of possible values: |
transition_triggers | array Animation starting triggers. Default value: An array must not be empty. |
type | string Required parameter. The value must always be |
visibility | string Element visibility. Possible values: Default value: |
visibility_action | object Tracking visibility of a single element. Not used if the The value has the type |
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 Default value: |