Created
December 6, 2019 14:57
-
-
Save ShellyShulei/e0b1091510ce6e013068861f4ed443e2 to your computer and use it in GitHub Desktop.
Performs a basic Excel API call using plain JavaScript & Promises.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Basic API call (JavaScript) | |
| description: Performs a basic Excel API call using plain JavaScript & Promises. | |
| host: EXCEL | |
| api_set: {} | |
| script: | |
| content: | | |
| $("#run").click(() => tryCatch(run)); | |
| function run() { | |
| return Excel.run(function(context) { | |
| var range = context.workbook.getSelectedRange(); | |
| range.format.fill.color = "yellow"; | |
| range.load(["address","values"]); | |
| return context.sync().then(function() { | |
| console.log('The range address was "' + range.address + '".'); | |
| return populateRange(context, range); | |
| }); | |
| }); | |
| } | |
| function populateRange(context: Excel.RequestContext, range: Excel.Range) { | |
| console.log("populateRange: range is - ", range.address); | |
| var newValues = range.values; | |
| var counter = 1; | |
| for (var i = 0; i < newValues.length; i++) { | |
| for (var j = 0; j < newValues[i].length; j++) { | |
| newValues[i][j] = counter++; | |
| } | |
| } | |
| range.values = newValues; | |
| return context.sync() | |
| .then(function () { | |
| console.log("finished populating the matrix"); | |
| }); | |
| } | |
| /** Default helper for invoking an action and handling errors. */ | |
| function tryCatch(callback) { | |
| Promise.resolve() | |
| .then(callback) | |
| .catch(function(error) { | |
| // Note: In a production add-in, you'd want to notify the user through your add-in's UI. | |
| console.error(error); | |
| }); | |
| } | |
| language: typescript | |
| template: | |
| content: | | |
| <section class="ms-font-m"> | |
| <p class="ms-font-m">This sample demonstrates basic Excel API calls.</p> | |
| </section> | |
| <section class="samples ms-font-m"> | |
| <h3>Try it out</h3> | |
| <p class="ms-font-m">Select some cells in the worksheet, then press <b>Highlight selected range</b>.</p> | |
| <button id="run" class="ms-Button"> | |
| <span class="ms-Button-label">Highlight selected range</span> | |
| </button> | |
| </section> | |
| language: html | |
| style: | |
| content: |- | |
| section.samples { | |
| margin-top: 20px; | |
| } | |
| section.samples .ms-Button, section.setup .ms-Button { | |
| display: block; | |
| margin-bottom: 5px; | |
| margin-left: 20px; | |
| min-width: 80px; | |
| } | |
| language: css | |
| libraries: | | |
| https://appsforoffice.microsoft.com/lib/1/hosted/office.js | |
| @types/office-js | |
| office-ui-fabric-js@1.4.0/dist/css/fabric.min.css | |
| office-ui-fabric-js@1.4.0/dist/css/fabric.components.min.css | |
| core-js@2.4.1/client/core.min.js | |
| @types/core-js | |
| jquery@3.1.1 | |
| @types/jquery@3.3.1 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment