config
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
Optional.
Default
None.
Example 1
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
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
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
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
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