Show Menu
TOPICS×

hei

View Height. Specifies the height of the response image (view image) when fit is not present in the request.
hei= * val *
var
Image height in pixels (int greater than 0).
If both wid= and scl= are specified, the composite image may be cropped according to the align= attribute. When fit= is present, hei= specifies the exact, the minimum, or the maximum response image height; refer to the description of [fit=](../../../../../is-api/http-ref/image-serving-api-ref/c-http-protocol-reference/c-command-reference/r-fit.md#reference-f11bff6d93d143d6b135de3a923bc989) for details.
If scl= is not specified, the composite image is scaled to fit. If both wid= and hei= are specified, and scl= is not specified, then the image is scaled to fit entirely within the wid/hei rectangle, leaving as little background area exposed as possible; in this case, the image is positioned within the view rectangle according to the align= attribute. The background area is filled with bgc= , or, if not specified with attribute::BkgColor .
An error is returned if the calculated reply image size is larger than attribute::MaxPix .

Properties

View attribute. Applies regardless of the current layer setting.

Default

If neither wid= , hei= , nor scl= are specified, the reply image has either the size of the composite image or attribute::DefaultPix , whichever is smaller.

Examples

Request an image to fit into a 200x200 rectangle; top-left align the image if it is not square. Any background area is filled with attribute::BkgColor .
http://server/myRootId/myImageId?wid=200&hei=200&align=-1,-1
The same image, delivered at a fixed height of 200 pixels, but with a variable width to match the aspect ratio of the image. In this case, the returned image never has any background fill areas. Note that in this case align= would have no effect at all.
http://server/myRootId/myImageId?hei=200