Anotasi
Tambahkan dukungan anotasi ke penampil
Anotasi di Doconut berfungsi dalam dua arah: pengguna menggambarnya di widget peramban dan server menyimpannya per halaman, atau kode Anda membuatnya secara programatik dan memuatnya ke dalam sesi terbuka. Dalam kedua kasus, anotasi ditampilkan pada halaman dan dapat dibakar ke dalam ekspor PDF/PNG.
Dukungan anotasi dibatasi oleh kemampuan lisensi Annotation (diberikan secara otomatis di bawah lisensi Temporary yang aktif).
Aktifkan UI anotasi
Anotasi adalah modul Viewer, bukan bilah alat mandiri. Halaman lengkap harus menyertakan sumber daya Viewer, bilah alat Viewer, mount Viewer, dan objViewer yang telah diinisialisasi; Ribbon Anotasi kemudian dipasang dan dilampirkan ke instance yang sama.
Emit bundel anotasi bersamaan dengan bundel viewer — mereka dibatasi lisensi, sehingga tag hanya muncul ketika kemampuan tersedia:
@Html.Raw(Viewer.ReferenceCss(new CssConfig
{
IncludeViewerCss = true,
IncludeAnnotationCss = true // jquery-ui.min.css + annotationBar.css
}))
@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig
{
IncludeJQuery = true,
IncludeViewerScripts = true,
IncludeAnnotationScripts = true, // jquery-ui, raphael.js, annotation.js
IncludeAnnotationBar = true // pita anotasi yang disematkan
}))Pertahankan komposisi Viewer lengkap terlihat dalam markup:
<nav id="toolbar" aria-label="Document viewer controls">
<!-- Kontrol penampil, termasuk tombol yang membuka Anotasi -->
</nav>
<div id="annBarMount"></div>
<div id="divDocViewer"><div id="div_ctlDoc"></div></div>Bundel Anotasi menghasilkan DOM Ribbon di dalam annBarMount; Anda tidak perlu menyalin tombol atau markup dialognya. Inisialisasi docViewer terlebih dahulu, lalu buat Ribbon hanya ketika server mengonfirmasi bahwa Anotasi berlisensi:
<script>
let annBar = null;
let currentToken = '';
const objViewer = $('#div_ctlDoc').docViewer({
BasePath: 'doconut',
ResPath: 'doconut-res/images',
onAnnLoaded: () => annBar?.handleAnnLoaded(),
onAnnSaved: () => annBar?.handleAnnSaved(),
onAnnSaveError: () => annBar?.handleAnnSaveError(),
onAnnClosed: () => annBar?.handleAnnClosed(),
onError: (message) => console.error('Viewer error:', message)
});
@if (Viewer.IsAnnotationEnabled)
{
<text>
annBar = $('#annBarMount').doconutAnnotationBar({
docId: 'ctlDoc',
getRequestParams: () => ({ token: currentToken }),
onStatus: (message) => console.log(message),
onToast: (message, type) => console.log(type, message),
onLayout: () => requestAnimationFrame(() => objViewer.Refit())
});
annBar.attach(objViewer);
</text>
}
</script>Tanpa kemampuan tersebut, ReferenceScripts menghilangkan skrip Ribbon, sehingga if sisi server menjaga panggilan doconutAnnotationBar(...) yang tidak terlindungi agar tidak merusak halaman.
Menyimpan dari Ribbon mengirim data melalui perantara (AnnSave), yang menyimpannya dalam sesi dokumen per halaman. Memuat (AnnLoad) terjadi secara otomatis ketika halaman dengan anotasi dirender. Empat onAnn* panggilan balik menjaga Ribbon tetap sinkron dengan siklus hidup penampil.
Buka dan tutup dari bilah alat Viewer milik host mana pun:
annBar.open();
annBar.close();API publik Ribbon adalah:
| Metode | Tujuan |
|---|---|
attach(objViewer) | Hubungkan Ribbon ke penampil yang telah diinisialisasi; diperlukan sekali |
open() / close() | Masuk atau keluar dari penyuntingan anotasi |
reset() | Kembalikan Ribbon ke keadaan tertutup, tidak dalam penyuntingan |
isOpen() / annotating() | Baca status Ribbon / status penyuntingan anotasi penampil |
reopenEditable() | Muat ulang anotasi halaman saat ini sebagai objek yang dapat disunting |
updateActionState() | Segarkan ketersediaan kontrol simpan/hapus setelah perubahan host |
headerSlot() | Dapatkan slot ekstensi header opsional untuk kontrol milik host |
onStatus, onToast, onLayout, onEditStart, dan onEditEnd adalah panggilan balik host opsional. Objek endpoints dapat tambahan menyediakan exportPdf, exportPng, imageUpload, dan imageList; kontrol tanpa endpoint yang dikonfigurasi tetap tersembunyi. Untuk urutan startup gabungan Viewer, Search, dan Annotation, lihat Panduan Cepat.
Bundel anotasi menambahkan alat authoring di peramban, tetapi data tetap milik sesi dokumen sisi server yang diidentifikasi oleh token. Membuka kembali sumber menciptakan sesi baru; persistensikan XML atau envelope anotasi yang terenkode dalam aplikasi Anda jika anotasi harus bertahan melampaui masa hidup sesi.
Dua jenis callback, terhubung dua cara
Kode anotasi menggunakan dua gaya callback, dan masing‑masing gagal secara diam‑diam ketika dihubungkan dengan cara yang lain:
onAnnLoaded,onAnnSaved,onAnnSaveError,onAnnClosedadalah opsi daridocViewer({...}), seperti setiap callback viewer.Created,Changed,Deleted, danPropertiesadalah fungsi global yang ditemukan berdasarkan nama: id viewer diprefix ke event. Untuk viewer di#div_ctlDocid‑nya adalahctlDoc, sehingga fungsi‑nya adalahctlDoc_Created,ctlDoc_Changed,ctlDoc_Deleted, danctlDoc_Properties. Fungsi yang salah eja atau diubah namanya tidak pernah dipanggil.
SaveAnnotations() tidak mengembalikan apakah berhasil disimpan: hasilnya datang melalui onAnnSaved atau onAnnSaveError. Kode yang membaca nilai kembaliannya tidak pernah menghapus flag "perubahan yang belum disimpan".
Buat anotasi dalam C#
Dapatkan manager yang terikat pada sesi terbuka, tambahkan anotasi, dan muat mereka (dengan using Doconut.Annotations; untuk tipe‑tipe dan using System.Drawing; untuk Rectangle/Color):
app.MapPost("/api/annotations/load-sample", (string token, Viewer viewer) =>
{
// Terikat pada dimensi halaman sesi terbuka
var manager = viewer.GetAnnotationManager(token);
var pageCount = viewer.GetPageCount(token);
// Satu cap per halaman
for (int page = 1; page <= pageCount; page++)
{
manager.Add(new StampAnnotation(page, new Rectangle(30, 20, 240, 90),
$"PAGE {page}", 28, 4, Color.Maroon)
{
Opacity = 60,
Rotate = -8
});
}
manager.Add(new NoteAnnotation(1, new Rectangle(420, 150, 220, 120),
"Loaded from C# code.", Color.FromArgb(255, 255, 255, 170), 14));
// Muat ke dalam sesi — widget mengambilnya melalui AnnLoad dan
// renderer membakar mereka menjadi ekspor gambar/PDF.
viewer.LoadAnnotationData(token, manager);
return Results.Ok();
});Tipe Anotasi
Semua tipe berada di Doconut.Annotations dan mewarisi dari BaseAnnotation (nomor halaman + Rectangle pembatas):
| Type | Notes |
|---|---|
StampAnnotation | Cap teks dengan ukuran font, border, warna; mendukung Opacity, Rotate |
NoteAnnotation | Catatan tempel dengan teks, warna latar, ukuran font, TitleColor |
RectangleAnnotation | Warna border + isi, Title/ShowTitle |
CircleAnnotation | Border + isi, ShowBorder |
EllipseAnnotation | Border + isi, ShowBorder |
TriangleAnnotation | Warna border, BackColor, ShowBorder |
LineAnnotation | Garis lurus dengan lebar dan warna |
ArrowAnnotation | Garis dengan kepala panah; Direction dapat diatur (tipe ArrowDirection, titik kompas, default E) |
FreehandAnnotation | Goresan bebas dari titik FreehandData yang terenkode |
ImageAnnotation | Gambar dari URL. URL relatif diresolusikan terhadap host permintaan saat anotasi ditambahkan; server mengambil gambar hanya pada saat pembakaran — lihat catatan ekspor di bawah |
API AnnotationManager
| Member | Purpose |
|---|---|
Add(BaseAnnotation) | Antrian anotasi |
GetAnnotations() / GetAnnotations(int page) | Periksa apa yang dimiliki manager |
ClearAnnotations() / ClearAnnotations(int page) | Hapus semua / per halaman |
GetAnnotationData() / GetAnnotationData(int page) | String data anotasi terenkode — sebuah envelope Base64 (apa yang dikonsumsi widget) |
GetAnnotationXml() | Formulir XML |
Viewer mencerminkan operasi muat/baca terhadap sebuah sesi: LoadAnnotationData(token, manager) atau LoadAnnotationData(token, encodedData) (envelope Base64 dari GetAnnotationData()), LoadAnnotationXML(token, xml), GetAnnotationXML(token).
Ekspor dengan anotasi dibakar
// PDF semua halaman dengan anotasi yang dirender di atasnya
app.MapGet("/api/annotations/export-pdf", async (string token, Viewer viewer) =>
{
byte[] pdf = await viewer.ExportAnnotationsToPdfAsync(token, zoom: 100);
return Results.File(pdf, "application/pdf", "export.pdf");
});
// Atau ZIP PNGs per halaman
app.MapGet("/api/annotations/export-png-zip", async (string token, Viewer viewer) =>
{
byte[] zip = await viewer.ExportAnnotationsToPngZipAsync(token, zoom: 100);
return Results.File(zip, "application/zip", "annotations-png.zip");
});Ekspor menggunakan pembakar yang sama seperti rendering di layar, sehingga apa yang dilihat pengguna adalah apa yang terdapat dalam file — kecuali untuk anotasi gambar, yang dijelaskan berikutnya.
Anotasi gambar pada host intranet mengekspor sebagai "Image blocked"
Penampil dan ekspor mengambil gambar ImageAnnotation dari tempat yang berbeda:
| Permukaan | Siapa yang mengunduh gambar | Pada host intranet atau pengembangan |
|---|---|---|
| Penampil di peramban | Browser pengguna | Gambar muncul |
ExportAnnotationsToPdfAsync / …PngZipAsync | Server | Placeholder berwarna merah "Image blocked" |
Ketika server mengambil gambar untuk disematkan, ia menolak alamat yang mengarah kembali ke jaringan pribadi: loopback (localhost, 127.0.0.1), 0.0.0.0, link‑local (169.254.x.x), rentang privat 10.x, 172.16–31.x, dan 192.168.x, carrier‑grade NAT (100.64.0.0/10), serta alamat link‑local dan unique‑local IPv6. Ini melindungi server dari penggunaan untuk mengakses sistem internal melalui URL gambar yang dibuat, dan tidak ada saklar untuk mematikannya.
URL gambar relatif diselesaikan terhadap host dari permintaan saat ini, jadi pada localhost, pada server intranet, atau pada situs apa pun yang diakses melalui alamat pribadi, gambar akan muncul di penampil dan ekspor berisi placeholder sebagai gantinya. Itu adalah mekanisme perlindungan yang bekerja, bukan kegagalan rendering. Jika ekspor harus menyertakan gambar, layani gambar dari host dengan alamat publik dan gunakan URL absolut. Nama host yang tidak dapat diselesaikan akan ditolak dengan cara yang sama; kegagalan unduhan lainnya akan menampilkan URL dan pesan error berwarna merah di tempat gambar seharusnya.
Alur Persistensi
- Buka dokumen dan dapatkan tokennya.
- Muat XML atau data terenkode yang sebelumnya disimpan ke dalam token tersebut.
- Biarkan widget membaca dan mengedit anotasi sesi.
- Ambil XML dengan
GetAnnotationXML(token)ketika aplikasi Anda memutuskan untuk menyimpan. - Ekspor PDF/PNG ketika diperlukan deliverable yang diratakan.
- Tutup sesi dokumen.
Jangan gunakan token penampil yang tidak transparan sebagai pengidentifikasi anotasi permanen. Kaitkan data anotasi yang dipersistensikan dengan dokumen Anda sendiri serta pengidentifikasi versi.
Catatan keamanan dan rendering
- Permintaan anotasi menggunakan keamanan sesi/token yang sama seperti permintaan halaman.
- Validasi dan kontrol setiap URL gambar yang diberikan pengguna untuk menghindari pemalsuan permintaan sisi server.
- Ekspor menerapkan keputusan lisensi/custom-watermark yang sama seperti rendering halaman di layar.
- Payload bebas tangan yang besar dan ekspor resolusi tinggi meningkatkan penggunaan memori; uji dokumen realistis dan nilai zoom.
Pemecahan Masalah
| Gejala | Pemeriksaan |
|---|---|
| Pita anotasi tidak ada | kemampuan Annotation dan empat flag CSS/script anotasi |
| Callback penyimpanan melaporkan kesalahan | Kedaluwarsa token/sesi dan middleware BasePath |
ctlDoc_Created (atau fungsi event lain) tidak pernah dijalankan | Nama fungsi: id penampil + _ + event, sebagai fungsi global |
| Anotasi C# tidak muncul | Penomoran halaman dimulai dari satu dan data dimuat ke dalam token aktif |
| Anotasi gambar muncul di layar tetapi tidak di ekspor | Host gambar memiliki alamat pribadi atau loopback — lihat di atas |
| Dokumen yang dibuka kembali tidak memiliki anotasi | Persistensikan XML/data di luar sesi penampil, lalu muat ke dalam token baru |
Apakah halaman ini membantu?