ZoomView.enableHD zoomview-enablehd

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


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 2 below.


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

See Example 2 below.

Properties section-65be9301796240e38f31818229da7acc


Default section-bd374ffc5182484faa77a7a3c8fa70f2


Example section-bd6c4249bccf44aab13fee8552f5a8b3

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

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

  • 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.

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.

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.