Container

The SpreadJS Designer Component provides the option to insert a container in a ReportSheet to organize data dynamically by associating fields with specific rows, columns, and values. This feature allows users to create structured templates for displaying and analyzing data. Users can configure and fine-tune the containers to match their specific requirements, ensuring that the output aligns with their reporting goals.

Create Container

Follow the steps below to create a container in the ReportSheet.

1. Add a ReportSheet to the workbook.

2. Right-click on any cell and select the Insert Container option from the context menu.

   
   

   
   

   
   

   A container layout will be added to the ReportSheet.

   
   

   
   

   
   

3. Select the fields from the TableList area and drag them into the container’s row, column, or value ranges, or drop them directly into the Row/Column/Value fields of the container.

   
   

   
   

   
   

   When you place a static field into the container, it will display the static cell label instead of the column's information.

   
   

   
   

   
   

4. Click the group label and value label checkboxes to modify the container layout, enabling or disabling the inclusion of labels within the container.

   
   

   
   

Delete Container

You can delete a container to convert the container range into a normal ReportSheet range. To delete a specific container, select the container, right-click to open the context menu, and click the Delete Container option.

Important Rules and Behavior

Note that while creating a container, the following rules and behaviors apply:

• Default Dimensions: The container range has a default row count of 8 and a column count of 5. Containers cannot be added if the remaining row or column count is less than 2.

• Existing Containers: A new container cannot be added if there is an existing container in the selected range.

• Clearing Styles and Data: Before adding a container, any existing styles and data in the container range will be cleared.

• Field Placement:

  • Fields can only be dropped into the container's defined ranges, not individual cells.

  • The container layout is automatically regenerated based on the order of the dropped fields.

• Blank Containers: If the container is blank, template binding information in the right panel cannot be updated and cell values cannot be edited.

• Grouping Behavior:

  • Row and column fields are treated as group types.

  • Column groups are oriented horizontally, while row groups are oriented vertically.

  • Fields in the value range are aggregated by default:

    • Sum for numeric data types.

    • List for string data types.

• Container Size Adjustments: Adding or deleting rows and columns will impact the container range size. If only one row or column remains in the range and it is deleted, the container range will also be removed.

• Restrictions:

  • Users cannot paste, drag-move, or drag-fill values and fields within the container range.

  • Fields can only be dragged and dropped into the container when they are selected.

  • Cells within the container range cannot be merged.