-
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
ClassMap
Class: ClassMap
Represents the value of the ClassMap entry of the structure tree: a dictionary that maps name objects designating attribute classes to the corresponding collections of attribute objects (AttrCollection). See the PDF specification for details.
Keys are PDF names (plain JS strings); values are AttrCollection objects.
Obtain it from StructTreeRoot#classMap.
Extends
Accessors
count
Get Signature
get count(): number;
Gets the number of entries in the map.
Returns
number
id
Get Signature
get id(): number;
Gets the reference to the object.
Returns
number
Inherited from
om
Get Signature
get om(): ObjectManager;
Gets the owner ObjectManager instance.
Returns
Inherited from
Methods
clear()
clear(): void;
Removes all entries from the map.
Returns
void
contains()
contains(key): boolean;
Determines whether the map contains the specified key.
Parameters
key
string
The attribute class name to check.
Returns
boolean
true if the key is present, false otherwise.
entries()
entries(): [string, AttrCollection][];
Gets the array of key/value pairs in the map.
Returns
[string, AttrCollection][]
free()
free(): void;
Detaches the object from the ObjectManager and deallocates its memory, if possible.
Returns
void
Inherited from
get()
get(key): AttrCollection;
Gets the collection of attribute objects mapped to the specified key.
Parameters
key
string
The attribute class name.
Returns
The mapped AttrCollection, or undefined if the key is not present.
getOrCreate()
getOrCreate(key): AttrCollection;
Gets the collection of attribute objects mapped to the specified key, creating and storing an empty AttrCollection if the key is not yet present.
Parameters
key
string
The attribute class name.
Returns
The AttrCollection mapped to the key.
keys()
keys(): string[];
Gets the array of keys (the attribute class names).
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
remove()
remove(key): boolean;
Removes the entry with the specified key.
Parameters
key
string
The attribute class name to remove.
Returns
boolean
true if the entry was actually removed, false otherwise.
set()
set(key, value): void;
Maps the specified attribute class name to a collection of attribute objects.
Parameters
key
string
The attribute class name.
value
The AttrCollection to map to the key.
Returns
void