Skip to content
RevoGrid [Pro]

Row Transpose

The Row Transpose Plugin modifies the grid by transposing its data, meaning that the original rows are converted into columns and vice versa. This can be especially useful when dealing with datasets that require pivoting or when users need to explore data from different perspectives.

Source code
src/components/row-transpose/rowTranspose.ts
import { controlAttributes, createControl } from '@revolist/ui';
import { defineCustomElements } from '@revolist/revogrid/loader';
defineCustomElements();


import { currentTheme } from '../composables/useRandomData';
const { isDark } = currentTheme();
import { makeData } from '../composables/makeData';


import {
  avatarRenderer,
  ColumnStretchPlugin,
  ratingStarRenderer,
  RowOddPlugin,
  RowTransposePlugin,
  TransposedRow,
} from '@revolist/revogrid-pro';


export function load(parentSelector: string) {
  const parent = document.querySelector(parentSelector);
  if (!parent) return;


  const grid = document.createElement('revo-grid');


  // Define columns
  grid.columns = [
    {
      name: 'Avatar',
      prop: 'avatar',
      cellTemplate: avatarRenderer,
      rectangular: true,
    },
    { name: 'Full name', prop: 'fullName' },
    { name: 'Rating', prop: 'rating', cellTemplate: ratingStarRenderer },
    { name: 'Email', prop: 'email' },
    { name: 'Age', prop: 'age' },
    { name: 'Address', prop: 'address' },
    { name: 'City', prop: 'city' },
    { name: 'State', prop: 'state' },
    { name: 'Zip code', prop: 'zipCode' },
  ];


  // Define plugin
  grid.plugins = [RowTransposePlugin, ColumnStretchPlugin, RowOddPlugin];
  grid.theme = isDark() ? 'darkMaterial' : 'material';


  // Define additional data
  Object.assign(grid, {
    transpose: {
      transposedRowHeader: { columnTemplate: () => '' },
      transposedColumnHeader: { columnTemplate: () => '' },
      hideColumnHeader: true,
    },
    stretch: 'all',
    colSize: 150,
  });


  grid.addEventListener('beforeedit', async (e) => {
    const model = e.detail.model as TransposedRow;
    // Example how to transform TransposedRow to original model
    console.log(
      'beforeedit',
      e.detail,
      model.getOriginalModels([e.detail.prop]),
    );
  });


  grid.hideAttribution = true;


  const container = document.createElement('div');
  container.style.display = 'flex';
  container.style.flexDirection = 'column';
  container.style.gap = '0.5rem';


  const buttonContainer = document.createElement('div');
  const button = createControl(document, 'button');
  button.innerText = 'Transpose Rows';
  button.className = controlAttributes('button', { class: 'rv-btn' }).class;
  button.onclick = async () => {
    const plugins = await grid.getPlugins();
    const plugin = plugins.find(
      (p) => p instanceof RowTransposePlugin,
    ) as RowTransposePlugin;
    plugin?.transpose();
    if (plugin.isTransposed) {
      grid.rowDefinitions = [
        {
          type: 'rgRow',
          size: 150,
          index: 0,
        },
      ];
      grid.colSize = 250;
    } else {
      grid.rowDefinitions = [];
      grid.colSize = 100;
    }
  };
  buttonContainer.appendChild(button);
  container.appendChild(buttonContainer);
  container.appendChild(grid);


  parent.appendChild(container);
  grid.source = makeData(10);
}

Key Features

  • Toggle Transpose: Switch between the original view and the transposed view. - Dynamic Headers: Customizable transposed headers for better data representation. - Custom Transpose Configuration: Define how the columns and rows should be transformed, including whether to transpose column headers into rows.

How Transposing Works

Section titled “How Transposing Works”

The plugin offers two primary functionalities:

  • Original View: Displays rows and columns as defined in your data model.
  • Transposed View: When activated, this feature converts rows into columns and columns into rows.

The RowTransposePlugin listens for the row-transpose. When triggered, it switches between the original view and the transposed view while preserving the original structure, allowing you to revert to the standard view at any time.

Alternatively, you can access the plugin directly using the following JavaScript code:

document
  .querySelector('revo-grid')
  .getPlugins()
  .then((plugins) => {
    const plugin = plugins.find((p) => p instanceof RowTransposePlugin);
    plugin?.transpose();
  });

When the rows are transposed, RevoGrid enters a virtual transposed mode. This means that events related to row and column edits will return instances of the TransposedRow class, which represent the transposed data model. If you wish to retrieve the original model, you can use the TransposedRow.getOriginalModels method. This method takes transposed column properties as input and converts the corresponding transposed cell back to the original model.

For example:

document
  .querySelector('revo-grid')
  .addEventListener('beforeedit', async (e) => {
    const model = e.detail.model;
    console.log('beforeedit', model.getOriginalModels([e.detail.prop])); // returns original row model
  });

Customizing the Transpose

Section titled “Customizing the Transpose”

The plugin configuration allows you to fine-tune the transposing process. For example, you can choose to transpose the column headers into rows, or leave them unchanged.

document.querySelector('revo-grid').additionalData = {
  transpose: {
    transposedRowHeader: { cellTemplate: () => '', columnTemplate: () => '' }, // defined row/header template
    transposedColumnHeader: { columnTemplate: () => '' }, // template for transposed columns
  },
};

Conclusion

Section titled “Conclusion”

The Row Transpose Plugin is a powerful tool for displaying data in different formats within RevoGrid. Whether you’re working with complex datasets that require pivoting or simply need to view your data from a different perspective, this plugin provides the flexibility to switch between views seamlessly. With customizable options for how rows and columns are transposed, you can easily tailor the grid to your needs.