ColorPicker

ColorPicker is a type of drop-down in SpreadJS. Using JavaScript code, the developer can define either the default or custom color picker as a style that can be applied to cells in the workbook. The below spreadsheet shows those two variations.

Description
app.vue
index.html
Copy to CodeMine

Drop-downs provide a developer the ability to add a drop-down menu with specific properties to cells in a workbook. These drop-down menus don't require any extra code other than simply specifying which one to use for the drop-down menu.

SpreadJS has 9 different kinds of drop-downs, and this demo shows how to use the Color Picker.

You can use ColorPicker drop-down like the following code :

    // The way of click the dropdown icon to open ColorPicker. 
    var style = new GC.Spread.Sheets.Style();
    style.cellButtons = [
        {
            imageType: GC.Spread.Sheets.ButtonImageType.dropdown,
                command: "openColorPicker",
                useButtonStyle: true,
            }
        ];
    sheet.setText(4, 3, "Default Color Picker");
    sheet.setStyle(5, 3, style);

    // The way just open ColorPicker with command rather then clicking the dropdown button.
    spread.commandManager().execute({cmd:"openColorPicker",row:5,col:3,sheetName:"Sheet1"});

If you want to customize the ColorPicker, you can use these options :

  • colorBlockSize: number : Specify every color cell's size.

  • groups: IColorGroup[] : Specify the group of the color picker, every group accept a name as group name, and a color array as the group's colors.

  • needScaleColor: boolean : Specify whether to generate scale color group.

For example:

let style = new GC.Spread.Sheets.Style();
style.dropDowns = [
    {
        type: GC.Spread.Sheets.DropDownType.colorPicker,
        option: option
    }
];

// interface of option
export interface IColorPickerOption{
    colorBlockSize?: number;
    groups?: GC.Spread.Sheets.IColorPickerGroup[];
}
export interface IColorPickerGroup{
    name: string;
    colors: string[][];
    needScaleColor?: boolean;
}
Drop-downs provide a developer the ability to add a drop-down menu with specific properties to cells in a workbook. These drop-down menus don't require any extra code other than simply specifying which one to use for the drop-down menu. SpreadJS has 9 different kinds of drop-downs, and this demo shows how to use the Color Picker. You can use ColorPicker drop-down like the following code : If you want to customize the ColorPicker, you can use these options : colorBlockSize: number : Specify every color cell's size. groups: IColorGroup[] : Specify the group of the color picker, every group accept a name as group name, and a color array as the group's colors. needScaleColor: boolean : Specify whether to generate scale color group. For example:
<template> <div class="sample-tutorial"> <gc-spread-sheets class="sample-spreadsheets" @workbookInitialized="initSpread"> </gc-spread-sheets> </div> </template> <script setup> import '@mescius/spread-sheets-vue'; import GC from '@mescius/spread-sheets'; import { ref } from "vue"; const spreadRef = ref(null); function initSpread(spread) { spreadRef.value = spread; let sheet = spread.getSheet(0); sheet.suspendPaint(); let style = new GC.Spread.Sheets.Style(); style.cellButtons = [{ imageType: GC.Spread.Sheets.ButtonImageType.dropdown, command: "openColorPicker", useButtonStyle: true, }]; sheet.setText(4, 3, "Default Color Picker"); sheet.setStyle(5, 3, style); // -------------------- Custom Calculator --------------------- let colorGroup1 = { name: 'group1', colors: [ ['#ffffff', '#000000', '#e7e6e6', '#44546a', '#5b9bd5', '#ed7d31', '#a5a5a5', '#ffc000', '#4472c4', '#70ad47'], ['#f2f2f2', '#7f7f7f', '#d1d0d0', '#d6dde4', '#dfebf6', '#fae6d7', '#ececec', '#fdf3ce', '#dae3f2', '#e3efda'] ] }; let colorGroup2 = { name: 'group2', colors: [ ['#d8d8d8', '#595959', '#aeadac', '#aeb9c8', '#c0d7ed', '#f4ccaf', '#dadada', '#fce69d', '#b6c7e6', '#c8dfb5'], ['#bfbfbf', '#3f3f3f', '#777171', '#8797ae', '#9fc3e4', '#f0b186', '#c8c8c8', '#fbd96c', '#91acda', '#add091'] ] }; let colorGroup3 = { name: 'group3', colors: [ ['#a5a5a5', '#252525', '#3c3939', '#344051', '#3977b6', '#c35a15', '#7c7c7c', '#bd9014', '#355696', '#5a8339'], ['#7f7f7f', '#0b0b0b', '#171615', '#222a35', '#264f79', '#823c0d', '#525252', '#7e600a', '#223a64', '#3b5825'] ] }; let customStyle = new GC.Spread.Sheets.Style(); customStyle.cellButtons = [{ imageType: GC.Spread.Sheets.ButtonImageType.dropdown, command: "openColorPicker", useButtonStyle: true, }]; customStyle.dropDowns = [{ type: GC.Spread.Sheets.DropDownType.colorPicker, option: { colorBlockSize: 20, groups: [ colorGroup1, colorGroup2, colorGroup3 ] } }]; sheet.setText(4, 11, "Custom Color Picker"); sheet.setStyle(5, 11, customStyle); sheet.resumePaint(); spread.commandManager().execute({ cmd: "openColorPicker", row: 5, col: 3, sheetName: "Sheet1" }); } </script> <style scoped> #app { height: 100%; } .sample-tutorial { position: relative; height: 100%; overflow: hidden; } .sample-spreadsheets { width: 100%; height: 100%; overflow: hidden; float: left; } body { position: absolute; top: 0; bottom: 0; left: 0; right: 0; } </style>
<!DOCTYPE html> <html style="height:100%;font-size:14px;"> <head> <meta charset="utf-8" /> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <title>SpreadJS VUE</title> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <link rel="stylesheet" type="text/css" href="$DEMOROOT$/en/vue3/node_modules/@mescius/spread-sheets/styles/gc.spread.sheets.excel2013white.css"> <script src="$DEMOROOT$/en/vue3/node_modules/systemjs/dist/system.src.js"></script> <script src="systemjs.config.js"></script> <script src="compiler.js" type="module"></script> <script> var System = SystemJS; System.import("./src/app.js"); System.import('$DEMOROOT$/en/lib/vue3/license.js'); </script> </head> <body> <div id="app"></div> </body> </html>
(function (global) { SystemJS.config({ transpiler: 'plugin-babel', babelOptions: { es2015: true }, paths: { // paths serve as alias 'npm:': 'node_modules/' }, packageConfigPaths: [ './node_modules/*/package.json', "./node_modules/@mescius/*/package.json", "./node_modules/@babel/*/package.json", "./node_modules/@vue/*/package.json" ], map: { 'vue': "npm:vue/dist/vue.esm-browser.js", 'tiny-emitter': 'npm:tiny-emitter/index.js', 'plugin-babel': 'npm:systemjs-plugin-babel/plugin-babel.js', "systemjs-babel-build": "npm:systemjs-plugin-babel/systemjs-babel-browser.js", '@mescius/spread-sheets': 'npm:@mescius/spread-sheets/index.js', '@mescius/spread-sheets-vue': 'npm:@mescius/spread-sheets-vue/index.js', }, meta: { '*.css': { loader: 'systemjs-plugin-css' }, '*.vue': { loader: "../plugin-vue/index.js" } } }); })(this);