[]
        
(Showing Draft Content)

ActionURI

DsPdfJS API v9.1.0


DsPdfJS API / ActionURI

Class: ActionURI

Represents an action that causes navigation to a specified URI.

Extends

Constructors

Constructor

new ActionURI(om, uri?): ActionURI

Creates a new ActionURI.

Parameters

om

ObjectManager

ObjectManager that controls the lifetime of the ActionURI.

uri?

string

The URI to navigate to.

Returns

ActionURI

Overrides

ActionBase.constructor

Constructor

new ActionURI(uri?): ActionURI

Creates a new ActionURI.

Parameters

uri?

string

The URI to navigate to.

Returns

ActionURI

Overrides

ActionBase.constructor

Accessors

id

Get Signature

get id(): number

Gets the reference to the object.

Returns

number

Inherited from

ActionBase.id


isMap

Get Signature

get isMap(): boolean

Gets or sets a value indicating whether to track the mouse position when the URI is resolved.

This property applies only to actions triggered by the user's clicking an annotation; it is ignored for actions associated with OutlineNode or with a PdfDocument#openAction property.

Returns

boolean

Set Signature

set isMap(value): void

Gets or sets a value indicating whether to track the mouse position when the URI is resolved.

This property applies only to actions triggered by the user's clicking an annotation; it is ignored for actions associated with OutlineNode or with a PdfDocument#openAction property.

Parameters
value

boolean

Returns

void


om

Get Signature

get om(): ObjectManager

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

ActionBase.om


uri

Get Signature

get uri(): string | null

Gets or sets the URI to navigate.

Returns

string | null

Set Signature

set uri(value): void

Gets or sets the URI to navigate.

Parameters
value

string | null

Returns

void

Methods

free()

free(): void

Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns

void

Inherited from

ActionBase.free


rebind()

rebind(omTo): void

Rebinds the object from the current ObjectManager to the specified one.

Parameters

omTo

ObjectManager

The new ObjectManager for the object.

Returns

void

Inherited from

ActionBase.rebind