printedDiagramHeader Property

Description

This property is used to apply a header configuration to the Web SDK editor from the host application. When this property is set, a header will be printed on the first page and on the field measurements output page if requested. See the includeFieldMeasurements option in the store() method.

To set this property, use the ESDWeb object's set() method, as illustrated below. Note that this will overwrite any existing header configuration but will not change any existing diagram.

Note — The information in this property will never be saved as part of a diagram. This means that the developer is completely responsible for keeping the current diagram and its print header information in sync.

Example

editor = new window.__editor(undefined, document.getElementById('editor-node'));

editor.startup(...);

editor.set("printedDiagramHeader", {
    title: "Incident " + incidentID,
    header: [
        [
            { caption: "Date", value: incidentDate },
            { caption: "Incident", value: incidentID },
            { caption: "Prepared By", value: userName }
        ],
        [
            { caption: "Location", value: location },
            { caption: "Latitude & Longitude, value: latitude + ", " + longitude}
        ]
    ],
    diagramCaption: "Planimetric survey"
});