Class: TemplateSheet

Spread.Report.TemplateSheet

Hierarchy

• Worksheet

  ↳ TemplateSheet

Table of contents

Constructors

• constructor

Methods

• getDataEntrySetting
• getLayoutSetting
• getPaginationSetting
• getTemplateCell
• setDataEntrySetting
• setLayoutSetting
• setPaginationSetting
• setTemplateCell

Constructors

constructor

• new TemplateSheet(name)

Represents a TemplateSheet.

example

const spread = new GC.Spread.Sheets.Workbook('spread-host', { sheetCount: 0 });
const reportSheet = spread.addSheetTab(0, 'orders-report', GC.Spread.Sheets.SheetType.reportSheet);
const templateSheet = reportSheet.getTemplate();
templateSheet.setValue(0, 0, 'test');

Parameters

Name	Type	Description
name	string	The name of the TemplateSheet.

Overrides

Worksheet.constructor

Methods

getDataEntrySetting

▸ getDataEntrySetting(): DataEntrySetting

Get the data entry setting.

example

// get the data entry setting.
const dataEntrySetting = templateSheet.getDataEntrySetting();

Returns

DataEntrySetting

Return the data entry setting.

---

getLayoutSetting

▸ getLayoutSetting(): LayoutSetting

Get the layout setting.

example

// get the layout setting.
const layoutSetting = templateSheet.getLayoutSetting();

Returns

LayoutSetting

Return the layout setting.

---

getPaginationSetting

▸ getPaginationSetting(): IPaginationSetting

Get the pagination setting.

example

// get the pagination setting.
const paginationSetting = templateSheet.getPaginationSetting();

Returns

IPaginationSetting

Return the pagination setting.

---

getTemplateCell

▸ getTemplateCell(row, col): TemplateCell

Get the template cell.

example

// get the A2 template cell's setting.
const templateCell = templateSheet.getTemplateCell(1, 0);

Parameters

Name	Type	Description
row	number	The row index.
col	number	The column index.

Returns

TemplateCell

Returns the template cell.

---

setDataEntrySetting

▸ setDataEntrySetting(dataEntrySetting): void

Set the data entry setting.

example

// add the customers table.
const customersTable = spread.dataManager().addTable('Customers', {
    remote: {
        read: { url: 'https://demodata.mescius.io/northwind/api/v1/customers' },
        batch: (data) => {
            // sync the changes to the server here.
            console.log('changes: ', data);
            return Promise.resolve(data.map((item) => ({ succeed: true })));
        },
    },
    batch: true,
});

// set binding for the template
const columns = ['customerId', 'companyName', 'contactName', 'contactTitle', 'address', 'region', 'country', 'city', 'postalCode', 'phone', 'fax'];
columns.forEach((columnName, i) => {
    templateSheet.setValue(0, i, `${columnName[0].toUpperCase()}${columnName.substring(1)}`);
    templateSheet.setTemplateCell(1, i, {
        type: 'List',
        binding: `Customers[${columnName}]`,
    });
});

// config the data entry setting
const customerRule = {
    name: 'customers',
    tableName: 'Customers',
    fields: [
        { formula: 'A2', dbColumnName: 'customerId', isPrimary: true },
        { formula: 'B2', dbColumnName: 'companyName' },
        { formula: 'C2', dbColumnName: 'contactName' },
        { formula: 'D2', dbColumnName: 'contactTitle' },
        { formula: 'E2', dbColumnName: 'address' },
        { formula: 'F2', dbColumnName: 'region' },
        { formula: 'G2', dbColumnName: 'country' },
        { formula: 'H2', dbColumnName: 'city' },
        { formula: 'I2', dbColumnName: 'postalCode' },
        { formula: 'J2', dbColumnName: 'phone' },
        { formula: 'K2', dbColumnName: 'fax' },
    ],
};
templateSheet.setDataEntrySetting([customerRule]);

Parameters

Name	Type	Description
dataEntrySetting	DataEntrySetting	The data entry setting.

Returns

void

---

setLayoutSetting

▸ setLayoutSetting(setting): void

Set the layout setting.

example

const dataManager = spread.dataManager();
dataManager.addTable("orders",
     {
          remote: {
              read: {
                  url: "https://demodata.mescius.io/northwind/api/v1/orders"
              }
          }
     }
);
templateSheet.setTemplateCell(1, 0, { type: 'List', binding: 'orders[orderId]' });
const setting = {
     dataRange: "A2",
     type: "RowLayout",
     rowCount: 10
}
templateSheet.setLayoutSetting(setting);

Parameters

Name	Type	Description
setting	LayoutSetting	The layout setting.

Returns

void

---

setPaginationSetting

▸ setPaginationSetting(setting): void

Set the pagination setting.

example

// set the paper size pagination.
const printInfo = templateSheet.printInfo();
printInfo.paperSize().kind(GC.Spread.Sheets.Print.PaperKind.a4);
templateSheet.setPaginationSetting({
    paperSizePagination: true,
    titleRow: {
        start: 0,
        end: 0,
    },
    titleCol: {
        start: 0,
        end: 0,
    },
    paginationOrder: 'OverThenDown',
});

// set row pagination, row pagination only can work for the list template cell.
templateSheet.setTemplateCell(1, 0, { type: 'List', binding: 'orders[orderId]' });
templateSheet.setPaginationSetting({
    rowPagination: {
        paginationDataCell: 'A2',
        rowCountPerPage: 20,
    },
    titleRow: {
        start: 0,
        end: 0,
    },
});

Parameters

Name	Type	Description
setting	IPaginationSetting	The pagination setting.

Returns

void

---

setTemplateCell

▸ setTemplateCell(row, col, templateCell): void

Set the template cell.

example

const dataManager = spread.dataManager();
dataManager.addTable("orders",
     {
          remote: {
              read: {
                  url: "https://demodata.mescius.io/northwind/api/v1/orders"
              }
          }
     }
);
// set the template cell setting for the A2 cell.
templateSheet.setTemplateCell(1, 0, { type: 'List', binding: 'orders[shipCity]' });

Parameters

Name	Type	Description
row	number	The row index.
col	number	The column index.
templateCell	TemplateCell	The template cell.

Returns

void