- Index
- Enumerations
- Classes
- Interfaces
-
Type Aliases
- AnnotationMarkedStateType
- AnnotationReviewStateType
- AnnotationStateModel
- AnnotationTypeName
- BusEventName
- DocumentListItem
- FieldAppearanceRenderingType
- FontFormat
- FormFieldMapping
- FormFillerSettings
- GcProps
- InputFieldMapping
- JsCancelEventArgs
- JsEventArgs
- JsExecutionConfig
- KeyboardShortcutDefinition
- KeyboardShortcutTool
- LineEndStyle
- LinkDestinationType
- LinkType
- LogLevel
- ModificationsState
- NamedAction
- OpenAction
- OpenParameters
- OptionalContentConfig
- OptionalContentGroup
- PageLayout
- PageMode
- PageModification
- PageStructureChange
- PageViewport
- PdfOrganizerSettings
- ReplaceTextModel
- ReplyToolSettings
- ReplaceTextSettings
- RotationInit
- RulerLine
- SaveSettings
- ScrollPageIntoViewOptions
- SelectedTextCoordinates
- SignatureInfo
- SharedDocumentInfo
- SignatureInformation
- SignToolSettings
- StampCategory
- StructTreeContent
- StructTreeNode
- StructureChanges
- SupportApiSettings
- TableDataExtractionModel
- TableDataExtractionSettings
- TextMarkupContextMenuSettings
- ToolbarButtonKey
- UndoChangeName
- UserAccess
- ViewerFeatureName
- ViewerPreferences
- WidgetFieldTypeName
OptionalContentGroup
Type Alias: OptionalContentGroup
OptionalContentGroup:
object
Represents an Optional Content Group (OCG), also known as a "Layer" in a PDF document. OCGs allow content to be dynamically shown or hidden based on user interactions or viewing conditions. Defined in ISO 32000-2.
Type declaration
creatorInfo?
optionalcreatorInfo:object
Metadata about the application that created the optional content group. This is an optional dictionary that stores application-specific data.
creatorInfo.Creator
Creator:
string
The name of the application that created the group.
creatorInfo.Subtype
Subtype:
string
The intended content type of the group. Suggested values include:
"Artwork"- for graphic design or publishing applications."Technical"- for technical drawings such as schematics or architectural plans.
exportState?
optionalexportState:"ON"|"OFF"
The export state of the group.
If "ON", content in this group should be included in exported output (e.g., saving, flattening).
If "OFF", content in this group should be excluded from export.
id
id:
string
The unique identifier of the optional content group.
intent?
optionalintent:"View"|"Design"
Specifies the intended use of the graphics in this group. A PDF processor may selectively render content based on this intent.
"View": Intended for on-screen viewing (default)."Design": Intended for design-related content.
If "Design" is specified, a creatorInfo entry should also be included.
name
name:
string
The display name of the optional content group.
printState?
optionalprintState:"ON"|"OFF"
The print state of the group.
If "ON", the group will be printed.
If "OFF", the group will be hidden in printed output.
type
type:
"OCG"|string
The type of the optional content group. "OCG" (Optional Content Group) is the standard type, but custom types may be used.
viewState?
optionalviewState:"ON"|"OFF"
The initial view state of the group when the document is opened.
If "ON", the group is visible by default.
If "OFF", the group is hidden by default.
visible
visible:
boolean
The current visibility state of the group in the viewer. This does not necessarily reflect its default state in the document.
zoom?
optionalzoom:object
Defines a range of zoom levels at which this optional content group should be visible.
zoom.max?
optionalmax:number
The maximum zoom level beyond which the group should be hidden.
Default: Infinity (always visible at any zoom level).
zoom.min?
optionalmin:number
The minimum zoom level at which the group should be visible.
Default: 0 (always visible at any zoom level).