Set Pin

The pin option is used to clear the offset of the spilled cell in the template sheet.

After the cell spill, the report layout can be changed. In this scenario, you can pin the cell in the template sheet to clear the offset of the spilled cell. To configure the pin option, use the pin property in the setTemplateCell method of the Spread.Report.TemplateSheet class.

The options available for the pin property are None, Row, Column, and Both. The default pin value is None.

Notes:

• The pin option can only work on no-parent Static cells, and Static cells cannot intersect with spilled cell tree ranges.

• The pin column requires no spilled cells in the entire row.

• The pin row requires no spilled cells in the entire column.

  
  

Let's discuss how the pin option clears the offset of the spilled cell with some examples.

In these examples, we are using the Orders data table as the data source. The data binding is established between a template cell and the data source, using the shipCountry field.

Example 1: Clear Column Offset

1. Load the below template in the report sheet.

   templateSheet.setTemplateCell(1, 0, {
       type: 'Group',
       binding: 'Orders[shipCountry]',
       spillDirection: 'Horizontal',
   });
   templateSheet.setValue(0, 1, 2023);

   The output of the above code will look like below.

   
   

   
   

2. To keep the cell B1 (value 2023) at its original place, pin the A1 cell.

   templateSheet.setTemplateCell(0, 0, {
       pin: 'Column',
   });

   The template will look like below.

   
   

   
   

   
   

3. With pinned cell, the report will be generated as displayed below.

   
   

   
   

Example 2: Clear Row Offset

1. Load the below template in the report sheet.

   templateSheet.setTemplateCell(0, 1, {
       type: 'Group',
       binding: 'Orders[shipCountry]',
   });
   templateSheet.setValue(1, 0, 2023);

   The output of the above code will look like below.

   
   

   
   

   
   

2. To keep the cell A2 (value 2023) in its original place, pin the A1 cell.

   templateSheet.setTemplateCell(0, 0, {
       pin: 'Row',
   });

   The template will look like below.

   
   

   
   

   
   

3. With pinned cell, the report will be generated as displayed below.