DocumentationDynamic Media Viewers Reference Guide

ZoomView.enableHD zoomview-enablehd

Last update: Tue Oct 12 2021 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • User

[ZoomView.|<containerId>_zoomView.]enableHD=always|never|limit[, *number*]

always|never|limit

Enable, limit, or disable optimization for devices where devicePixelRatio is greater than 1, that is devices with high-density display like iPhone4 and similar devices. If active then the component limits the size of the IS image request as if the device only had a pixel ratio of 1 and that way reducing the bandwidth.

See example below.

number

If using the limit setting, the component enables high pixel density only up to the specified limit.

See example below.

Properties section-50bcd15223174bb79ce08b31ea03d682

Optional.

Default section-7564169749ff4a4996049ea1148cb2a5

limit,1500

Example section-96e69b70365f461dae4399e49044ea2f

The following are the expected results when you use this configuration attribute with the viewer, and the viewer size is 1000 x 1000:

If the set variable equals
Result
always

The pixel density of the screen/device is always accounted.

  • If the screen pixel density = 1, then the requested image is 1000 x 1000.

  • If the screen pixel density = 1.5, then the requested image is 1500 x 1500.

  • If the screen pixel density = 2, then the requested image is 2000 x 2000.

never
It always uses a pixel density of 1 and ignores the device's HD capability. Therefore, the requested image requested is always 1000 x 1000.
limit<number>

A device pixel density is requested and served only if the resulting image is below the specified limit.

The limit number applies to either the width or the height dimension.

  • If the limit number is 1600, and the pixel density is 1.5, then the 1500 x 1500 image is served.

  • If the limit number is 1600, and the pixel density is 2, then the 1000 x 1000 image is served because the 2000 x 2000 image exceeds the limit.

Best practice: The limit number must work with the company setting for maximum size image. Therefore, set the limit number to equal the company maximum image size setting.

recommendation-more-help
b7426f53-aad9-4c00-83fc-664f30f681e8