Foxit PDF SDK

Public 成员函数 | 静态 Public 成员函数 | 所有成员列表
FoxitPDFSDKPython2.ImageObject类 参考
类 FoxitPDFSDKPython2.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)
| 将图像的一帧设置到当前图像图形对象。 更多...
Public 成员函数 继承自 FoxitPDFSDKPython2.GraphicsObject
def | AddClipPath (path, fill_mode)
| 添加用于裁剪的路径。 更多...
def | AddClipTextObject (textobject)
| 添加用于裁剪的文本对象。 更多...
def | ClearClips ()
| 清除所有裁剪。 更多...
def | Clone ()
| 克隆新的图形对象。 更多...
def | GetBlendMode ()
| 获取透明成像模型的混合模式。 更多...
def | GetClipPath (index)
| 根据索引获取路径裁剪。 更多...
def | GetClipPathCount ()
| 获取路径裁剪的数量。 更多...
def | GetClipPathFillMode (index)
| 根据索引获取路径裁剪的填充模式。 更多...
def | GetClipRect ()
| 获取裁剪矩形。 更多...
def | GetClipTextObject (index)
| 根据索引获取文本裁剪的文本对象。 更多...
def | GetClipTextObjectCount ()
| 获取文本裁剪的数量。 更多...
def | GetColorState ()
| 获取颜色状态。 更多...
def | GetFillColor ()
| 获取填充颜色。 更多...
def | GetFillOpacity ()
| 获取除描边外的绘制操作的不透明度值。 更多...
def | GetFormXObject ()
| 如果当前图形对象表示表单XObject对象，则获取表单XObject图形对象。 更多...
def | GetGraphState ()
| 获取图形状态。 更多...
def | GetImageObject ()
| 如果当前图形对象表示图像对象，则获取图像图形对象。 更多...
def | GetLayers (layer_tree)
| 获取与当前图形对象关联的所有图层。 更多...
def | GetMarkedContent ()
| 获取标记内容对象。 更多...
def | GetMatrix ()
| 获取矩阵。 更多...
def | GetPathObject ()
| 如果当前图形对象表示路径对象，则获取路径图形对象。 更多...
def | GetRect ()
| 获取当前图形对象的矩形。 更多...
def | GetShadingObject ()
| 如果当前图形对象表示阴影对象，则获取阴影图形对象。 更多...
def | GetStrokeColor ()
| 获取描边颜色。 更多...
def | GetStrokeOpacity ()
| 获取路径和字形轮廓的描边绘制操作的不透明度值。 更多...
def | GetTextObject ()
| 如果当前图形对象表示文本对象，则获取文本图形对象。 更多...
def | GetType ()
| 获取当前图形对象的类型。 更多...
def | HasTransparency ()
| 检查当前图形对象是否具有透明度。 更多...
def | Release ()
| 释放尚未插入到任何PDF页面中的克隆或新创建的PDF图形对象或其他对象。 更多...
def | RemoveClipPath (index)
| 根据索引删除路径裁剪。 更多...
def | RemoveClipTextObject (index)
| 根据索引删除用于裁剪的文本裁剪。 更多...
def | Rotate (angle)
| 从当前状态以指定的角度顺时针旋转当前图形对象。 更多...
def | SetBlendMode (blend_mode)
| 设置透明成像模型的混合模式。 更多...
def | SetClipRect (clip_rect)
| 设置裁剪矩形。 更多...
def | SetColorState (color_state)
| 设置颜色状态。 更多...
def | SetFillColor (color)
| 设置填充颜色。 更多...
def | SetFillOpacity (opacity)
| 设置除描边外的绘制操作的不透明度值。 更多...
def | SetGraphState (graph_state)
| 设置图形状态。 更多...
def | SetMatrix (matrix)
| 设置矩阵。 更多...
def | SetStrokeColor (color)
| 设置描边颜色。 更多...
def | SetStrokeOpacity (opacity)
| 设置路径和字形轮廓的描边绘制操作的不透明度值。 更多...
def | Transform (matrix, need_transform_clippath)
| 变换当前图形对象。 更多...

## 静态 Public 成员函数
def | Create (document)
| 创建新的图像图形对象。 更多...
def | CreateFromType3TextObject (page, text_obj)
| 从type3文本对象创建图像图形对象。 更多...

## 额外继承的成员函数
静态 Public 属性 继承自 FoxitPDFSDKPython2.GraphicsObject
| e_BlendColor = _fsdk.GraphicsObject_e_BlendColor
| 使用源颜色的色调和饱和度以及背景颜色的明度创建颜色。 更多...
| e_BlendColorBurn = _fsdk.GraphicsObject_e_BlendColorBurn
| 加深背景颜色以反映源颜色。 更多...
| e_BlendColorDodge = _fsdk.GraphicsObject_e_BlendColorDodge
| 增亮背景颜色以反映源颜色。 更多...
| e_BlendDarken = _fsdk.GraphicsObject_e_BlendDarken
| 选择背景和源颜色中较暗的一个。 更多...
| e_BlendDifference = _fsdk.GraphicsObject_e_BlendDifference
| 从较亮的颜色中减去两种组成颜色中较暗的一种。 更多...
| e_BlendExclusion = _fsdk.GraphicsObject_e_BlendExclusion
| 使用源颜色的色调和背景颜色的饱和度和明度创建颜色。 更多...
| e_BlendHardlight = _fsdk.GraphicsObject_e_BlendHardlight
| 根据源颜色值进行相乘或滤色。 更多...
| e_BlendHue = _fsdk.GraphicsObject_e_BlendHue
| 使用源颜色的色调和背景颜色的饱和度和明度创建颜色。 更多...
| e_BlendLighten = _fsdk.GraphicsObject_e_BlendLighten
| 选择背景和源颜色中较亮的一个。 更多...
| e_BlendLuminosity = _fsdk.GraphicsObject_e_BlendLuminosity
| 使用源颜色的明度和背景颜色的色调和饱和度创建颜色。 更多...
| e_BlendMultiply = _fsdk.GraphicsObject_e_BlendMultiply
| 将背景与源颜色值相乘。 更多...
| e_BlendNormal = _fsdk.GraphicsObject_e_BlendNormal
| 选择源颜色并忽略背景颜色。 更多...
| e_BlendOverlay = _fsdk.GraphicsObject_e_BlendOverlay
| 根据背景颜色值进行相乘或滤色。 更多...
| e_BlendSaturation = _fsdk.GraphicsObject_e_BlendSaturation
| 使用源颜色的饱和度和背景颜色的色调和明度创建颜色。 更多...
| e_BlendScreen = _fsdk.GraphicsObject_e_BlendScreen
| 将背景的补码与源颜色值相乘，然后对结果取补。 更多...
| e_BlendSoftlight = _fsdk.GraphicsObject_e_BlendSoftlight
| 根据源颜色值使颜色变暗或变亮。 更多...
| e_TypeAll = _fsdk.GraphicsObject_e_TypeAll
| 表示所有图形对象类型，仅用作过滤器。
| e_TypeEmptyMarkedContent = _fsdk.GraphicsObject_e_TypeEmptyMarkedContent
| 空标记内容对象。
| e_TypeFormXObject = _fsdk.GraphicsObject_e_TypeFormXObject
| 表单XObject图形对象。
| e_TypeImage = _fsdk.GraphicsObject_e_TypeImage
| 图像图形对象。
| e_TypeInlines = _fsdk.GraphicsObject_e_TypeInlines
| 内联图形对象。
| e_TypePath = _fsdk.GraphicsObject_e_TypePath
| 路径图形对象。
| e_TypeShading = _fsdk.GraphicsObject_e_TypeShading
| 阴影图形对象。
| e_TypeText = _fsdk.GraphicsObject_e_TypeText
| 文本图形对象。

## 详细描述

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

参见
  GraphicsObject

## 成员函数说明

## ◆ CloneBitmap() [1/2]

def FoxitPDFSDKPython2.ImageObject.CloneBitmap | ( |  | graphics_objects | ) |

弃用:
  此函数已弃用。请使用带两个参数的函数FoxitPDFSDKPython2.ImageObject.CloneBitmap 。

目前，只有当位图格式是以下格式之一时，才能从图像图形对象克隆位图：
FoxitPDFSDKPython2.Bitmap.e_DIB8bppMask 、FoxitPDFSDKPython2.Bitmap.e_DIB8bpp 、 FoxitPDFSDKPython2.Bitmap.e_DIBRgb 、FoxitPDFSDKPython2.Bitmap.e_DIBRgb32 、 FoxitPDFSDKPython2.Bitmap.e_DIBArgb 、FoxitPDFSDKPython2.Bitmap.e_DIBCmyk 。
如果返回位图对象的函数FoxitPDFSDKPython2.Bitmap.IsEmpty 的返回值为true， 表示位图的DIB格式不受支持。

参数

  [in] | graphics_objects | 有效的FoxitPDFSDKPython2.GraphicsObjects 对象。请确保当前图像图形对象 正好属于此FoxitPDFSDKPython2.GraphicsObjects 对象(可能是PDF页面)。

返回
  新克隆的位图对象。如果返回位图对象的函数FoxitPDFSDKPython2.Bitmap.IsEmpty 的返回值为true， 表示位图的DIB格式不受支持。

## ◆ CloneBitmap() [2/2]

def FoxitPDFSDKPython2.ImageObject.CloneBitmap | ( |  | page,
|  |  | graphics_objects
| ) |  |

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

目前，只有当位图格式是以下格式之一时，才能从图像图形对象克隆位图：
FoxitPDFSDKPython2.Bitmap.e_DIB8bppMask 、FoxitPDFSDKPython2.Bitmap.e_DIB8bpp 、 FoxitPDFSDKPython2.Bitmap.e_DIBRgb 、FoxitPDFSDKPython2.Bitmap.e_DIBRgb32 、 FoxitPDFSDKPython2.Bitmap.e_DIBArgb 、FoxitPDFSDKPython2.Bitmap.e_DIBCmyk 。
如果返回位图对象的函数FoxitPDFSDKPython2.Bitmap.IsEmpty 的返回值为true， 表示位图的DIB格式不受支持。

参数

  [in] | page | 有效的PDF页面对象。请确保当前图像图形对象正好属于此页面。
  [in] | graphics_objects | 有效的FoxitPDFSDKPython2.GraphicsObjects 对象。请确保当前图像图形对象 正好属于此FoxitPDFSDKPython2.GraphicsObjects 对象(可能是PDF页面)。

返回
  新克隆的位图对象。如果返回位图对象的函数FoxitPDFSDKPython2.Bitmap.IsEmpty 的返回值为true， 表示位图的DIB格式不受支持。

## ◆ Create()

FoxitPDFSDKPython2.ImageObject.Create | ( |  | document | ) |
| static

创建新的图像图形对象。

新创建的图像图形对象还没有任何数据。然后，可以调用设置函数 为新的图像图形对象设置数据。 如果新创建的图像图形对象不会插入到任何页面或其他对象中， 请记住在不使用时调用函数FoxitPDFSDKPython2.GraphicsObject.Release 来释放它。

参数

  [in] | document | 有效的PDF文档对象。然后新的图像图形对象应该插入到 此PDF文档的一个页面中。

返回
  新的图像对象。如果有任何错误，此函数将返回null。

## ◆ CreateFromType3TextObject()

FoxitPDFSDKPython2.ImageObject.CreateFromType3TextObject | ( |  | page,
|  |  | text_obj
| ) |  |
| static

从type3文本对象创建图像图形对象。

如果新创建的图像图形对象不会插入到任何页面或其他对象中， 请记住在不使用时调用函数FoxitPDFSDKPython2.GraphicsObject.Release 来释放它。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | text_obj | 有效的文本对象。此文本对象应该是type3文本对象。

返回
  新的图像对象。如果有任何错误，此函数将返回null。

## ◆ GetColorSpace()

def FoxitPDFSDKPython2.ImageObject.GetColorSpace | ( |  | ) |

获取颜色空间。

返回
  颜色空间。请参考从FoxitPDFSDKPython2.e_ColorSpaceDeviceGray 开始的值， 这将是这些值中的一个。

## ◆ GetMask()

def FoxitPDFSDKPython2.ImageObject.GetMask | ( |  | ) |

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

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

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

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

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

## ◆ GetStream()

def FoxitPDFSDKPython2.ImageObject.GetStream | ( |  | ) |

获取图像流。

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

## ◆ IsImageMask()

def FoxitPDFSDKPython2.ImageObject.IsImageMask | ( |  | ) |

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

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

## ◆ SetBitmap()

def FoxitPDFSDKPython2.ImageObject.SetBitmap | ( |  | bitmap,
|  |  | mask
| ) |  |

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

参数

  [in] | bitmap | 要设置到当前图像的有效位图对象。
  [in] | mask | 蒙版位图。默认值：通过默认构造函数创建的位图对象，未设置任何值， 表示不使用蒙版。 如果此参数有效，其格式应为FoxitPDFSDKPython2.Bitmap.e_DIB8bppMask 。 仅当参数bitmap没有alpha通道时，此参数才有用。

返回
  无

注解
  当此函数成功时，应调用函数FoxitPDFSDKPython2.GraphicsObjects.GenerateContent 。 更多详细信息请参阅函数FoxitPDFSDKPython2.GraphicsObjects.GenerateContent 。

## ◆ SetImage()

def FoxitPDFSDKPython2.ImageObject.SetImage | ( |  | image,
|  |  | frame_index
| ) |  |

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

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

参数

  [in] | image | 有效的图像对象。此图像应至少包含一帧，图像类型 不应为FoxitPDFSDKPython2.Image.e_Unknown 。
  [in] | frame_index | 帧索引，用于决定参数image的哪一帧要被设置。 有效范围：从0到(count-1)。count由函数 FoxitPDFSDKPython2.Image.GetFrameCount 返回。

返回
  无

注解
  当此函数成功时，应调用函数FoxitPDFSDKPython2.GraphicsObjects.GenerateContent 。 更多详细信息请参阅函数FoxitPDFSDKPython2.GraphicsObjects.GenerateContent 。