| FoxitPDFSDKforWeb v11.0.5 Archives Foxit PDF SDK for Web

Public Member Functions | Public Attributes | List of all members
ShadingGraphicObject Interface Reference
UIExtension » addons » advanced_edit » page_editor

Represents a shading object within the Page Editor. More...

Inheritance diagram for ShadingGraphicObject:

## Public Member Functions
Promise< void > | setProperties (properties:Partial< ShadingGraphicObjectProperties >)
| Set properties for the shading object. More...

## Public Attributes
string | type = 'shading'
| The type of the graphic object, which is always 'shading' for shading objects. More...
Public Attributes inherited from PageGraphicsObject
string | type
| The type of the graphic object. It can be one of the following: 'text', 'path', 'image', 'shading'. More...

## Detailed Description

Represents a shading object within the Page Editor.

This interface extends PageGraphicsObject and allows you to manipulate and modify shading objects within a PDF document.

Since
  9.2.0

## Member Function Documentation

## ◆ setProperties()

Promise<void> ShadingGraphicObject::setProperties | ( | properties:Partial< ShadingGraphicObjectProperties > |  | ) |

Set properties for the shading object.

Use this method to update the properties of the shading object. The properties that can be set are defined by ShadingGraphicObjectProperties.

Parameters

  properties | Partial<ShadingGraphicObjectProperties> - An object containing the updated properties for the shading object.

Returns
  Promise<void> - A promise that resolves once the properties are successfully set.

Since
  9.2.0

Implements PageGraphicsObject.

## Member Data Documentation

## ◆ type

string ShadingGraphicObject::type = 'shading'

The type of the graphic object, which is always 'shading' for shading objects.

Since
  9.2.0

@2025 Foxit Software Incorporated. All rights reserved.