FoxitPDFSDKforWeb  7.1.1
Foxit PDF SDK for Web
Screen Class Reference

Screen annot object. More...

Inheritance diagram for Screen:
Annot

Public Member Functions

 getAction ()
 Get screen's action. More...
 
 getOpacity ()
 Get opacity value.
This property has effect on markup annotation's appearance. More...
 
 setOpacity (opacity)
 Set opacity value. More...
 
- Public Member Functions inherited from Annot
 exportToJSON ()
 Export annotation to a json object. More...
 
 getBorderColor ()
 Get annotation's border color. More...
 
 getBorderInfo ()
 Get annotation's border information. More...
 
 getContent ()
 Get annotation's contents. More...
 
 getFlags ()
 Get annotation's flag. More...
 
 getModifiedDateTime ()
 Get annotation's last modified date time. More...
 
 getPage ()
 Get annotation's page. More...
 
 getRect ()
 Get annotation's rect. More...
 
 getTitle ()
 Get annotation's title. More...
 
 getType ()
 Get annotation's type. More...
 
 getUniqueID ()
 Get annotation's unique ID. More...
 
 isEmpty ()
 Check annotation is empty or not. More...
 
 isMarkup ()
 Check if current annotation is a markup annotation. More...
 
 setBorderColor (borderColor)
 Set annotation's border color. More...
 
 setBorderInfo (borderInfo)
 Set annotation's border information. More...
 
 setContent (content)
 Set annotation's contents. More...
 
 setFlags (flag)
 Set annotation's flag. More...
 
 setModifiedDateTime (date)
 Set annotation's last modified date time. More...
 

Detailed Description

Screen annot object.

Member Function Documentation

◆ getAction()

Screen::getAction ( )
inline

Get screen's action.

Returns
{Action} - An action object.

◆ getOpacity()

Screen::getOpacity ( )
inline

Get opacity value.
This property has effect on markup annotation's appearance.

Returns
{number} The opacity value. Valid range: 0.0 to 1.0. 0.0 means full transparency and 1.0 means full opaque.

◆ setOpacity()

Screen::setOpacity (   opacity)
inline

Set opacity value.

Parameters
opacity{number} The new opacity value. Valid range: 0.0 to 1.0. 0.0 means full transparency and 1.0 means full opaque.
Returns
{Promise.<Annot[]>} - An array of annotation objects which has been modified. @pro event @problock Events.annotationUpdated Annot[] PDFPage
Events.annotationAppearanceUpdated Annot[] PDFPage @endproblock

Foxit Software Corporation Logo
@2019 Foxit Software Incorporated. All rights reserved.