Type Alias: OpenParameters

type OpenParameters = object;

Open parameters.

Properties

fileName?

optional fileName: string;

Optional. Friendly file name.

Example

viewer.open("/getSampleImage", { fileName: "sample.png" });

imageDPI?

optional imageDPI: number;

Image DPI. DPI value is used to determine the quality and resolution of the image.

Default

96

Example

viewer.open("sample.png", { imageDPI: 72 });

imageFormat?

optional imageFormat: 
  | ImageFormatCode
  | ImageFormatName
  | ImageFormatCode;

Image format type. Use the imageFormat parameter when the viewer cannot automatically determine the image format.

Description

Available image formats are: 1 = JPEG, 2 = PNG, 3 = TIFF, 4 = GIF, 5 = BMP, 6 = ICO, 7 = SVG, 8 = WEBP

Example

// Open TIFF image from URL.
viewer.open("http://localhost/getimage?id=1&fmt=3", { imageFormat: 3 });
// or:
viewer.open("http://localhost/getimage?id=1&fmt=3", { imageFormat: "tiff" });