ViewerConfig – Doconut เอกสาร

ViewerConfig (namespace Doconut) อธิบายลักษณะและพฤติกรรมของผู้ชมในเบราว์เซอร์ มันไม่ได้ส่งผลต่อคุณภาพการเรนเดอร์เอกสาร; ใช้การกำหนดค่ารูปแบบสำหรับเรื่องนั้น คลาส C# และวิดเจ็ต JavaScript ที่มีมานานมีค่าเริ่มต้นที่แตกต่างกัน ดังนั้นให้แมปค่าต่าง ๆ อย่างชัดเจน.

คุณสมบัติ C#

ชนิด	คุณสมบัติ	ค่าเริ่มต้น	คำอธิบาย
`bool`	`ShowThumbs`	`true`	แสดงแผงภาพย่อ.
`bool`	`AutoLoad`	`false`	โหลดโดยอัตโนมัติหลังจากการเริ่มต้น การไหลของโทเค็นปกติจะเรียก `View(token)` อย่างชัดเจน.
`bool`	`AutoFocus`	`true`	ย้ายโฟกัส/การเลื่อนของเบราว์เซอร์ไปยังผู้ชมระหว่างการเริ่มต้น.
`bool`	`AutoPageFocus`	`true`	ทำให้ภาพย่อปัจจุบันมองเห็นได้ขณะหน้าเปลี่ยน.
`int`	`PageZoom`	`100`	เปอร์เซ็นต์การซูมเริ่มต้น.
`int`	`ZoomStep`	`10`	เปอร์เซ็นต์ที่เพิ่มหรือลบโดยคำสั่งซูม.
`int`	`MaxZoom`	`300`	เปอร์เซ็นต์การซูมสูงสุด.
`bool`	`ShowToolTip`	`true`	แสดงทูลทิปตำแหน่งหน้าในขณะเลื่อน.
`string`	`ToolTipPageText`	`"Page "`	คำนำหน้าที่ใช้ในทูลทิปของหน้า.
`bool`	`CacheEnabled`	`false`	เก็บหน้าต่างเคลื่อนที่ของภาพหน้าในหน่วยความจำของเบราว์เซอร์ ไม่ใช้ `localStorage`.
`bool`	`LargeDoc`	`false`	เพิ่มองค์ประกอบหน้าเป็นชุดตามเวลาสำหรับเอกสารขนาดใหญ่.
`bool`	`ShowHyperlinks`	`false`	แสดงซ้อนทับไฮเปอร์ลิงก์เมื่อการกำหนดค่าของเซิร์ฟเวอร์สกัดออกมา.
`bool`	`FixedZoom`	`true`	ใช้เปอร์เซ็นต์การซูมคงที่แทนการคำนวณแบบตอบสนอง.
`int`	`FixedZoomPercent`	`100`	การซูมคงที่บนเดสก์ท็อป.
`int`	`FixedZoomPercentMobile`	`75`	การซูมคงที่บนมือถือ.
`string`	`BasePath`	`"/"`	สาขาที่โฮสต์แมป `UseDoconut()`.
`string`	`ResPath`	`"doconut-res"`	ฐานทรัพยากรที่วิดเจ็ตใช้ ในการตั้งค่าปกติให้ชี้ไปที่ `<ResourcesPath>/images`.
`string`	`FitType`	`"width"`	`"width"`, `"height"` หรือว่างเปล่าสำหรับไม่มีการปรับอัตโนมัติ `"page"` ไม่ได้รับการยอมรับโดยวิดเจ็ตปัจจุบัน.
`bool`	`RetryOn409`	`false`	เปิดใช้งานการโพลเมื่อการผลิตหน้าที่อะซิงโครนัส/กระจายตอบกลับ `202 Accepted`; `409` ก็ได้รับการยอมรับเพื่อความเข้ากันได้กับเซิร์ฟเวอร์เก่า ไม่จำเป็นสำหรับผู้ชมแบบซิงโครนัสปกติ.

csharp

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

การแมปจาก C# ไปยัง JavaScript

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`

ค่าเริ่มต้นของ JavaScript

ตัวเลือก	ค่าเริ่มต้น	หมายเหตุ
`leftMinWidth` / `leftMaxWidth`	`220` / `800`	ขอบเขตความกว้างของแผงภาพย่อ.
`showThumbs`	`true`	การมองเห็นภาพย่อเริ่มต้น.
`autoFocus` / `autoPageFocus`	`true` / `false`	`autoPageFocus` แตกต่างจากค่าเริ่มต้นของ C#.
`thumbWidth` / `thumbHeight` / `thumbPadding`	`150` / `200` / `10`	เรขาคณิตของภาพย่อเป็นพิกเซล.
`pageZoom` / `zoomStep` / `maxZoom`	`100` / `10` / `200`	`maxZoom` ของ JavaScript แตกต่างจาก C# (`300`).
`showToolTip` / `toolTipPageText`	`true` / `"Page "`	ทูลทิปตำแหน่งหน้า.
`format` / `doc` / `AccessToken`	`""` / `0` / `""`	ค่าการเริ่มต้นภายใน; ปกติจะถูกเติมโดย `View(token)`.
`debugMode`	`false`	การวินิจฉัยเพิ่มเติมของไคลเอนต์.
`FitType`	`""`	ไม่มีการปรับอัตโนมัติหากไม่ได้ระบุ.
`BasePath`	`"DocImage.axd"`	ค่าเริ่มต้นของไคลเอนต์ในประวัติที่เก็บไว้เพื่อความเข้ากันได้ โฮสต์ ASP.NET Core ปัจจุบันต้องตั้งค่าอย่างชัดเจนเป็นสาขามิดเดิลแวร์ที่แมป.
`ResPath`	`""`	ตั้งค่าอย่างชัดเจนเป็นเส้นทางของภาพที่ฝังอยู่.
`cacheEnabled` / `cacheCount` / `cacheDelay`	`false` / `3` / `3`	หน้าต่างการโหลดล่วงหน้าของหน้าในหน่วยความจำและการหน่วงเวลา.
`autoLoad`	`false`	แนะนำให้ใช้การไหลของโทเค็นอย่างชัดเจน.
`largeDoc`	`true`	แตกต่างจากค่าเริ่มต้นของ C#.
`fixedZoom`	`false`	แตกต่างจากค่าเริ่มต้นของ C#.
`fixedZoomPercent` / `fixedZoomPercentMobile`	`100` / `50`	ค่าบนมือถือแตกต่างจาก C# (`75`).
`showHyperlinks`	`true`	ต้องการการสกัดออกจากฝั่งเซิร์ฟเวอร์เพื่อสร้างซ้อนทับ.

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>

คอลแบ็ก

คอลแบ็ก	อาร์กิวเมนต์	จุดประสงค์
`onPageLoading`	`pageNum`	กำลังเริ่มคำขอหน้า.
`onPageLoaded`	`pageNum`	ภาพหน้าสำเร็จการโหลด.
`onThumbnailClicked`	`pageNum`	ผู้ใช้เลือกภาพย่อ.
`onPageClicked`	`pageNum`	ผู้ใช้เลือกหน้า.
`onDoubleClick`	none	ผู้ชมได้รับการคลิกสองครั้ง.
`onViewerBusy`	none	ผู้ชมเข้าสู่สถานะทำงาน.
`onViewerReady`	none	การเริ่มต้นเสร็จสมบูรณ์.
`onViewerError`	none	ผู้ชมเข้าสู่สถานะข้อผิดพลาด.
`onError`	`message`	การดำเนินการคืนข้อความข้อผิดพลาด.
`onCopy`	`data`	ข้อมูลการคัดลอกข้อความพร้อมใช้งาน.
`onAutoLoadStatus`	`pageNum`	การโหลดอัตโนมัติก้าวไปยังหน้าที่.
`onThumbsShown`	none	แผงภาพย่อปรากฏ.
`onAnnLoaded`	none	ข้อมูลคำอธิบายโหลดแล้ว.
`onAnnSaved`	none	ข้อมูลคำอธิบายบันทึกแล้ว.
`onAnnSaveError`	none	การบันทึกคำอธิบายล้มเหลว.
`onAnnClosed`	none	ส่วนติดต่อผู้ใช้ของคำอธิบายปิดลง.

ทำให้คอลแบ็กทำงานเร็ว; ส่งเทเลเมทรีแบบอะซิงโครนัสและอย่าบล็อกการเรนเดอร์หน้า.

กลุ่มเมธอดสาธารณะ

กลุ่ม	เมธอดทั่วไป
วงจรชีวิต	`View(token, accessToken?)`, `Close(server?)`, `Token()`, `Init()`, `IsLoaded()`
การนำทาง	`GotoPage(page)`, `ShowPage(page, focus?)`, `Next(next)`, `CurrentPage()`, `TotalPages()`
ซูมและการปรับขนาด	`Zoom(zoomIn)`, `CurrentZoom()`, `FitType(value)`, `Refit()`
การวางแนว	`Rotate(page, angle)`, `Flip(page, flipType)`
ภาพย่อ	`HideThumbs(hide)`, `ThumbSize(size)`, `ReloadThumbs(width)`, `ScrollToThumb(thumb)`
การค้นหา	`CanSearch()`, `Search(...)`, `SearchMatchCount()`, `SearchSummary(...)`, `GotoSearchMatch(...)`
คำอธิบาย	`SaveAnnotations()`, `GetAnnotations()`, `PushAnnotations(...)`, `CloseAnnotations(...)`, `ShowAnnotations(...)`
คัดลอก	`Copy(...)`, `CopyPage(pageNumber)`, `CopyMode(enabled)`

ไฟล์ JavaScript ยังมีตัวช่วยภายในด้วย ให้ถือว่าเฉพาะเมธอดที่ใช้โดย UI อ้างอิงและที่อธิบายไว้ที่นี่หรือในคู่มือฟีเจอร์เป็นจุดเชื่อมต่อที่เสถียร.

การลองใหม่ขณะที่หน้าที่กระจายยังคงเรนเดอร์

retryOn409 รักษาชื่อเดิมของมัน มันใช้สำหรับการผลิตหน้าที่อะซิงโครนัสและลองใหม่การตอบสนอง 202 Accepted พร้อมกับสัญญาณ 409 Conflict เก่า เมื่อเปิดใช้งาน วิดเจ็ตจะโพลด้วยค่าเริ่มต้น JavaScript เหล่านี้:

ตัวเลือก	ค่าเริ่มต้น
`retryInitialDelayMs`	`250`
`retryBackoffFactor`	`1.6`
`retryMaxDelayMs`	`2500`
`retryMaxAttempts`	`60`
`retryMaxTotalMs`	`120000`

ปล่อยให้ปิดสำหรับผู้ชมปกติ การเปิดใช้งานไม่สามารถทำให้การเรนเดอร์แบบซิงโครนัสที่ไม่รองรับกลายเป็นอะซิงโครนัสได้.

รายการตรวจสอบเส้นทาง

DoconutOptions.MiddlewarePath ต้องอธิบายสาขาที่คุณแมปจริง
BasePath ต้องชี้ไปยังสาขานั้น
DoconutOptions.ResourcesPath เป็นเส้นทางของทรัพยากรที่ฝังอยู่
ResPath ปกติจะชี้ไปยังโฟลเดอร์ย่อย /images ของมัน
ExtractHyperlinks ต้องเปิดใช้งานในการกำหนดค่ารูปแบบของเซิร์ฟเวอร์ก่อนที่ showHyperlinks จะสามารถแสดงอะไรได้