ViewerConfig
ตัวเลือกวิดเจ็ตผู้ชมฝั่งไคลเอนต์
ViewerConfig (namespace Doconut) อธิบายลักษณะและพฤติกรรมของตัวดูเบราว์เซอร์ มันไม่ส่งผลต่อคุณภาพการเรนเดอร์เอกสาร; ใช้การกำหนดรูปแบบสำหรับสิ่งนั้น คลาส C# และวิดเจ็ต JavaScript ที่มีมานานมีค่าเริ่มต้นที่แตกต่างกัน ดังนั้นให้แมปค่าอย่างชัดเจน.
การเปลี่ยนแปลงสองอย่างฝั่งไคลเอนต์ในรุ่นนี้ล้มเหลวโดยเงียบ ฟังก์ชันจัดการจะถูกส่งเป็นตัวเลือก — วิดเจ็ตไม่ดึงคอลแบ็กเหตุการณ์จาก id ของคอนเทนเนอร์อีกต่อไป — และ
ResPathต้องชี้ไปที่คำนำหน้าทรัพยากรแทนรากของแอปพลิเคชัน ทั้งสองทำให้เซิร์ฟเวอร์ทำงานได้อย่างสมบูรณ์และไม่รายงานอะไรในคอนโซลของเบราว์เซอร์ หากคุณกำลังย้ายหน้าจากไลบรารีก่อนหน้า อ่าน คอลแบ็ก และ รายการตรวจสอบเส้นทาง ก่อนอื่นอื่นใด
คุณสมบัติ 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 | "/" | ตำแหน่งที่ตัวดูส่งคำขอหน้า "/" อยู่ที่ DocImage.axd ที่รากของไซต์; มิฉะนั้นที่สาขาที่โฮสต์แมป UseDoconut(), โดยไม่มี / นำหน้า ("doconut" หมายถึง /doconut/DocImage.axd). |
string | ResPath | "doconut-res/images" (26.9.0; "doconut-res" before) | โฟลเดอร์ที่วิดเจ็ตโหลดภาพของตนเอง: โฟลเดอร์ images ภายใต้ ResourcesPath, โดยไม่มี / นำหน้า. |
string | FitType | "width" | "width", "height", หรือว่างสำหรับไม่มีการปรับอัตโนมัติ. "page" ไม่ได้รับการยอมรับโดยวิดเจ็ตปัจจุบัน. |
bool | RetryOn409 | false | เปิดใช้งานการโพลเมื่อการผลิตหน้าที่ไม่ประสานกัน/กระจายตอบสนอง 202 Accepted; 409 ยังได้รับการยอมรับเพื่อความเข้ากันได้กับเซิร์ฟเวอร์รุ่นเก่า ไม่จำเป็นสำหรับตัวดูแบบประสานกันปกติ. |
var config = new ViewerConfig
{
ShowThumbs = true,
AutoLoad = false,
PageZoom = 100,
MaxZoom = 300,
FitType = "width",
BasePath = "doconut", // ไม่มี '/' นำหน้า: ตัวแสดงผลจะเพิ่มให้ ("/doconut" จะกลายเป็น //doconut, โฮสต์อื่น)
ResPath = "doconut-res/images",
ShowHyperlinks = true
};การแมป C# ไปยัง JavaScript
ห้ามส่ง ViewerConfig ที่ถูกซีเรียลไลซ์โดยตรงไปยัง docViewer(...). คีย์ส่วนใหญ่ของวิดเจ็ตใช้รูปแบบ camelCase, ในขณะที่คีย์เส้นทาง/การปรับที่ตั้งมั่นสามตัวใช้รูปแบบ 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 |
ค่าเริ่มต้นของ JavaScript
วิดเจ็ตมีค่าเริ่มต้นเก่าที่แตกต่างจากคลาส C#. ค่าต่อไปนี้มาจากการทำงานของ docViewer.js ปัจจุบัน.
| ตัวเลือก | ค่าเริ่มต้น | หมายเหตุ |
|---|---|---|
leftMinWidth / leftMaxWidth | 220 / 800 | ขอบเขตความกว้างของแผงภาพย่อ. |
showThumbs | true | การมองเห็นภาพย่อเริ่มต้น. |
autoFocus / autoPageFocus | true / false | autoPageFocus แตกต่างจากค่าเริ่มต้นของ C#. |
thumbWidth / thumbHeight / thumbPadding | 150 / 200 / 10 | เรขาคณิตของภาพย่อเป็นพิกเซล. |
pageZoom / zoomStep / maxZoom | 100 / 10 / 200 | JavaScript maxZoom แตกต่างจาก 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 | ต้องการการสกัดจากฝั่งเซิร์ฟเวอร์เพื่อสร้างโอเวอร์เลย์. |
ตั้งค่าทั้งหมดที่สำคัญต่อพฤติกรรมแทนการพึ่งพาชุดค่าเริ่มต้นใดชุดหนึ่ง:
<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 | ส่วนต่อประสานคำอธิบายปิด. |
ทำให้คอลแบ็กทำงานเร็ว; ส่งข้อมูลการตรวจวัดแบบอะซิงโครนัสและไม่บล็อกการเรนเดอร์หน้า.
ทุกอันเหล่านี้เป็นตัวเลือกบนอ็อบเจกต์ init. ผู้ชมรุ่นก่อนค้นหาฟังก์ชันระดับโลกที่ชื่อได้มาจาก id ของคอนเทนเนอร์ — หน้าที่มี <div id="div_ctlDoc"> เพียงต้องประกาศ function ctlDoc_OnViewerReady(). การค้นหานั้นหายไปแล้ว ส่งฟังก์ชันโดยตรง:
function ctlDoc_OnViewerBusy() { /* แสดงตัวบ่งชี้กำลังทำงานของคุณ */ }
function ctlDoc_OnViewerReady() { /* ซ่อนมัน */ }
function ctlDoc_Copy(text) { /* ใช้ข้อความที่คัดลอก */ }
function ctlDoc_AutoLoadStatus(pageNum) { /* รายงานความคืบหน้า */ }
const objViewer = $('#div_ctlDoc').docViewer({
// ... ตัวเลือกที่มีอยู่ของคุณ ...
onViewerBusy: ctlDoc_OnViewerBusy, // พบตามชื่อ
onViewerReady: ctlDoc_OnViewerReady, // พบตามชื่อ
onCopy: ctlDoc_Copy, // เป็น ctlDoc_Copy(text)
onAutoLoadStatus: ctlDoc_AutoLoadStatus // เป็น ctlDoc_AutoLoadStatus(page)
});การค้นหาเก่าได้ถูกห่อหุ้มด้วย catch ว่างเปล่า ดังนั้นไม่มีอะไรถูกรายงานเลย ในรุ่นนี้ฟังก์ชันจะไม่ทำงานเลย: อาการทั่วไปคือสปินเนอร์ทำงานอยู่แต่ไม่หยุด เพราะตัวจัดการที่ซ่อนมันคือ onViewerReady. เอกสารที่อยู่ด้านหลังนั้นกำลังเรนเดอร์อย่างถูกต้อง.
ยังคงมีการค้นหา hook การบันทึกคำอธิบายสองตัวตามชื่อ: SaveAnnotations() เรียก
<elementId>_BeforeAnnSave() และ <elementId>_DeletedAnnotationIds() เมื่อมีอยู่ โดยใช้
id เต็มขององค์ประกอบ (div_ctlDoc_BeforeAnnSave สำหรับตัวอย่างด้านบน).
ไม่มีคอลแบ็กสำหรับการคลิกลิงก์ — การจัดการไฮเปอร์ลิงก์ถูกสร้างไว้แล้วและขับเคลื่อนโดย
showHyperlinks.
กลุ่มเมธอดสาธารณะ
| กลุ่ม | เมธอดทั่วไป |
|---|---|
| วงจรชีวิต | 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 | 150 |
retryMaxTotalMs | 300000 |
ปล่อยให้ปิดไว้สำหรับผู้ชมแบบโหนดเดียวปกติ การเปิดใช้งานไม่สามารถทำให้การเรนเดอร์แบบซิงโครนัสที่ไม่รองรับกลายเป็นแบบอะซิงโครนัสได้
เปิดใช้งานเมื่อหน้าถูกให้บริการจากที่เก็บข้อมูลร่วมกับ FirstPagePriority ซึ่งหน้าที่ตามมาจะตอบอย่างถูกต้องกับ 202 Accepted จนกว่าจะถูกเขียนลง ลูกค้าที่ไม่ลองใหม่จะแสดงไทล์ที่เสียหายสำหรับหน้าที่ยังคงเรนเดอร์ — ดู การปรับใช้แบบกระจาย.
รายการตรวจสอบเส้นทาง
DoconutOptions.MiddlewarePathต้องอธิบายสาขาที่คุณแมปจริงๆBasePathต้องชี้ไปยังสาขานั้น โดยเขียนโดยไม่มี/นำหน้า ('doconut', ไม่ใช่'/doconut': ผู้ชมจะเพิ่มสแลชและ//doconut/...เป็นการร้องขอไปยังโฮสต์อื่น) การตั้งค่าทั่วไปจะรักษารูปแบบการร้องขอDocImage.axdแบบประวัติบนสาขาMapWhenและจึงตั้งค่าBasePath: '/'.DoconutOptions.ResourcesPathคือเส้นทางทรัพยากรที่ฝังอยู่ResPathปกติจะชี้ไปยังโฟลเดอร์ย่อยimagesของมัน โดยไม่มี/นำหน้า —'doconut-res/images'พร้อมคำนำหน้าตามค่าเริ่มต้น ค่าที่ว่างเปล่าResPathเคยถูกต้องในไลบรารีก่อนหน้า ที่ซึ่งทรัพยากรมาจากรากของแอปพลิเคชัน; ที่นี่ไม่ถูกต้องและจะล้มเหลวโดยไม่มีข้อผิดพลาดExtractHyperlinksต้องเปิดใช้งานในการกำหนดค่ารูปแบบเซิร์ฟเวอร์ก่อนที่showHyperlinksจะสามารถแสดงอะไรได้
หน้านี้เป็นประโยชน์หรือไม่?