คำอธิบาย

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

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

เปิดใช้งาน UI ของคำอธิบาย

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

ปล่อยชุดบันเดิลของคำอธิบายพร้อมกับบันเดิลของ 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>

บันเดิล Annotation จะสร้าง DOM ของ Ribbon ภายใน annBarMount; คุณไม่จำเป็นต้องคัดลอกปุ่มหรือ markup ของไดอะล็อก Initialize 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), ซึ่งจะเก็บข้อมูลไว้ในเซสชันเอกสารต่อหน้า การโหลด (AnnLoad) จะเกิดขึ้นอัตโนมัติเมื่อหน้าที่มีคำอธิบายถูกเรนเดอร์ คอลแบ็ก onAnn* ทั้งสี่จะทำให้ Ribbon ซิงโครไนซ์กับวงจรชีวิตของ viewer

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

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

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

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

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

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

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

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

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

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

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