---
title: PDFOutline
framework: pdfkit
role: symbol
role_heading: Class
path: pdfkit/pdfoutline
---

# PDFOutline

A PDFOutline object is an element in a tree-structured hierarchy that can represent the structure of a PDF document.

## Declaration

```swift
class PDFOutline
```

## Overview

Overview An outline is an optional component of a PDF document, useful for viewing the structure of the document and for navigating within it. Outlines are created by the document’s author. If you represent a PDF document outline using outline objects, the root of the hierarchy is obtained from the PDF document itself. This root outline is not visible and serves merely as a container for the visible outlines.

## Topics

### Initializing an Outline

- [init()](pdfkit/pdfoutline/init().md)

### Getting Information About an Outline

- [document](pdfkit/pdfoutline/document.md)
- [numberOfChildren](pdfkit/pdfoutline/numberofchildren.md)
- [parent](pdfkit/pdfoutline/parent.md)
- [child(at:)](pdfkit/pdfoutline/child(at:).md)
- [index](pdfkit/pdfoutline/index.md)

### Managing Outline Labels

- [label](pdfkit/pdfoutline/label.md)

### Managing Actions and Destinations

- [destination](pdfkit/pdfoutline/destination.md)
- [action](pdfkit/pdfoutline/action.md)

### Changing an Outline Hierarchy

- [insertChild(_:at:)](pdfkit/pdfoutline/insertchild(_:at:).md)
- [removeFromParent()](pdfkit/pdfoutline/removefromparent().md)

### Managing the Disclosure of an Outline Object

- [isOpen](pdfkit/pdfoutline/isopen.md)

## Relationships

### Inherits From

- [NSObject](objectivec/nsobject-swift.class.md)

### Conforms To

- [CVarArg](swift/cvararg.md)
- [CustomDebugStringConvertible](swift/customdebugstringconvertible.md)
- [CustomStringConvertible](swift/customstringconvertible.md)
- [Equatable](swift/equatable.md)
- [Hashable](swift/hashable.md)
- [NSObjectProtocol](objectivec/nsobjectprotocol.md)

## See Also

### Content Model

- [PDFDocument](pdfkit/pdfdocument.md)
- [PDFPage](pdfkit/pdfpage.md)
- [PDFSelection](pdfkit/pdfselection.md)