Public 成员函数
def	AddClipPath (path, fill_mode)
	添加用于裁剪的路径。更多...

def	AddClipTextObject (textobject)
	添加用于裁剪的文本对象。更多...

def	ClearClips ()
	清除所有裁剪。更多...

def	Clone (a, interface)
	克隆新的图形对象。更多...

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)
	变换当前图形对象。更多...

详细描述

PDF页面的内容通常由一系列图形对象组成。每个图形对象包含其状态信息、数据和渲染指令。
类GraphicsObject 是所有类型PDF图形对象的基类。它提供获取/设置图形对象通用属性的基本函数。对于具体的图形对象类型，请参阅派生类。
要获取或插入/删除图形对象，请参阅类fsdk.GraphicsObjects 。
如果对PDF图形对象进行了任何更改，请记住为fsdk.GraphicsObjects 对象 (当前图形对象所属的对象)调用函数fsdk.GraphicsObjects.GenerateContent 。更多详细信息请参阅函数fsdk.GraphicsObjects.GenerateContent 的注释。

参见: fsdk.GraphicsObjects

成员函数说明

◆ AddClipPath()

def fsdk.GraphicsObject.AddClipPath	(	path,
		fill_mode
	)

添加用于裁剪的路径。

参数

[in]	path	要添加到当前图形对象的路径数据。
[in]	fill_mode	输入路径的填充模式。请参考从 fsdk.E_FillModeNone 开始的值，这应该是这些值中的一个。

返回: true 表示成功，false 表示失败。

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

◆ AddClipTextObject()

def fsdk.GraphicsObject.AddClipTextObject ( textobject )

添加用于裁剪的文本对象。

参数

[in] textobject 要添加用于裁剪的文本对象。

返回: true 表示成功，false 表示失败。

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

◆ ClearClips()

def fsdk.GraphicsObject.ClearClips ( )

清除所有裁剪。

返回: true 表示成功，false 表示失败。

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

◆ Clone()

def fsdk.GraphicsObject.Clone	(	a,
		interface
	)

克隆新的图形对象。

新克隆的图形对象默认与当前图形对象关联到同一页面。新克隆的图形对象只能在包含当前图形对象的PDF文件内使用。如果克隆的图形对象未插入到任何PDF页面或其他对象中，请记住在不再使用时调用函数fsdk.GraphicsObject.Release 来释放它。

返回: 克隆的图形对象。如果有任何错误，此函数将返回null。

新克隆的图形对象与dest_graphicsobjects所属的页面相关联。新克隆的图形对象可以在包含当前图形对象的PDF文件内外使用。如果克隆的图形对象未插入到任何PDF页面或其他对象中，请记住在不再使用时调用函数fsdk.GraphicsObject.Release 来释放它。

参数

[in]	src_graphicsobjects	包含当前图形对象的GraphicsObjects 对象。
[in]	dest_graphicsobjects	将包含克隆图形对象的GraphicsObjects 对象。这可以属于当前文档中的另一页面或另一文档中的页面。

返回: 克隆的图形对象。如果有任何错误，此函数将返回null。

◆ GetBlendMode()

def fsdk.GraphicsObject.GetBlendMode ( )

获取透明成像模型的混合模式。

返回: 透明成像模型的混合模式。请参考从 fsdk.GraphicsObjectE_BlendNormal 开始的值，这将是这些值中的一个。

◆ GetClipPath()

def fsdk.GraphicsObject.GetClipPath ( index )

根据索引获取路径裁剪。

参数

[in] index 路径裁剪索引。有效范围：从0到(count-1)。 count 由函数fsdk.GraphicsObject.GetClipPath 返回。

返回: 路径数据。如果返回路径对象的函数fsdk.Path.IsEmpty 的返回值为true，表示有任何错误。

◆ GetClipPathCount()

def fsdk.GraphicsObject.GetClipPathCount ( )

获取路径裁剪的数量。

返回: 路径裁剪的数量。

◆ GetClipPathFillMode()

def fsdk.GraphicsObject.GetClipPathFillMode ( index )

根据索引获取路径裁剪的填充模式。

参数

[in] index 路径裁剪索引。有效范围：从0到(count-1)。 count 由函数fsdk.GraphicsObject.GetClipPath 返回。

返回: 填充模式。请参考从fsdk.E_FillModeNone 开始的值，这将是这些值中的一个。

◆ GetClipRect()

def fsdk.GraphicsObject.GetClipRect ( )

获取裁剪矩形。

返回: 裁剪矩形。如果没有裁剪矩形，将返回一个所有值都为0的RectF对象。

◆ GetClipTextObject()

def fsdk.GraphicsObject.GetClipTextObject ( index )

根据索引获取文本裁剪的文本对象。

参数

[in] index 文本裁剪索引。有效范围：从0到(count-1)。 count 由函数fsdk.GraphicsObject.GetClipTextObjectCount 返回。

返回: 文本图形对象。如果有任何错误，此函数将返回null。

◆ GetClipTextObjectCount()

def fsdk.GraphicsObject.GetClipTextObjectCount ( )

获取文本裁剪的数量。

返回: 文本裁剪的数量。

◆ GetColorState()

def fsdk.GraphicsObject.GetColorState ( )

获取颜色状态。

文本图形对象、路径图形对象和表单XObject图形对象可以具有颜色状态。

返回: 颜色状态。

◆ GetFillColor()

def fsdk.GraphicsObject.GetFillColor ( )

获取填充颜色。

文本图形对象、路径图形对象和表单XObject图形对象可以具有此属性。函数fsdk.GraphicsObject.GetColorState 可用于获取其他颜色空间(如CMYK颜色空间)中的填充颜色。

返回: 颜色值，格式为0xAARRGGBB。

◆ GetFillOpacity()

def fsdk.GraphicsObject.GetFillOpacity ( )

获取除描边外的绘制操作的不透明度值。

返回: 不透明度值。有效范围：0.0到1.0。0.0表示完全透明，1.0表示完全不透明。如果找不到不透明度值，将返回1作为默认值。

◆ GetFormXObject()

def fsdk.GraphicsObject.GetFormXObject ( )

如果当前图形对象表示表单XObject对象，则获取表单XObject图形对象。

返回: 表单XObject图形对象。如果当前图形对象不表示表单XObject对象，此函数将返回null。

◆ GetGraphState()

def fsdk.GraphicsObject.GetGraphState ( )

获取图形状态。

表单XObject图形对象、路径图形对象和文本图形对象可以具有此属性。

返回: 图形状态。

◆ GetImageObject()

def fsdk.GraphicsObject.GetImageObject ( )

如果当前图形对象表示图像对象，则获取图像图形对象。

返回: 图像图形对象。如果当前图形对象不表示图像对象，此函数将返回null。

◆ GetLayers()

def fsdk.GraphicsObject.GetLayers ( layer_tree )

获取与当前图形对象关联的所有图层。

参数

[in] layer_tree 有效的图层树。此图层树中的所有图层节点将按顺序枚举，以查找与当前图形对象关联的图层。

返回: 包含所有匹配图层节点的图层节点数组。

◆ GetMarkedContent()

def fsdk.GraphicsObject.GetMarkedContent ( )

获取标记内容对象。

返回: 标记内容对象。如果有任何错误，此函数将返回null。

◆ GetMatrix()

def fsdk.GraphicsObject.GetMatrix ( )

获取矩阵。

返回: 矩阵值。如果有任何错误，此函数将返回一个所有值都为0的矩阵。

◆ GetPathObject()

def fsdk.GraphicsObject.GetPathObject ( )

如果当前图形对象表示路径对象，则获取路径图形对象。

返回: 路径图形对象。如果当前图形对象不表示路径对象，此函数将返回null。

◆ GetRect()

def fsdk.GraphicsObject.GetRect ( )

获取当前图形对象的矩形。

返回: 当前图形对象的矩形。如果有任何错误，此函数将返回一个所有值都为0的RectF对象。

◆ GetShadingObject()

def fsdk.GraphicsObject.GetShadingObject ( )

如果当前图形对象表示阴影对象，则获取阴影图形对象。

返回: 阴影图形对象。如果当前图形对象不表示阴影对象，此函数将返回null。

◆ GetStrokeColor()

def fsdk.GraphicsObject.GetStrokeColor ( )

获取描边颜色。

文本图形对象、路径图形对象和表单XObject图形对象可以具有此属性。
函数fsdk.GraphicsObject.GetColorState 可用于获取其他颜色空间(如CMYK颜色空间)中的描边颜色。

返回: 颜色值，格式为0xAARRGGBB。

◆ GetStrokeOpacity()

def fsdk.GraphicsObject.GetStrokeOpacity ( )

获取路径和字形轮廓的描边绘制操作的不透明度值。

返回: 不透明度值。有效范围：0.0到1.0。0.0表示完全透明，1.0表示完全不透明。如果找不到不透明度值，将返回1作为默认值。

◆ GetTextObject()

def fsdk.GraphicsObject.GetTextObject ( )

如果当前图形对象表示文本对象，则获取文本图形对象。

返回: 文本图形对象。如果当前图形对象不表示文本对象，此函数将返回null。

◆ GetType()

def fsdk.GraphicsObject.GetType ( )

获取当前图形对象的类型。

返回: 图形对象类型。请参考从fsdk.GraphicsObjectE_TypeText 开始的值，这将是这些值中的一个，除了fsdk.GraphicsObjectE_TypeAll 。

◆ HasTransparency()

def fsdk.GraphicsObject.HasTransparency ( )

检查当前图形对象是否具有透明度。

返回: true 表示当前图形对象具有透明度，false 表示没有。

◆ Release()

def fsdk.GraphicsObject.Release ( )

释放尚未插入到任何PDF页面中的克隆或新创建的PDF图形对象或其他对象。

返回: 无。

◆ RemoveClipPath()

def fsdk.GraphicsObject.RemoveClipPath ( index )

根据索引删除路径裁剪。

参数

[in] index 路径裁剪索引。有效范围：从0到(count-1)。 count 由函数fsdk.GraphicsObject.GetClipPath 返回。

返回: true 表示成功，false 表示失败。

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

◆ RemoveClipTextObject()

def fsdk.GraphicsObject.RemoveClipTextObject ( index )

根据索引删除用于裁剪的文本裁剪。

参数

[in] index 文本裁剪索引。有效范围：从0到(count-1)。 count 由函数fsdk.GraphicsObject.GetClipTextObjectCount 返回。

返回: true 表示成功，false 表示失败。

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

◆ Rotate()

def fsdk.GraphicsObject.Rotate ( angle )

从当前状态以指定的角度顺时针旋转当前图形对象。

参数

[in] angle 角度值，用于从当前状态顺时针旋转当前图形对象。值范围：从0到360。特别地，如果输入值为0或360(表示不旋转当前图形对象)，当前函数将不执行任何操作。

返回: 无。

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

◆ SetBlendMode()

def fsdk.GraphicsObject.SetBlendMode ( blend_mode )

设置透明成像模型的混合模式。

参数

[in] blend_mode 新的混合模式。请参考从fsdk.GraphicsObjectE_BlendNormal 开始的值，这应该是这些值中的一个。

返回: 无。

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

◆ SetClipRect()

def fsdk.GraphicsObject.SetClipRect ( clip_rect )

设置裁剪矩形。

新的裁剪矩形将默认使用填充模式fsdk.E_FillModeWinding 设置。

参数

[in] clip_rect 新的裁剪矩形。

返回: 无。

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

◆ SetColorState()

def fsdk.GraphicsObject.SetColorState ( color_state )

设置颜色状态。

文本图形对象、路径图形对象和表单XObject图形对象可以具有此属性。如果尝试为其余不支持的类型设置颜色状态，将抛出异常fsdk.E_ErrUnsupported 。

参数

[in] color_state 要设置到当前图形对象的颜色状态对象。

返回: 无。

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

◆ SetFillColor()

def fsdk.GraphicsObject.SetFillColor ( color )

设置填充颜色。

文本图形对象、路径图形对象和表单XObject图形对象可以具有颜色状态。如果尝试为其余不支持的类型设置填充颜色，将抛出fsdk.E_ErrUnsupported 。
对于路径图形对象，请确保填充模式不是fsdk.E_FillModeNone ；否则填充颜色将不会对路径图形对象产生任何影响。请参阅函数 fsdk.PathObject.GetFillMode 和fsdk.PathObject.SetFillMode 来检查和更改路径图形对象的填充模式。

此函数仅设置RGB颜色值。如果需要设置其他颜色空间（如CMYK颜色空间）的填充颜色，可以使用函数fsdk.GraphicsObject.SetColorState 。

参数

[in] color 新的颜色值，格式为0xAARRGGBB。

返回: 无。

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

◆ SetFillOpacity()

def fsdk.GraphicsObject.SetFillOpacity ( opacity )

设置除描边外的绘制操作的不透明度值。

参数

[in] opacity 新的不透明度值。有效范围：0.0到1.0。 0.0表示完全透明，1.0表示完全不透明。

返回: 无。

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

◆ SetGraphState()

def fsdk.GraphicsObject.SetGraphState ( graph_state )

设置图形状态。

表单XObject图形对象、路径图形对象和文本图形对象(其文本模式为 fsdk.TextStateE_ModeStroke 、fsdk.TextStateE_ModeStrokeClip 、 fsdk.TextStateE_ModeFillStroke 或fsdk.TextStateE_ModeFillStrokeClip ) 可以具有此属性。如果尝试为其余不支持的类型设置图形状态，将抛出异常 fsdk.E_ErrUnsupported 。

参数

[in] graph_state 新的图形状态。

返回: 无。

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

◆ SetMatrix()

def fsdk.GraphicsObject.SetMatrix ( matrix )

设置矩阵。

参数

[in] matrix 新的矩阵值。

返回: 无。

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

◆ SetStrokeColor()

def fsdk.GraphicsObject.SetStrokeColor ( color )

设置描边颜色。

文本图形对象、路径图形对象和表单XObject图形对象可以具有此属性。如果当前图形对象是文本图形对象且文本模式为fsdk.TextStateE_ModeFill ，描边颜色将不会对文本图形对象产生影响。
如果尝试为其余不支持的类型设置描边颜色，将抛出异常fsdk.E_ErrUnsupported 。
函数fsdk.GraphicsObject.SetColorState 可用于在其他颜色空间(如CMYK颜色空间)中设置描边颜色。

参数

[in] color 新的颜色值，格式为0xAARRGGBB。

返回: 无。

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

◆ SetStrokeOpacity()

def fsdk.GraphicsObject.SetStrokeOpacity ( opacity )

设置路径和字形轮廓的描边绘制操作的不透明度值。

参数

[in] opacity 新的不透明度值。有效范围：0.0到1.0。 0.0表示完全透明，1.0表示完全不透明。

返回: 无。

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

◆ Transform()

def fsdk.GraphicsObject.Transform	(	matrix,
		need_transform_clippath
	)

变换当前图形对象。

参数

[in]	matrix	变换矩阵。
[in]	need_transform_clippath	true 表示与当前图形对象一起变换裁剪路径。 false 表示仅变换当前图形对象。

返回: true 表示成功，false 表示失败。

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

Public 成员函数

详细描述

成员函数说明

◆ AddClipPath()

◆ AddClipTextObject()

◆ ClearClips()

◆ Clone()

◆ GetBlendMode()

◆ GetClipPath()

◆ GetClipPathCount()

◆ GetClipPathFillMode()

◆ GetClipRect()

◆ GetClipTextObject()

◆ GetClipTextObjectCount()

◆ GetColorState()

◆ GetFillColor()

◆ GetFillOpacity()

◆ GetFormXObject()

◆ GetGraphState()

◆ GetImageObject()

◆ GetLayers()

◆ GetMarkedContent()

◆ GetMatrix()

◆ GetPathObject()

◆ GetRect()

◆ GetShadingObject()

◆ GetStrokeColor()

◆ GetStrokeOpacity()

◆ GetTextObject()

◆ GetType()

◆ HasTransparency()

◆ Release()

◆ RemoveClipPath()

◆ RemoveClipTextObject()

◆ Rotate()

◆ SetBlendMode()

◆ SetClipRect()

◆ SetColorState()

◆ SetFillColor()

◆ SetFillOpacity()

◆ SetGraphState()

◆ SetMatrix()

◆ SetStrokeColor()

◆ SetStrokeOpacity()

◆ Transform()