Aspose.PDF FOSS dla Python

API reference dla Aspose.Pdf FOSS dla Python. 265 publicznych typów uporządkowanych według modułu.

Podstawowe API

KlasaOpis
ActionKlasa bazowa dla interaktywnej akcji.
AsposePdfExceptionKlasa bazowa dla wszystkich wyjątków aspose_pdf.
ByteArrayDataSourceŹródło danych oparte na bajtach w pamięci.
CdrLoadOptionsOpcje ładowania plików CDR.
CgmLoadOptionsOpcje ładowania plików CGM.
ColorPrimitiveBardzo mały prymityw koloru z obsługą przezroczystości.
DataSourceKlasa bazowa dla wejść i wyjść wtyczek.
DeprecatedFeatureExceptionZgłaszany, gdy używana jest przestarzała funkcja PDF, niedozwolona w nowszych wersjach PDF.
DestinationKlasa bazowa dla miejsca docelowego widoku na stronie dokumentu.
Document-documentPythonic wrapper dla cyklu życia dokumentu PDF i podstawowych operacji.
FieldPole interaktywnego formularza.
FileDataSourceŹródło danych oparte na pliku na dysku.
FileFontSourceOdkryj czcionkę(i) zawarte w jednym pliku.
FileSpecificationWbudowany plik na poziomie dokumentu (/Filespec) z typowanymi metadanymi.
FillModeEnumeracja trybu wypełniania dla operacji ścieżki.
FitBDestinationDopasuj ramkę ograniczającą strony w oknie.
FitBHDestinationDopasuj szerokość ramki ograniczającej z top u góry okna.
FitBVDestinationDopasuj wysokość ramki ograniczającej z left po lewej stronie okna.
FitDestinationDopasuj całą stronę do okna.
FitHDestinationDopasuj szerokość strony z top na górze okna.
FitRDestinationDopasuj prostokąt (left, bottom, right, top) w oknie.
FitVDestinationDopasuj wysokość strony z left po lewej stronie okna.
FolderFontSourceZbierz czcionki z katalogu (opcjonalnie rekurencyjnie w podfolderach).
FontDescriptorReprezentuje odnajdywalną czcionkę.
FontEmbeddingExceptionPodnoszone, gdy wystąpi błąd osadzania czcionek w pliku PDF.
FontRegistryRejestr Singleton dla rozwiązywania dobrze znanych nazw czcionek.
FontRepositoryAgreguj źródła czcionek i rozwiąż czcionki według nazwy.
FontSourceKlasa bazowa dla zewnętrznych dostawców czcionek.
FontSubstitutionOptionsŹródła czcionek, z których renderujący może podstawić.
FormReprezentuje interaktywny formularz (AcroForm) w dokumencie PDF.
GoToActionPrzejdź do miejsca docelowego w tym dokumencie.
GoToRActionPrzejdź do miejsca docelowego w innym (zdalnym) pliku PDF.
GradientAxialShadingReprezentuje gradientowe cieniowanie osiowe (liniowe).
GraphicElementNamalowana ścieżka lub umieszczony obraz, odczytany ze strumienia zawartości strony.
GraphicElementCollectionLista w pamięci obiektów :class:GraphicElement.
GraphicsAbsorberAbsorbuje elementy graficzne z stron PDF.
HtmlLoadOptionsOpcje ładowania dokumentów HTML.
HtmlSaveOptionsOpcje zapisywania dokumentów PDF jako HTML.
ImagePlacement-imagesReprezentuje obraz umieszczony na stronie PDF.
ImagePlacementAbsorber-imagesAbsorber do zbierania rozmieszczeń obrazów ze stron PDF.
IncorrectCMapUsageExceptionZgłaszany, gdy występuje nieprawidłowe użycie CMap.
InvalidFormTypeOperationExceptionException zgłaszany, gdy próbuje się wykonać nieprawidłową operację typu formularza.
InvalidOperationExceptionZgłaszany, gdy element graficzny jest dołączany do niewłaściwego rodzica.
InvalidPasswordExceptionZgłaszany, gdy podano nieprawidłowe hasło do zaszyfrowanego dokumentu.
InvalidPdfFileFormatExceptionZgłaszany, gdy format pliku PDF jest nieprawidłowy lub uszkodzony.
InvalidValueFormatExceptionZgłaszane, gdy podczas parsowania lub konwersji napotkano nieprawidłową wartość.
JavaScriptActionUruchom skrypt JavaScript (zserializowany dosłownie, nieweryfikowany).
LatexFragmentMały obiekt wartościowy, który przechowuje tekst źródłowy LaTeX.
LaunchActionUruchom aplikację lub otwórz plik (zserializowane dosłownie).
LayerJedna opcjonalna grupa treści oraz informacja, czy jest obecnie wyświetlana.
LayerCollectionWarstwy dokumentu, indeksowalne według pozycji lub nazwy.
LicenseKlasa zarządzania licencją dla Aspose.PDF.
MarginMargin zapewnia prosty kontener dla wartości marginesów strony (top, left, bottom, right) które mogą być przekazywane do interfejsów API związanych z układem.
MarkdownSaveOptionsMarkdownSaveOptions pozwala deweloperom konfigurować eksport Markdown, w tym docelowy resources_directory_name, markdown_format, czy extract_images, i image_directory; ustawienia mogą być serializowane przy użyciu to_dict.
Matrix3DReprezentuje macierz przekształcenia 3D.
MemoryFontSourceUdostępnij program czcionki dostarczony jako bajty w pamięci.
MergeOptionsOpcje dla :class:Merger: połącz wszystkie wejścia w kolejności.
MergerPołącz każdy plik PDF wejściowy w jeden dokument.
NamedActionWstępnie zdefiniowana nazwana akcja, np.
NamespaceProviderRozwiąż prefiksy i URI przestrzeni nazw XMP.
OfdLoadOptionsOpcje ładowania plików OFD.
OperationResultPojedynczy wynik generowany przez wtyczkę.
OptimizationOptionsOptimizationOptions.to_dict serializuje wszystkie flagi optymalizacji do słownika w celu inspekcji lub JSON wyjścia.
OptimizeOptionsOpcje dla :class:Optimizer.
OptimizerOptymalizuj każdy wejściowy PDF (kompresja + usuwanie nieużywanych obiektów).
OutlineCollectionZbiór najwyższego poziomu zakładek :class:OutlineItem.
OutlineItemPojedynczy wpis zakładki w drzewie spisu treści PDF.
PageStrona dokumentu PDF.
PageCollectionKolekcja do zarządzania stronami PDF w obiekcie Document.
PageInfoKlasa z 1 właściwością.
PdfAConversionResultWynik operacji konwersji PDF/A.
PdfAValidateOptions-pdfaKontener ustawień walidacji PDF/A.
PdfAValidationResult-pdfaSzczegółowy wynik uruchomienia walidacji PDF/A.
PdfAValidatorWtyczka, która wykonuje walidację PDF/A na jednym lub kilku wejściach.
PdfConstsKlasa z 2 metodami.
PdfExceptionKlasa bazowa dla wyjątków związanych z PDF.
PdfExtractorProsty ekstraktor tekstu i obrazów PDF.
PdfFileEditorFasada dla operacji edycji plików PDF.
PdfIOExceptionZgłaszany, gdy wystąpi błąd I/O podczas przetwarzania PDF.
PdfLoadLimitsNiezmienialne limity bezpieczeństwa dla niezaufanego wejścia PDF i zasobów autorstwa.
PdfParseExceptionZgłaszany, gdy wystąpi błąd podczas parsowania dokumentu PDF.
PdfPluginKlasa bazowa dla wtyczek low-code.
PdfResourceLimitExceptionZgłaszany, gdy przetwarzanie pliku PDF przekroczy skonfigurowany limit zasobów.
PdfSecurityExceptionZgłaszany, gdy wystąpi błąd szyfrowania, podpisu lub uprawnień.
PdfSignatureReprezentuje cyfrowy podpis PDF.
PdfUaValidateOptionsKontener ustawień walidacji wsadowej PDF/UA.
PdfUaValidationResultSzczegółowy wynik sprawdzenia struktury PDF/UA (heurystyczny).
PdfUaValidatorWtyczka, która wykonuje heurystyczną walidację PDF/UA na jednym lub kilku wejściach.
PdfValidationExceptionZgłaszany, gdy dokument PDF nie przechodzi walidacji lub kontroli zgodności.
PerformanceLoggerPerformanceLogger.log_line(line) zapisuje wiersz diagnostyczny w właściwości log loggera w celu niestandardowego śledzenia wydajności.
PluginOptionsPrzechowuj źródła danych wejścia/wyjścia oraz ich politykę ograniczeń zasobów PDF.
PointReprezentuje punkt w przestrzeni 2D.
Point3DReprezentuje punkt 3D.
PrinterSettingsKlasa z 11 właściwościami.
RecipientJeden certyfikat, który może otworzyć dokument, i co może potem zrobić.
RectangleProstokąt przedstawiający granice umieszczenia obrazu na stronie PDF.
RegexResultOpakowuje pojedyncze dopasowanie wyrażenia regularnego znalezione na stronie PDF.
ResetFormActionZresetuj pola formularza do ich domyślnych wartości.
ResultContainerZawiera uporządkowane wyniki operacji wtyczki.
SplitOptionsOpcje dla :class:Splitter: podziel pierwsze wejście na pojedyncze strony.
SplitterPodziel pierwszy plik PDF wejściowy na jeden dokument na stronę.
StatisticsEntryWpis służący do śledzenia statystyk i informacji o czasie.
StreamDataSourceŹródło danych oparte na strumieniu binarnym (np.
StructureElementModyfikowalny element struktury logicznej w oznakowanym PDF.
SubmitFormActionWyślij wartości pól formularza do url.
SvgLoadOptions-load_optionsOpcje ładowania plików SVG.
SvgLoadOptions-svgKlasa z 1 metodą i 2 właściwościami.
SystemFontSourceZbieranie czcionek z typowych katalogów czcionek systemowych.
TaggedContentEdytowalny widok drzewa logicznej struktury dokumentu.
TaggedContextKlasa z 4 właściwościami.
TextAbsorberPobiera tekst z stron PDF (klasa przestarzała, alias dla TextFragmentAbsorber).
TextExtractionOptionsOpcje wyodrębniania tekstu ze stron PDF.
TextExtractorWyodrębnij zwykły tekst z każdego wejściowego pliku PDF.
TextExtractorOptionsOpcje dla :class:TextExtractor: wyodrębnianie tekstu z każdego wejścia.
TextFormattingModeTryb formatowania tekstu dla wyodrębniania tekstu.
TextFragmentFragment tekstu znaleziony wewnątrz strony PDF.
TextFragmentAbsorber-textPochłania fragmenty tekstu ze strony PDF lub dokumentu.
TextFragmentCollectionModyfikowalna uporządkowana kolekcja obiektów :class:TextFragment.
TextLayoutOptionsSkonfiguruj kształtowanie złożonego tekstu i układ linii dla Page.add_text.
TextSearchOptionsOpcje kontrolujące sposób wykonywania wyszukiwania tekstowego.
URIActionRozwiąż jednolity identyfikator zasobu (zazwyczaj link internetowy).
UnsignedContent-formsReprezentuje zbiór niepodpisanych elementów treści w dokumencie PDF.
UnsignedContentAbsorber-formsWyodrębnij niepodpisane pola formularza i adnotacje z dokumentu PDF.
UnsupportedFeatureExceptionZgłaszane, gdy warstwa kompatybilności wymienia funkcję, której ten pakiet nie posiada.
ValidationOptionsKonfiguracja weryfikacji podpisu.
ValidationResultUstrukturyzowany wynik zwrócony po weryfikacji podpisu.
VirtualizationPerformanceKlasa z 5 metodami.
WarichuWPElementMinimalny typ elementu tagowanego dla kompatybilności z API.
XYZDestinationUmieść (left, top) w lewym górnym rogu z opcjonalnym zoom.

Wyliczenia

WyliczenieOpis
CertificationLevelDocMDP poziom certyfikacji podpisu.
DocFormatDocelowy format dla operacji zapisu.
DuplexWyliczenie z 4 elementami.
FieldTypeTyp pola formularza.
FormTypeTyp formularza PDF.
PadesLevelPoziom zgodności podstawowej PAdES osiągnięty przez podpis.
PluginIdentyfikatory dostępnych wtyczek low-code.
PrintRangeWyliczenie z 4 elementami.
RevocationStatusWynik unieważnienia certyfikatu (OCSP/CRL).
SaveFormatFormat zapisu dokumentów PDF.
StructureTypeStandardEnum z 15 członkami.
TrustStatusWynik budowania/weryfikacji łańcucha certyfikatów podpisującego.
ValidationMethodWybiera format podpisu / algorytm walidacji.
ValidationModeKontroluje, czy odwołanie certyfikatu jest sprawdzane przez sieć.
ValidationStatusWynik klasy :class:ValidationResult.

Adnotacje

KlasaOpis
AnnotationPodgląd na żywo pojedynczej adnotacji na stronie.
AnnotationCollectionMutowalny wrapper podobny do sekwencji nad adnotacjami strony.
LinkAnnotationKonkretnego typu adnotacji zachowanego dla kompatybilności z tests/API.
MarkupAnnotationKlasa bazowa dla adnotacji markup.
PDF3DAnnotationMinimalny wrapper adnotacji dla importów prerelease.
PDF3DArtworkKontener dla treści 3D i nazwanych widoków.
PDF3DContentOdniesienie do treści 3D przechowywanych na dysku.
PDF3DViewLekkie opisanie zapisanego widoku 3D.

Wyliczenia

WyliczenieOpis
AnnotationFlagsFlagi definiujące zachowanie adnotacji.
AnnotationTypeZnane nazwy podtypów adnotacji (PDF 32000-1:2008, Tabela 169).
PDF3DLightingSchemeEnum z 5 elementami.
PDF3DRenderModeenumy PDF3DRenderMode i PDF3DLightingScheme pozwalają programistom wybrać styl renderowania (SOLID, WIREFRAME, TRANSPARENT) oraz oświetlenie (HEADLAMP, WHITE itp.) dla adnotacji 3D.

Clustering

KlasaOpis
ClusterReprezentuje skupisko punktów danych.
ClusterCollectionZbiór klastrów.
DataPointReprezentuje punkt danych w operacjach grupowania.

Engine

KlasaOpis
AbsorbedElementJedna pomalowana ścieżka lub umieszczony obraz, w przestrzeni strony (użytkownika).
AnnotationNamePodklasa str, która oznacza wartość do serializacji jako nazwa PDF.
AuthoredFontZnormalizowana osadzona czcionka oraz zmienna mapa CID dla tworzonego tekstu.
AuthoredImagePrzygotowane dane obrazu oraz metadane XObject obrazu PDF.
BitStreamMinimalny bufor bitowy używany przez kod kompatybilności.
BlockJeden element wyeksportowanej struktury.
CffOutlinesDekoduj kontury glifów z programu czcionki CFF (Type 2 charstring).
ChainResultWynik budowania i weryfikacji ścieżki certyfikatu.
CharacterCollectionRejestr CIDSystemInfo, kolejność i trójka suplementu.
CidTextCodecKodek kodu dla ciągów wyświetlania czcionki złożonej (Type0).
CodestreamKlasa z 2 metodami i 8 właściwościami.
ColorReprezentuje kolor w dokumentach PDF.
CompositeFontMetricMetryki przyrostu dla czcionki złożonej (Type0).
ContentStreamParserPrzeanalizuj strumień zawartości PDF i wyodrębnij zwykły tekst.
CosExtractorWyodrębnij strony, strumienie, obrazy i metadane z PdfDocument.
DecodedImageZdekodowany obraz JPEG 2000 jako przeplatane próbki 8-bitowe.
DecodedJpegZdekodowany obraz JPEG.
Decoder-ccittKlasa z 2 metodami.
Decoder-jbig2Dekoder JBIG2, który analizuje strukturę segmentu i wyodrębnia dane bitmapowe.
Decoder-jpxDekoder strumienia JPEG 2000 (JPX).
DssMaterialMateriał walidacyjny przeznaczony dla (lub pozyskany z) /DSS.
EncodingKlasa z 1 metodą i 4 członkami.
EncryptionUtilsKlasa narzędziowa dla zgodnego z PDF AES-CBC, szyfrowania RC4 i wyprowadzania klucza.
FontResolverIndeksuj zewnętrzne źródła czcionek i rozpoznaj nazwy czcionek PDF względem nich.
GeneratedAppearanceSyntezowany wygląd: bajty treści plus wszelkie wymagane wpisy ExtGState.
GlyphPlacementJedna ukształtowana glif w położeniu względnym do em w obrębie ułożonej linii.
ImagePlacement-simple_pdfReprezentuje umiejscowienie obrazu na stronie.
ImagePlacementAbsorber-simple_pdfAbsorber, który znajduje położenia obrazów w pliku PDF.
IncrementalUpdateWygeneruj sekcję aktualizacji przyrostowej dla istniejącego pliku PDF.
IncrementalWriterNarzędzie, które dołącza aktualizacje przyrostowe do istniejącego pliku PDF.
Jpeg2000ErrorStrumień kodowy JPEG 2000, którego nie można zdekodować.
LayoutElementUmieszczony fragment zawartości strony (obiekt tekstowy lub obraz).
LayoutLineJedna wizualna linia z logicznym tekstem zamiennym i ukształtowanymi glifami.
LayoutResultPełny układ linii; współrzędne glifów i ich szerokości są w jednostkach em.
LazyImageDictSłownik, który dekoduje strumienie obrazów na żądanie, aby oszczędzać pamięć.
LazyPdfObjectStoreObiekt-numer → mapa obiektu COS, która parsuje z :class:PdfCosParser na żądanie.
MQDecoderDekoder arytmetyczny MQ z Aneksu C.
MatrixMatrix.translate(x, y) przesuwa system współrzędnych, podczas gdy Matrix.multiply(other) łączy dwie transformacje, odsłaniając podstawowe składniki a‑f.
OptionalContentOpcjonalne grupy zawartości dokumentu oraz ich domyślna widoczność.
OptionalContentGroupJedna opcjonalna grupa zawartości (/OCG) dokumentu.
ParseWarningsZbiera ostrzeżenia podczas parsowania.
PdfArrayPdfArray zapewnia kolekcję elementów oraz metodę append do budowania obiektów tablic PDF.
PdfBooleanPdfBoolean reprezentuje wartość logiczną PDF poprzez jej właściwość ‘value’.
PdfCorruptedErrorNieodwracalne uszkodzenie pliku PDF.
PdfCosParserPrzetwórz plik PDF (bajty) do :class:PdfDocument.
PdfCosWriterSerializuj :class:PdfDocument do sekwencji bajtów PDF.
PdfDictionaryPdfDictionary zachowuje się jak mapowanie z metodami get i pop do dostępu do wpisów.
PdfDocumentKontener dla grafu obiektów COS w PDF.
PdfEncodingErrorBłąd kodowania czcionki lub strumienia zawartości.
PdfIndirectReferencePdfIndirectReference ujawnia numer obiektu i numer generacji pośredniego obiektu PDF.
PdfMalformedErrorNaprawialna nieprawidłowa struktura PDF.
PdfNameKlasa z 1 metodą i 1 właściwością.
PdfNullReprezentuje obiekt null PDF.
PdfNumberKlasa z 1 metodą i 1 właściwością.
PdfObjectKlasa bazowa dla wszystkich obiektów PDF COS.
PdfObjectIDPdfObjectID udostępnia object_number i generation_number pośredniego obiektu PDF, umożliwiając precyzyjną identyfikację w tabeli cross‑reference.
PdfObjectRegistryPdfObjectRegistry pozwala zarejestrować dowolny PdfObject i pobrać go później po jego PdfObjectID za pomocą metod register() i get().
PdfParseErrorPodstawowy wyjątek dla błędów parsowania PDF.
PdfParseWarningNiefatalny problem parsowania, z którego odzyskano.
PdfSecurityErrorBłąd związany z szyfrowaniem lub uprawnieniami.
PdfStreamPdfStream zachowuje się jak mutowalna mapowanie; możesz pobierać wartości za pomocą get(key, default) i usuwać wpisy przy pomocy pop(key, default).
PdfStringKlasa z 1 metodą i 1 właściwością.
PdfTrailerableKlasa z 1 metodą.
PdfValidationErrorPDF/A lub błąd walidacji strukturalnej.
PdfWriterV0Zapisuje SimplePdf w formacie PDF 1.7.
PredefinedCMapRozwiązana wstępnie zdefiniowana mapa CMap oraz jej semantyczne mapowanie Unicode.
PredefinedCMapEncodingKompaktowy widok kod-do-CID wstępnie zdefiniowanej mapy CMap.
RasterizedPageRenderowana strona PDF w spakowanym formacie RGB.
RecipientPayloadCo niesie otwarta koperta.
ReshaperPolityka kształtowania zamian złożonych skryptów podczas edycji tekstu.
ResolvedFaceProgram czcionki wybrany dla nieosadzonej czcionki PDF.
RevocationResultKlasa z 3 właściwościami.
RichRunKlasa z 2 właściwościami.
RichStyleRozwiązany styl fragmentu tekstu.
SfntFaceMetadane odzyskane z pojedynczej czcionki SFNT.
ShadingKlasa bazowa dla ograniczonego próbkowania RGB w przestrzeni docelowej cieniowania.
SignedDataInfoWszystko, czego potrzebujemy z parsowanego CMS SignedData.
SignerVerificationWynik weryfikacji pojedynczego podpisującego.
SigningUtilsKlasa narzędziowa do generowania certyfikatów i podpisów PKCS#7.
SimpleFontMetricZaawansowane metryki dla single-byte simple font, w przestrzeni 1000-unit glyph space.
SimplePdfNatywna reprezentacja dokumentu PDF Python.
StandardFontsKlasa narzędziowa dla czcionek PDF Standard 14.
StreamDecoderDekoduj dane strumienia PDF przy użyciu obsługiwanych filtrów.
StreamEncoderZakoduj surowe bajty do danych strumienia PDF, odwrotność :class:StreamDecoder.
TagTreeDrzewo znaczników B.10.2, używane do włączania i sygnalizacji zerowej płaszczyzny bitowej.
TextFragmentAbsorber-simple_pdfAbsorber, który wyodrębnia fragmenty tekstu z instancji SimplePdf.
TextObjectA BT …
TiffPageJeden obraz w pliku TIFF.
TimestampInfoWynik weryfikacji tokenu znacznika czasu RFC 3161.
TrueTypeOutlinesDekoduj kontury glifów z osadzonego programu TrueType (glyf).
Type1OutlinesDekoduj kontury glifów z programu czcionkowego Type 1 (/FontFile).
XmpArrayUporządkowana wartość tablicy XMP.
XmpFieldJedna właściwość XMP.
XmpNamespaceProviderDwukierunkowy resolver prefiksu URI przestrzeni nazw XMP.
XmpPacketPakiet XMP w pamięci: uporządkowana kolekcja właściwości.
XmpPropertyWłaściwość niosąca dowolne kwalifikatory.
XmpStructStrukturalna wartość XMP (blok rdf:parseType="Resource").

Wyliczenia

WyliczenieOpis
EncodingTypeWyliczenie z 5 elementami.
FilterTypeEnum FilterType wymienia obsługiwane nazwy filtrów strumieni, takie jak FLATE_DECODE, LZW_DECODE i DCT_DECODE.

Generated

KlasaOpis
Document-generated_documentPythonic wrapper dla cyklu życia dokumentu PDF i podstawowych operacji.
PdfAValidateOptions-generated_pdfaOpcje dla uruchomienia walidacji PDF/A.
PdfAValidationResult-generated_pdfaWynik uruchomienia walidacji PDF/A.
UnsignedContent-generated_formsKontener dla niepodpisanej zawartości (strony, pola formularzy, adnotacje).
UnsignedContentAbsorber-generated_formsWyodrębnia niepodpisane elementy treści; zawiera informacje o polach formularza/adnotacji.

Security

KlasaOpis
CompromiseCheckResultKlasa z 4 właściwościami.
SignaturesCompromiseDetectorWykryj możliwe wskaźniki kompromisu wokół podpisanych plików PDF.

 Polski