ViewerConfig – Doconut Dokumentasi

ViewerConfig (namespace Doconut) mendeskripsikan tampilan dan perilaku penampil browser. Ini tidak memengaruhi kualitas rendering dokumen; gunakan konfigurasi format untuk itu. Kelas C# dan widget JavaScript yang telah lama ada memiliki 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/scroll 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 ditambahkan 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 ulang responsif.
`int`	`FixedZoomPercent`	`100`	Zoom desktop tetap.
`int`	`FixedZoomPercentMobile`	`75`	Zoom seluler tetap.
`string`	`BasePath`	`"/"`	Cabang tempat host memetakan `UseDoconut()`.
`string`	`ResPath`	`"doconut-res"`	Basis sumber daya yang digunakan oleh widget. Pada pengaturan normal arahkan ke `<ResourcesPath>/images`.
`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.

csharp

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "/doconut",
    ResPath = "/doconut-res/images",
    ShowHyperlinks = true
};

Pemetaan C# ke JavaScript

Jangan mengirimkan ViewerConfig yang diserialisasi secara langsung ke docViewer(...). Kebanyakan kunci widget menggunakan camelCase, sementara tiga kunci jalur/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 yang lebih lama dan berbeda dari kelas C#. Nilai‑nilai berikut diambil dari implementasi docViewer.js saat ini.

Opsi	Bawaan	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`	`maxZoom` JavaScript 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 preloading halaman dalam memori dan penundaan.
`autoLoad`	`false`	Alur token eksplisit direkomendasikan.
`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.

Tentukan semua nilai yang penting secara perilaku alih‑alih mengandalkan salah satu set default:

html

<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`	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 salinan teks tersedia.
`onAutoLoadStatus`	`pageNum`	Auto‑loading maju 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 telemetry 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. Perlakukan hanya metode yang digunakan oleh UI referensi dan didokumentasikan di sini atau dalam panduan fitur sebagai titik integrasi yang stabil.

Retry saat halaman terdistribusi masih dirender

retryOn409 mempertahankan nama historisnya. Ini untuk produksi halaman asinkron dan melakukan retry pada respons kesiapan 202 Accepted serta sinyal 409 Conflict yang lebih lama. Ketika diaktifkan, widget melakukan polling dengan pengaturan bawaan JavaScript berikut:

Opsi	Bawaan
`retryInitialDelayMs`	`250`
`retryBackoffFactor`	`1.6`
`retryMaxDelayMs`	`2500`
`retryMaxAttempts`	`60`
`retryMaxTotalMs`	`120000`

Biarkan nonaktif untuk penampil normal. Mengaktifkannya tidak dapat membuat render sinkron yang tidak didukung menjadi asinkron.

Daftar periksa jalur

DoconutOptions.MiddlewarePath harus menggambarkan cabang yang sebenarnya Anda petakan.
BasePath harus menargetkan cabang tersebut.
DoconutOptions.ResourcesPath adalah rute sumber daya tersemat.
ResPath biasanya menargetkan subfolder /images‑nya.
ExtractHyperlinks harus diaktifkan dalam konfigurasi format server sebelum showHyperlinks dapat menampilkan apa pun.