DocumentationDynamic Media Viewers Reference Guide

config config

Last update: Tue Sep 14 2021 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • User

Parameter common to all viewers.

config= *configId*

configId

Catalog/ID for the viewer configuration.

Specifies an image catalog entry that contains the viewer configuration properties in catalog::UserData . When this command is present, the viewer sends a req=userdata command for configId to the server and extracts properties from the reply. The properties are used to initialize the viewer. If the URL string specifies the same properties, they override the values from catalog::UserData .

All viewer commands that can be specified in catalog::UserData expect asset, serverUrl, contentUrl, searchServerUrl, and config itself.

Properties section-10ee45d637134e0fbcd943c62578cb78

Optional.

Default section-d411e450028c460392cb8508f8ccc5d9

None.

Example 1 section-a8afbf76f8384aa0a83ed1feeccd5b9a

An image catalog named 2020 contains the entry preset-oct. The catalog::UserData field of this catalog entry includes the following data:

style=customStyle.css

Load the viewer with the following command:

config=2020/preset-oct

This example is equivalent to the following command specified explicitly in the URL:

style=customStyle.css

Example 2 section-577fce5ddbee43fc96d88b2055df47aa

An image catalog named 2019 contains the entry spin-oct. The catalog::UserData field of this catalog entry includes the following data:

zoomStep=3
maxZoom=200

Load the viewer with the following command:

config=2019/spin-oct

This example is equivalent to the following command specified explicitly in the URL:

zoomStep=3&maxZoom=200

Example 3 section-2b3a42c3926e4eb19fa14434def9195f

A viewer preset named Shoppable_Banner includes the following data:

style=etc/dam/presets/css/html5_interactiveimage.css

Load the viewer with the following command:

config=/etc/dam/presets/viewer/Shoppable_Banner

This example is equivalent to the following commands specified explicitly in the URL:

style=etc/dam/presets/css/html5_interactiveimage.css

Example 4 section-98dd1cc6b2a24375a1bd572fa83be35c

A viewer preset named Shoppable_Video_Dark contains the following data:

style=etc/dam/presets/css/html5_interactivevideo_dark.css

Load the viewer with the following command:

config=/etc/dam/presets/viewer/Shoppable_Video_Dark

This example is equivalent to the following commands specified explicitly in the URL:

style=etc/dam/presets/css/html5_interactivevideo_dark.css

Example 5 section-19b988551d1d492a9079948e0b04b38f

A viewer preset named Carousel_Dotted_light the following data:

style= etc/dam/presets/css/html5_carouselviewer_dotted_light.css

Load the viewer with the following command:

config=/etc/dam/presets/viewer/Carousel_Dotted_light

This example is equivalent to the following commands specified explicitly in the URL:

style= etc/dam/presets/css/html5_carouselviewer_dotted_light.css
recommendation-more-help
b7426f53-aad9-4c00-83fc-664f30f681e8