ViewerConfig
Opsi widget penampil klien
ViewerConfig (namespace Doconut) menjelaskan tampilan dan perilaku penampil browser. Itu tidak memengaruhi kualitas rendering dokumen; gunakan konfigurasi format untuk itu. Kelas C# dan widget JavaScript yang telah lama ada memiliki nilai default yang berbeda, jadi petakan nilai secara eksplisit.
Dua perubahan sisi klien dalam rilis ini gagal secara diam-diam. Fungsi penangan diteruskan sebagai opsi — widget tidak lagi mengambil callback acara dari id kontainer — dan
ResPathharus menunjuk ke awalan sumber daya alih-alih akar aplikasi. Kedua hal tersebut membuat server berfungsi sempurna dan tidak melaporkan apa pun di konsol browser. Jika Anda membawa halaman dari perpustakaan sebelumnya, baca Callback dan Daftar periksa jalur sebelum hal lain.
Properti C#
| Tipe | Properti | Bawaan | Deskripsi |
|---|---|---|---|
bool | ShowThumbs | true | Tampilkan panel thumbnail. |
bool | AutoLoad | false | Muat secara otomatis setelah inisialisasi. Alur token normal memanggil View(token) secara eksplisit. |
bool | AutoFocus | true | Pindahkan fokus/gulir browser ke penampil selama inisialisasi. |
bool | AutoPageFocus | true | Pertahankan thumbnail saat ini terlihat saat halaman berubah. |
int | PageZoom | 100 | Persentase zoom awal. |
int | ZoomStep | 10 | Persentase yang ditambah atau dikurangi oleh perintah zoom. |
int | MaxZoom | 300 | Persentase zoom maksimum. |
bool | ShowToolTip | true | Tampilkan tooltip posisi halaman saat menggulir. |
string | ToolTipPageText | "Page " | Awalan yang digunakan dalam tooltip halaman. |
bool | CacheEnabled | false | Pertahankan jendela bergerak gambar halaman dalam memori browser. Itu tidak menggunakan localStorage. |
bool | LargeDoc | false | Tambahkan elemen halaman dalam batch berwaktu untuk dokumen besar. |
bool | ShowHyperlinks | false | Render overlay hyperlink ketika konfigurasi server mengekstraknya. |
bool | FixedZoom | true | Gunakan persentase zoom tetap alih-alih perhitungan ulang responsif. |
int | FixedZoomPercent | 100 | Zoom desktop tetap. |
int | FixedZoomPercentMobile | 75 | Zoom seluler tetap. |
string | BasePath | "/" | Tempat penampil mengirim permintaan halaman. "/" adalah DocImage.axd di akar situs; jika tidak, cabang tempat host memetakan UseDoconut(), tanpa awalan / ("doconut" berarti /doconut/DocImage.axd). |
string | ResPath | "doconut-res/images" (26.9.0; "doconut-res" sebelum) | Folder tempat widget memuat gambar sendiri: folder images di bawah ResourcesPath, tanpa awalan /. |
string | FitType | "width" | "width", "height", atau kosong untuk tidak ada penyesuaian otomatis. "page" tidak diterima oleh widget saat ini. |
bool | RetryOn409 | false | Aktifkan polling ketika produksi halaman asinkron/terdistribusi merespons 202 Accepted; 409 juga diterima untuk kompatibilitas dengan server lama. Tidak diperlukan oleh penampil sinkron normal. |
var config = new ViewerConfig
{
ShowThumbs = true,
AutoLoad = false,
PageZoom = 100,
MaxZoom = 300,
FitType = "width",
BasePath = "doconut", // tidak ada '/' di depan: penampil menambahkannya ("/doconut" akan menjadi //doconut, host lain)
ResPath = "doconut-res/images",
ShowHyperlinks = true
};Pemetaan C# ke JavaScript
Jangan mengirim ViewerConfig yang diserialkan langsung ke docViewer(...). Kebanyakan kunci widget menggunakan camelCase, sementara tiga kunci path/fit yang sudah mapan menggunakan PascalCase.
| C# | JavaScript |
|---|---|
ShowThumbs | showThumbs |
AutoLoad | autoLoad |
AutoFocus | autoFocus |
AutoPageFocus | autoPageFocus |
PageZoom | pageZoom |
ZoomStep | zoomStep |
MaxZoom | maxZoom |
ShowToolTip | showToolTip |
ToolTipPageText | toolTipPageText |
CacheEnabled | cacheEnabled |
LargeDoc | largeDoc |
ShowHyperlinks | showHyperlinks |
FixedZoom | fixedZoom |
FixedZoomPercent | fixedZoomPercent |
FixedZoomPercentMobile | fixedZoomPercentMobile |
BasePath | BasePath |
ResPath | ResPath |
FitType | FitType |
RetryOn409 | retryOn409 |
Pengaturan Bawaan JavaScript
Widget memiliki default lama yang berbeda dari kelas C#. Nilai berikut berasal dari implementasi docViewer.js saat ini.
| Opsi | Default | Catatan |
|---|---|---|
leftMinWidth / leftMaxWidth | 220 / 800 | Batas lebar panel thumbnail. |
showThumbs | true | Visibilitas thumbnail awal. |
autoFocus / autoPageFocus | true / false | autoPageFocus berbeda dari default C#. |
thumbWidth / thumbHeight / thumbPadding | 150 / 200 / 10 | Geometri thumbnail dalam piksel. |
pageZoom / zoomStep / maxZoom | 100 / 10 / 200 | JavaScript maxZoom berbeda dari C# (300). |
showToolTip / toolTipPageText | true / "Page " | Tooltip posisi halaman. |
format / doc / AccessToken | "" / 0 / "" | Nilai inisialisasi internal; biasanya diisi oleh View(token). |
debugMode | false | Diagnostik klien tambahan. |
FitType | "" | Tidak ada penyesuaian otomatis kecuali disediakan. |
BasePath | "DocImage.axd" | Default klien historis dipertahankan untuk kompatibilitas. Host ASP.NET Core saat ini harus mengaturnya secara eksplisit ke cabang middleware yang dipetakan. |
ResPath | "" | Atur secara eksplisit ke jalur gambar tersemat. |
cacheEnabled / cacheCount / cacheDelay | false / 3 / 3 | Jendela dan penundaan preloading halaman dalam memori. |
autoLoad | false | Alur token eksplisit disarankan. |
largeDoc | true | Berbeda dari default C#. |
fixedZoom | false | Berbeda dari default C#. |
fixedZoomPercent / fixedZoomPercentMobile | 100 / 50 | Nilai seluler berbeda dari C# (75). |
showHyperlinks | true | Membutuhkan ekstraksi sisi server untuk menghasilkan overlay. |
Setel semua nilai penting perilaku alih-alih bergantung pada salah satu set default:
<div id="divDocViewer"><div id="div_ctlDoc"></div></div>
<script>
const objViewer = $('#div_ctlDoc').docViewer({
showThumbs: true,
autoLoad: false,
autoFocus: true,
autoPageFocus: true,
pageZoom: 100,
zoomStep: 10,
maxZoom: 300,
FitType: 'width',
cacheEnabled: false,
largeDoc: false,
showHyperlinks: true,
fixedZoom: true,
fixedZoomPercent: 100,
fixedZoomPercentMobile: 75,
BasePath: 'doconut',
ResPath: 'doconut-res/images',
onViewerReady: function () {},
onError: function (message) { console.error('DocViewer:', message); }
});
</script>Panggilan Balik
| Callback | Argumen | Tujuan |
|---|---|---|
onPageLoading | pageNum | Permintaan halaman sedang dimulai. |
onPageLoaded | pageNum | Gambar halaman selesai dimuat. |
onThumbnailClicked | pageNum | Pengguna memilih thumbnail. |
onPageClicked | pageNum | Pengguna memilih halaman. |
onDoubleClick | none | Penampil menerima klik ganda. |
onViewerBusy | none | Penampil masuk ke status sibuk. |
onViewerReady | none | Inisialisasi selesai. |
onViewerError | none | Penampil masuk ke status error. |
onError | message | Operasi mengembalikan pesan error. |
onCopy | data | Data salinan teks tersedia. |
onAutoLoadStatus | pageNum | Pemuat otomatis melanjutkan ke halaman. |
onThumbsShown | none | Panel thumbnail menjadi terlihat. |
onAnnLoaded | none | Data anotasi dimuat. |
onAnnSaved | none | Data anotasi disimpan. |
onAnnSaveError | none | Penyimpanan anotasi gagal. |
onAnnClosed | none | UI anotasi ditutup. |
Jaga callback tetap cepat; kirim telemetry secara asynchronous dan jangan memblokir rendering halaman.
Semua ini adalah opsi pada objek init. Penampil sebelumnya mencari fungsi global yang namanya diambil dari id kontainer — sebuah halaman dengan <div id="div_ctlDoc"> hanya perlu mendeklarasikan function ctlDoc_OnViewerReady(). Pencarian itu sudah tidak ada. Berikan fungsi secara eksplisit:
function ctlDoc_OnViewerBusy() { /* tampilkan indikator sibuk Anda */ }
function ctlDoc_OnViewerReady() { /* sembunyikan */ }
function ctlDoc_Copy(text) { /* gunakan teks yang disalin */ }
function ctlDoc_AutoLoadStatus(pageNum) { /* laporkan kemajuan */ }
const objViewer = $('#div_ctlDoc').docViewer({
// ... opsi yang ada ...
onViewerBusy: ctlDoc_OnViewerBusy, // ditemukan berdasarkan nama
onViewerReady: ctlDoc_OnViewerReady, // ditemukan berdasarkan nama
onCopy: ctlDoc_Copy, // adalah ctlDoc_Copy(text)
onAutoLoadStatus: ctlDoc_AutoLoadStatus // adalah ctlDoc_AutoLoadStatus(page)
});Pencarian lama dibungkus dalam catch kosong, sehingga tidak ada yang pernah dilaporkan. Pada rilis ini fungsi-fungsi tidak pernah dijalankan: gejala biasanya adalah spinner sibuk yang tidak pernah berhenti, karena penangan yang menyembunyikannya adalah onViewerReady. Dokumen di belakangnya dirender dengan benar.
Dua hook penyimpanan anotasi masih dicari berdasarkan nama: SaveAnnotations() memanggil <elementId>_BeforeAnnSave() dan <elementId>_DeletedAnnotationIds() ketika ada, menggunakan id lengkap elemen (div_ctlDoc_BeforeAnnSave untuk contoh di atas).
Tidak ada callback klik tautan — penanganan hyperlink sudah terintegrasi dan dipandu oleh showHyperlinks.
Grup metode publik
| Grup | Metode umum |
|---|---|
| Siklus hidup | View(token, accessToken?), Close(server?), Token(), Init(), IsLoaded() |
| Navigasi | GotoPage(page), ShowPage(page, focus?), Next(next), CurrentPage(), TotalPages() |
| Zoom dan sesuaikan | Zoom(zoomIn), CurrentZoom(), FitType(value), Refit() |
| Orientasi | Rotate(page, angle), Flip(page, flipType) |
| Thumbnail | HideThumbs(hide), ThumbSize(size), ReloadThumbs(width), ScrollToThumb(thumb) |
| Pencarian | CanSearch(), Search(...), SearchMatchCount(), SearchSummary(...), GotoSearchMatch(...) |
| Anotasi | SaveAnnotations(), GetAnnotations(), PushAnnotations(...), CloseAnnotations(...), ShowAnnotations(...) |
| Salin | Copy(...), CopyPage(pageNumber), CopyMode(enabled) |
File JavaScript juga berisi pembantu internal. Perlakukan hanya metode yang digunakan oleh UI referensi dan didokumentasikan di sini atau dalam panduan fitur sebagai titik integrasi yang stabil.
Coba ulang saat halaman terdistribusi masih merender
retryOn409 mempertahankan nama historisnya. Ini untuk produksi halaman asinkron dan mencoba ulang respons kesiapan 202 Accepted saat ini serta sinyal 409 Conflict yang lebih lama. Ketika diaktifkan, widget melakukan polling dengan default JavaScript ini:
| Opsi | Default |
|---|---|
retryInitialDelayMs | 250 |
retryBackoffFactor | 1.6 |
retryMaxDelayMs | 2500 |
retryMaxAttempts | 150 |
retryMaxTotalMs | 300000 |
Biarkan dinonaktifkan untuk penampil satu-node normal. Mengaktifkannya tidak dapat membuat render sinkron yang tidak didukung menjadi asinkron.
Aktifkan ketika halaman disajikan dari penyimpanan bersama dengan FirstPagePriority, di mana halaman selanjutnya secara sah menjawab 202 Accepted sampai mereka ditulis. Klien yang tidak mencoba ulang akan menampilkan ubin rusak untuk halaman yang masih merender — lihat Penyebaran Terdistribusi.
Daftar periksa jalur
DoconutOptions.MiddlewarePathharus menggambarkan cabang yang sebenarnya Anda petakan.BasePathharus menargetkan cabang itu, ditulis tanpa/di depan ('doconut', bukan'/doconut': penampil menambahkan garis miring, dan//doconut/...adalah permintaan ke host lain). Pengaturan umum mempertahankan bentuk permintaan historisDocImage.axdpada cabangMapWhendan oleh karena itu menetapkanBasePath: '/'.DoconutOptions.ResourcesPathadalah rute sumber daya tersemat.ResPathbiasanya menargetkan subfolderimages-nya, tanpa/di depan —'doconut-res/images'dengan awalan default.ResPathkosong dulu benar di perpustakaan sebelumnya, di mana sumber daya berasal dari akar aplikasi; itu tidak benar di sini, dan gagal tanpa kesalahan.ExtractHyperlinksharus diaktifkan dalam konfigurasi format server sebelumshowHyperlinksdapat menampilkan apa pun.
Apakah halaman ini membantu?