Foxit PDF SDK
|
Public Member Functions | |
def | Image () |
Constructor. More... | |
def | Image (buffer, length) |
Constructor, from a memory buffer. More... | |
def | Image (file_read) |
Constructor, with a file read callback object. More... | |
def | Image (other) |
Constructor, with another image object. More... | |
def | Image (path) |
Constructor, from an existing image file path. More... | |
def | AddFrame (bitmap) |
Add a bitmap as a frame. (Unsupported DIB formats: FoxitPDFSDKPython3.Bitmap.e_DIBRgb565 and FoxitPDFSDKPython3.Bitmap.e_DIB8bppMask ) More... | |
def | GetFrameBitmap (index) |
Get a frame bitmap, specified by index. More... | |
def | GetFrameCount () |
Get frame count. More... | |
def | GetHeight () |
Get image height. More... | |
def | GetType () |
Get image type. More... | |
def | GetWidth () |
Get image width. More... | |
def | GetXDPI () |
Get DPI for X-axis. More... | |
def | GetYDPI () |
Get DPI for Y-axis. More... | |
def | IsEmpty () |
Check whether current object is empty or not. More... | |
def | SaveAs (file, file_extension) |
Save current image as an image file. More... | |
def | SaveAs (file_path) |
Save current image as an image file. More... | |
def | SetDPIs (x_dpi, y_dpi) |
Set DPI for X-axis and Y-axis. More... | |
Static Public Attributes | |
e_BMP = _fsdk.Image_e_BMP | |
Image type is BMP. | |
e_GIF = _fsdk.Image_e_GIF | |
Image type is GIF. | |
e_JBIG2 = _fsdk.Image_e_JBIG2 | |
Image type is JBIG2. More... | |
e_JPG = _fsdk.Image_e_JPG | |
Image type is JPG or JPEG. | |
e_JPX = _fsdk.Image_e_JPX | |
Image type is JPX or JPEG-2000. | |
e_None = _fsdk.Image_e_None | |
Not have image type yet. More... | |
e_PNG = _fsdk.Image_e_PNG | |
Image type is PNG. | |
e_TIF = _fsdk.Image_e_TIF | |
Image type is TIF or TIFF. | |
Foxit PDF SDK offers following image types:
def FoxitPDFSDKPython3.Image.Image | ( | ) |
Constructor.
This constructor is to construct a new image object (without any data). The image type of this constructed image object would be FoxitPDFSDKPython3.Image.e_None .
def FoxitPDFSDKPython3.Image.Image | ( | path | ) |
Constructor, from an existing image file path.
[in] | path | A full path of an existing image file. It should not be an empty string. |
def FoxitPDFSDKPython3.Image.Image | ( | buffer, | |
length | |||
) |
Constructor, from a memory buffer.
[in] | buffer | A memory buffer. The image file data should be fully loaded in this memory buffer. It should not be null. |
[in] | length | The size of memory buffer. It should be above 0. |
def FoxitPDFSDKPython3.Image.Image | ( | file_read | ) |
Constructor, with a file read callback object.
[in] | file_read | A FoxitPDFSDKPython3.FileReaderCallback object which is implemented by user to load an image file. It should not be null. |
def FoxitPDFSDKPython3.Image.Image | ( | other | ) |
Constructor, with another image object.
[in] | other | Another image object. |
def FoxitPDFSDKPython3.Image.AddFrame | ( | bitmap | ) |
Add a bitmap as a frame. (Unsupported DIB formats: FoxitPDFSDKPython3.Bitmap.e_DIBRgb565 and FoxitPDFSDKPython3.Bitmap.e_DIB8bppMask )
Currently, this function does not support an image with type FoxitPDFSDKPython3.Image.e_JBIG2 , or FoxitPDFSDKPython3.Image.e_Unknown .
For supporting image types:
[in] | bitmap | A valid bitmap as a frame to be added or set. |
def FoxitPDFSDKPython3.Image.GetFrameBitmap | ( | index | ) |
Get a frame bitmap, specified by index.
Currently, this function does not support an image with type FoxitPDFSDKPython3.Image.e_JBIG2 . This function can only support to get a frame bitmap which is in following formats:
FoxitPDFSDKPython3.Bitmap.e_DIB8bppMask , FoxitPDFSDKPython3.Bitmap.e_DIB8bpp , FoxitPDFSDKPython3.Bitmap.e_DIBRgb , FoxitPDFSDKPython3.Bitmap.e_DIBRgb32 , FoxitPDFSDKPython3.Bitmap.e_DIBArgb .
For other unsupported DIB format, this function will return a bitmap object which's function FoxitPDFSDKPython3.Bitmap.IsEmpty returns true.
[in] | index | Index of the frame. Valid range: from 0 to (count-1). count is returned by function FoxitPDFSDKPython3.Image.GetFrameCount . |
def FoxitPDFSDKPython3.Image.GetFrameCount | ( | ) |
Get frame count.
Currently, this function does not support an image with type FoxitPDFSDKPython3.Image.e_JBIG2 .
def FoxitPDFSDKPython3.Image.GetHeight | ( | ) |
Get image height.
If the image has multiple frames, usually the first frame's size will be treated as the image size.
def FoxitPDFSDKPython3.Image.GetType | ( | ) |
Get image type.
If current image is a new image (not constructed from any image file), its type would be FoxitPDFSDKPython3.Image.e_None .
def FoxitPDFSDKPython3.Image.GetWidth | ( | ) |
Get image width.
If the image has multiple frames, usually the first frame's size will be treated as the image size.
def FoxitPDFSDKPython3.Image.GetXDPI | ( | ) |
Get DPI for X-axis.
Currently, this function does not support an image with type FoxitPDFSDKPython3.Image.e_JPX , FoxitPDFSDKPython3.Image.e_GIF or FoxitPDFSDKPython3.Image.e_JBIG2 .
For a new image (not constructed from any image file), the default DPI for X-axis is 96.
def FoxitPDFSDKPython3.Image.GetYDPI | ( | ) |
Get DPI for Y-axis.
Currently, this function does not support an image with type FoxitPDFSDKPython3.Image.e_JPX , FoxitPDFSDKPython3.Image.e_GIF or FoxitPDFSDKPython3.Image.e_JBIG2 .
For a new image (not constructed from any image file), the default DPI for Y-axis is 96.
def FoxitPDFSDKPython3.Image.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
def FoxitPDFSDKPython3.Image.SaveAs | ( | file, | |
file_extension | |||
) |
Save current image as an image file.
If the type of current image is FoxitPDFSDKPython3.Image.e_TIF , FoxitPDFSDKPython3.Image.e_GIF or FoxitPDFSDKPython3.Image.e_None , and the saved image file type does not support multiply frames, only the first frame of current image will be saved to the image file.
For an image object (not constructed from any image file), please ensure to add at least one valid frame bitmap to the image object before using this function; otherwise this function will fail.
[in] | file | A FoxitPDFSDKPython3.StreamCallback object which is implemented by user to save image file. |
[in] | file_extension | A full path of the saved image file. It should not be an empty string. Currently, this function supports following extension names: .bmp, .jpg, .jpeg, .png, .tif, .tiff, .jpx, .jp2. |
def FoxitPDFSDKPython3.Image.SaveAs | ( | file_path | ) |
Save current image as an image file.
If the type of current image is FoxitPDFSDKPython3.Image.e_TIF , FoxitPDFSDKPython3.Image.e_GIF or FoxitPDFSDKPython3.Image.e_None , and the saved image file type does not support multiply frames, only the first frame of current image will be saved to the image file.
For an image object (not constructed from any image file), please ensure to add at least one valid frame bitmap to the image object before using this function; otherwise this function will fail.
[in] | file_path | A full path of the saved image file. It should not be an empty string. Currently, this function supports following extension names: .bmp, .jpg, .jpeg, .png, .tif, .tiff, .jpx, .jp2. |
def FoxitPDFSDKPython3.Image.SetDPIs | ( | x_dpi, | |
y_dpi | |||
) |
Set DPI for X-axis and Y-axis.
Currently, this function does not support an image with type FoxitPDFSDKPython3.Image.e_JPX , FoxitPDFSDKPython3.Image.e_GIF , or FoxitPDFSDKPython3.Image.e_JBIG2 .
[in] | x_dpi | DPI for X-axis. It should be above 0. |
[in] | y_dpi | DPI for Y-axis. It should be above 0. |
|
static |
Image type is JBIG2.
|
static |
Not have image type yet.