คำอธิบาย

การอธิบายประกอบใน Doconut ทำงานในสองทิศทาง: ผู้ใช้วาดในวิดเจ็ตเบราว์เซอร์และเซิร์ฟเวอร์บันทึกตามหน้า, หรือโค้ดของคุณสร้างขึ้นโปรแกรมmatically แล้วโหลดเข้าสู่เซสชันที่เปิดอยู่ ไม่ว่ากรณีใดก็ตาม พวกมันจะแสดงบนหน้าและสามารถฝังลงในไฟล์ PDF/PNG ที่ส่งออกได้

การสนับสนุนการอธิบายประกอบถูกจำกัดโดยความสามารถของไลเซนส์ Annotation (ได้รับโดยอัตโนมัติภายใต้ไลเซนส์ Temporary ที่ใช้งานอยู่).

เปิดใช้งาน UI การอธิบายประกอบ

Annotation เป็นโมดูลของ Viewer ไม่ใช่แถบเครื่องมือแยกอิสระ หน้าเต็มต้องรวม ทรัพยากร Viewer, แถบเครื่องมือ Viewer, จุดเชื่อมต่อ Viewer, และ objViewer ที่ได้เริ่มต้นแล้ว; จากนั้น Ribbon ของ Annotation จะถูกติดตั้งและเชื่อมต่อกับอินสแตนซ์เดียวกันนั้น

ส่งไฟล์ bundle ของการอธิบายประกอบพร้อมกับ bundle ของ viewer — พวกมันถูกจำกัดโดยไลเซนส์ ดังนั้นแท็กจะปรากฏเฉพาะเมื่อความสามารถพร้อมใช้งาน:

@Html.Raw(Viewer.ReferenceCss(new CssConfig
{
    IncludeViewerCss     = true,
    IncludeAnnotationCss = true   // jquery-ui.min.css + annotationBar.css
}))

@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig
{
    IncludeJQuery             = true,
    IncludeViewerScripts      = true,
    IncludeAnnotationScripts  = true, // jquery-ui, raphael.js, annotation.js
    IncludeAnnotationBar      = true  // the embedded annotation ribbon
}))

เก็บโครงสร้าง Viewer ทั้งหมดให้มองเห็นใน markup:

<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Viewer controls, including the button that opens Annotation -->
</nav>
<div id="annBarMount"></div>
<div id="divDocViewer"><div id="div_ctlDoc"></div></div>

Bundle ของ Annotation จะสร้าง Ribbon DOM ภายใน annBarMount; คุณไม่จำเป็นต้อง คัดลอกปุ่มหรือ markup ของ dialog. เริ่มต้น docViewer ก่อน, แล้วสร้าง Ribbon เฉพาะเมื่อเซิร์ฟเวอร์ยืนยันว่า Annotation มีไลเซนส์:

<script>
    let annBar = null;
    let currentToken = '';

    const objViewer = $('#div_ctlDoc').docViewer({
        BasePath: '/doconut',
        ResPath: '/doconut-res/images',
        onAnnLoaded:    () => annBar?.handleAnnLoaded(),
        onAnnSaved:     () => annBar?.handleAnnSaved(),
        onAnnSaveError: () => annBar?.handleAnnSaveError(),
        onAnnClosed:    () => annBar?.handleAnnClosed(),
        onError:        (message) => console.error('Viewer error:', message)
    });

    @if (Viewer.IsAnnotationEnabled)
    {
        <text>
    annBar = $('#annBarMount').doconutAnnotationBar({
        docId: 'ctlDoc',
        getRequestParams: () => ({ token: currentToken }),
        onStatus: (message) => console.log(message),
        onToast: (message, type) => console.log(type, message),
        onLayout: () => requestAnimationFrame(() => objViewer.Refit())
    });
    annBar.attach(objViewer);
        </text>
    }
</script>

การบันทึกจาก Ribbon จะส่งข้อมูลผ่าน middleware (AnnSave), ซึ่งจะเก็บไว้ใน session ของเอกสารต่อหน้า. การโหลด (AnnLoad) จะทำโดยอัตโนมัติเมื่อหน้าที่มี การอธิบายประกอบถูกเรนเดอร์. คอลแบ็กสี่ตัว onAnn* ทำให้ Ribbon ซิงโครไนซ์กับ วงจรชีวิตของ viewer.

เปิดและปิดจากแถบเครื่องมือ Viewer ที่เป็นของโฮสต์ได้ทุกที่:

annBar.open();
annBar.close();

API สาธารณะของ Ribbon มีดังนี้:

onStatus, onToast, onLayout, onEditStart, และ onEditEnd เป็นคอลแบ็กของโฮสต์ที่เป็นตัวเลือก. อ็อบเจ็กต์ endpoints สามารถให้ค่าเพิ่มเติมเช่น exportPdf, exportPng, imageUpload, และ imageList; คอนโทรลที่ไม่มี endpoint ตั้งค่าไว้จะถูกซ่อน. สำหรับลำดับการเริ่มต้นของ Viewer, Search, และ Annotation ร่วมกัน, ดูที่ เริ่มต้นอย่างเร็ว.

Bundle ของการอธิบายประกอบเพิ่มเครื่องมือการสร้างในเบราว์เซอร์, แต่ข้อมูลยังคงเป็นของ session ฝั่งเซิร์ฟเวอร์ที่ระบุด้วย token. การเปิดใหม่ของแหล่งข้อมูลจะสร้าง session ใหม่; ให้บันทึก XML หรือ envelope ของการอธิบายประกอบที่เข้ารหัสไว้ในแอปของคุณหากต้องการให้การอธิบายประกอบคงอยู่หลังจาก session สิ้นสุด.

สร้างการอธิบายประกอบใน C#

รับ manager ที่ผูกกับ session ที่เปิดอยู่, เพิ่มการอธิบายประกอบ, แล้วโหลดมัน (ด้วย using Doconut.Annotations; สำหรับประเภทและ using System.Drawing; สำหรับ Rectangle/Color):

app.MapPost("/api/annotations/load-sample", (string token, Viewer viewer) =>
{
    // Bound to the open session's page dimensions
    var manager = viewer.GetAnnotationManager(token);
    var pageCount = viewer.GetPageCount(token);

    // One stamp per page
    for (int page = 1; page <= pageCount; page++)
    {
        manager.Add(new StampAnnotation(page, new Rectangle(30, 20, 240, 90),
            $"PAGE {page}", 28, 4, Color.Maroon)
        {
            Opacity = 60,
            Rotate  = -8
        });
    }

    manager.Add(new NoteAnnotation(1, new Rectangle(420, 150, 220, 120),
        "Loaded from C# code.", Color.FromArgb(255, 255, 255, 170), 14));

    // Load into the session — the widget fetches them via AnnLoad and the
    // renderer burns them into image/PDF exports.
    viewer.LoadAnnotationData(token, manager);
    return Results.Ok();
});

ประเภทของการอธิบายประกอบ

ทุกประเภทอยู่ใน Doconut.Annotations และสืบทอดจาก BaseAnnotation (เลขหน้า + Rectangle ที่กำหนดขอบเขต):

API ของ AnnotationManager

Viewer สะท้อนการโหลด/อ่านต่อ session: LoadAnnotationData(token, manager) หรือ LoadAnnotationData(token, encodedData) (envelope Base64 จาก GetAnnotationData()), LoadAnnotationXML(token, xml), GetAnnotationXML(token).

ส่งออกพร้อมการฝังการอธิบายประกอบ

// PDF of all pages with annotations rendered onto them
app.MapGet("/api/annotations/export-pdf", async (string token, Viewer viewer) =>
{
    byte[] pdf = await viewer.ExportAnnotationsToPdfAsync(token, zoom: 100);
    return Results.File(pdf, "application/pdf", "export.pdf");
});

// Or a ZIP of per-page PNGs
app.MapGet("/api/annotations/export-png-zip", async (string token, Viewer viewer) =>
{
    byte[] zip = await viewer.ExportAnnotationsToPngZipAsync(token, zoom: 100);
    return Results.File(zip, "application/zip", "annotations-png.zip");
});

การส่งออกใช้เครื่องมือบันทึกเดียวกับการเรนเดอร์บนหน้าจอ, ดังนั้นสิ่งที่ผู้ใช้เห็นคือสิ่งที่ไฟล์ประกอบด้วย.

กระบวนการทำให้คงอยู่

1. เปิดเอกสารและรับ token ของมัน.
2. โหลด XML หรือข้อมูลที่เข้ารหัสที่เก็บไว้ก่อนหน้านี้เข้าสู่ token นั้น.
3. ให้ widget อ่านและแก้ไขการอธิบายประกอบใน session.
4. ดึง XML ด้วย GetAnnotationXML(token) เมื่อแอปของคุณต้องการบันทึก.
5. ส่งออก PDF/PNG เมื่อจำเป็นต้องมีไฟล์แบนที่รวมการอธิบายประกอบ.
6. ปิด session ของเอกสาร.

ห้ามใช้ token ของ viewer ที่เป็นแบบไม่โปร่งใสเป็นตัวระบุการอธิบายประกอบถาวร. ให้เชื่อมข้อมูลการอธิบายประกอบที่บันทึกกับตัวระบุเอกสารและเวอร์ชันของคุณเอง.

ความปลอดภัยและหมายเหตุการเรนเดอร์

• คำขอการอธิบายประกอบใช้การรักษาความปลอดภัยของ session/token เหมือนกับคำขอหน้า.
• URL ของ ImageAnnotation ที่เป็น relative จะถูกแก้จากโฮสต์ของคำขอและต้องยังคงเข้าถึงได้จากเซิร์ฟเวอร์ในช่วงบันทึก.
• ตรวจสอบและควบคุม URL ของรูปภาพที่ผู้ใช้ส่งเข้ามาเพื่อป้องกันการปลอมแปลงคำขอฝั่งเซิร์ฟเวอร์.
• การส่งออกใช้การตัดสินใจไลเซนส์/ลายน้ำแบบเดียวกับการเรนเดอร์หน้าในหน้าจอ.
• ภาระข้อมูล freehand ขนาดใหญ่และการส่งออกความละเอียดสูงจะเพิ่มการใช้หน่วยความจำ; ควรทดสอบกับเอกสารและค่า zoom ที่เป็นจริง.

การแก้ไขปัญหา