CreateImageButtonOptions Interface Reference

Options for creating an image button field in the PDF form. More...

Inheritance diagram for CreateImageButtonOptions:

Public Attributes
string	imagePath
	The path to the image file. It supports HTTP/HTTPS, data-URI and Blob-URL. More...
Public Attributes inherited from BasicCreateWidgetOptions
Array< ActionSpecWithTrigger >	actions
	An array of action data classified by triggering events.
Record< string, unknown >	extra
	Additional data related to the widget.
String	fieldName
	The name of the form field.
number	pageIndex
	The index of the page where the widget is located.
Rect	pdfRect
	The rectangle defining the widget's position and size in PDF Point unit.
number	rotate
	The rotation angle of the widget, as a value of 0, 1, 2, or 3, representing 0, 90, 180, and 270 degrees, respectively.

Detailed Description

Options for creating an image button field in the PDF form.

Since

11.0.0

Member Data Documentation

imagePath

string CreateImageButtonOptions::imagePath

The path to the image file. It supports HTTP/HTTPS, data-URI and Blob-URL.

The image path can be specified in the following formats:

• HTTP/HTTPS URL (e.g. https://example.com/image.png)
• Data URI (e.g. data:image/png;base64,iVBORw0KGg...)
• Blob URL (e.g. blob:https://example.com/1234567890abcdef)

  Since

  11.0.0