ViewerConfig
Opsi widget penampil klien
ViewerConfig (namespace Doconut) menggambarkan tampilan dan perilaku penampil browser. Itu tidak memengaruhi kualitas rendering dokumen; gunakan konfigurasi format untuk itu. Kelas C# dan plugin JavaScript warisan memiliki nilai default yang berbeda, jadi petakan nilai secara eksplisit.
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. 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 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-gambarnya: 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 mengirimkan ViewerConfig yang diserialisasi langsung ke docViewer(...). Sebagian besar 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 |
Nilai default JavaScript
Widget ini memiliki nilai 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 penangan lama. Atur secara eksplisit untuk ASP.NET Core. |
ResPath | "" | Atur secara eksplisit ke jalur gambar tersemat. |
cacheEnabled / cacheCount / cacheDelay | false / 3 / 3 | Jendela dan penundaan pramuat halaman dalam memori. |
autoLoad | false | Aliran 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 | Memerlukan ekstraksi sisi server untuk menghasilkan overlay. |
Atur 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>Callback
| 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 | tidak ada | Penampil menerima double-click. |
onViewerBusy | tidak ada | Penampil masuk ke keadaan sibuk. |
onViewerReady | tidak ada | Inisialisasi selesai. |
onViewerError | tidak ada | Penampil masuk ke keadaan error. |
onError | message | Operasi mengembalikan pesan error. |
onCopy | data | Data salin teks tersedia. |
onAutoLoadStatus | pageNum | Pemuat otomatis melanjutkan ke halaman. |
onThumbsShown | tidak ada | Panel thumbnail menjadi terlihat. |
onAnnLoaded | tidak ada | Data anotasi dimuat. |
onAnnSaved | tidak ada | Data anotasi disimpan. |
onAnnSaveError | tidak ada | Penyimpanan anotasi gagal. |
onAnnClosed | tidak ada | UI anotasi ditutup. |
Jaga callback tetap cepat; kirim telemetri secara asinkron dan jangan memblokir rendering halaman.
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 penyesuaian | 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. Anggap hanya metode yang digunakan oleh UI referensi dan didokumentasikan di sini atau dalam panduan fitur sebagai titik integrasi yang stabil.
Coba lagi saat halaman terdistribusi masih sedang dirender
retryOn409 mempertahankan nama historisnya. Ini untuk produksi halaman asinkron dan mencoba kembali respons kesiapan 202 Accepted saat ini serta sinyal 409 Conflict yang lebih lama. Saat diaktifkan, widget melakukan polling dengan default JavaScript berikut:
| Opsi | Bawaan |
|---|---|
retryInitialDelayMs | 250 |
retryBackoffFactor | 1.6 |
retryMaxDelayMs | 2500 |
retryMaxAttempts | 150 |
retryMaxTotalMs | 300000 |
Biarkan dalam keadaan nonaktif untuk penampil normal. Mengaktifkannya tidak dapat membuat render sinkron yang tidak didukung menjadi asinkron.
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).DoconutOptions.ResourcesPathadalah rute sumber daya tersemat.ResPathbiasanya menargetkan subfolderimagesnya, juga tanpa/di depan ('doconut-res/images').ExtractHyperlinksharus diaktifkan dalam konfigurasi format server sebelumshowHyperlinksdapat menampilkan apa pun.
Apakah halaman ini membantu?