Interface: BaseRetrieveOptions
Base retrieves define some alternate path information, the decode level, whether the transfer syntax supports streaming decode, and the desired status and partial status used for retrieval.
Properties
decodeLevel?
optionaldecodeLevel:number
Decode level to attempt. Currently only HTJ2K decoders support this. Value of 0 means decode full resolution,
- 1 means 1/2 resolution in each dimension (eg 1/4 size)
- i means 1/2^i resolution in each dimension, or 1/4^i size.
Defined in
packages/core/src/types/IRetrieveConfiguration.ts:109
framesPath?
optionalframesPath:string
Alternate way to encode argument information by updating the frames path
Defined in
packages/core/src/types/IRetrieveConfiguration.ts:102
imageQualityStatus?
optionalimageQualityStatus:ImageQualityStatus
Status to use when the full retrieve has been completed, defined as all the bytes for a given image. Defaults to FULL_RESOLUTION, so if the complete image is lossy, this should be set to LOSSY.
Defined in
packages/core/src/types/IRetrieveConfiguration.ts:115
urlArguments?
optionalurlArguments:string
Additional arguments to add to the URL, in the format arg1=value1 ('&' arg2=value2)* For example: '&lossy=jhc' to use JHC lossy values