Formula picker
The formula picker feature allows users to automatically generate range strings in external HTML elements by selecting cells on a JSS spreadsheet with their mouse.
Documentation
Options
To customize the integration of the formula picker in your application, you can use the following options.
Method | Description |
type?: 'default' | 'picker' |
Define the render type. |
onchange?: function |
The function is triggered when the user completes the selection of cells in the data grid.
onchange(element: HTMLElement, mouseEvent: object) => void |
onupdate?: function |
The function is triggered when the user moves their mouse to update the cell selection in the data grid.
onupdate(element: HTMLElement, mouseEvent: object) => void |
Syntax
jspreadsheet.picker(document.getElementById('picker'), {
type: 'picker',
onchange: function(v) {
// Do something
}
});
Example
Create a javascript formula picker using Jspreadsheet.
JavaScript example
<html>
<script src="https://jspreadsheet.com/v10/jspreadsheet.js"></script>
<script src="https://jsuites.net/v5/jsuites.js"></script>
<link rel="stylesheet" href="https://jspreadsheet.com/v10/jspreadsheet.css" type="text/css" />
<link rel="stylesheet" href="https://jsuites.net/v5/jsuites.css" type="text/css" />
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Material+Icons" />
<div id="picker" style="max-width: 320px;"></div>
<div id="data-grid"></div>
<script>
// Set your JSS license key (The following key only works for one day)
jspreadsheet.setLicense('YzRmYjQ2Yzg5NmZlODM3N2I1NDQ0YzMwYjM0ZDY0ZTU0ZDQ5OGE2NzdiZTI3M2FjOGI5NzBkZTMxNTQ1ODVlMTdmNDcyYjA4ZTM1MGEyNjg5YTIyZTJhYzE5ZTljM2JlZDVmMTNmMjZlYjFiOTk0ZGVjOGZiODY1M2UwMzRlMWYsZXlKdVlXMWxJam9pU25Od2NtVmhaSE5vWldWMElpd2laR0YwWlNJNk1UY3dNak0zTWprMk9Dd2laRzl0WVdsdUlqcGJJbXB6Y0hKbFlXUnphR1ZsZEM1amIyMGlMQ0pqYjJSbGMyRnVaR0p2ZUM1cGJ5SXNJbXB6YUdWc2JDNXVaWFFpTENKamMySXVZWEJ3SWl3aWQyVmlJaXdpYkc5allXeG9iM04wSWwwc0luQnNZVzRpT2lJek5DSXNJbk5qYjNCbElqcGJJblkzSWl3aWRqZ2lMQ0oyT1NJc0luWXhNQ0lzSW1Ob1lYSjBjeUlzSW1admNtMXpJaXdpWm05eWJYVnNZU0lzSW5CaGNuTmxjaUlzSW5KbGJtUmxjaUlzSW1OdmJXMWxiblJ6SWl3aWFXMXdiM0owWlhJaUxDSmlZWElpTENKMllXeHBaR0YwYVc5dWN5SXNJbk5sWVhKamFDSXNJbkJ5YVc1MElpd2ljMmhsWlhSeklsMHNJbVJsYlc4aU9uUnlkV1Y5');
// Create the spreadsheet
jspreadsheet(document.getElementById('data-grid'), {
worksheets: [{
minDimensions: [8,8],
}]
});
jspreadsheet.picker(document.getElementById('picker'), {
type: 'picker',
onchange: function() {
// Do something
}
});
</script>
</html>
React example
import React, { useRef, useEffect } from "react";
import { Spreadsheet, Worksheet, jspreadsheet } from "@jspreadsheet/react";
// Set your JSS license key (The following key only works for one day)
jspreadsheet.setLicense('YzRmYjQ2Yzg5NmZlODM3N2I1NDQ0YzMwYjM0ZDY0ZTU0ZDQ5OGE2NzdiZTI3M2FjOGI5NzBkZTMxNTQ1ODVlMTdmNDcyYjA4ZTM1MGEyNjg5YTIyZTJhYzE5ZTljM2JlZDVmMTNmMjZlYjFiOTk0ZGVjOGZiODY1M2UwMzRlMWYsZXlKdVlXMWxJam9pU25Od2NtVmhaSE5vWldWMElpd2laR0YwWlNJNk1UY3dNak0zTWprMk9Dd2laRzl0WVdsdUlqcGJJbXB6Y0hKbFlXUnphR1ZsZEM1amIyMGlMQ0pqYjJSbGMyRnVaR0p2ZUM1cGJ5SXNJbXB6YUdWc2JDNXVaWFFpTENKamMySXVZWEJ3SWl3aWQyVmlJaXdpYkc5allXeG9iM04wSWwwc0luQnNZVzRpT2lJek5DSXNJbk5qYjNCbElqcGJJblkzSWl3aWRqZ2lMQ0oyT1NJc0luWXhNQ0lzSW1Ob1lYSjBjeUlzSW1admNtMXpJaXdpWm05eWJYVnNZU0lzSW5CaGNuTmxjaUlzSW5KbGJtUmxjaUlzSW1OdmJXMWxiblJ6SWl3aWFXMXdiM0owWlhJaUxDSmlZWElpTENKMllXeHBaR0YwYVc5dWN5SXNJbk5sWVhKamFDSXNJbkJ5YVc1MElpd2ljMmhsWlhSeklsMHNJbVJsYlc4aU9uUnlkV1Y5');
export default function App() {
// Spreadsheet array of worksheets
const spreadsheet = useRef();
const picker = useRef();
useEffect(() => {
jspreadsheet.picker(picker.current, {
type: 'picker',
onchange: function() {
// Do something
}
});
});
// Render component
return (
<>
<div ref={picker} />
<Spreadsheet ref={spreadsheet} license={license}>
<Worksheet />
</Spreadsheet>
</>
);
}
Vue example
<template>
<div ref="picker" />
<Spreadsheet ref="spreadsheet" :license="license">
<Worksheet />
</Spreadsheet>
</template>
<script>
import { Spreadsheet, Worksheet } from "@jspreadsheet/vue";
const license = 'YzRmYjQ2Yzg5NmZlODM3N2I1NDQ0YzMwYjM0ZDY0ZTU0ZDQ5OGE2NzdiZTI3M2FjOGI5NzBkZTMxNTQ1ODVlMTdmNDcyYjA4ZTM1MGEyNjg5YTIyZTJhYzE5ZTljM2JlZDVmMTNmMjZlYjFiOTk0ZGVjOGZiODY1M2UwMzRlMWYsZXlKdVlXMWxJam9pU25Od2NtVmhaSE5vWldWMElpd2laR0YwWlNJNk1UY3dNak0zTWprMk9Dd2laRzl0WVdsdUlqcGJJbXB6Y0hKbFlXUnphR1ZsZEM1amIyMGlMQ0pqYjJSbGMyRnVaR0p2ZUM1cGJ5SXNJbXB6YUdWc2JDNXVaWFFpTENKamMySXVZWEJ3SWl3aWQyVmlJaXdpYkc5allXeG9iM04wSWwwc0luQnNZVzRpT2lJek5DSXNJbk5qYjNCbElqcGJJblkzSWl3aWRqZ2lMQ0oyT1NJc0luWXhNQ0lzSW1Ob1lYSjBjeUlzSW1admNtMXpJaXdpWm05eWJYVnNZU0lzSW5CaGNuTmxjaUlzSW5KbGJtUmxjaUlzSW1OdmJXMWxiblJ6SWl3aWFXMXdiM0owWlhJaUxDSmlZWElpTENKMllXeHBaR0YwYVc5dWN5SXNJbk5sWVhKamFDSXNJbkJ5YVc1MElpd2ljMmhsWlhSeklsMHNJbVJsYlc4aU9uUnlkV1Y5';
export default {
components: {
Spreadsheet,
Worksheet,
},
mounted() {
jspreadsheet.picker(this.$refs.picker.value, {
type: 'picker',
onchange: function() {
// Do something
}
});
},
data() {
return {
license,
};
}
}
</script>
Angular example
import { Component, ViewChild, ElementRef } from "@angular/core";
import * as jspreadsheet from "jspreadsheet";
// Set your JSS license key (The following key only works for one day)
jspreadsheet.setLicense('YzRmYjQ2Yzg5NmZlODM3N2I1NDQ0YzMwYjM0ZDY0ZTU0ZDQ5OGE2NzdiZTI3M2FjOGI5NzBkZTMxNTQ1ODVlMTdmNDcyYjA4ZTM1MGEyNjg5YTIyZTJhYzE5ZTljM2JlZDVmMTNmMjZlYjFiOTk0ZGVjOGZiODY1M2UwMzRlMWYsZXlKdVlXMWxJam9pU25Od2NtVmhaSE5vWldWMElpd2laR0YwWlNJNk1UY3dNak0zTWprMk9Dd2laRzl0WVdsdUlqcGJJbXB6Y0hKbFlXUnphR1ZsZEM1amIyMGlMQ0pqYjJSbGMyRnVaR0p2ZUM1cGJ5SXNJbXB6YUdWc2JDNXVaWFFpTENKamMySXVZWEJ3SWl3aWQyVmlJaXdpYkc5allXeG9iM04wSWwwc0luQnNZVzRpT2lJek5DSXNJbk5qYjNCbElqcGJJblkzSWl3aWRqZ2lMQ0oyT1NJc0luWXhNQ0lzSW1Ob1lYSjBjeUlzSW1admNtMXpJaXdpWm05eWJYVnNZU0lzSW5CaGNuTmxjaUlzSW5KbGJtUmxjaUlzSW1OdmJXMWxiblJ6SWl3aWFXMXdiM0owWlhJaUxDSmlZWElpTENKMllXeHBaR0YwYVc5dWN5SXNJbk5sWVhKamFDSXNJbkJ5YVc1MElpd2ljMmhsWlhSeklsMHNJbVJsYlc4aU9uUnlkV1Y5');
@Component({
selector: "app-root",
template: `<div #picker></div>
<div #spreadsheet></div>`
})
export class AppComponent {
@ViewChild("spreadsheet") spreadsheet: ElementRef;
@ViewChild("picker") picker: ElementRef;
// Worksheets
worksheets: jspreadsheet.worksheetInstance[];
// Create a new data grid
ngOnInit() {
// Create the spreadsheet
this.worksheets = jspreadsheet(this.spreadsheet.nativeElement, {
worksheets: [{
minDimensions: [8,8],
}]
});
jspreadsheet.picker(this.picker.nativeElement, {
type: 'picker',
onchange: function() {
// Do something
}
});
}
}