Foxit PDF SDK
fsdk.ImageObject类 参考

Public 成员函数

def CloneBitmap (graphics_objects)
 
def CloneBitmap (page, graphics_objects)
 从当前图像图形对象克隆位图。 更多...
 
def GetColorSpace ()
 获取颜色空间。 更多...
 
def GetMask ()
 获取表示当前图像图形对象蒙版的PDF对象。 更多...
 
def GetStream ()
 获取图像流。 更多...
 
def IsImageMask ()
 检查当前图像对象是否被视为蒙版。 更多...
 
def SetBitmap (bitmap, mask)
 将位图设置到当前图像图形对象。 更多...
 
def SetImage (image, frame_index)
 将图像的一帧设置到当前图像图形对象。 更多...
 

详细描述

图像图形对象是一种PDF图形对象,因此类ImageObject 派生自 类GraphicsObject 。它提供获取/设置图像图形对象数据的函数。
要创建新的图像图形对象,请使用函数fsdk.ImageObjectCreate ,然后 使用设置函数为新的图像图形对象设置信息。

参见
GraphicsObject

成员函数说明

◆ CloneBitmap() [1/2]

def fsdk.ImageObject.CloneBitmap (   graphics_objects)
弃用:
此函数已弃用。请使用带两个参数的函数fsdk.ImageObject.CloneBitmap

目前,只有当位图格式是以下格式之一时,才能从图像图形对象克隆位图:
fsdk.BitmapE_DIB8bppMask fsdk.BitmapE_DIB8bpp fsdk.BitmapE_DIBRgb fsdk.BitmapE_DIBRgb32 fsdk.BitmapE_DIBArgb fsdk.BitmapE_DIBCmyk
如果返回位图对象的函数fsdk.Bitmap.IsEmpty 的返回值为true, 表示位图的DIB格式不受支持。

参数
[in]graphics_objects有效的fsdk.GraphicsObjects 对象。请确保当前图像图形对象 正好属于此fsdk.GraphicsObjects 对象(可能是PDF页面)。
返回
新克隆的位图对象。如果返回位图对象的函数fsdk.Bitmap.IsEmpty 的返回值为true, 表示位图的DIB格式不受支持。

◆ CloneBitmap() [2/2]

def fsdk.ImageObject.CloneBitmap (   page,
  graphics_objects 
)

从当前图像图形对象克隆位图。

目前,只有当位图格式是以下格式之一时,才能从图像图形对象克隆位图:
fsdk.BitmapE_DIB8bppMask fsdk.BitmapE_DIB8bpp fsdk.BitmapE_DIBRgb fsdk.BitmapE_DIBRgb32 fsdk.BitmapE_DIBArgb fsdk.BitmapE_DIBCmyk
如果返回位图对象的函数fsdk.Bitmap.IsEmpty 的返回值为true, 表示位图的DIB格式不受支持。

参数
[in]page有效的PDF页面对象。请确保当前图像图形对象正好属于此页面。
[in]graphics_objects有效的fsdk.GraphicsObjects 对象。请确保当前图像图形对象 正好属于此fsdk.GraphicsObjects 对象(可能是PDF页面)。
返回
新克隆的位图对象。如果返回位图对象的函数fsdk.Bitmap.IsEmpty 的返回值为true, 表示位图的DIB格式不受支持。

◆ GetColorSpace()

def fsdk.ImageObject.GetColorSpace ( )

获取颜色空间。

返回
颜色空间。请参考从fsdk.E_ColorSpaceDeviceGray 开始的值, 这将是这些值中的一个。

◆ GetMask()

def fsdk.ImageObject.GetMask ( )

获取表示当前图像图形对象蒙版的PDF对象。

蒙版可以是PDF字典或PDF数组:

  • PDF字典表示要应用到此图像的图像蒙版。

  • PDF数组表示要作为颜色键蒙版应用到图像的颜色范围。

更多详细信息请参阅<PDF Reference 1.7>中的第4.8.4节"图像字典"。

返回
表示蒙版的PDF对象。 如果fsdk.ImageObject.IsImageMask 返回true,此函数将返回null

◆ GetStream()

def fsdk.ImageObject.GetStream ( )

获取图像流。

返回
表示图像流的fsdk.PDFStream 。 如果有任何错误,此函数将返回null

◆ IsImageMask()

def fsdk.ImageObject.IsImageMask ( )

检查当前图像对象是否被视为蒙版。

返回
true 表示当前对象被视为蒙版,false 表示不是。

◆ SetBitmap()

def fsdk.ImageObject.SetBitmap (   bitmap,
  mask 
)

将位图设置到当前图像图形对象。

参数
[in]bitmap要设置到当前图像的有效位图对象。
[in]mask蒙版位图。默认值:通过默认构造函数创建的位图对象,未设置任何值, 表示不使用蒙版。
如果此参数有效,其格式应为fsdk.BitmapE_DIB8bppMask
仅当参数bitmap没有alpha通道时,此参数才有用。
返回
注解
当此函数成功时,应调用函数fsdk.GraphicsObjects.GenerateContent 。 更多详细信息请参阅函数fsdk.GraphicsObjects.GenerateContent

◆ SetImage()

def fsdk.ImageObject.SetImage (   image,
  frame_index 
)

将图像的一帧设置到当前图像图形对象。

输入图像可能包含多帧,只能将图像的一帧设置到当前图像图形对象。

参数
[in]image有效的图像对象。此图像应至少包含一帧,图像类型 不应为fsdk.ImageE_Unknown
[in]frame_index帧索引,用于决定参数image的哪一帧要被设置。 有效范围:从0到(count-1)。count由函数 fsdk.Image.GetFrameCount 返回。
返回
注解
当此函数成功时,应调用函数fsdk.GraphicsObjects.GenerateContent 。 更多详细信息请参阅函数fsdk.GraphicsObjects.GenerateContent