Aspose.PDF FOSS для Go
API reference для Aspose.Pdf FOSS для Go. 206 публичных типов, организованных по модулям.
Основной API
| Класс | Описание: |
|---|---|
AIClient | AIClient — это контракт, который использует каждый копилот: один вызов, одно завершение чата. |
APIError | APIError возвращается, когда AI endpoint отвечает статусом, отличным от 2xx. |
Action | Action — общий интерфейс, реализуемый каждым конкретным типом действия. |
ActionType | ActionType определяет тип действия, привязанного к аннотации (обычно запись /A у LinkAnnotation). |
Annotation | Annotation — общий интерфейс, реализуемый каждым конкретным типом аннотации. |
AnnotationCollection | AnnotationCollection — живой упорядоченный набор аннотаций, привязанных к одной странице. |
AnnotationType | AnnotationType определяет тип аннотации. |
BmpDevice | BmpDevice рендерит страницу в BMP. |
BookletBinding | BookletBinding выбирает сторону переплёта буклета. |
BookletOptions | BookletOptions настраивает расположение страниц в буклете. |
BorderEffect | BorderEffect контролирует запись /BE/S согласно ISO 32000-1 §12.5.4 Таблица 167. |
BorderInfo | BorderInfo описывает границу, нарисованную вокруг таблицы или ячейки. |
BorderSide | BorderSide — это битовая маска, выбирающая, какие стороны прямоугольной границы будут нарисованы. |
BorderStyle | BorderStyle управляет словарём /BS для рисования аннотаций в соответствии с ISO 32000-1 §12.5.4 Таблица 168. |
ButtonAppearance | ButtonAppearance настраивает расширенный внешний вид push-button: отдельные подписи для обычного / наведённого / нажатого состояний, необязательное изображение значка и цвета лица/границы/текста. |
ButtonField | ButtonField — это push button, только действие, без семантики значения. |
ButtonIconPosition | ButtonIconPosition управляет тем, как push button размещает свою иконку и подпись — запись /MK /TP согласно ISO 32000-1 §12.5.6.19 Таблица 189. |
CaretAnnotation | CaretAnnotation отмечает точку вставки или удаления текста, изображается как восходящий карет ("^"), заполненный цветом аннотации. |
CaretSymbol | CaretSymbol является записью /Sy аннотации Caret согласно ISO 32000-1 §12.5.6.11 Таблица 180 — необязательный символ, рисуемый вместе с каретой для связи её с действием редактирования. |
Cell | Cell — это отдельная ячейка в Row. |
CertifyPermission | CertifyPermission — это уровень разрешения DocMDP подписи сертификата (ISO 32000-1 §12.8.2.2 Table 254). |
ChatCopilot | ChatCopilot отвечает на вопросы о документе, сохраняя историю диалога. |
ChatOptions | ChatOptions настраивает ChatCopilot. |
CheckboxField | CheckboxField — это флажок с состоянием включено/выключено. |
ChoiceOption | ChoiceOption — один вариант ComboBoxField или ListBoxField. |
CircleAnnotation | CircleAnnotation рисует эллиптическую аннотацию. |
Color | Color представляет цвет RGBA со значениями в [0, 1]. |
ComboBoxField | ComboBoxField — это поле выбора с одиночным выпадающим списком. |
CompletionRequest | CompletionRequest описывает один вызов chat-completion. |
CompletionResponse | CompletionResponse — это ответ модели. |
DateField | DateField — это текстовое поле с действием формата даты JavaScript и маской формата (например, |
Destination | Destination — общий интерфейс для всех явных назначений. |
DestinationFit | DestinationFit — [page /Fit]. |
DestinationFitB | DestinationFitB — [page /FitB]. |
DestinationFitBH | DestinationFitBH — [page /FitBH top]. |
DestinationFitBV | DestinationFitBV — [page /FitBV слева]. |
DestinationFitH | DestinationFitH — [page /FitH top]. |
DestinationFitR | DestinationFitR — [page /FitR left bottom right top]. |
DestinationFitV | DestinationFitV — [page /FitV left]. |
DestinationType | DestinationType определяет целевой flavor. |
DestinationXYZ | DestinationXYZ — [page /XYZ left top zoom]. |
Document | Документ является PDF-документом. |
DocumentInfo | DocumentInfo содержит информацию о документе из словаря PDF Info. |
EmbeddedFile | EmbeddedFile является одним вложением: словарь /Filespec с встроенным потоком. |
EmbeddedFiles | EmbeddedFiles — это набор присоединённых (встроенных) файлов документа — дерево имён /Catalog/Names/EmbeddedFiles (ISO 32000-1 §7.11.4). |
EncryptionAlgorithm | EncryptionAlgorithm выбирает шифр и версию обработчика безопасности, используемые в (*Document).SetEncryption. |
EncryptionOptions | EncryptionOptions объединяет все параметры, управляющие тем, как документ шифруется при сохранении. |
Field | Field — это общий интерфейс, реализуемый каждым конкретным типом поля формы (TextBoxField, CheckboxField, RadioButtonField и т.д.). |
FieldStyle | FieldStyle — это визуальное оформление, применяемое к виджету(ам) поля формы. |
FigureAlt | FigureAlt — это элемент структуры /Figure, не имеющий альтернативного текста, сопряжённый с изображением, которое он ограничивает (если оно разрешимо). |
FileAttachmentAnnotation | FileAttachmentAnnotation встраивает файл в документ и отображает значок в /Rect аннотации. |
FileAttachmentIcon | FileAttachmentIcon названия согласно ISO 32000-1 §12.5.6.15 Таблица 178. |
FileSelectBoxField | FileSelectBoxField — это текстовое поле, значение которого представляет собой путь к файлу (флаг FileSelect), используемое для прикрепления локального файла при отправке. |
FloatSide | FloatSide выбирает, к какому краю будет притягиваться плавающий блок, пока текст обтекает его. |
FloatingBox | FloatingBox — это позиционированный контейнер содержимого (уровень 2 модели потока): коробка с необязательной рамкой, фоном и отступом, в которой размещается собственное содержимое (абзацы, заголовки, изображения, списки) внутри её ширины. |
Flow | Flow — это генератор документов, который размещает содержимое сверху вниз и автоматически разбивает его на страницы — «flow»-аналог рисования на основе Rectangle API. |
FlowOptions | FlowOptions настраивает Flow. |
Font | Шрифт реализуется с помощью стандартных 14 шрифтов и встроенных TTF-шрифтов. |
Form | Форма — это AcroForm представление документа. |
FormFieldType | FormFieldType определяет тип поля формы. |
FreeTextAnnotation | FreeTextAnnotation отображает текст непосредственно на странице, рендерится в /AP/N с использованием встроенного шрифта. |
FreeTextIntent | FreeTextIntent согласно ISO 32000-1 §12.5.6.6 /IT entry. |
GenericAnnotation | GenericAnnotation — это универсальная поверхность для значений /Subtype, которые данная версия ещё не моделирует (Stamp, FreeText, Ink и т.д.). |
GifDevice | GifDevice преобразует страницу в GIF. |
GoToAction | GoToAction переходит к странице внутри того же документа. |
GoToURIAction | GoToURIAction открывает URI в обработчике по умолчанию пользователя (обычно веб-браузер). |
Gradient | Градиент — это заливка, в которой цвет меняется по форме: либо LinearGradient, либо RadialGradient. |
GradientStop | GradientStop — это одна цветовая остановка в градиенте, расположенная по смещению (0 в начале градиента, 1 в его конце). |
HAlign | HAlign определяет горизонтальное выравнивание текста внутри прямоугольника. |
HTMLMode | HTMLMode выбирает, как SaveHTML / WriteHTML представляет текст страницы. |
HTMLSaveOptions | HTMLSaveOptions настраивает SaveHTML / WriteHTML. |
HighlightAnnotation | HighlightAnnotation помечает область полупрозрачным цветом выделения. |
Image | Image содержит извлечённое изображение с его закодированными данными и метаданными. |
ImageColorSpace | ImageColorSpace описывает оригинальное цветовое пространство изображения в PDF. |
ImageDescriptionCopilot | ImageDescriptionCopilot описывает изображения с моделью компьютерного зрения. |
ImageDescriptionOptions | ImageDescriptionOptions настраивает ImageDescriptionCopilot. |
ImageFormat | ImageFormat описывает формат вывода извлечённого изображения. |
ImageInfo | ImageInfo хранит метаданные об изображении, найденном на странице, без декодирования пиксельных данных. |
ImageStamp | ImageStamp накладывает растровое изображение (PNG или JPEG), растянутое, чтобы заполнить Rect. |
ImageToDocumentOptions | ImageToDocumentOptions управляет размером страницы для ImageToDocument. |
InkAnnotation | InkAnnotation рисует серию свободных штрихов — обычно используется для представления рукописного письма. |
JSONExportOptions | JSONExportOptions управляет (*Form).ExportJSON / WriteJSON. |
JavaScriptAction | JavaScriptAction содержит фрагмент JavaScript, прикреплённый к аннотации. |
JavaScriptCollection | JavaScriptCollection является хранилищем JavaScript уровня документа, поддерживаемым именованным деревом /Catalog/Names/JavaScript (ISO 32000-1 §7.7.4 / §8.5.1). |
JpegDevice | JpegDevice рендерит страницу в JPEG. |
LLMOCREngine | LLMOCREngine распознаёт текст, отправляя изображение страницы в чат-модель с поддержкой зрения. |
LLMOCROptions | LLMOCROptions настраивает движок OCR на основе визуальной модели. |
Layer | Layer — это одна группа необязательного контента (OCG) в документе. |
LineAnnotation | LineAnnotation рисует прямую линию между двумя точками, с необязательными окончаниями линии на каждом конце (стрелки, круги и т.д. |
LineCap | LineCap — стиль окончания линии /J согласно ISO 32000-1 §8.4.3.3 Таблица 54. |
LineEndingStyle | LineEndingStyle является одной из 10 форм завершения линии согласно ISO 32000-1 §12.5.6.7 Таблица 176, используемой в поле /LE аннотаций /Line. |
LineJoin | LineJoin — стиль соединения линий /j согласно ISO 32000-1 §8.4.3.4 Таблица 55. |
LineStyle | LineStyle описывает, как рисуется обводка пути. |
LinearGradient | LinearGradient интерполирует цвет вдоль линии от (X1, Y1) до (X2, Y2). |
LinkAnnotation | LinkAnnotation — это кликабельная область. |
LinkHighlightMode | LinkHighlightMode управляет визуальной реакцией, когда ссылка активируется пользователем (запись /H согласно ISO 32000-1 §12.5.6.5). |
ListBoxField | ListBoxField — это поле выбора из списка, позволяющее одиночный или множественный выбор. |
MarginInfo | MarginInfo описывает отступы или внутренние поля в пунктах: Верх / Право / Низ / Лево. |
MarkdownOptions | MarkdownOptions настраивает рендеринг Markdown. |
MarkdownSaveOptions | MarkdownSaveOptions настраивает SaveMarkdown / WriteMarkdown. |
MarkupParagraph | MarkupParagraph — это последовательность строк, образующих один абзац. |
MarkupSection | MarkupSection — это колонка абзацев (слева направо по странице). |
Message | Сообщение представляет собой одно сообщение чата. |
MessageImage | MessageImage — это встроенное изображение, прикреплённое к сообщению, отправленное как URL-адрес данных base64. |
NUpOptions | NUpOptions настраивает расположение NUp. |
NUpOrder | NUpOrder управляет порядком, в котором исходные страницы заполняют ячейки сетки листа N-up. |
NamedAction | NamedAction инициирует встроенную команду просмотрщика (FirstPage, Print, …). |
NamedActionType | NamedActionType определяет одну из стандартных команд просмотрщика, поддерживаемых /Named actions согласно ISO 32000-1 §12.6.4.11. |
NamedDestination | NamedDestination оборачивает ссылку на имя в коллекцию NamedDestinations документа. |
NamedDestinations | NamedDestinations представляет собой карту имя-назначение согласно ISO 32000-1 §12.3.2.3. |
NumberField | NumberField — это текстовое поле с действием JavaScript number-format, поэтому просмотрщики отображают и проверяют значение как отформатированное число. |
NumberFormatOptions | NumberFormatOptions настраивает формат отображения NumberField (соответствует AFNumber_Format в Acrobat). |
OCRBox | OCRBox — это прямоугольник в пиксельном пространстве изображения: начало в левом верхнем углу, ось Y увеличивается вниз (обычная растровая конвенция — специально отличается от пользовательского пространства PDF). |
OCREngine | OCREngine распознаёт текст на одностраничном изображении. |
OCRLine | OCRLine — одна физическая строка текста. |
OCRResult | OCRResult — распознанное содержимое изображения одной страницы. |
OCRWord | OCRWord — детализированная информация о слове в строке, для движков, которые её предоставляют. |
OcrCopilot | OcrCopilot распознает текст на отсканированных страницах. |
OcrOptions | OcrOptions настраивает OcrCopilot. |
OpenAIClient | OpenAIClient обращается к совместимому с OpenAI конечному пункту chat-completions, используя только стандартную библиотеку. |
OpenAIClientOptions | OpenAIClientOptions настраивает NewOpenAIClient. |
OptimizationOptions | OptimizationOptions выбирает, какие сокращения применяет Document.Optimize. |
OptimizationResult | OptimizationResult сообщает, что Document.Optimize изменил. |
OptimizeImageOptions | OptimizeImageOptions управляет поведением оптимизации изображений. |
OutlineItemCollection | OutlineItemCollection представляет запись оглавления и набор её дочерних элементов. |
PDFAFormat | PDFAFormat определяет уровень соответствия PDF/A. |
PDFAIssue | PDFAIssue описывает единственное нарушение соответствия PDF/A. |
PDFAValidationReport | PDFAValidationReport возвращается методом (*Document).ValidatePDFA. |
PDFUAIssue | PDFUAIssue описывает отдельное нарушение соответствия PDF/UA (доступность). |
PDFUAValidationReport | PDFUAValidationReport возвращается методом (*Document).ValidatePDFUA. |
Page | Page — это живой просмотр отдельной страницы внутри Document. |
PageFormat | PageFormat описывает размер страницы в пунктах (1/72 дюйма). |
PageLabelRange | PageLabelRange описывает непрерывный набор страниц, которые используют один стиль нумерации. |
PageLabelStyle | PageLabelStyle — стиль нумерации, применяемый внутри PageLabelRange. |
PageMarkup | PageMarkup — структурированный текст одной страницы. |
PageNumberStamp | PageNumberStamp ставит номер страницы (и, при желании, общее количество), отформатированный с помощью Format. |
PageRange | PageRange указывает включительный диапазон страниц (нумерация с 1). |
PageSize | PageSize содержит ширину и высоту страницы PDF в пунктах (1/72 дюйма). |
PasswordBoxField | PasswordBoxField — это текстовое поле, ввод в котором маскируется (флаг Password). |
Path | Path — это последовательность операций MoveTo/LineTo/CurveTo/Close, определяющая произвольный 2-D путь в пользовательском пространстве PDF (начало координат в левом нижнем углу страницы, ось Y направлена вверх). |
PdfPageStamp | PdfPageStamp накладывает (или подложивает) страницу из другого PDF-документа в виде штампа — исходная страница импортируется один раз как Form XObject и рисуется в прямоугольнике штампа, масштабируется до заполнения с сохранением пропорций, позиционируется с помощью HAlign/VAlign и учитывает Opacity, RotateAngle и Background. |
Permissions | Permissions контролирует, какие действия разрешает просмотрщик в зашифрованном PDF. |
PngDevice | PngDevice рендерит страницу в PNG с фиксированным разрешением. |
Point | Point — это одна точка в координатах пользовательского пространства PDF. |
PolygonAnnotation | PolygonAnnotation рисует замкнутый многоугольник по списку вершин, с обведённой границей и опциональной заливкой. |
PolylineAnnotation | PolylineAnnotation рисует открытую полилинию по списку вершин, с обведённой границей, опциональными окончаниями линии в первой и последней вершине и опциональной заливкой для закрытых окончаний. |
QuadPoint | QuadPoint является одним из четырёхугольников в массиве /QuadPoints разметки аннотации. |
RadialGradient | RadialGradient интерполирует цвет от фокусной точки (FX, FY) до круга, центрированного в (CX, CY) с радиусом R. |
RadioButtonField | RadioButtonField — это группа взаимно исключающих вариантов. |
RadioButtonOptionField | RadioButtonOptionField — один из виджетов вариантов внутри RadioButtonField. |
RadioItem | RadioItem описывает один виджет внутри радиогруппы. |
Rectangle | Rectangle представляет собой PDF-прямоугольник [llx, lly, urx, ury] в пунктах (1/72 дюйма). |
RedactAnnotation | RedactAnnotation отмечает области для редактирования. |
RenderOptions | RenderOptions управляет растеризацией страницы. |
ReplaceOptions | ReplaceOptions регулирует, как ReplaceText сопоставляет поисковый текст. |
ResetFormAction | ResetFormAction сбрасывает именованные поля формы к их /DV значениям по умолчанию. |
Resolution | Resolution — это разрешение рендеринга в DPI. |
RichTextBoxField | RichTextBoxField — это текстовое поле, которое содержит значение в формате rich-text (RichText флаг + /RV) помимо обычного /V. |
RotationAngle | RotationAngle представляет собой допустимое вращение страницы PDF по часовой стрелке в градусах. |
Row | Row — это одна строка в таблице. |
SVG | SVG — это предварительно разобранный документ SVG. |
SVGFontResolver | SVGFontResolver сопоставляет семейство шрифтов SVG + стиль с pdf.Font. |
SVGSaveOptions | SVGSaveOptions настраивает SaveSVG / WriteSVG. |
SearchOptions | SearchOptions настраивает то, как SearchText интерпретирует запрос. |
ShapeStyle | ShapeStyle сочетает обводку (LineStyle) с необязательным цветом заливки. |
SignOptions | SignOptions настраивает цифровую подпись. |
SignatureAppearance | SignatureAppearance управляет содержимым и оформлением видимого блока подписи. |
SignatureVerification | SignatureVerification является результатом проверки одной цифровой подписи. |
SquareAnnotation | SquareAnnotation рисует прямоугольную аннотацию с обведённой рамкой и необязательной заливкой внутри. |
SquigglyAnnotation | SquigglyAnnotation рисует волнистое подчеркивание под текстом (обычно используется для подсказок орфографической проверки). |
Stamp | Отметка — это содержимое, наложенное (или расположенное за) страницей: TextStamp, ImageStamp или PageNumberStamp. |
StampAnnotation | StampAnnotation — это аннотация-штамп. |
StampName | StampName наименования согласно ISO 32000-1 §12.5.6.13 Таблица 184. |
StrikeOutAnnotation | StrikeOutAnnotation рисует горизонтальную линию через текст. |
StructElement | StructElement является узлом в логическом дереве структуры. |
StructType | StructType — тип стандартной структуры PDF (ISO 32000-1 §14.8.4), используемый в качестве значения /S элемента структуры. |
SubmitFormAction | SubmitFormAction отправляет значения полей формы по URL. |
SubmitFormFlags | SubmitFormFlags — битовое поле /Flags для действия /SubmitForm согласно ISO 32000-1 Таблица 237. |
SummaryCopilot | SummaryCopilot создает резюме документов с помощью AI модели. |
SummaryOptions | SummaryOptions настраивает SummaryCopilot. |
TOCEntry | TOCEntry — это одна строка оглавления: заголовок, уровень отступа (0 = верхний уровень) и страница, на которую она указывает. |
TOCOptions | TOCOptions управляет тем, как отображается оглавление. |
Table | Table — это временный конструктор табличного макета, рисуемого на Page. |
TaggedContent | TaggedContent — это оболочка для создания Tagged PDF (ISO 32000-1 §14.8): она владеет логическим деревом структуры документа и устанавливает метки каталога, требуемые PDF/UA. |
TextAnnotation | TextAnnotation — это аннотация-липкая заметка. |
TextBoxField | TextBoxField — это однострочный или многострочный текстовый ввод. |
TextExtractOptions | TextExtractOptions настраивает ExtractText. |
TextExtractionMode | TextExtractionMode выбирает, как ExtractText упорядочивает извлечённый текст. |
TextFragment | TextFragment представляет собой непрерывный фрагмент текста с одинаковым шрифтом. |
TextIcon | TextIcon названия согласно ISO 32000-1 §12.5.6.4 Таблица 172, используемые в поле /Name аннотаций /Subtype /Text. |
TextLine | TextLine представляет собой горизонтальную линию фрагментов текста на общей позиции Y. |
TextMatch | TextMatch — это единственное вхождение, расположенное SearchText. |
TextRecognitionResult | TextRecognitionResult — распознанный текст одной обработанной страницы. |
TextStamp | TextStamp накладывается на строку (или перенесённый блок) текста. |
TextStyle | TextStyle определяет переиспользуемые свойства форматирования текста. |
TiffDevice | TiffDevice преобразует страницы в TIFF. |
TilingPattern | TilingPattern — это повторяющаяся заливка (PatternType 1, ISO 32000-1 §8.7.3.1): небольшая ячейка контента, размещённая плиткой по любой форме, которую она заполняет. |
UnderlineAnnotation | UnderlineAnnotation рисует горизонтальную линию под текстом. |
Usage | Отчёты об использовании отображают количество токенов, когда провайдер их возвращает. |
VAlign | VAlign указывает вертикальное выравнивание текста внутри прямоугольника. |
ValidationIssue | ValidationIssue описывает одну проблему, найденную в PDF-файле. |
ValidationReport | ValidationReport возвращается функцией Validate и суммирует структурную целостность PDF. |
WidgetAnnotation | WidgetAnnotation — это только для чтения представление аннотации виджета формы, получаемое через AnnotationCollection. |
XForm | XForm — переиспользуемый Form XObject (ISO 32000-1 §8.10) — автономный поток содержимого (со своими ресурсами), который может быть размещён на произвольном количестве страниц и позиций одним вызовом Do. |
XMPMetadata | XMPMetadata — XMP-пакет документа, смоделированный как общие поля схемы плюс список произвольных Custom свойств. |
XMPProperty | XMPProperty — отдельное простое (строковое) XMP-свойство в произвольном пространстве имён. |
