JavaScript Data Grid Custom renderer in Angular

Table of contents

• Overview
• Example
• Related articles
  • Related guides
  • Related API reference

Overview

The following example is an implementation of @handsontable/angular with a custom renderer added. It takes an image URL as the input and renders the image in the edited cell.

Example

// app.component.ts import { Component } from '@angular/core'; import Handsontable from 'handsontable/base'; import { textRenderer } from 'handsontable/renderers/textRenderer'; @Component({ selector: 'app-root', template: ` <div> <hot-table [settings]="hotSettings"></hot-table> </div> `, }) class AppComponent { hotSettings: Handsontable.GridSettings = { data: [ ['A1', 'https://handsontable.com/docs/12.1/img/examples/professional-javascript-developers-nicholas-zakas.jpg'], ['A2', 'https://handsontable.com/docs/12.1/img/examples/javascript-the-good-parts.jpg'] ], columns: [ {}, { renderer(instance, td, row, col, prop, value, cellProperties) { const img = document.createElement('img'); img.src = value; img.addEventListener('mousedown', event => { event.preventDefault(); }); td.innerText = ''; td.appendChild(img); return td; } } ], colHeaders: true, rowHeights: 55, height: 'auto', licenseKey: 'non-commercial-and-evaluation' }; } // app.module.ts import { NgModule } from '@angular/core'; import { BrowserModule } from '@angular/platform-browser'; import { HotTableModule } from '@handsontable/angular'; import { registerAllModules } from 'handsontable/registry'; // register Handsontable's modules registerAllModules(); @NgModule({ imports: [ BrowserModule, HotTableModule ], declarations: [ AppComponent ], bootstrap: [ AppComponent ] }) class AppModule { } // bootstrap import { platformBrowserDynamic } from '@angular/platform-browser-dynamic'; platformBrowserDynamic().bootstrapModule(AppModule).catch(err => { console.error(err) }); <script src="https://cdn.jsdelivr.net/npm/handsontable@12.1/dist/handsontable.full.min.js"></script> <link type="text/css" rel="stylesheet" href="https://cdn.jsdelivr.net/npm/handsontable@12.1/dist/handsontable.full.min.css" /> <script src="https://handsontable.com/docs/12.1/scripts/fixer.js"></script> <script src="https://handsontable.com/docs/12.1/scripts/helpers.js"></script> <script src="https://cdn.jsdelivr.net/npm/rxjs@6/bundles/rxjs.umd.js"></script> <script src="https://cdn.jsdelivr.net/npm/core-js@2/client/core.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/zone.js@0.9/dist/zone.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/@angular/compiler@8/bundles/compiler.umd.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/@angular/core@8/bundles/core.umd.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/@angular/common@8/bundles/common.umd.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/@angular/platform-browser@8/bundles/platform-browser.umd.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/@angular/platform-browser-dynamic@8/bundles/platform-browser-dynamic.umd.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/@handsontable/angular@12.1/bundles/handsontable-angular.umd.min.js"></script> <app-root></app-root>

// app.component.ts
import { Component } from '@angular/core';
import Handsontable from 'handsontable/base';
import { textRenderer } from 'handsontable/renderers/textRenderer';

@Component({
  selector: 'app-root',
  template: `
  <div>
    <hot-table [settings]="hotSettings"></hot-table>
  </div>
  `,
})
class AppComponent {
  hotSettings: Handsontable.GridSettings = {
    data:
      [
        ['A1', 'https://handsontable.com/docs/12.1/img/examples/professional-javascript-developers-nicholas-zakas.jpg'],
        ['A2', 'https://handsontable.com/docs/12.1/img/examples/javascript-the-good-parts.jpg']
      ],
    columns: [
      {},
      {
        renderer(instance, td, row, col, prop, value, cellProperties) {
          const img = document.createElement('img');

          img.src = value;

          img.addEventListener('mousedown', event => {
            event.preventDefault();
          });

          td.innerText = '';
          td.appendChild(img);

          return td;
        }
      }
    ],
    colHeaders: true,
    rowHeights: 55,
    height: 'auto',
    licenseKey: 'non-commercial-and-evaluation'
  };
}

// app.module.ts
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { HotTableModule } from '@handsontable/angular';
import { registerAllModules } from 'handsontable/registry';

// register Handsontable's modules
registerAllModules();

@NgModule({
  imports:      [ BrowserModule, HotTableModule ],
  declarations: [ AppComponent ],
  bootstrap:    [ AppComponent ]
})
class AppModule { }

// bootstrap
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';

platformBrowserDynamic().bootstrapModule(AppModule).catch(err => { console.error(err) });

<app-root></app-root>

Related articles

Related guides

• Cell renderer

Related API reference

• APIs:
  • BasePlugin
• Configuration options:
  • renderer
• Core methods:
  • getCellMeta()
  • getCellMetaAtRow()
  • getCellsMeta()
  • getCellRenderer()
  • setCellMeta()
  • setCellMetaObject()
  • removeCellMeta()
• Hooks:
  • afterGetCellMeta
  • afterGetColumnHeaderRenderers
  • afterGetRowHeaderRenderers
  • afterRenderer
  • beforeGetCellMeta
  • beforeRenderer