ViewerConfig
ตัวเลือกวิดเจ็ต viewer ของไคลเอนต์
ViewerConfig (namespace Doconut) อธิบายลักษณะและพฤติกรรมของ viewer ในเบราว์เซอร์ ไม่ส่งผลต่อคุณภาพการแสดงผลของเอกสาร; ใช้การตั้งค่า format สำหรับเรื่องนั้น คลาส C# และปลั๊กอิน JavaScript รุ่นเก่ามีค่าเริ่มต้นที่แตกต่างกัน ดังนั้นให้แมปค่าอย่างชัดเจน.
คุณสมบัติ C#
| ประเภท | คุณสมบัติ | ค่าเริ่มต้น | คำอธิบาย |
|---|---|---|---|
bool | ShowThumbs | true | แสดงแผงภาพย่อ. |
bool | AutoLoad | false | โหลดโดยอัตโนมัติหลังจากการเริ่มต้น การไหลของโทเค็นปกติจะเรียก View(token) อย่างชัดเจน. |
bool | AutoFocus | true | ย้ายโฟกัส/การเลื่อนของเบราว์เซอร์ไปยัง viewer ระหว่างการเริ่มต้น. |
bool | AutoPageFocus | true | คงภาพย่อปัจจุบันให้มองเห็นได้ขณะหน้าเปลี่ยน. |
int | PageZoom | 100 | เปอร์เซ็นต์การซูมเริ่มต้น. |
int | ZoomStep | 10 | เปอร์เซ็นต์ที่เพิ่มหรือหักโดยคำสั่งซูม. |
int | MaxZoom | 300 | เปอร์เซ็นต์การซูมสูงสุด. |
bool | ShowToolTip | true | แสดง tooltip ตำแหน่งหน้าในขณะเลื่อน. |
string | ToolTipPageText | "Page " | คำนำหน้าที่ใช้ใน tooltip ของหน้า. |
bool | CacheEnabled | false | เก็บหน้าต่างเคลื่อนที่ของภาพหน้าในหน่วยความจำของเบราว์เซอร์ ไม่ใช้ localStorage. |
bool | LargeDoc | false | ต่อท้ายองค์ประกอบหน้าตามชุดที่กำหนดเวลา สำหรับเอกสารขนาดใหญ่. |
bool | ShowHyperlinks | false | เรนเดอร์โอเวอร์เลย์ของลิงก์เมื่อการตั้งค่าเซิร์ฟเวอร์ดึงออกมา. |
bool | FixedZoom | true | ใช้เปอร์เซ็นต์การซูมคงที่แทนการคำนวณใหม่แบบตอบสนอง. |
int | FixedZoomPercent | 100 | ซูมเดสก์ท็อปคงที่. |
int | FixedZoomPercentMobile | 75 | ซูมมือถือคงที่. |
string | BasePath | "/" | ตำแหน่งที่ viewer ส่งคำขอหน้า "/" อยู่ที่ 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 ยังได้รับการยอมรับเพื่อความเข้ากันได้กับเซิร์ฟเวอร์รุ่นเก่า ไม่จำเป็นสำหรับ viewer แบบซิงโครนัสปกติ. |
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 ในขณะที่คีย์ path/fit ที่กำหนดไว้สามรายการใช้รูปแบบ 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 | ส่วนต่อประสานคำอธิบายถูกปิด |
ทำให้คอลแบ็กทำงานเร็ว; ส่งข้อมูลการตรวจวัดแบบอะซิงโครนัสและอย่าบล็อกการเรนเดอร์หน้า
กลุ่มเมธอดสาธารณะ
| กลุ่ม | เมธอดทั่วไป |
|---|---|
| วงจรชีวิต | 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 |
ปล่อยให้ปิดอยู่สำหรับผู้ชมปกติ การเปิดใช้งานมันไม่สามารถทำให้การเรนเดอร์แบบซิงโครนัสที่ไม่รองรับกลายเป็นแบบอะซิงโครนัสได้
รายการตรวจสอบเส้นทาง
DoconutOptions.MiddlewarePathต้องอธิบายสาขาที่คุณแมปจริงๆBasePathต้องชี้ไปยังสาขานั้น โดยเขียนโดยไม่มี/นำหน้า ('doconut', ไม่ใช่'/doconut': ตัวชมเพิ่มสแลช และ//doconut/...เป็นการร้องขอไปยังโฮสต์อื่น)DoconutOptions.ResourcesPathคือเส้นทางทรัพยากรที่ฝังอยู่ResPathปกติจะชี้ไปยังโฟลเดอร์ย่อยimagesของมัน โดยไม่มี/นำหน้า ('doconut-res/images')ExtractHyperlinksต้องเปิดใช้งานในการตั้งค่ารูปแบบเซิร์ฟเวอร์ก่อนที่showHyperlinksจะสามารถแสดงอะไรได้
หน้านี้เป็นประโยชน์หรือไม่?