-
Classes
- AcroForm
- ActionBase
- ActionFieldsBase
- ActionGoTo
- ActionGoToR
- ActionHide
- ActionImportData
- ActionJavaScript
- ActionJavaScriptMap
- ActionLaunch
- ActionLaunchWinAttrs
- ActionNamed
- ActionResetForm
- ActionSound
- ActionSubmitForm
- ActionUnknown
- ActionUri
- AnnotationBase
- AnnotationCollection
- AnnotationPagesCollection
- AppearanceStream
- AppearanceStreams
- AssociatedFiles
- Attr
- AttrClsRevision
- AttrClsRevisionCollection
- AttrCollection
- AttrRevision
- AttrRevisionCollection
- BilevelBitmap
- Bitmap
- BmpContext
- Border
- BorderEffect
- Brush
- ButtonAppearance
- CaretAnnotation
- CheckBoxField
- ChoiceField
- CircleAnnotation
- ClassMap
- ComboBoxField
- CombTextField
- ContentItemLink
- ContentItemLinkCollection
- DefaultAppearance
- Destination
- DestinationBase
- DestinationFit
- DestinationFitB
- DestinationFitBh
- DestinationFitBv
- DestinationFitH
- DestinationFitR
- DestinationFitV
- DestinationRef
- DestinationUnknown
- DestinationXyz
- DocAction
- DocumentDestinations
- DocumentInfo
- DocumentSecurityStore
- DrawingContext
- DsPdf
- DsPdfConfig
- EmbeddedFileStream
- Field
- FieldCollection
- FieldWidgetCollection
- FileAttachmentAnnotation
- FileInfo
- FileSpecification
- FileSpecificationMap
- Font
- FontCollection
- FontHandler
- FontHandlerCollection
- Format
- FormXObject
- FreeTextAnnotation
- GraphicsPath
- GrayscaleBitmap
- HatchBrush
- IccProfile
- Image
- ImageBrush
- InkAnnotation
- Layout
- LineAnnotation
- LinearGradientBrush
- LinkAnnotation
- ListBoxField
- MarkInfo
- MarkupAnnotation
- McidContentItemLink
- McrContentItemLink
- Metadata
- Model3DAnnotation
- Model3DStream
- Model3DView
- Model3DViewCollection
- Namespace
- NamespaceCollection
- ObjectBase
- ObjectManager
- ObjrContentItemLink
- OutlineNode
- OutlineNodeCollection
- OutputIntent
- OutputIntentCollection
- PageLabelingRange
- PageLabelingRangeMap
- PdfCidFont
- PdfCidFontType0
- PdfCidFontType2
- PdfCidFontUnknown
- PdfCMapTable
- PdfContext
- PdfDocument
- PdfFont
- PdfFontDescriptor
- PdfFontSimple
- PdfFontTrueType
- PdfFontType0
- PdfFontType1
- PdfFontType3
- PdfImageHandler
- PdfImageHandlerCollection
- PdfPage
- PdfPageCollection
- PdfSignature
- Pen
- Pkcs7Signer
- Pkcs7SignerBase
- PolygonAnnotation
- PolygonAnnotationBase
- PolyLineAnnotation
- PopupAnnotation
- PushButtonField
- RadialGradientBrush
- RadioButtonField
- RContentItemLink
- RedactAnnotation
- RichMediaAnnotation
- RoleMap
- Security
- SecurityHandlerBase
- SignatureField
- SolidBrush
- SoundAnnotation
- SoundObject
- SplitOptions
- SquareAnnotation
- StampAnnotation
- StandardSecurityHandler
- StandardSecurityHandlerRev2
- StandardSecurityHandlerRev3
- StandardSecurityHandlerRev4
- StandardSecurityHandlerRev5
- StandardSecurityHandlerRev6
- StructElement
- StructElementCollection
- StructTreeItem
- StructTreeItemCollection
- StructTreeRoot
- SvgContext
- SvgDocument
- TextAnnotation
- TextField
- TextMarkupAnnotation
- TimeStamper
- TimeStampProvider
- Transform
- UnknownAnnotation
- UnknownSecurityHandler
- WatermarkAnnotation
- WidgetAnnotation
- Enumerations
- Functions
- Interfaces
- README
- Index
- TypeAliases
- Variables
Model3DAnnotation
Class: Model3DAnnotation
Represents a rich media annotation. Rich media annotations provide a common framework for video, audio, animations and other multimedia presentations.
Extends
Constructors
Constructor
new Model3DAnnotation(om): Model3DAnnotation;
Creates a new Model3DAnnotation.
Parameters
om
ObjectManager that controls the lifetime of the Model3DAnnotation.
Returns
Model3DAnnotation
Overrides
AnnotationBase.constructor
Constructor
new Model3DAnnotation(): Model3DAnnotation;
Creates a new Model3DAnnotation.
Returns
Model3DAnnotation
Overrides
AnnotationBase.constructor
Accessors
activationCondition
Get Signature
get activationCondition(): string;
Gets the value specifying the circumstances under which the annotation shall be activated. The Model3DActivationCondition defines the values listed in the PDF specification; this list may be extended in future revisions.
See
Model3DActivationCondition
Returns
string
Set Signature
set activationCondition(value): void;
Sets the value specifying the circumstances under which the annotation shall be activated. The Model3DActivationCondition defines the values listed in the PDF specification; this list may be extended in future revisions.
See
Model3DActivationCondition
Parameters
value
string
Returns
void
appearanceStreams
Get Signature
get appearanceStreams(): AppearanceStreams;
Gets the AppearanceStreams object providing access to the annotation's appearance streams.
Returns
Inherited from
AnnotationBase.appearanceStreams
associatedFiles
Get Signature
get associatedFiles(): AssociatedFiles;
Gets the list of embedded files associated with this annotation.
Returns
Inherited from
AnnotationBase.associatedFiles
contents
Get Signature
get contents(): string;
Gets or sets the text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human-readable form. In either case, this text is useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes.
Returns
string
Set Signature
set contents(value): void;
Gets or sets the text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human-readable form. In either case, this text is useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes.
Parameters
value
string
Returns
void
Inherited from
deactivationCondition
Get Signature
get deactivationCondition(): string;
Gets the value specifying the circumstances under which the annotation shall be deactivated. The Model3DDeactivationCondition defines the values listed in the PDF specification; this list may be extended in future revisions.
See
Model3DDeactivationCondition
Returns
string
Set Signature
set deactivationCondition(value): void;
Sets the value specifying the circumstances under which the annotation shall be deactivated. The Model3DDeactivationCondition defines the values listed in the PDF specification; this list may be extended in future revisions.
See
Model3DDeactivationCondition
Parameters
value
string
Returns
void
defaultView
Get Signature
get defaultView(): Model3DView;
Gets the default initial Model3DView for this annotation.
The PDF specification allows the default view to be specified in multiple places and using different forms (for example, by name or by index). This method encapsulates the logic to find and return the effective default view that should be used when the annotation is activated.
Typical resolution behavior:
- Inspect annotation-level settings that explicitly identify a default view.
- If not found, inspect the associated 3D stream(s) for a named or indexed default view.
- If the default is specified by name, the view with a matching Model3DView.name is returned;
- If specified by index, the view at that index in the stream's view list is returned.
If no explicit default view is defined or the referenced view cannot be resolved,
the method returns
Returns
Set Signature
set defaultView(value): void;
Sets the default initial Model3DView for this annotation, the value can be specified as object itself or zero-based index of 3D view in Model3DStream.views collection.
Parameters
value
number | Model3DView
Returns
void
doc
Get Signature
get doc(): PdfDocument;
Gets the PdfDocument owning this annotation.
Returns
Inherited from
flags
Get Signature
get flags(): AnnotationFlags;
Gets or sets the flags specifying various characteristics of the annotation.
Returns
Set Signature
set flags(value): void;
Gets or sets the flags specifying various characteristics of the annotation.
Parameters
value
Returns
void
Inherited from
id
Get Signature
get id(): number;
Gets the reference to the object.
Returns
number
Inherited from
locked
Get Signature
get locked(): boolean;
Gets or sets a value indicating whether the annotation can be deleted or its properties (including position and size) can be modified by the user. However, this flag does not restrict changes to the annotation's contents, such as the value of a form field.
Returns
boolean
Set Signature
set locked(value): void;
Gets or sets a value indicating whether the annotation can be deleted or its properties (including position and size) can be modified by the user. However, this flag does not restrict changes to the annotation's contents, such as the value of a form field.
Parameters
value
boolean
Returns
void
Inherited from
lockedContents
Get Signature
get lockedContents(): boolean;
Gets or sets a value indicating whether the contents of the annotation can be modified by the user. This flag does not restrict deletion of the annotation or changes to other annotation properties, such as position and size.
Returns
boolean
Set Signature
set lockedContents(value): void;
Gets or sets a value indicating whether the contents of the annotation can be modified by the user. This flag does not restrict deletion of the annotation or changes to other annotation properties, such as position and size.
Parameters
value
boolean
Returns
void
Inherited from
modifiedDate
Get Signature
get modifiedDate(): PdfDateTime;
Gets or sets the date and time when the annotation was modified.
Returns
Set Signature
set modifiedDate(value): void;
Gets or sets the date and time when the annotation was modified.
Parameters
value
Returns
void
Inherited from
name
Get Signature
get name(): string;
Gets or sets the annotation name, a text string uniquely identifying it among all annotations on its page.
Returns
string
Set Signature
set name(value): void;
Gets or sets the annotation name, a text string uniquely identifying it among all annotations on its page.
Parameters
value
string
Returns
void
Inherited from
om
Get Signature
get om(): ObjectManager;
Gets the owner ObjectManager instance.
Returns
Inherited from
page
Get Signature
get page(): PdfPage;
Gets or sets the PdfPage that contains this annotation. Note that an annotation may be referenced by several pages. In that case this property returns the first element in the pages collection. When setting this property, the following applies: If the new value is null, this annotation is removed from all pages. Otherwise, this annotation is assigned exclusively to the specified page.
Returns
Set Signature
set page(value): void;
Gets or sets the PdfPage that contains this annotation. Note that an annotation may be referenced by several pages. In that case this property returns the first element in the pages collection. When setting this property, the following applies: If the new value is null, this annotation is removed from all pages. Otherwise, this annotation is assigned exclusively to the specified page.
Parameters
value
Returns
void
Inherited from
pages
Get Signature
get pages(): AnnotationPagesCollection;
Gets the list of pages that reference this annotation.
Returns
Inherited from
pdfRect
Get Signature
get pdfRect(): Rect;
Gets or sets the rectangle that defines the location and size of the annotation on a page in PDF user space coordinates. The positive X axis extends horizontally to the right, and the positive Y axis extends vertically upward, with the origin usually in the lower left corner of the page.
See
Returns
Set Signature
set pdfRect(value): void;
Gets or sets the rectangle that defines the location and size of the annotation on a page in PDF user space coordinates. The positive X axis extends horizontally to the right, and the positive Y axis extends vertically upward, with the origin usually in the lower left corner of the page.
See
Parameters
value
Returns
void
Inherited from
presentationStyle
Get Signature
get presentationStyle(): string;
Gets or sets the value specifyingthe style of presentation of the rich media (embedded or windowed). The Model3DPresentationStyle defines the values listed in the PDF specification; this list may be extended in future revisions.
See
Model3DPresentationStyle
Returns
string
Set Signature
set presentationStyle(value): void;
Sets the value specifyingthe style of presentation of the rich media (embedded or windowed). The Model3DPresentationStyle defines the values listed in the PDF specification; this list may be extended in future revisions.
See
Model3DPresentationStyle
Parameters
value
string
Returns
void
rect
Get Signature
get rect(): Rect;
Gets or sets the rectangle that defines the location and size of the annotation on a page. The coordinates of the rectangle are relative to the upper left corner of the page's media box, with the Y (vertical) coordinates increasing from top to bottom. Note that if the annotation is associated with more than one page, the media box of the first of those pages is used to calculate the rectangle's location.
Returns
Set Signature
set rect(value): void;
Gets or sets the rectangle that defines the location and size of the annotation on a page. The coordinates of the rectangle are relative to the upper left corner of the page's media box, with the Y (vertical) coordinates increasing from top to bottom. Note that if the annotation is associated with more than one page, the media box of the first of those pages is used to calculate the rectangle's location.
Parameters
value
Returns
void
Inherited from
showToolbar
Get Signature
get showToolbar(): boolean;
Gets or sets the value indicating the default behavior of an interactive toolbar associated with this annotation. If "true", the toolbar should be displayed when the annotation is activated and given focus. If "false", the toolbar should not be displayed.
Returns
boolean
Set Signature
set showToolbar(value): void;
Gets or sets the value indicating the default behavior of an interactive toolbar associated with this annotation. If "true", the toolbar should be displayed when the annotation is activated and given focus. If "false", the toolbar should not be displayed.
Parameters
value
boolean
Returns
void
stream
Get Signature
get stream(): Model3DStream;
Gets Model3DStream object defining 3D content of the annotation.
Returns
Set Signature
set stream(value): void;
Sets Model3DStream object defining 3D content of the annotation.
Parameters
value
Returns
void
transparent
Get Signature
get transparent(): boolean;
Gets the value indicating whether the interactive PDF processor shall display the underlying page content through the transparent areas of the rich media content.
Returns
boolean
Set Signature
set transparent(value): void;
Sets the value indicating whether the interactive PDF processor shall display the underlying page content through the transparent areas of the rich media content.
Parameters
value
boolean
Returns
void
Methods
createAppearanceContentStream()
createAppearanceContentStream(): FormXObject;
Creates an instance of FormXObject that can be used to define the annotation's appearance stream. Note that when this method is called, the annotation must already have been added to the document, otherwise an exception will be thrown.
Returns
The FormXObject object.
Inherited from
AnnotationBase.createAppearanceContentStream
free()
free(): void;
Detaches the object from the ObjectManager and deallocates its memory, if possible.
Returns
void
Inherited from
get3DContentBytes()
get3DContentBytes(): Uint8Array<ArrayBufferLike>;
Retrieves the 3D stream content from this annotation.
Returns
Uint8Array<ArrayBufferLike>
get3DContentFormat()
get3DContentFormat(): string;
Retrieves the format of this annotation's 3D stream content.
Returns
string
rebind()
rebind(omTo): void;
Rebinds the object from the current ObjectManager to the specified one.
Parameters
omTo
The new ObjectManager for the object.
Returns
void
Inherited from
removeAppearance()
removeAppearance(): void;
Removes all appearance streams associated with the current annotation, and disables generation of appearance steams for this annotation when the document is saved.
Note that if any property affecting the annotation's appearance 'rect' is then changed, the appearance streams will be regenerated. So this method would usually be called after initializing all annotation's properties.
Returns
void
Inherited from
AnnotationBase.removeAppearance
resetAppearance()
resetAppearance(): void;
Forces regeneration of the annotation's appearance streams next time the document is saved.
Returns
void
Inherited from
AnnotationBase.resetAppearance
set3DContent()
set3DContent(bytes, format): void;
Sets the 3D stream content for this annotation. This method creates a new Model3DStream with the provided stream data and format, replacing any existing 3D stream in the annotation.
Parameters
bytes
Uint8Array
The 'Uint8Array' object containing the 3D model data in U3D or PRC formats.
format
The 3D model data format.
Returns
void
setPreviewAppearance()
setPreviewAppearance(image): void;
Sets the preview appearance for this 3D annotation using a raster image. This method creates a visual representation of the 3D content that is displayed when the 3D annotation is not activated. Since DsPdf cannot automatically generate previews for 3D content, you must provide a preview image generated by a third-party tool or rendered separately. The provided image is stretched to fill the annotation's bounds (AnnotationBase.rect). The appearance stream is stored as the normal default appearance of the annotation.
Parameters
image
The Image object to use as the preview appearance when the annotation is not activated. The image will be stretched to fit the annotation's bounds.
Returns
void