Foxit PDF SDK
fsdk.GraphicsObject Class Reference

Public Member Functions

def AddClipPath (path, fill_mode)
 Add a path for clipping. More...
 
def AddClipTextObject (textobject)
 Add text object for clipping. More...
 
def ClearClips ()
 Clear all clips. More...
 
def Clone (a, interface)
 Clone a new graphics object. More...
 
def GetBlendMode ()
 Get the blend mode for transparent imaging model. More...
 
def GetClipPath (index)
 Get a path clip by index. More...
 
def GetClipPathCount ()
 Get the count of path clip. More...
 
def GetClipPathFillMode (index)
 Get the fill mode of a path clip by index. More...
 
def GetClipRect ()
 Get clip rectangle. More...
 
def GetClipTextObject (index)
 Get the text object of a text clip by index. More...
 
def GetClipTextObjectCount ()
 Get the count of text clip. More...
 
def GetColorState ()
 Get color state. More...
 
def GetFillColor ()
 Get the fill color. More...
 
def GetFillOpacity ()
 Get the opacity value for painting operations other than stroking. More...
 
def GetFormXObject ()
 Get the form XObject graphics object if current graphics object represents a form XObject object. More...
 
def GetGraphState ()
 Get graph state. More...
 
def GetImageObject ()
 Get the image graphics object if current graphics object represents an image object. More...
 
def GetLayers (layer_tree)
 Get all the layers which are associated with current graphics object. More...
 
def GetMarkedContent ()
 Get marked content object. More...
 
def GetMatrix ()
 Get matrix. More...
 
def GetPathObject ()
 Get the path graphics object if current graphics object represents a path object. More...
 
def GetRect ()
 Get the rectangle of current graphics object. More...
 
def GetShadingObject ()
 Get the shading graphics object if current graphics object represents a shading object. More...
 
def GetStrokeColor ()
 Get the stroke color. More...
 
def GetStrokeOpacity ()
 Get opacity value for stroke painting operations for paths and glyph outlines. More...
 
def GetTextObject ()
 Get the text graphics object if current graphics object represents a text object. More...
 
def GetType ()
 Get the type of current graphics object. More...
 
def HasTransparency ()
 Check whether current graphics object has transparency or not. More...
 
def Release ()
 Release a cloned or newly created PDF graphics object which has not been inserted into any PDF page or other object. More...
 
def RemoveClipPath (index)
 Remove a path clip by index. More...
 
def RemoveClipTextObject (index)
 Remove a text clip by index for clipping. More...
 
def Rotate (angle)
 Rotate current graphics object from current state with specified angle degree in clockwise. More...
 
def SetBlendMode (blend_mode)
 Set the blend mode for transparent imaging model. More...
 
def SetClipRect (clip_rect)
 Set clip rectangle. More...
 
def SetColorState (color_state)
 Set color state. More...
 
def SetFillColor (color)
 Set the fill color. More...
 
def SetFillOpacity (opacity)
 Set the opacity value for painting operations other than stroking. More...
 
def SetGraphState (graph_state)
 Set graph state. More...
 
def SetMatrix (matrix)
 Set matrix. More...
 
def SetStrokeColor (color)
 Set the stroke color. More...
 
def SetStrokeOpacity (opacity)
 Set opacity value for stroke painting operations for paths and glyph outlines. More...
 
def Transform (matrix, need_transform_clippath)
 Transform current graphics object. More...
 

Detailed Description

Content of a PDF page usually consists of a sequence of graphics objects. Each graphics object contains its state information, data and instructions for rendering.
Class GraphicsObject is the base class for all types of PDF graphics objects. It offers the base functions to get/set graphics object's common properties. For concrete graphics object types, please refer to derived classes.
To get or insert/remove a graphics object, please refer to class fsdk.GraphicsObjects .
If any change is done to a PDF graphics object, please remember to call function fsdk.GraphicsObjects.GenerateContent for fsdk.GraphicsObjects object (to which current graphics object belongs). Please refer to comment of function fsdk.GraphicsObjects.GenerateContent for more details.

See also
fsdk.GraphicsObjects

Member Function Documentation

◆ AddClipPath()

def fsdk.GraphicsObject.AddClipPath (   path,
  fill_mode 
)

Add a path for clipping.

Parameters
[in]pathPath data to be added to current graphics object.
[in]fill_modeFill mode for the input path. Please refer to values starting from fsdk.E_FillModeNone and this should be one of these values.
Returns
true means success, while false means failure.
Note
When this function succeeds, function fsdk.GraphicsObjects.GenerateContent should be called. Please refer to function fsdk.GraphicsObjects.GenerateContent for more details.

◆ AddClipTextObject()

def fsdk.GraphicsObject.AddClipTextObject (   textobject)

Add text object for clipping.

Parameters
[in]textobjectText object to be added for clipping.
Returns
true means success, while false means failure.
Note
When this function succeeds, function fsdk.GraphicsObjects.GenerateContent should be called. Please refer to function fsdk.GraphicsObjects.GenerateContent for more details.

◆ ClearClips()

def fsdk.GraphicsObject.ClearClips ( )

Clear all clips.

Returns
true means success, while false means failure.
Note
When this function succeeds, function fsdk.GraphicsObjects.GenerateContent should be called. Please refer to function fsdk.GraphicsObjects.GenerateContent for more details.

◆ Clone()

def fsdk.GraphicsObject.Clone (   a,
  interface 
)

Clone a new graphics object.

Newly cloned graphics object is related to the same page with current graphics object by default. Newly cloned graphics object can only be used inside the PDF file which contains current graphics object. If the cloned graphics object is not inserted to any PDF page or other object, please remember to call function fsdk.GraphicsObject.Release to release it when not use it any more.

Returns
Cloned graphics object. If there is any error, this function will return null.

Newly cloned graphics object is related to the page which is dest_graphicsobjects belong to. Newly cloned graphics object can be used inside or outside the PDF file which contains current graphics object. If the cloned graphics object is not inserted to any PDF page or other object, please remember to call function fsdk.GraphicsObject.Release to release it when not use it any more.

Parameters
[in]src_graphicsobjectsA GraphicsObjects object which contains current graphics object.
[in]dest_graphicsobjectsA GraphicsObjects object which will contain the cloned graphics object. This can belong to another page in current document or a page in another document.
Returns
Cloned graphics object. If there is any error, this function will return null.

◆ GetBlendMode()

def fsdk.GraphicsObject.GetBlendMode ( )

Get the blend mode for transparent imaging model.

Returns
The Blend mode for transparent imaging model. Please refer to values starting from fsdk.GraphicsObjectE_BlendNormal and this would be one of these values.

◆ GetClipPath()

def fsdk.GraphicsObject.GetClipPath (   index)

Get a path clip by index.

Parameters
[in]indexPath clip index. Valid range: from 0 to (count-1). count is returned by function fsdk.GraphicsObject.GetClipPath .
Returns
Path data. If the return value of function fsdk.Path.IsEmpty for the returned path object is true, that means there is any error.

◆ GetClipPathCount()

def fsdk.GraphicsObject.GetClipPathCount ( )

Get the count of path clip.

Returns
Count of path clip.

◆ GetClipPathFillMode()

def fsdk.GraphicsObject.GetClipPathFillMode (   index)

Get the fill mode of a path clip by index.

Parameters
[in]indexPath clip index. Valid range: from 0 to (count-1). count is returned by function fsdk.GraphicsObject.GetClipPath .
Returns
Fill mode. Please refer to values starting from fsdk.E_FillModeNone and this would be one of these values.

◆ GetClipRect()

def fsdk.GraphicsObject.GetClipRect ( )

Get clip rectangle.

Returns
Clip rectangle. If there is no clip rectangle, a RectF object with all values 0 will be returned.

◆ GetClipTextObject()

def fsdk.GraphicsObject.GetClipTextObject (   index)

Get the text object of a text clip by index.

Parameters
[in]indexText clip index. Valid range: from 0 to (count-1). count is returned by function fsdk.GraphicsObject.GetClipTextObjectCount .
Returns
A text graphics object. If there is any error, this function will return null.

◆ GetClipTextObjectCount()

def fsdk.GraphicsObject.GetClipTextObjectCount ( )

Get the count of text clip.

Returns
Count of text clip.

◆ GetColorState()

def fsdk.GraphicsObject.GetColorState ( )

Get color state.

Text graphics object, path graphics object, and form XObject graphics object can have color state.

Returns
Color state.

◆ GetFillColor()

def fsdk.GraphicsObject.GetFillColor ( )

Get the fill color.

Text graphics object, path graphics object, and form XObject graphics object can have this property. Function fsdk.GraphicsObject.GetColorState can be used to get fille color in other color space, like CMYK color space.

Returns
Color value, in format 0xAARRGGBB.

◆ GetFillOpacity()

def fsdk.GraphicsObject.GetFillOpacity ( )

Get the opacity value for painting operations other than stroking.

Returns
The opacity value. Valid range: 0.0 to 1.0. 0.0 means full transparency and 1.0 means full opaque. If no opacity value can be found, 1 will be returned as default value.

◆ GetFormXObject()

def fsdk.GraphicsObject.GetFormXObject ( )

Get the form XObject graphics object if current graphics object represents a form XObject object.

Returns
Form XObject graphics object. If current graphics object does not represent a form XObject object, this function will return null.

◆ GetGraphState()

def fsdk.GraphicsObject.GetGraphState ( )

Get graph state.

Form XObjet graphics object, path graphics object and text graphics object can have this property.

Returns
Graph state.

◆ GetImageObject()

def fsdk.GraphicsObject.GetImageObject ( )

Get the image graphics object if current graphics object represents an image object.

Returns
Image graphics object. If current graphics object does not represent an image object, this function will return null.

◆ GetLayers()

def fsdk.GraphicsObject.GetLayers (   layer_tree)

Get all the layers which are associated with current graphics object.

Parameters
[in]layer_treeA valid layer tree. All the layer nodes in this layer tree will be enumerated in order to find which are associated with current graphics object.
Returns
A layer node array which contains all the matched layer node.

◆ GetMarkedContent()

def fsdk.GraphicsObject.GetMarkedContent ( )

Get marked content object.

Returns
A marked content object. If there is any error, this function will return null.

◆ GetMatrix()

def fsdk.GraphicsObject.GetMatrix ( )

Get matrix.

Returns
Matrix value. If there is any error, this function will return a Matrix with all values 0.

◆ GetPathObject()

def fsdk.GraphicsObject.GetPathObject ( )

Get the path graphics object if current graphics object represents a path object.

Returns
Path graphics object. If current graphics object does not represent a path object, this function will return null.

◆ GetRect()

def fsdk.GraphicsObject.GetRect ( )

Get the rectangle of current graphics object.

Returns
Rectangle of current graphics object. If there is any error, this function will return a RectF object with all values 0.

◆ GetShadingObject()

def fsdk.GraphicsObject.GetShadingObject ( )

Get the shading graphics object if current graphics object represents a shading object.

Returns
Shading graphics object. If current graphics object does not represent a shading object, this function will return null.

◆ GetStrokeColor()

def fsdk.GraphicsObject.GetStrokeColor ( )

Get the stroke color.

Text graphics object, path graphics object, and form XObject graphics object can have this property.
Function fsdk.GraphicsObject.GetColorState can be used to get stroke color in other color space, like CMYK color space.

Returns
Color value, in format 0xAARRGGBB.

◆ GetStrokeOpacity()

def fsdk.GraphicsObject.GetStrokeOpacity ( )

Get opacity value for stroke painting operations for paths and glyph outlines.

Returns
The opacity value. Valid range: 0.0 to 1.0. 0.0 means full transparency and 1.0 means full opaque. If no opacity value can be found, 1 will be returned as default value.

◆ GetTextObject()

def fsdk.GraphicsObject.GetTextObject ( )

Get the text graphics object if current graphics object represents a text object.

Returns
Text graphics object. If current graphics object does not represent a text object, this function will return null.

◆ GetType()

def fsdk.GraphicsObject.GetType ( )

Get the type of current graphics object.

Returns
Graphics object type. Please refer to values starting from fsdk.GraphicsObjectE_TypeText and this would be one of these values except fsdk.GraphicsObjectE_TypeAll .

◆ HasTransparency()

def fsdk.GraphicsObject.HasTransparency ( )

Check whether current graphics object has transparency or not.

Returns
true means current graphics object has transparency, while false means not.

◆ Release()

def fsdk.GraphicsObject.Release ( )

Release a cloned or newly created PDF graphics object which has not been inserted into any PDF page or other object.

Returns
None.

◆ RemoveClipPath()

def fsdk.GraphicsObject.RemoveClipPath (   index)

Remove a path clip by index.

Parameters
[in]indexPath clip index. Valid range: from 0 to (count-1). count is returned by function fsdk.GraphicsObject.GetClipPath .
Returns
true means success, while false means failure.
Note
When this function succeeds, function fsdk.GraphicsObjects.GenerateContent should be called. Please refer to function fsdk.GraphicsObjects.GenerateContent for more details.

◆ RemoveClipTextObject()

def fsdk.GraphicsObject.RemoveClipTextObject (   index)

Remove a text clip by index for clipping.

Parameters
[in]indexText clip index. Valid range: from 0 to (count-1). count is returned by function fsdk.GraphicsObject.GetClipTextObjectCount .
Returns
true means success, while false means failure.
Note
When this function succeeds, function fsdk.GraphicsObjects.GenerateContent should be called. Please refer to function fsdk.GraphicsObjects.GenerateContent for more details.

◆ Rotate()

def fsdk.GraphicsObject.Rotate (   angle)

Rotate current graphics object from current state with specified angle degree in clockwise.

Parameters
[in]angleAngle degree value, which is used to rotate current graphics object from current state in clockwise. Value range: from 0 to 360. Specially, if the input value is 0 or 360 (which means not to rotate current graphics object), current function will do nothing.
Returns
None.
Note
When this function succeeds, function fsdk.GraphicsObjects.GenerateContent should be called. Please refer to function fsdk.GraphicsObjects.GenerateContent for more details.

◆ SetBlendMode()

def fsdk.GraphicsObject.SetBlendMode (   blend_mode)

Set the blend mode for transparent imaging model.

Parameters
[in]blend_modeNew blend mode. Please refer to values starting from fsdk.GraphicsObjectE_BlendNormal and this should be one of these values.
Returns
None.
Note
When this function succeeds, function fsdk.GraphicsObjects.GenerateContent should be called. Please refer to function fsdk.GraphicsObjects.GenerateContent for more details.

◆ SetClipRect()

def fsdk.GraphicsObject.SetClipRect (   clip_rect)

Set clip rectangle.

New clip rectangle will be set with fill mode fsdk.E_FillModeWinding by default.

Parameters
[in]clip_rectNew clip rectangle.
Returns
None.
Note
When this function succeeds, function fsdk.GraphicsObjects.GenerateContent should be called. Please refer to function fsdk.GraphicsObjects.GenerateContent for more details.

◆ SetColorState()

def fsdk.GraphicsObject.SetColorState (   color_state)

Set color state.

Text graphics object, path graphics object, and form XObject graphics object can have this property. If try to set color state for rest unsupported types, exception fsdk.E_ErrUnsupported will be thrown.

Parameters
[in]color_stateA color state object to be set to current graphics object.
Returns
None.
Note
When this function succeeds, function fsdk.GraphicsObjects.GenerateContent should be called. Please refer to function fsdk.GraphicsObjects.GenerateContent for more details.

◆ SetFillColor()

def fsdk.GraphicsObject.SetFillColor (   color)

Set the fill color.

Text graphics object, path graphics object, and form XObject graphics object can have color state. If try to set fill color for rest unsupported types, fsdk.E_ErrUnsupported will be thrown.
For path graphics object, please ensure the fill mode is not fsdk.E_FillModeNone ; otherwise the fill color will not have any effect on the path graphics object. Please refer to functions fsdk.PathObject.GetFillMode and fsdk.PathObject.SetFillMode to check and change the fill mode of a path graphics object.
Function fsdk.GraphicsObject.SetColorState can be used to set fill color in other color space, like CMYK color space.

Parameters
[in]colorNew color value, in format 0xAARRGGBB.
Returns
None.
Note
When this function succeeds, function fsdk.GraphicsObjects.GenerateContent should be called. Please refer to function fsdk.GraphicsObjects.GenerateContent for more details.

◆ SetFillOpacity()

def fsdk.GraphicsObject.SetFillOpacity (   opacity)

Set the opacity value for painting operations other than stroking.

Parameters
[in]opacityThe new opacity value. Valid range: 0.0 to 1.0. 0.0 means full transparency and 1.0 means full opaque.
Returns
None.
Note
When this function succeeds, function fsdk.GraphicsObjects.GenerateContent should be called. Please refer to function fsdk.GraphicsObjects.GenerateContent for more details.

◆ SetGraphState()

def fsdk.GraphicsObject.SetGraphState (   graph_state)

Set graph state.

Form XObjet graphics object, path graphics object and text graphics object (whose text mode is fsdk.TextStateE_ModeStroke , fsdk.TextStateE_ModeStrokeClip , fsdk.TextStateE_ModeFillStroke or fsdk.TextStateE_ModeFillStrokeClip ) can have this property. If try to set graph state to rest unsupported types, exception fsdk.E_ErrUnsupported will be thrown.

Parameters
[in]graph_stateNew graph state.
Returns
None.
Note
When this function succeeds, function fsdk.GraphicsObjects.GenerateContent should be called. Please refer to function fsdk.GraphicsObjects.GenerateContent for more details.

◆ SetMatrix()

def fsdk.GraphicsObject.SetMatrix (   matrix)

Set matrix.

Parameters
[in]matrixNew matrix value.
Returns
None.
Note
When this function succeeds, function fsdk.GraphicsObjects.GenerateContent should be called. Please refer to function fsdk.GraphicsObjects.GenerateContent for more details.

◆ SetStrokeColor()

def fsdk.GraphicsObject.SetStrokeColor (   color)

Set the stroke color.

Text graphics object, path graphics object, and form XObject graphics object can have this property. If current graphics object is a text graphics object and the text mode is fsdk.TextStateE_ModeFill , the stroke color will not have effect on the text graphics object.
If try to set stroke color for rest unsupported types, exception fsdk.E_ErrUnsupported will be thrown.
Function fsdk.GraphicsObject.SetColorState can be used to set stroke color in other color space, like CMYK color space.

Parameters
[in]colorNew color value, in format 0xAARRGGBB.
Returns
None.
Note
When this function succeeds, function fsdk.GraphicsObjects.GenerateContent should be called. Please refer to function fsdk.GraphicsObjects.GenerateContent for more details.

◆ SetStrokeOpacity()

def fsdk.GraphicsObject.SetStrokeOpacity (   opacity)

Set opacity value for stroke painting operations for paths and glyph outlines.

Parameters
[in]opacityThe new opacity value. Valid range: 0.0 to 1.0. 0.0 means full transparency and 1.0 means full opaque.
Returns
None.
Note
When this function succeeds, function fsdk.GraphicsObjects.GenerateContent should be called. Please refer to function fsdk.GraphicsObjects.GenerateContent for more details.

◆ Transform()

def fsdk.GraphicsObject.Transform (   matrix,
  need_transform_clippath 
)

Transform current graphics object.

Parameters
[in]matrixTransform matrix.
[in]need_transform_clippathtrue means to transform clip path with current graphics object. false means to transform current graphics object only.
Returns
true means success, while false means failure.
Note
When this function succeeds, function fsdk.GraphicsObjects.GenerateContent should be called. Please refer to function fsdk.GraphicsObjects.GenerateContent for more details.