Screen Class Reference

Screen annot object. More...

Inheritance diagram for Screen:

Public Member Functions
	getAction ()
	Get screen's action. [Support in Server] More...
	getImage (type)
	getOpacity ()
	Get opacity value. [Support in Server] This property has effect on markup annotation's appearance. More...
	getRotation ()
	Get the rotation of the image used for the appearance of current screen annotation. More...
	removeAction (trigger=-1, action)
	Remove screen's action. More...
	setImage (buffer)
	Set screen's image. More...
	setOpacity (opacity)
	Set opacity value. [Support in Server] More...
	setRotation (rotation)
	Set the rotation of the image used for the appearance of current screen annotation. More...
Public Member Functions inherited from Annot
	exportToJSON ()
	Export the current annotation to a Json object. [Support in Server] More...
	getBorderColor ()
	Get annotation's border color. [Support in Server] More...
	getBorderInfo ()
	Get annotation's border information. [Support in Server] More...
	getContent ()
	Get annotation's contents. [Support in Server] More...
	getDictionaryEntry (key)
	Get the dictionary property of Annot by key. More...
	getFlags ()
	Get annotation's flag. [Support in Server] More...
	getModifiedDateTime ()
	Get annotation's last modified date time. [Support in Server] More...
	getObjectNumber ()
	Get annotation's object number. More...
	getPage ()
	Get annotation's page. [Support in Server] More...
	getRect ()
	Get annotation's rect. [Support in Server] More...
	getTitle ()
	Get annotation's title. [Support in Server] More...
	getType ()
	Get annotation's type. [Support in Server] More...
	getUniqueID ()
	Get annotation's unique ID. [Support in Server] More...
	isEmpty ()
	Check annotation is empty or not. [Support in Server] More...
	isMarkup ()
	Check if current annotation is a markup annotation. [Support in Server] More...
	setBorderColor (borderColor)
	Set annotation's border color. [Support in Server] More...
	setBorderInfo (borderInfo)
	Set annotation's border information. [Support in Server] More...
	setContent (content)
	Set contents for the currently gotten annotation. [Support in Server] More...
	setDictionaryEntry (key, value)
	Add a new entry or replace the existing entry of the annotation dictionary. Caller could use this method to store their private data to the annotation. Do not use any standard key of the annotation dictionary, such as 'Type', 'Subtype', 'Rect' defined in PDF Reference. If any standard key is used, this behaviour will be undefined. More...
	setFlags (flag, notTriggerEvent)
	Set annotation's flag. [Support in Server] More...
	setModifiedDateTime (date)
	Set annotation's last modified date time. [Support in Server] More...

Detailed Description

Screen annot object.

Member Function Documentation

getAction()

Screen::getAction ( )

inline

Get screen's action. [Support in Server]

Returns

{Action} - An action object.

getImage()

Screen::getImage (   type )

inline

Get the image data by the specified type.

Parameters

[type='canvas']

The data type, valid value: 'canvas' | 'image' | 'buffer'.

Returns

{Promise.<T>} - The image data by the specified type.

var imageBuf = getImage('buffer');
var blob = new Blob([imageBuf], {type: 'image/png'});
var url = URL.createObjectURL(blob);

Since

8.4.0

getOpacity()

Screen::getOpacity ( )

inline

Get opacity value. [Support in Server]
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.

getRotation()

Screen::getRotation ( )

inline

Get the rotation of the image used for the appearance of current screen annotation.

Returns

Rotation value of the image.

Since

8.2.0

removeAction()

Screen::removeAction (   trigger = -1,   action  )

inline

Remove screen's action.

Returns

{Promise.<bool>} - A boolean value indecated success or failue.

setImage()

Screen::setImage (   buffer )

inline

Set screen's image.

Parameters

buffer

{ArrayBuffer} -The raw image buffer, supported types are jpeg/png/bmp..

Returns

{Promise.<bool>} - true for success, otherwise failure.

async function example(screenAnnot)
 {
     const resp = await fetch('/xxx/xx.jpeg');
     const imageBuffer = await resp.arrayBuffer();
     await screenAnnot.setImage(imageBuffer);
 }

setOpacity()

Screen::setOpacity (   opacity )

inline

Set opacity value. [Support in Server]

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. event Events.annotationUpdated Annot[] PDFPage
Events.annotationAppearanceUpdated Annot[] PDFPage

setRotation()

Screen::setRotation (   rotation )

inline

Set the rotation of the image used for the appearance of current screen annotation.

Parameters

rotation

Rotation value. this should be one of these values : 0, 90, 180, 270.

Since

8.2.0