การทำหมายเหตุ

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

การสนับสนุน Annotation ถูกจำกัดโดยความสามารถของใบอนุญาต Annotation (ได้รับโดยอัตโนมัติภายใต้ใบอนุญาต Temporary ที่ใช้งานอยู่)

เปิดใช้งาน UI ของ Annotation

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

รวม bundle ของ annotation ควบคู่กับ 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, รวมถึงปุ่มที่เปิด 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) จะทำโดยอัตโนมัติเมื่อหน้าที่มี annotation ถูกเรนเดอร์. คอลแบ็กสี่ตัว onAnn* ทำให้ Ribbon สอดคล้องกับ วงจรชีวิตของ viewer.

เปิดและปิด Ribbon จากแถบเครื่องมือ Viewer ที่เป็นของ host ใดก็ได้:

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

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

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

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

สร้างคำอธิบายใน C#

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

app.MapPost("/api/annotations/load-sample", (string token, Viewer viewer) =>
{
    // ผูกกับมิติของหน้าที่เปิดอยู่ในเซสชัน
    var manager = viewer.GetAnnotationManager(token);
    var pageCount = viewer.GetPageCount(token);

    // ตราประทับหนึ่งต่อหน้า
    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));

    // โหลดเข้าสู่เซสชัน — วิดเจ็ตดึงข้อมูลผ่าน AnnLoad และ
    // ตัวเรนเดอร์บันทึกพวกมันลงในไฟล์ภาพ/PPDF ที่ส่งออก.
    viewer.LoadAnnotationData(token, manager);
    return Results.Ok();
});

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

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

API ของ AnnotationManager

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

ส่งออกพร้อมคำอธิบายที่ฝังไว้

// PDF ของทุกหน้าพร้อมคำอธิบายที่เรนเดอร์บนหน้า
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");
});

// หรือ ZIP ของ PNG แยกตามหน้า
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. เปิดเอกสารและรับโทเค็นของมัน
2. โหลด XML หรือข้อมูลที่เข้ารหัสที่เก็บไว้ก่อนหน้านี้เข้าสู่โทเค็นนั้น
3. ให้วิดเจ็ตอ่านและแก้ไขคำอธิบายของเซสชัน
4. ดึง XML ด้วย GetAnnotationXML(token) เมื่อแอปพลิเคชันของคุณตัดสินใจบันทึก
5. ส่งออก PDF/PNG เมื่อจำเป็นต้องมีไฟล์ที่แบน
6. ปิดเซสชันเอกสาร

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

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

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

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