Sheets Reorder

You can reorder Worksheets and TableSheets by reordering the tabs of tab strip.

Description
app.jsx
app-func.jsx
app-class.jsx
index.html
styles.css
Copy to CodeMine

You can get the sheet position by using the getSheetPosition method, for example:

/**
 * Gets the sheet tab position with the specified name.
 * @param {string} name The sheet tab name.
 * @returns {number} The sheet tab position, based on the Worksheet and TableSheet collection.
 */
getSheetPosition(sheetName: string): number;

//This example uses the getSheetPosition method.
spread.setSheetCount(5);
spread.addSheetTab(0, "tableSheet1", GC.Spread.Sheets.SheetType.tableSheet);
var position = spread.getSheetPosition("tableSheet1");
console.log(position); // 5

You can also change the sheet position by using the changeSheetPosition method, for example:

/**
 * Change sheet position and reorder sheets.
 * @param {string} sheetName The sheet name.
 * @param {number} targetPosition The target position.
 */
changeSheetPosition(sheetName: string, targetPosition: number): boolean;

//This example show how to change sheet position.
spread.setSheetCount(5);
spread.addSheetTab(0, "tableSheet1", GC.Spread.Sheets.SheetType.tableSheet); // The sheets sequence should be "Sheet1", "Sheet2", "Sheet3", "Sheet4", "Sheet5", "tableSheet1".
spread.changeSheetPosition("tableSheet1", 3); // The sheets sequence should be "Sheet1", "Sheet2", "Sheet3", "tableSheet1", "Sheet4", "Sheet5".

In addition, the sub property sheetPosition is added for event GC.Spread.Sheets.Events.SheetChanging and event GC.Spread.Sheets.Events.SheetChanged.

spread.bind(GC.Spread.Sheets.Events.SheetChanging, function (e, args) {
    console.log(args.sheetPosition);
});

spread.bind(GC.Spread.Sheets.Events.SheetChanged, function (e, args) {
    console.log(args.sheetPosition);
});
You can get the sheet position by using the getSheetPosition method, for example: You can also change the sheet position by using the changeSheetPosition method, for example: In addition, the sub property sheetPosition is added for event GC.Spread.Sheets.Events.SheetChanging and event GC.Spread.Sheets.Events.SheetChanged.
import * as React from 'react'; import * as ReactDOM from 'react-dom'; import { AppFunc } from './app-func'; import { App } from './app-class'; // 1. Functional Component sample ReactDOM.render(<AppFunc />, document.getElementById('app')); // 2. Class Component sample // ReactDOM.render(<App />, document.getElementById('app'));
/*REPLACE_MARKER*/ /*DO NOT DELETE THESE COMMENTS*/ import * as React from 'react'; import { useState } from 'react'; import GC from '@mescius/spread-sheets'; import '@mescius/spread-sheets-tablesheet'; import { SpreadSheets, Worksheet } from '@mescius/spread-sheets-react'; import './styles.css'; let spread = null; export function AppFunc() { const [state, setState] = useState({ sheetPosition: "" }); const initSpread = (sjs) => { spread = sjs; spread.suspendPaint(); spread.options.autoFitType = GC.Spread.Sheets.AutoFitType.cellWithHeader; //init a data manager var tableName = "Supplier"; var baseApiUrl = getBaseApiUrl(); var apiUrl = baseApiUrl + "/" + tableName; var dataManager = spread.dataManager(); var myTable = dataManager.addTable("myTable", { remote: { read: { url: apiUrl } } }); //init a table sheet var sheet = spread.addSheetTab(0, "TableSheet1", GC.Spread.Sheets.SheetType.tableSheet); sheet.options.allowAddNew = false; //hide new row //bind a view to the table sheet myTable.fetch().then(function () { var style = { formatter: 'MM/dd/yyyy' }; var view = myTable.addView("myView", [ { value: "Id", width: 80 }, { value: "CompanyName", width: 200, caption: "Company Name" }, { value: "ContactName", width: 150, caption: "Contact" }, { value: "ContactTitle", width: 200, caption: "Title" }, { value: "Address", width: 200 }, { value: "City", width: 150, caption: "City" }, { value: "State", width: 100, caption: "State" }, { value: "Region", width: 100, caption: "Region" } ]); sheet.setDataView(view); }); spread.resumePaint(); } const onClick = ($event) => { setState({ sheetPosition: getSheetPositionInfo(spread) }); } return <div class="sample-tutorial"> <div class="sample-spreadsheets"> <SpreadSheets workbookInitialized={spread => initSpread(spread)}> <Worksheet></Worksheet> <Worksheet></Worksheet> <Worksheet></Worksheet> </SpreadSheets> </div> <div class="options-container"> <div class="option-row"> <input type="button" id="getSheetPosition" value="Get Sheet Position" onClick={e => onClick(e)} /> </div> <div class="option-row"> <input id="sheetPosition" value={state.sheetPosition} /> </div> </div> </div>; } function getSheetPositionInfo(spread) { let sheetName, sheet = spread.getActiveSheet(); if (sheet) { sheetName = sheet.name(); } else { sheet = spread.getActiveSheetTab(); if (sheet) { sheetName = sheet.name(); } } if (sheetName) { return sheetName + "'s position is " + spread.getSheetPosition(sheetName); } else { return ""; } } function getBaseApiUrl() { return window.location.href.match(/http.+spreadjs\/demos\//)[0] + 'server/api'; }
/*REPLACE_MARKER*/ /*DO NOT DELETE THESE COMMENTS*/ import * as React from 'react'; import GC from '@mescius/spread-sheets'; import '@mescius/spread-sheets-tablesheet'; import { SpreadSheets, Worksheet } from '@mescius/spread-sheets-react'; import './styles.css'; const Component = React.Component; export class App extends Component { constructor(props) { super(props); this.spread = null; this.state = { sheetPosition: "" }; } render() { return <div class="sample-tutorial"> <div class="sample-spreadsheets"> <SpreadSheets workbookInitialized={spread => this.initSpread(spread)}> <Worksheet></Worksheet> <Worksheet></Worksheet> <Worksheet></Worksheet> </SpreadSheets> </div> <div class="options-container"> <div class="option-row"> <input type="button" id="getSheetPosition" value="Get Sheet Position" onClick={e => this.onClick(e)} /> </div> <div class="option-row"> <input id="sheetPosition" value={this.state.sheetPosition} /> </div> </div> </div>; } initSpread(spread) { this.spread = spread; spread.suspendPaint(); spread.options.autoFitType = GC.Spread.Sheets.AutoFitType.cellWithHeader; //init a data manager var tableName = "Supplier"; var baseApiUrl = getBaseApiUrl(); var apiUrl = baseApiUrl + "/" + tableName; var dataManager = spread.dataManager(); var myTable = dataManager.addTable("myTable", { remote: { read: { url: apiUrl } } }); //init a table sheet var sheet = spread.addSheetTab(0, "TableSheet1", GC.Spread.Sheets.SheetType.tableSheet); sheet.options.allowAddNew = false; //hide new row //bind a view to the table sheet myTable.fetch().then(function () { var style = { formatter: 'MM/dd/yyyy' }; var view = myTable.addView("myView", [ { value: "Id", width: 80 }, { value: "CompanyName", width: 200, caption: "Company Name" }, { value: "ContactName", width: 150, caption: "Contact" }, { value: "ContactTitle", width: 200, caption: "Title" }, { value: "Address", width: 200 }, { value: "City", width: 150, caption: "City" }, { value: "State", width: 100, caption: "State" }, { value: "Region", width: 100, caption: "Region" } ]); sheet.setDataView(view); }); spread.resumePaint(); } onClick($event) { this.setState({sheetPosition: getSheetPositionInfo(this.spread)}); } } function getSheetPositionInfo(spread) { let sheetName, sheet = spread.getActiveSheet(); if (sheet) { sheetName = sheet.name(); } else { sheet = spread.getActiveSheetTab(); if (sheet) { sheetName = sheet.name(); } } if (sheetName) { return sheetName + "'s position is " + spread.getSheetPosition(sheetName); } else { return ""; } } function getBaseApiUrl() { return window.location.href.match(/http.+spreadjs\/demos\//)[0] + 'server/api'; }
<!doctype html> <html style="height:100%;font-size:14px;"> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <link rel="stylesheet" type="text/css" href="$DEMOROOT$/en/react/node_modules/@mescius/spread-sheets/styles/gc.spread.sheets.excel2013white.css"> <!-- SystemJS --> <script src="$DEMOROOT$/en/react/node_modules/systemjs/dist/system.src.js"></script> <script src="systemjs.config.js"></script> <script> System.import('$DEMOROOT$/en/lib/react/license.js').then(function () { System.import('./src/app'); }); </script> </head> <body> <div id="app"></div> </body> </html>
.sample-tutorial { position: relative; height: 100%; overflow: hidden; } .sample-spreadsheets { width: calc(100% - 280px); height: 100%; overflow: hidden; float: left; } .options-container { float: right; width: 280px; padding: 12px; height: 100%; box-sizing: border-box; background: #fbfbfb; overflow: auto; } .option-row { font-size: 14px; padding: 5px; } body { position: absolute; top: 0; bottom: 0; left: 0; right: 0; } #app { height: 100%; }
(function (global) { System.config({ transpiler: 'plugin-babel', babelOptions: { es2015: true, react: true }, meta: { '*.css': { loader: 'css' } }, paths: { // paths serve as alias 'npm:': 'node_modules/' }, // map tells the System loader where to look for things map: { '@mescius/spread-sheets': 'npm:@mescius/spread-sheets/index.js', '@mescius/spread-sheets-tablesheet': 'npm:@mescius/spread-sheets-tablesheet/index.js', '@mescius/spread-sheets-react': 'npm:@mescius/spread-sheets-react/index.js', '@grapecity/jsob-test-dependency-package/react-components': 'npm:@grapecity/jsob-test-dependency-package/react-components/index.js', 'react': 'npm:react/umd/react.production.min.js', 'react-dom': 'npm:react-dom/umd/react-dom.production.min.js', 'css': 'npm:systemjs-plugin-css/css.js', 'plugin-babel': 'npm:systemjs-plugin-babel/plugin-babel.js', 'systemjs-babel-build': 'npm:systemjs-plugin-babel/systemjs-babel-browser.js' }, // packages tells the System loader how to load when no filename and/or no extension packages: { src: { defaultExtension: 'jsx' }, "node_modules": { defaultExtension: 'js' }, } }); })(this);