Custom Spreadsheet Column Type
Jspreadsheet is a javascript data grid with spreadsheet-like controls that gives developers a lot of flexibility. The following example shows how to integrate a third-party clock plugin as a custom column. From version 8, the editor is created once, and it is the same during the entire lifecycle of the application.
A custom column based on the clockpicker plugin by weareoutman.
<html>
<script src="https://jspreadsheet.com/v8/jspreadsheet.js"></script>
<script src="https://jsuites.net/v5/jsuites.js"></script>
<link rel="stylesheet" href="https://jspreadsheet.com/v8/jspreadsheet.css" type="text/css" />
<link rel="stylesheet" href="https://jsuites.net/v5/jsuites.css" type="text/css" />
<link rel="stylesheet" type="text/css"
href="http://weareoutman.github.io/clockpicker/dist/jquery-clockpicker.min.css" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js"></script>
<script src="http://weareoutman.github.io/clockpicker/dist/jquery-clockpicker.min.js"></script>
<div id="custom"></div>
<script>
let clockEditor = function() {
// Create the editor once to persist the whole lifecycle of the spreadsheet
let editor = document.createElement('input');
editor.classList.add('jss_object');
editor.type = 'text';
editor.style.width = '100%';
// Close event
let closeEvent = null;
// Create instance of the clock picker
$(editor).clockpicker({ afterDone: function() {
closeEvent();
}});
// JSS editor
let methods = {};
methods.createCell = function(cell, value, x, y, instance, options) {
cell.innerHTML = value;
}
methods.updateCell = function(cell, value, x, y, instance, options) {
if (cell) {
cell.innerHTML = value;
}
}
methods.openEditor = function(cell, value, x, y, instance, options) {
// Append the clock picker to the input container
instance.parent.input.appendChild(editor);
// Make sure input container is not editable
instance.parent.input.setAttribute('contentEditable', false);
// Set the current value
editor.value = value;
// Focus to open the clock picker
editor.focus();
// Make sure JSS object class is set to keep the focus on the spreadsheet
if (! document.querySelector('.clockpicker-popover').classList.contains('jss_object')) {
document.querySelector('.clockpicker-popover').classList.add('jss_object');
}
// Update close event
closeEvent = function() {
instance.closeEditor(cell, true);
}
}
methods.closeEditor = function(cell, save, x, y, instance, options) {
if (save) {
cell.innerHTML = editor.value;
} else {
cell.innerHTML = '';
}
// Return value
return cell.innerHTML;
}
return methods;
}();
// Set the JSS spreadsheet license
jspreadsheet.setLicense('NTU4NTVhYWJjZmYzYWY2ZTE4ZjczYTE0MmEyNmI2OTQ5YzNhODY4OTM0NTg2NzU4ZmJkYWQ3MmEyOTUwMzVmZGM1N2E0NTM1NTkyYTQ5MDI4YjFiNGRmYmE1OTk0ODk3MmE0YWYzMDAxOTcyZDQwMjY1NmU5MjcwZGJkYzhiOGQsZXlKamJHbGxiblJKWkNJNklpSXNJbTVoYldVaU9pSktjM0J5WldGa2MyaGxaWFFpTENKa1lYUmxJam94TnpFME1ETTJOekl4TENKa2IyMWhhVzRpT2xzaWFuTndjbVZoWkhOb1pXVjBMbU52YlNJc0ltTnZaR1Z6WVc1a1ltOTRMbWx2SWl3aWFuTm9aV3hzTG01bGRDSXNJbU56WWk1aGNIQWlMQ0ozWldJaUxDSnNiMk5oYkdodmMzUWlYU3dpY0d4aGJpSTZJak0wSWl3aWMyTnZjR1VpT2xzaWRqY2lMQ0oyT0NJc0luWTVJaXdpZGpFd0lpd2lkakV4SWl3aVkyaGhjblJ6SWl3aVptOXliWE1pTENKbWIzSnRkV3hoSWl3aWNHRnljMlZ5SWl3aWNtVnVaR1Z5SWl3aVkyOXRiV1Z1ZEhNaUxDSnBiWEJ2Y25SbGNpSXNJbUpoY2lJc0luWmhiR2xrWVhScGIyNXpJaXdpYzJWaGNtTm9JaXdpY0hKcGJuUWlMQ0p6YUdWbGRITWlMQ0pqYkdsbGJuUWlMQ0p6WlhKMlpYSWlMQ0p6YUdGd1pYTWlYU3dpWkdWdGJ5STZkSEoxWlgwPQ==');
// Create the spreadsheet
jspreadsheet(document.getElementById('custom'), {
worksheets: [{
data: [
['PHP', '14:00'],
['Javascript', '16:30'],
],
columns: [
{
type: 'text',
title: 'Course Title',
width: '300px'
},
{
type: clockEditor,
title: 'Time',
width: '200px'
},
]
}]
});
</script>
</html>