order: 1
id: excel-basics-basic-api-call
name: Basic API call (TypeScript)
description: Performs a basic Excel API call using TypeScript.
author: OfficeDev
host: EXCEL
api_set:
    ExcelApi: '1.1'
script:
    content: |
        $("#run").click(() => tryCatch(run));

        async function run() {
            await Excel.run(async (context) => {
                const range = context.workbook.getSelectedRange();
                range.format.fill.color = "yellow";
                range.load("address");

                await context.sync()

                console.log(`The range address was "${range.address}".`);
            });
        }

        /** Default helper for invoking an action and handling errors. */
        async function tryCatch(callback) {
            try {
                await callback();
            }
            catch (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