# GC.Spread.Report.TemplateSheet

## Content

# Class: TemplateSheet

[Spread](../modules/GC.Spread).[Report](../modules/GC.Spread.Report).TemplateSheet

## Hierarchy

- [`Worksheet`](GC.Spread.Sheets.Worksheet)

  ↳ **`TemplateSheet`**

## Table of contents

### Constructors

- [constructor](GC.Spread.Report.TemplateSheet#constructor)

### Methods

- [getDataEntrySetting](GC.Spread.Report.TemplateSheet#getdataentrysetting)
- [getLayoutSetting](GC.Spread.Report.TemplateSheet#getlayoutsetting)
- [getPaginationSetting](GC.Spread.Report.TemplateSheet#getpaginationsetting)
- [getTemplateCell](GC.Spread.Report.TemplateSheet#gettemplatecell)
- [setDataEntrySetting](GC.Spread.Report.TemplateSheet#setdataentrysetting)
- [setLayoutSetting](GC.Spread.Report.TemplateSheet#setlayoutsetting)
- [setPaginationSetting](GC.Spread.Report.TemplateSheet#setpaginationsetting)
- [setTemplateCell](GC.Spread.Report.TemplateSheet#settemplatecell)

## Constructors

### <a id="constructor" name="constructor"></a> 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](GC.Spread.Sheets.Worksheet).[constructor](GC.Spread.Sheets.Worksheet#constructor)

## Methods

### <a id="getdataentrysetting" name="getdataentrysetting"></a> getDataEntrySetting

▸ **getDataEntrySetting**(): [`DataEntrySetting`](../modules/GC.Spread.Report#dataentrysetting)

Get the data entry setting.

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

#### Returns

[`DataEntrySetting`](../modules/GC.Spread.Report#dataentrysetting)

Return the data entry setting.

___

### <a id="getlayoutsetting" name="getlayoutsetting"></a> getLayoutSetting

▸ **getLayoutSetting**(): [`LayoutSetting`](../modules/GC.Spread.Report#layoutsetting)

Get the layout setting.

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

#### Returns

[`LayoutSetting`](../modules/GC.Spread.Report#layoutsetting)

Return the layout setting.

___

### <a id="getpaginationsetting" name="getpaginationsetting"></a> getPaginationSetting

▸ **getPaginationSetting**(): [`IPaginationSetting`](../interfaces/GC.Spread.Report.IPaginationSetting)

Get the pagination setting.

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

#### Returns

[`IPaginationSetting`](../interfaces/GC.Spread.Report.IPaginationSetting)

Return the pagination setting.

___

### <a id="gettemplatecell" name="gettemplatecell"></a> getTemplateCell

▸ **getTemplateCell**(`row`, `col`): [`TemplateCell`](../modules/GC.Spread.Report#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`](../modules/GC.Spread.Report#templatecell)

Returns the template cell.

___

### <a id="setdataentrysetting" name="setdataentrysetting"></a> 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`](../modules/GC.Spread.Report#dataentrysetting) | The data entry setting. |

#### Returns

`void`

___

### <a id="setlayoutsetting" name="setlayoutsetting"></a> 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`](../modules/GC.Spread.Report#layoutsetting) | The layout setting. |

#### Returns

`void`

___

### <a id="setpaginationsetting" name="setpaginationsetting"></a> 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`](../interfaces/GC.Spread.Report.IPaginationSetting) | The pagination setting. |

#### Returns

`void`

___

### <a id="settemplatecell" name="settemplatecell"></a> 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`](../modules/GC.Spread.Report#templatecell) | The template cell. |

#### Returns

`void`