asposepdfcloud
Version:
Aspose.PDF Cloud is a REST API for creating and editing PDF files. Most popular features proposed by Aspose.PDF Cloud: PDF to Word, Convert PDF to Image, Merge PDF, Split PDF, Add Images to PDF, Rotate PDF. It can also be used to convert PDF files to diff
166 lines (158 loc) • 6.34 kB
text/typescript
/**
*
* Copyright (c) 2025 Aspose.PDF Cloud
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*/
import { ImageCompressionVersion } from "./imageCompressionVersion";
import { ImageEncoding } from "./imageEncoding";
/**
* Represents Pdf optimize options.
*/
export class OptimizeOptions {
/**
* Specifies document password (if any) encoded with base-64.
*/
'password': string;
/**
* If true page contents will be reused when document is optimized for equal pages. LinkDuplcateStreams option must be set to true.
*/
'allowReusePageContent': boolean;
/**
* If this flag is set to true images will be compressed in the document. Compression level is specified with ImageQuality property.
*/
'compressImages': boolean;
/**
* Specifies level of image compression when CompressImages flag is used.
*/
'imageQuality': number;
/**
* If this flag is set to true, Resource streams will be analyzed. If duplicate streams are found (i.e. if stream contents is equal), then thees streams will be stored as one object. This allows to decrease document size in some cases (for example, when same document was concatenated multiple times).
*/
'linkDuplcateStreams': boolean;
/**
* If this flag is set to true, all document objects will be checked and unused objects (i.e. objects which does not have any reference) are removed from document.
*/
'removeUnusedObjects': boolean;
/**
* If this flag set to true, every resource is checked on it's usage. If resource is never used, then resources is removed. This may decrease document size for example when pages were extracted from document.
*/
'removeUnusedStreams': boolean;
/**
* Make fonts not embedded if set to true. Unembedding a font means removing the embedded byte stream data of the font included in a PDF document.
*/
'unembedFonts': boolean;
/**
* If this flag set to true and CompressImages is true images will be resized if image resolution is greater then specified MaxResolution parameter.
*/
'resizeImages': boolean;
/**
* Specifies maximum resolution of images. If image has higher resolution it will be scaled.
*/
'maxResolution': number;
/**
* Fonts will be converted into subsets if set to true. Only those characters that are actually used in the layout are stored in the PDF.
*/
'subsetFonts': boolean;
/**
* Remove private information (page piece info).
*/
'removePrivateInfo': boolean;
/**
* Image encode which will be used.
*/
'imageEncoding': ImageEncoding;
/**
* Version of compression algorithm. Possible values are: \"Standard\" - standard compression, \"Fast\" - fast (improved compression which is faster then standard but may be applicable not for all images), \"Mixed\" - mixed (standard compression is applied to images which can not be compressed by faster algorithm, this may give best compression but more slow then \"Fast\" algorithm. Version \"Fast\" is not applicable for resizing images (standard method will be used). Default is \"Standard\".
*/
'imageCompressionVersion': ImageCompressionVersion;
static discriminator = undefined;
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
{
"name": "password",
"baseName": "Password",
"type": "string"
},
{
"name": "allowReusePageContent",
"baseName": "AllowReusePageContent",
"type": "boolean"
},
{
"name": "compressImages",
"baseName": "CompressImages",
"type": "boolean"
},
{
"name": "imageQuality",
"baseName": "ImageQuality",
"type": "number"
},
{
"name": "linkDuplcateStreams",
"baseName": "LinkDuplcateStreams",
"type": "boolean"
},
{
"name": "removeUnusedObjects",
"baseName": "RemoveUnusedObjects",
"type": "boolean"
},
{
"name": "removeUnusedStreams",
"baseName": "RemoveUnusedStreams",
"type": "boolean"
},
{
"name": "unembedFonts",
"baseName": "UnembedFonts",
"type": "boolean"
},
{
"name": "resizeImages",
"baseName": "ResizeImages",
"type": "boolean"
},
{
"name": "maxResolution",
"baseName": "MaxResolution",
"type": "number"
},
{
"name": "subsetFonts",
"baseName": "SubsetFonts",
"type": "boolean"
},
{
"name": "removePrivateInfo",
"baseName": "RemovePrivateInfo",
"type": "boolean"
},
{
"name": "imageEncoding",
"baseName": "ImageEncoding",
"type": "ImageEncoding"
},
{
"name": "imageCompressionVersion",
"baseName": "ImageCompressionVersion",
"type": "ImageCompressionVersion"
} ];
static getAttributeTypeMap() {
return OptimizeOptions.attributeTypeMap;
}
}