# @embedpdf/plugin-outline — ./contract DocumentOutline [InterfaceDeclaration] (from packages/engine/core/src/dto/DocumentOutline.ts): export interface DocumentOutline{ items: OutlineItem[]; incomplete: boolean; } LinkActivation [TypeAliasDeclaration] (from packages/plugin/link/src/contract.ts): export type LinkActivation = |{ status: 'revealed'} |{ status: 'destination'; destination: PageDestination} |{ status: 'uri'; uri: string} |{ status: 'named'; name: string} |{ status: 'reported'; target: PdfLinkTarget} |{ status: 'dispatched'; dispatch: Promise} |{ status: 'none'} ; OutlineCapability [InterfaceDeclaration]: export interface OutlineCapability{ list(): readonly OutlineItem[]; get(ref: OutlineItemRef): OutlineItem | null; getChildren(parent: OutlineItemRef | null): readonly OutlineItem[]; listRows(): readonly OutlineRow[]; getCurrentItem(): OutlineItemRef | null; isIncomplete(): boolean; getStatus(): ResourceStatus; ensureLoaded(options?: OperationOptions): Promise; refresh(options?: OperationOptions): Promise; isExpanded(ref: OutlineItemRef): boolean; expand(ref: OutlineItemRef): void; collapse(ref: OutlineItemRef): void; toggle(ref: OutlineItemRef): void; expandAll(): void; collapseAll(): void; reveal(ref: OutlineItemRef): void; getSelected(): readonly OutlineItemRef[]; select(refs: readonly OutlineItemRef[]): void; activate(ref: OutlineItemRef): LinkActivation; canEdit(): boolean; getCurrentViewTarget(): PdfLinkTargetWritable | null; create( input?: OutlineItemInput, options?: OutlineCreateOptions, ): Promise<{ readonly item: OutlineItem} >; update( ref: OutlineItemRef, patch: OutlineItemPatch, options?: OperationOptions, ): Promise<{ readonly item: OutlineItem} >; move( refs: readonly OutlineItemRef[], parent: OutlineItemRef | null, position: OutlinePosition, options?: OperationOptions, ): Promise; delete(refs: readonly OutlineItemRef[], options?: OperationOptions): Promise; readonly onChanged: EventHook; readonly onResynced: EventHook; } OutlineChangedEvent [InterfaceDeclaration]: export interface OutlineChangedEvent{ readonly type: 'created' | 'updated' | 'moved' | 'deleted' | 'restored'; readonly items: readonly OutlineItemRef[]; readonly origin: EventOrigin; } OutlineCreateOptions [InterfaceDeclaration]: export interface OutlineCreateOptions extends OperationOptions{ readonly select?: boolean; } OutlineItem [InterfaceDeclaration] (from packages/engine/core/src/dto/DocumentOutline.ts): export interface OutlineItem{ ref: OutlineItemRef; parent: OutlineItemRef | null; title: string; target: PdfLinkTarget | null; action: PdfActionTree | null; open: boolean; color: string | null; bold: boolean; italic: boolean; } OutlineItemDraft [InterfaceDeclaration] (from packages/engine/core/src/dto/DocumentOutline.ts): export interface OutlineItemDraft{ title: string; target?: PdfLinkTargetWritable | null; color?: string | null; bold?: boolean; italic?: boolean; } OutlineItemInput [InterfaceDeclaration]: export interface OutlineItemInput extends Partial{ readonly parent?: OutlineItemRef | null; readonly position?: OutlinePosition; } OutlineItemPatch [TypeAliasDeclaration] (from packages/engine/core/src/dto/DocumentOutline.ts): export type OutlineItemPatch = Partial> &{ open?: boolean; } ; OutlineItemRef [TypeAliasDeclaration] (from packages/engine/core/src/identity/OutlineItemRef.ts): export type OutlineItemRef ={ kind: 'objectNumber'; objectNumber: number} ; OutlinePosition [TypeAliasDeclaration] (from packages/engine/core/src/mutation/ListPosition.ts): export type OutlinePosition = ListPosition; OutlineResyncedEvent [InterfaceDeclaration]: export interface OutlineResyncedEvent{ readonly outline: DocumentOutline; } OutlineRow [InterfaceDeclaration]: export interface OutlineRow{ readonly item: OutlineItem; readonly depth: number; readonly hasChildren: boolean; readonly expanded: boolean; } OutlineToken [VariableDeclaration] (from packages/plugin/outline/src/token.ts): OutlineToken = createCapabilityToken('outline', { hint: "add outlinePlugin() from '@embedpdf/plugin-outline' to your plugins list", promises:{ ensureLoaded: true, refresh: true, create: true, update: true, move: true, delete: true, } , } )