Skip to main content

DHTMLX Spreadsheet. Readonly example

This demo shows how to enable full readonly mode in DHTMLX Spreadsheet by setting the readonly configuration property to true, preventing all user edits.

Live example​

const spreadsheet = new dhx.Spreadsheet("spreadsheet", {
    readonly: true // the read-only mode is switched on, false - to switch it off
});

spreadsheet.parse(dataset);
<!-- component container -->
<div style="height: 100%; max-width:100%" id="spreadsheet"></div>

<!-- dataset -->

<script>
const dataset = {
        styles: {
            bold: {
                "font-weight": "bold",
            },
            right: {
                "justify-content": "flex-end",
                "text-align": "right",
            },
        },
        data: [
            { cell: "a1", value: "Country", css:"bold" },
            { cell: "b1", value: "Product", css:"bold" },
            { cell: "c1", value: "Price", css:"right bold" },
            { cell: "d1", value: "Amount", css:"right bold" },
            { cell: "e1", value: "Total Price", css:"right bold" },

            { cell: "a2", value: "Ecuador" },
            { cell: "b2", value: "Banana" },
            { cell: "c2", value: 6.68, format: "currency" },
            { cell: "d2", value: 430 },
            { cell: "e2", value: 2872.4, format: "currency" },

            { cell: "a3", value: "Belarus" },
            { cell: "b3", value: "Apple" },
            { cell: "c3", value: 3.75, format: "currency" },
            { cell: "d3", value: 600 },
            { cell: "e3", value: 2250, format: "currency" },

            { cell: "a4", value: "Peru" },
            { cell: "b4", value: "Grapes" },
            { cell: "c4", value: 7.69, format: "currency" },
            { cell: "d4", value: 740 },
            { cell: "e4", value: 5690.6, format: "currency" },

            { cell: "a5", value: "Egypt" },
            { cell: "b5", value: "Orange" },
            { cell: "c5", value: 5.86, format: "currency" },
            { cell: "d5", value: 560 },
            { cell: "e5", value: 3281.6, format: "currency" },

            { cell: "a6", value: "South Africa" },
            { cell: "b6", value: "Grapefruit" },
            { cell: "c6", value: 8.58, format: "currency" },
            { cell: "d6", value: 800 },
            { cell: "e6", value: 6864, format: "currency" },

            { cell: "a7", value: "Spain" },
            { cell: "b7", value: "Lemon" },
            { cell: "c7", value: 9.12, format: "currency" },
            { cell: "d7", value: 650 },
            { cell: "e7", value: 5928, format: "currency" },

            { cell: "a8", value: "Iran" },
            { cell: "b8", value: "Pomegranate" },
            { cell: "c8", value: 9.67, format: "currency" },
            { cell: "d8", value: 300 },
            { cell: "e8", value: 2901, format: "currency" }
        ],
    };
</script>

Published reports, reference tables, and embedded data displays need to show spreadsheet data without allowing any modifications. Full readonly mode turns the component into a viewer. Users can scroll and see data but cannot edit cells, change styles, or modify the grid structure.

This example sets readonly: true in the Spreadsheet constructor configuration. Editing operations are disabled, so the loaded data is presented in a non-editable view while users can still scroll.

Solution overview​

  1. Create the Spreadsheet with new dhx.Spreadsheet("spreadsheet", { readonly: true })
  2. Load data with spreadsheet.parse(dataset)

Key points​

  • Full lockdown: Unlike cell-level locking, readonly: true applies non-editable behavior across the entire component
  • Navigation preserved: Users can still scroll and select cells while modifications are blocked
  • Global config: The readonly mode is enabled directly through the Spreadsheet constructor configuration

API reference​

  • readonly: Enables or disables full readonly mode.
  • lock(): Locks individual cells (alternative to global readonly).

Additional resources​