- README
- globals
-
classes
- AcroForm
- ActionBase
- ActionFieldsBase
- ActionGoTo
- ActionGoToR
- ActionJavaScript
- ActionJavaScriptMap
- ActionNamed
- ActionResetForm
- ActionSubmitForm
- ActionUnknown
- ActionURI
- AnnotationBase
- AnnotationCollection
- AnnotationPagesCollection
- BilevelBitmap
- Bitmap
- BmpContext
- Border
- BorderEffect
- Brush
- ButtonAppearance
- CaretAnnotation
- CheckBoxField
- ChoiceField
- CircleAnnotation
- ComboBoxField
- CombTextField
- DefaultAppearance
- Destination
- DestinationBase
- DestinationFit
- DestinationFitB
- DestinationFitBH
- DestinationFitBV
- DestinationFitH
- DestinationFitR
- DestinationFitV
- DestinationRef
- DestinationUnknown
- DestinationXYZ
- DocAction
- DocumentDestinations
- DocumentInfo
- DrawingContext
- DsPdf
- DsPdfConfig
- EmbeddedFileStream
- Field
- FieldCollection
- FieldWidgetCollection
- FileAttachmentAnnotation
- FileSpecification
- FileSpecificationMap
- Font
- FontCollection
- FontHandler
- FontHandlerCollection
- Format
- FreeTextAnnotation
- GraphicsPath
- GrayscaleBitmap
- HatchBrush
- Image
- ImageBrush
- InkAnnotation
- Layout
- LineAnnotation
- LinearGradientBrush
- LinkAnnotation
- ListBoxField
- MarkupAnnotation
- Metadata
- ObjectBase
- ObjectManager
- OutlineNode
- OutlineNodeCollection
- PdfContext
- PdfDocument
- PdfImageHandler
- PdfImageHandlerCollection
- PdfPage
- PdfPageCollection
- Pen
- PolygonAnnotation
- PolygonAnnotationBase
- PolyLineAnnotation
- PopupAnnotation
- PushButtonField
- RadialGradientBrush
- RadioButtonField
- RedactAnnotation
- RichMediaAnnotation
- Security
- SecurityHandlerBase
- SignatureField
- SolidBrush
- SoundAnnotation
- SoundObject
- SplitOptions
- SquareAnnotation
- StampAnnotation
- StandardSecurityHandler
- StandardSecurityHandlerRev2
- StandardSecurityHandlerRev3
- StandardSecurityHandlerRev4
- StandardSecurityHandlerRev5
- StandardSecurityHandlerRev6
- SvgContext
- SvgDocument
- TextAnnotation
- TextField
- TextMarkupAnnotation
- Transform
- UnknownAnnotation
- UnknownSecurityHandler
- WatermarkAnnotation
- WidgetAnnotation
- enumerations
- functions
- type-aliases
OutlineNode
DsPdfJS API / OutlineNode
Class: OutlineNode
Defines the outline node within PDF document.
Extends
Constructors
Constructor
new OutlineNode(
om,title?,action?,expanded?):OutlineNode
Initialize a new instance of the OutlineNode class.
Parameters
om
ObjectManager that controls the lifetime of the OutlineNode.
title?
string
The title of OutlineNode.
action?
The action which should be performed or destination defining the new document view.
DestinationProperties | ActionProperties | ActionBase | DestinationBase
expanded?
boolean
Indicates whether the node should be expanded.
Returns
OutlineNode
Overrides
ObjectBase.constructor
Constructor
new OutlineNode(
title?,action?,expanded?):OutlineNode
Initialize a new instance of the OutlineNode class.
Parameters
title?
string
The title of OutlineNode.
action?
The action which should be performed or destination defining the new document view.
DestinationProperties | ActionProperties | ActionBase | DestinationBase
expanded?
boolean
Indicates whether the node should be expanded.
Returns
OutlineNode
Overrides
ObjectBase.constructor
Accessors
action
Get Signature
get action():
ActionBase|null
Gets or sets the ActionBase to be performed when this OutlineNode is activated. If both 'dest' and 'action' are specified, the viewer application will determine the behavior, which may be unpredictable. For consistent results, specify only one.
Returns
ActionBase | null
Set Signature
set action(
value):void
Gets or sets the ActionBase to be performed when this OutlineNode is activated. If both 'dest' and 'action' are specified, the viewer application will determine the behavior, which may be unpredictable. For consistent results, specify only one.
Parameters
value
ActionProperties | ActionBase | null
Returns
void
children
Get Signature
get children():
OutlineNodeCollection
Gets the OutlineNodeCollection collection containing child nodes.
Returns
dest
Get Signature
get dest():
DestinationBase|null
Gets or sets the DestinationBase to be displayed when this OutlineNode is activated. If both 'dest' and 'action' are specified, the viewer application will determine the behavior, which may be unpredictable. For consistent results, specify only one.
Returns
DestinationBase | null
Set Signature
set dest(
value):void
Gets or sets the DestinationBase to be displayed when this OutlineNode is activated. If both 'dest' and 'action' are specified, the viewer application will determine the behavior, which may be unpredictable. For consistent results, specify only one.
Parameters
value
DestinationProperties | DestinationBase | null
Returns
void
doc
Get Signature
get doc():
PdfDocument|null
Gets the PdfDocument owning this object.
Returns
PdfDocument | null
expanded
Get Signature
get expanded():
boolean
Gets or sets a value indicating whether this OutlineNode expanded and its child nodes are visible.
Returns
boolean
Set Signature
set expanded(
value):void
Gets or sets a value indicating whether this OutlineNode expanded and its child nodes are visible.
Parameters
value
boolean
Returns
void
hasChildren
Get Signature
get hasChildren():
boolean
Gets a value indicating whether children collection is not empty.
Returns
boolean
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
owner
Get Signature
get owner():
OutlineNodeCollection|null
Gets the OutlineNodeCollection collection containing this object.
Returns
OutlineNodeCollection | null
parent
Get Signature
get parent():
OutlineNode|null
Gets the parent OutlineNode.
Returns
OutlineNode | null
textColor
Get Signature
get textColor():
Color
Gets or sets the text color of the outline node.
Returns
Set Signature
set textColor(
value):void
Gets or sets the text color of the outline node.
Parameters
value
Returns
void
textStyle
Get Signature
get textStyle():
OutlineNodeFontStyle
Gets or sets the text style of the outline node.
Returns
Set Signature
set textStyle(
value):void
Gets or sets the text style of the outline node.
Parameters
value
Returns
void
title
Get Signature
get title():
string|null
Gets or sets the title of the outline node.
Returns
string | null
Set Signature
set title(
value):void
Gets or sets the title of the outline node.
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
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