Aspose.Note FOSS for Python
Ši nuoroda apima visą viešą API paviršių, skirtą aspose-note versijai 26.3.1. Tik simboliai, eksportuoti iš aspose.note paketo yra dokumentuojami čia. Viskas, kas yra po aspose.note._internal yra įgyvendinimo detalė ir gali pasikeisti be įspėjimo.
ImageRenderOptions: pip install aspose-note (core) arba pip install "aspose-note[pdf]" (su PDF eksportu)
ImageRenderOptions: from aspose.note import Document, RichText, ...
ImageRenderOptions
Dokumentas ir naršymas
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Document | Šakninis dokumento objektas. Įkelkite .one failą, peržvelkite puslapius ir išsaugokite į PDF. |
DocumentVisitor | Abstrakti bazė lankytojo šablono (visitor-pattern) medžio traversavimui. |
Node | Bazinė klasė visiems dokumentų mazgams. |
CompositeNode | Bazinė klasė mazgams, galintiems turėti vaikų mazgus. |
Dokumento struktūra
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Page | Atstovauja OneNote puslapiui. |
Title | Puslapio antraštės blokas, kuriame yra TitleText, TitleDate, TitleTime. |
Outline | Pozicinis konteineris OutlineElement mazgams. |
OutlineElement | Leaf konteineris; talpina RichText, Image, Table, AttachedFile. |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
RichText | Teksto blokas su formatavimo sekcijomis, žymomis ir hipersaitais. |
TextRun | Vienas suformatuotas teksto segmentas RichText viduje. |
TextStyle | Formatavimo savybės TextRun elementui. |
Image | Įterptas paveikslėlis su neapdorotais baitais ir metaduomenimis. |
AttachedFile | Įterptas failo priedas su neapdorotais baitais. |
Table | Lentelė su eilutėmis, langeliais ir stulpelių pločiais. |
TableRow | Eilutė lentelėje. |
TableCell | Langelis lentelės eilutėje; jame yra turinio mazgai. |
NoteTag | OneNote žyma (žvaigždutė, žymimasis langelis ir kt.) priskirta turinio mazgui. |
NumberList | Numeruoto sąrašo metaduomenys OutlineElement elemente. |
ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
LoadOptions | Parinktys įkeliant .one failą. |
SaveOptions | Pagrindinė klasė išsaugojimo parinktyms. |
PdfSaveOptions | PDF specifinės išsaugojimo parinktys (žymų piktogramos). |
Suderinamumo stubai
| ImageRenderOptions | ImageRenderOptions |
|---|---|
License | Suderinamumo stubas: SetLicense() yra no‑op šioje FOSS įgyvendinime. |
Metered | Suderinamumo stubas: SetMeteredKey() yra no‑op šioje FOSS įgyvendinime. |
Klasės detalės
ImageRenderOptions
Pagrindinė dokumento klasė. Įkelti .one failą iš failo kelio, pathlib.Path, arba binarinį srautą.
from aspose.note import Document, LoadOptions
doc = Document(source=None, load_options=None)Konstruktoriaus parametrai:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
source | `str | Path |
load_options | `LoadOptions | None` |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
DisplayName | `str | None` |
CreationTime | `datetime | None` |
FileFormat | FileFormat | Geriausio įmanomo pastangų nurodymas OneNote failo formato versijai |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Count() | () -> int | Tiesioginių vaikų puslapių skaičius |
GetPageHistory(page) | (Page) -> list[Page] | ImageRenderOptions [page] (stub; pilna istorija dar neįgyvendinta) |
DetectLayoutChanges() | () -> None | Suderinamumo stub; jokios operacijos |
Save(target, format_or_options) | `(str | Path |
Accept(visitor) | (DocumentVisitor) -> None | Iškviesti lankytojo perėjimą |
for page in doc | N/A | Iteruoti tiesioginius vaikus Page mazgus |
Document.FileFormat pastaba: Savybė suteikia geriausio įmanomo pastangų nurodymą OneNote failo formato versijai. The FileFormat enum turi tris reikšmes: OneNote2010, OneNoteOnline, ir OneNote2007.
Document.Save() srauto palaikymas: target gali būti dvejetainis srautas (io.BytesIO, failo rankena atidaryta dvejetainio rašymo režimu ir t.t.). Tai patvirtina testų rinkinys: doc.Save(io.BytesIO(), PdfSaveOptions(SaveFormat.Pdf)).
DocumentVisitor
Abstrakti bazinė klasė lankytojo šablono kelionės. Perrašykite reikiamus lankymo metodus, kurių jums reikia:
| ImageRenderOptions | Kviečiama, kai |
|---|---|
VisitDocumentStart(doc) | Įeinama į Document mazgą |
VisitDocumentEnd(doc) | Išeinama iš Document mazgo |
VisitPageStart(page) | Įeinama į Page mazgą |
VisitPageEnd(page) | Išeinama iš Page mazgo |
VisitTitleStart(title) | Įeinama į Title mazgą |
VisitTitleEnd(title) | Išeinama iš Title mazgo |
VisitOutlineStart(outline) | Įeinama į Outline mazgą |
VisitOutlineEnd(outline) | Išeinama iš Outline mazgo |
VisitOutlineElementStart(oe) | Įeinama į OutlineElement mazgą |
VisitOutlineElementEnd(oe) | Išeinama iš OutlineElement mazgo |
VisitRichTextStart(rt) | Įeinama į RichText mazgą |
VisitRichTextEnd(rt) | Išeinama iš RichText mazgo |
VisitImageStart(img) | Įeinama į Image mazgą |
VisitImageEnd(img) | Paliekant Image mazgą |
ImageRenderOptions
Bazinė klasė visiems dokumentų medžio mazgams.
| Savybė / Metodas | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
ParentNode | `Node | None` |
Document | `Document | None` |
Accept(visitor) | (DocumentVisitor) -> None | Išsiųsti lankytoją šiam mazgui |
CompositeNode
ImageRenderOptions Node. Prideda vaikų valdymą:
| Savybė / Metodas | ImageRenderOptions |
|---|---|
FirstChild | Pirmas vaiko mazgas, arba None |
LastChild | Paskutinis vaiko mazgas, arba None |
AppendChildLast(node) | Pridėti vaiko mazgą pabaigoje; nustato node.ParentNode = self |
AppendChildFirst(node) | Pridėti vaikų mazgą pradžioje |
InsertChild(index, node) | Įterpti vaiką nurodytoje pozicijoje |
RemoveChild(node) | Pašalinti vaikų mazgą; nustato node.ParentNode = None |
GetEnumerator() | Grąžina iteratorių tiesioginių vaikų |
for child in node | Iteruoti tiesioginius vaikus |
GetChildNodes(Type) | (Type) -> list[Type]: rekursinis, gylio pirmumo paieška visame po-medžyje, įskaitant self |
ImageRenderOptions
ImageRenderOptions CompositeNode. Atstovauja OneNote puslapiui.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Title | `Title | None` |
Author | `str | None` |
CreationTime | `datetime | None` |
LastModifiedTime | `datetime | None` |
Level | `int | None` |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Clone(deep=False) | Grąžina paviršinį arba gilų puslapio kloną |
ImageRenderOptions
ImageRenderOptions CompositeNode. Laiko pavadinimo bloką, priklausantį Page.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
TitleText | `RichText | None` |
TitleDate | `RichText | None` |
TitleTime | `RichText | None` |
ImageRenderOptions
ImageRenderOptions CompositeNode. Pozicinis konteineris, skirtas OutlineElement mazgams.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
X | `float | None` |
Y | `float | None` |
Width | `float | None` |
OutlineElement
ImageRenderOptions CompositeNode. Lapų konteineris, kuris laiko turinio mazgus.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
IndentLevel | int | Įdėjimo gylis (0 = išorinis) |
NumberList | `NumberList | None` |
Tags | list[NoteTag] | OneNote žymės, priskirtos šiam elementui |
RichText
ImageRenderOptions CompositeNode. Stiliaus teksto blokas.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Text | str | Pilna paprasto teksto eilutė (visos sekos sujungtos) |
Runs | list[TextRun] | Rūšiuotas formatuotų segmentų sąrašas |
FontSize | `float | None` |
Tags | list[NoteTag] | OneNote žymės, prisegtos prie šio bloko |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Append(text, style=None) | `(str, TextStyle | None) -> RichText` |
Replace(old_value, new_value) | (str, str) -> None | Atminties eilutės pakaitimas įjungtas Text; neatnaujina Runs |
TextRun
ImageRenderOptions Node. Vienas suformatuotas teksto segmentas.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
Text | str | Segmento teksto turinys (numatytasis "") |
Style | TextStyle | Formatavimo savybės |
Start | `int | None` |
End | `int | None` |
TextStyle
ImageRenderOptions Node. Vieno simbolio formatavimo savybės, skirtos TextRun.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
Bold | bool | False | ImageRenderOptions |
Italic | bool | False | ImageRenderOptions |
Underline | bool | False | ImageRenderOptions |
Strikethrough | bool | False | ImageRenderOptions |
Superscript | bool | False | ImageRenderOptions |
Subscript | bool | False | ImageRenderOptions |
FontName | `str | None` | None |
FontSize | `float | None` | None |
FontColor | `int | None` | None |
HighlightColor | `int | None` | None |
LanguageId | `int | None` | None |
IsHyperlink | bool | False | Ar šis fragmentas yra nuoroda |
HyperlinkAddress | `str | None` | None |
ImageRenderOptions
ImageRenderOptions CompositeNode. Įterptas paveikslėlis.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
FileName | `str | None` |
Bytes | bytes | Neapdoroti paveikslėlio duomenys (numatytasis b"") |
Width | `float | None` |
Height | `float | None` |
AlternativeTextTitle | `str | None` |
AlternativeTextDescription | `str | None` |
HyperlinkUrl | `str | None` |
Tags | list[NoteTag] | OneNote žymės, prisegtos prie šio paveikslėlio |
ImageRenderOptions:
| ImageRenderOptions | ImageRenderOptions |
|---|---|
Replace(image) | ImageRenderOptions Bytes ir FileName iš kito Image mazgas į šį |
AttachedFile
ImageRenderOptions CompositeNode. Įterptas failo priedas.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
FileName | `str | None` |
Bytes | bytes | Neapdoroti failo duomenys (numatytasis b"") |
Tags | list[NoteTag] | OneNote žymės, prisegtos prie šio priedo |
ImageRenderOptions
ImageRenderOptions CompositeNode. Lentelė OutlineElement viduje.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
Columns | list[float] | [] | Kiekvieno stulpelio plotis taškais |
IsBordersVisible | bool | True | Ar lentelės rėmeliai matomi |
Tags | list[NoteTag] | [] | OneNote žymės, priskirtos šiai lentelei |
TableRow
ImageRenderOptions CompositeNode. Eilutė viduje Table. Iteruoti GetChildNodes(TableCell) norint pasiekti langelius.
TableCell
ImageRenderOptions CompositeNode. Langelis viduje TableRow. Turi RichText, Image, ir kiti turinio mazgai.
NoteTag
ImageRenderOptions Node. OneNote žyma, prisegta prie turinio mazgo.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
shape | `int | None` | None |
label | `str | None` | None |
text_color | `int | None` | None |
highlight_color | `int | None` | None |
created | `int | None` | None |
completed | `int | None` | None |
Laiko žymės pastaba: created ir completed yra neapdoroti sveikųjų skaičių laiko žymės, iššifruotos iš MS-ONE dvejetainio formato, ne datetime objektai.
Gaminių metodai:
| ImageRenderOptions | ImageRenderOptions |
|---|---|
NoteTag.CreateYellowStar() | Sukuria NoteTag(shape=None, label="Yellow Star") |
NumberList
ImageRenderOptions Node. Numeruoto arba ženklelio sąrašo metaduomenys apie OutlineElement.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
Format | `str | None` | None |
Restart | `int | None` | None |
IsNumbered | bool | False | True tvarkytiems (numeruotiems) sąrašams |
LoadOptions
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
DocumentPassword | `str | None` | None |
LoadHistory | bool | False | API suderinamumo laukas; funkcionaliai nenaudojamas v26.3.1 versijoje |
SaveOptions
Bazinė klasė visoms išsaugojimo parinktimoms. Privalomas pozicinis argumentas.
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|
SaveFormat | SaveFormat | Tikslinis išsaugojimo formatas |
PdfSaveOptions
ImageRenderOptions SaveOptions. PDF specifinė eksporto konfigūracija. Sukurti su PdfSaveOptions(SaveFormat.Pdf).
| ImageRenderOptions | ImageRenderOptions | ImageRenderOptions | ImageRenderOptions |
|---|---|---|---|
PageIndex | int | 0 | Laukas egzistuoja; neperduodama PDF eksporteriui v26.3.1 versijoje: neturi įtakos išvesties rezultatui |
PageCount | `int | None` | None |
TagIconDir | `str | None` | None |
TagIconSize | `float | None` | None |
TagIconGap | `float | None` | None |
PageIndex / PageCount įspėjimas: Šie laukai yra deklaruoti PdfSaveOptions API suderinamumui, tačiau Document.Save() įgyvendinimas v26.3.1 neskaito ir neperduoda jų PDF eksporteriui. Visos puslapiai visada eksportuojami.
Licencija ir matuojama
Suderinamumo stubai eksportuojami API struktūros suderinamumui su Aspose.Note skirto .NET. Visi metodai šioje FOSS įgyvendinime yra neveiksni.
from aspose.note import License, Metered
lic = License()
lic.SetLicense("path/to/license.lic") # no-op
m = Metered()
m.SetMeteredKey("public_key", "private_key") # no-opNereikia licencijos rakto, norint naudoti bet kurią Aspose.Note FOSS funkciją, skirta Python.
ImageRenderOptions
Visas išvardijimo nuoroda: ImageRenderOptions
SaveFormat
| ImageRenderOptions | ImageRenderOptions |
|---|---|
SaveFormat.Pdf | PDF eksportas: įgyvendintas; reikalauja pip install "aspose-note[pdf]" |
SaveFormat.One | OneNote formatas: deklaruotas tik; sukelia UnsupportedSaveFormatException |
FileFormat
Išvardijimo reikšmės, atstovaujančios OneNote failo formato versiją. Document.FileFormat pateikia geriausią įmanomą indikaciją.
| ImageRenderOptions | String reikšmė |
|---|---|
FileFormat.OneNote2010 | "onenote2010" |
FileFormat.OneNoteOnline | "onenoteonline" |
FileFormat.OneNote2007 | "onenote2007" |
HorizontalAlignment
| ImageRenderOptions | String reikšmė |
|---|---|
HorizontalAlignment.Left | "left" |
HorizontalAlignment.Center | "center" |
HorizontalAlignment.Right | "right" |
NodeType
| ImageRenderOptions | String reikšmė |
|---|---|
NodeType.Document | "document" |
NodeType.Page | "page" |
NodeType.Outline | "outline" |
NodeType.OutlineElement | "outline_element" |
NodeType.RichText | "rich_text" |
NodeType.Image | "image" |
NodeType.Table | "table" |
NodeType.AttachedFile | "attached_file" |
ImageRenderOptions
Pilna išimčių nuoroda: ImageRenderOptions
| ImageRenderOptions | ImageRenderOptions |
|---|---|
AsposeNoteError | Bazinė klasė visoms Aspose.Note FOSS išimtim |
FileCorruptedException | ImageRenderOptions .one failas negali būti išanalizuotas (sugadintas arba netinkamai suformuotas dvejetainis) |
IncorrectDocumentStructureException | Failo struktūra yra neteisinga arba nepalaikoma |
IncorrectPasswordException | Keliama, kai LoadOptions.DocumentPassword yra nustatyta; šifruoti dokumentai nepalaikomi |
UnsupportedFileFormatException | Failo formatas neatpažintas; atskleidžia FileFormat lauką (string) |
UnsupportedSaveFormatException | Prašomas SaveFormat nėra įgyvendinta šioje versijoje |