Custom Localization

Custom localization provides the ability to customize SpreadJS with a specific language. Users can also get the current or specified culture language resources and translate to their custom resources.

Users need to define the localization object with the schema, or get the current working or specified culture resources with GC.Spread.Common.CultureManager.getResources(cultureName?: string). Then add to the CultureManager and switch to the defined culture. The worksheet displays different properties with the defined words. For example: Or modify resources based on specified culture resources. Hint: If some of the statements are not set, Spread will display English (if set to an empty string “”, it will not display anything).. The arguments is use {0}, {1}, … for display (e.g.: "Invalid {0}: {1} (must be between {2} and {3}).", "Height: {0} pixels"). Custom localization does not support fromJSON/toJSON, so a user will need to add it every time it is needed. The namespace ("common", "Sheets", "Filter") in the sample is optional, but "Functions" and "TableFunctions" are required. The following is also a valid format:
var spreadNS = GC.Spread.Sheets; window.onload = function () { var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"), {sheetCount: 1}); initSpread(spread); } function initSpread(spread) { var sheet = spread.getActiveSheet(); spread.suspendPaint(); spread.options.showScrollTip = 3; spread.options.showResizeTip = 3; var table = sheet.tables.addFromDataSource("table1", 0, 0, source, GC.Spread.Sheets.Tables.TableThemes.medium9) table.showFooter(true); table.showHeader(true); table.highlightFirstColumn(true); table.setColumnFormula(2, "=SUM(C2:C10)"); table.setColumnFormula(3, "=SUM(D2:D10)"); table.setColumnValue(0, "Total"); sheet.setColumnWidth(0, 130); sheet.setColumnWidth(4, 100); GC.Spread.Common.CultureManager.addCultureInfo("de", null, de); var zhResources = GC.Spread.Common.CultureManager.getResources("zh-cn"); zhResources.Sheets.Tip_Column = zh_tw.Sheet.Tip_Column; zhResources.Sheets.Tip_Height = zh_tw.Sheet.Tip_Height; zhResources.Sheets.Tip_Row = zh_tw.Sheet.Tip_Row; zhResources.Sheets.Tip_Width = zh_tw.Sheet.Tip_Width; zhResources.Sheets.NewTab = zh_tw.Sheet.NewTab; zhResources.StatusBar = zh_tw.StatusBar; zhResources.CalcEngine.Fbx_Summary = zh_tw.CalcEngine.Fbx_Summary; zhResources.Functions.SUM = zh_tw.Functions.SUM; zhResources.Functions.NOW = zh_tw.Functions.NOW; zhResources.Functions.IF = zh_tw.Functions.IF; GC.Spread.Common.CultureManager.addCultureInfo("zh_tw", null, zhResources); GC.Spread.Common.CultureManager.addCultureInfo("fr", null, fr); GC.Spread.Common.CultureManager.addCultureInfo("ha_ha", null, ha_ha); var statusBar = new GC.Spread.Sheets.StatusBar.StatusBar(document.getElementById('statusBar')); statusBar.bind(spread); spread.resumePaint(); var select = document.getElementById('CultureSelect'); select.addEventListener('change', function () { var culture = this.value; GC.Spread.Common.CultureManager.culture(culture); document.getElementById('l_description').innerText = langDescription[culture]; if (culture === "en") { document.getElementById('language').value = ""; } else if (culture === "zh_tw") { document.getElementById('language').value = JSON.stringify(GC.Spread.Common.CultureManager.getResources("zh_tw"), null, 2); } else { document.getElementById('language').value = JSON.stringify(window[culture], null, 2); } }); }
<!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/purejs/node_modules/@mescius/spread-sheets/styles/gc.spread.sheets.excel2013white.css"> <script src="$DEMOROOT$/en/purejs/node_modules/@mescius/spread-sheets/dist/gc.spread.sheets.all.min.js" type="text/javascript"></script> <script src="$DEMOROOT$/en/purejs/node_modules/@mescius/spread-sheets-resources-zh/dist/gc.spread.sheets.resources.zh.min.js" type="text/javascript"></script> <script src="$DEMOROOT$/spread/source/js/license.js" type="text/javascript"></script> <script src="$DEMOROOT$/spread/source/data/customLocalization.js" type="text/javascript"></script> <script src="app.js" type="text/javascript"></script> <link rel="stylesheet" type="text/css" href="styles.css"> </head> <body> <div class="sample-tutorial"> <div class="sample-container"> <div id="ss" class="sample-spreadsheets"></div> <div id="statusBar"></div> </div> <div class="sample-options"> <div class="options-container"> Switch Culture: <select id="CultureSelect"> <option value="en">en</option> <option value="zh_tw">zh-tw</option> <option value="fr">fr</option> <option value="de">de</option> <option value="ha_ha">Ha-Ha</option> </select> <p id="l_description">Define English for all worksheet properties as the base and default culture.</p> <textarea id="language" cols="85" rows="40" style="max-width: 98%; height: 465px" readonly="readonly"></textarea> <div class="sample-options"> <div class="options-container"> </div> </div> </div> </div> </div> </body> </html>
* { -webkit-tap-highlight-color: rgba(0, 0, 0, 0); } .sample-options { float: right; height: 100%; } .options-toggle { display: none; } .sample-tutorial { position: relative; height: 100%; overflow: hidden; } .sample-container { width: calc(100% - 280px); height: 100%; float: left; } .sample-spreadsheets { width: 100%; height: calc(100% - 25px); overflow: hidden; } #statusBar { bottom: 0; height: 25px; width: 100%; position: relative; } .options-container { float: right; width: 280px; padding: 12px; box-sizing: border-box; background: #fbfbfb; overflow: auto; } .option-row { font-size: 14px; padding: 5px; margin-top: 10px; } label { display: block; margin-bottom: 6px; } input { padding: 4px 6px; box-sizing: border-box; width: 100%; } input[type=button] { margin-top: 6px; display: block; } .summary { background-color: #e6e6fa; padding: 3px; } body { position: absolute; top: 0; bottom: 0; left: 0; right: 0; }