├── .gitattributes ├── .github ├── ISSUE_TEMPLATE │ ├── 1_documentation-issue.md │ ├── 2_sample-request.md │ └── 3_customer-feedback.yml ├── policies │ └── resourceManagement.yml └── workflows │ ├── auto-publish.yml │ └── autogen-docs.yml ├── .gitignore ├── .openpublishing.publish.config.json ├── Contributing.md ├── Issue_Template.md ├── LICENSE ├── LICENSE-CODE ├── README.md ├── SECURITY.md ├── ThirdPartyNotices ├── docs ├── breadcrumb │ └── toc.yml ├── docfx.json ├── docs-ref-autogen │ └── excel │ │ ├── excelscript.yml │ │ ├── excelscript │ │ ├── excelscript.aggregationfunction.yml │ │ ├── excelscript.alloweditrange.yml │ │ ├── excelscript.alloweditrangeoptions.yml │ │ ├── excelscript.application.yml │ │ ├── excelscript.arrowheadlength.yml │ │ ├── excelscript.arrowheadstyle.yml │ │ ├── excelscript.arrowheadwidth.yml │ │ ├── excelscript.autofilltype.yml │ │ ├── excelscript.autofilter.yml │ │ ├── excelscript.basicdatavalidation.yml │ │ ├── excelscript.binding.yml │ │ ├── excelscript.bindingtype.yml │ │ ├── excelscript.borderindex.yml │ │ ├── excelscript.borderlinestyle.yml │ │ ├── excelscript.borderweight.yml │ │ ├── excelscript.builtinstyle.yml │ │ ├── excelscript.calculationmode.yml │ │ ├── excelscript.calculationstate.yml │ │ ├── excelscript.calculationtype.yml │ │ ├── excelscript.cellcontrol.yml │ │ ├── excelscript.cellcontroltype.yml │ │ ├── excelscript.cellvalueconditionalformat.yml │ │ ├── excelscript.chart.yml │ │ ├── excelscript.chartareaformat.yml │ │ ├── excelscript.chartaxes.yml │ │ ├── excelscript.chartaxis.yml │ │ ├── excelscript.chartaxiscategorytype.yml │ │ ├── excelscript.chartaxisdisplayunit.yml │ │ ├── excelscript.chartaxisformat.yml │ │ ├── excelscript.chartaxisgroup.yml │ │ ├── excelscript.chartaxisposition.yml │ │ ├── excelscript.chartaxisscaletype.yml │ │ ├── excelscript.chartaxisticklabelposition.yml │ │ ├── excelscript.chartaxistickmark.yml │ │ ├── excelscript.chartaxistimeunit.yml │ │ ├── excelscript.chartaxistitle.yml │ │ ├── excelscript.chartaxistitleformat.yml │ │ ├── excelscript.chartaxistype.yml │ │ ├── excelscript.chartbinoptions.yml │ │ ├── excelscript.chartbintype.yml │ │ ├── excelscript.chartborder.yml │ │ ├── excelscript.chartboxquartilecalculation.yml │ │ ├── excelscript.chartboxwhiskeroptions.yml │ │ ├── excelscript.chartcolorscheme.yml │ │ ├── excelscript.chartdatalabel.yml │ │ ├── excelscript.chartdatalabelanchor.yml │ │ ├── excelscript.chartdatalabelformat.yml │ │ ├── excelscript.chartdatalabelposition.yml │ │ ├── excelscript.chartdatalabels.yml │ │ ├── excelscript.chartdatasourcetype.yml │ │ ├── excelscript.chartdatatable.yml │ │ ├── excelscript.chartdatatableformat.yml │ │ ├── excelscript.chartdisplayblanksas.yml │ │ ├── excelscript.charterrorbars.yml │ │ ├── excelscript.charterrorbarsformat.yml │ │ ├── excelscript.charterrorbarsinclude.yml │ │ ├── excelscript.charterrorbarstype.yml │ │ ├── excelscript.chartfill.yml │ │ ├── excelscript.chartfont.yml │ │ ├── excelscript.chartformatstring.yml │ │ ├── excelscript.chartgradientstyle.yml │ │ ├── excelscript.chartgradientstyletype.yml │ │ ├── excelscript.chartgridlines.yml │ │ ├── excelscript.chartgridlinesformat.yml │ │ ├── excelscript.chartleaderlines.yml │ │ ├── excelscript.chartleaderlinesformat.yml │ │ ├── excelscript.chartlegend.yml │ │ ├── excelscript.chartlegendentry.yml │ │ ├── excelscript.chartlegendformat.yml │ │ ├── excelscript.chartlegendposition.yml │ │ ├── excelscript.chartlineformat.yml │ │ ├── excelscript.chartlinestyle.yml │ │ ├── excelscript.chartmaparealevel.yml │ │ ├── excelscript.chartmaplabelstrategy.yml │ │ ├── excelscript.chartmapoptions.yml │ │ ├── excelscript.chartmapprojectiontype.yml │ │ ├── excelscript.chartmarkerstyle.yml │ │ ├── excelscript.chartparentlabelstrategy.yml │ │ ├── excelscript.chartpivotoptions.yml │ │ ├── excelscript.chartplotarea.yml │ │ ├── excelscript.chartplotareaformat.yml │ │ ├── excelscript.chartplotareaposition.yml │ │ ├── excelscript.chartplotby.yml │ │ ├── excelscript.chartpoint.yml │ │ ├── excelscript.chartpointformat.yml │ │ ├── excelscript.chartseries.yml │ │ ├── excelscript.chartseriesby.yml │ │ ├── excelscript.chartseriesdimension.yml │ │ ├── excelscript.chartseriesformat.yml │ │ ├── excelscript.chartsplittype.yml │ │ ├── excelscript.charttexthorizontalalignment.yml │ │ ├── excelscript.charttextverticalalignment.yml │ │ ├── excelscript.chartticklabelalignment.yml │ │ ├── excelscript.charttitle.yml │ │ ├── excelscript.charttitleformat.yml │ │ ├── excelscript.charttitleposition.yml │ │ ├── excelscript.charttrendline.yml │ │ ├── excelscript.charttrendlineformat.yml │ │ ├── excelscript.charttrendlinelabel.yml │ │ ├── excelscript.charttrendlinelabelformat.yml │ │ ├── excelscript.charttrendlinetype.yml │ │ ├── excelscript.charttype.yml │ │ ├── excelscript.chartunderlinestyle.yml │ │ ├── excelscript.checkboxcellcontrol.yml │ │ ├── excelscript.clearapplyto.yml │ │ ├── excelscript.colorscaleconditionalformat.yml │ │ ├── excelscript.comment.yml │ │ ├── excelscript.commentmention.yml │ │ ├── excelscript.commentreply.yml │ │ ├── excelscript.commentrichcontent.yml │ │ ├── excelscript.conditionalcellvalueoperator.yml │ │ ├── excelscript.conditionalcellvaluerule.yml │ │ ├── excelscript.conditionalcolorscalecriteria.yml │ │ ├── excelscript.conditionalcolorscalecriterion.yml │ │ ├── excelscript.conditionaldatabaraxisformat.yml │ │ ├── excelscript.conditionaldatabardirection.yml │ │ ├── excelscript.conditionaldatabarnegativeformat.yml │ │ ├── excelscript.conditionaldatabarpositiveformat.yml │ │ ├── excelscript.conditionaldatabarrule.yml │ │ ├── excelscript.conditionalformat.yml │ │ ├── excelscript.conditionalformatcolorcriteriontype.yml │ │ ├── excelscript.conditionalformatdirection.yml │ │ ├── excelscript.conditionalformaticonruletype.yml │ │ ├── excelscript.conditionalformatpresetcriterion.yml │ │ ├── excelscript.conditionalformatrule.yml │ │ ├── excelscript.conditionalformatruletype.yml │ │ ├── excelscript.conditionalformattype.yml │ │ ├── excelscript.conditionaliconcriterion.yml │ │ ├── excelscript.conditionaliconcriterionoperator.yml │ │ ├── excelscript.conditionalpresetcriteriarule.yml │ │ ├── excelscript.conditionalrangeborder.yml │ │ ├── excelscript.conditionalrangeborderindex.yml │ │ ├── excelscript.conditionalrangeborderlinestyle.yml │ │ ├── excelscript.conditionalrangefill.yml │ │ ├── excelscript.conditionalrangefont.yml │ │ ├── excelscript.conditionalrangefontunderlinestyle.yml │ │ ├── excelscript.conditionalrangeformat.yml │ │ ├── excelscript.conditionaltextcomparisonrule.yml │ │ ├── excelscript.conditionaltextoperator.yml │ │ ├── excelscript.conditionaltopbottomcriteriontype.yml │ │ ├── excelscript.conditionaltopbottomrule.yml │ │ ├── excelscript.connectortype.yml │ │ ├── excelscript.contenttype.yml │ │ ├── excelscript.cultureinfo.yml │ │ ├── excelscript.customconditionalformat.yml │ │ ├── excelscript.customdatavalidation.yml │ │ ├── excelscript.customproperty.yml │ │ ├── excelscript.customxmlpart.yml │ │ ├── excelscript.databarconditionalformat.yml │ │ ├── excelscript.datapivothierarchy.yml │ │ ├── excelscript.datasourcetype.yml │ │ ├── excelscript.datavalidation.yml │ │ ├── excelscript.datavalidationalertstyle.yml │ │ ├── excelscript.datavalidationerroralert.yml │ │ ├── excelscript.datavalidationoperator.yml │ │ ├── excelscript.datavalidationprompt.yml │ │ ├── excelscript.datavalidationrule.yml │ │ ├── excelscript.datavalidationtype.yml │ │ ├── excelscript.datefiltercondition.yml │ │ ├── excelscript.datetimedatavalidation.yml │ │ ├── excelscript.datetimeformatinfo.yml │ │ ├── excelscript.deleteshiftdirection.yml │ │ ├── excelscript.documentproperties.yml │ │ ├── excelscript.documentpropertytype.yml │ │ ├── excelscript.dynamicfiltercriteria.yml │ │ ├── excelscript.emptycellcontrol.yml │ │ ├── excelscript.fillpattern.yml │ │ ├── excelscript.filter.yml │ │ ├── excelscript.filtercriteria.yml │ │ ├── excelscript.filterdatetime.yml │ │ ├── excelscript.filterdatetimespecificity.yml │ │ ├── excelscript.filteron.yml │ │ ├── excelscript.filteroperator.yml │ │ ├── excelscript.filterpivothierarchy.yml │ │ ├── excelscript.formatprotection.yml │ │ ├── excelscript.geometricshape.yml │ │ ├── excelscript.geometricshapetype.yml │ │ ├── excelscript.groupoption.yml │ │ ├── excelscript.headerfooter.yml │ │ ├── excelscript.headerfootergroup.yml │ │ ├── excelscript.headerfooterstate.yml │ │ ├── excelscript.horizontalalignment.yml │ │ ├── excelscript.icon.yml │ │ ├── excelscript.iconset.yml │ │ ├── excelscript.iconsetconditionalformat.yml │ │ ├── excelscript.image.yml │ │ ├── excelscript.imagefittingmode.yml │ │ ├── excelscript.insertshiftdirection.yml │ │ ├── excelscript.iterativecalculation.yml │ │ ├── excelscript.keyboarddirection.yml │ │ ├── excelscript.labelfiltercondition.yml │ │ ├── excelscript.line.yml │ │ ├── excelscript.linkeddatatypestate.yml │ │ ├── excelscript.linkedworkbook.yml │ │ ├── excelscript.listdatavalidation.yml │ │ ├── excelscript.loadtotype.yml │ │ ├── excelscript.mixedcellcontrol.yml │ │ ├── excelscript.nameditem.yml │ │ ├── excelscript.nameditemarrayvalues.yml │ │ ├── excelscript.nameditemscope.yml │ │ ├── excelscript.nameditemtype.yml │ │ ├── excelscript.namedsheetview.yml │ │ ├── excelscript.numberformatcategory.yml │ │ ├── excelscript.numberformatinfo.yml │ │ ├── excelscript.pagebreak.yml │ │ ├── excelscript.pagelayout.yml │ │ ├── excelscript.pagelayoutmarginoptions.yml │ │ ├── excelscript.pagelayoutzoomoptions.yml │ │ ├── excelscript.pageorientation.yml │ │ ├── excelscript.papertype.yml │ │ ├── excelscript.pictureformat.yml │ │ ├── excelscript.pivotaxis.yml │ │ ├── excelscript.pivotdatefilter.yml │ │ ├── excelscript.pivotfield.yml │ │ ├── excelscript.pivotfilters.yml │ │ ├── excelscript.pivotfiltertopbottomcriterion.yml │ │ ├── excelscript.pivotfiltertype.yml │ │ ├── excelscript.pivothierarchy.yml │ │ ├── excelscript.pivotitem.yml │ │ ├── excelscript.pivotlabelfilter.yml │ │ ├── excelscript.pivotlayout.yml │ │ ├── excelscript.pivotlayouttype.yml │ │ ├── excelscript.pivotmanualfilter.yml │ │ ├── excelscript.pivottable.yml │ │ ├── excelscript.pivottablestyle.yml │ │ ├── excelscript.pivotvaluefilter.yml │ │ ├── excelscript.placement.yml │ │ ├── excelscript.predefinedcellstyle.yml │ │ ├── excelscript.presetcriteriaconditionalformat.yml │ │ ├── excelscript.printcomments.yml │ │ ├── excelscript.printerrortype.yml │ │ ├── excelscript.printmarginunit.yml │ │ ├── excelscript.printorder.yml │ │ ├── excelscript.protectionselectionmode.yml │ │ ├── excelscript.query.yml │ │ ├── excelscript.queryerror.yml │ │ ├── excelscript.range.yml │ │ ├── excelscript.rangeareas.yml │ │ ├── excelscript.rangeborder.yml │ │ ├── excelscript.rangecopytype.yml │ │ ├── excelscript.rangefill.yml │ │ ├── excelscript.rangefont.yml │ │ ├── excelscript.rangeformat.yml │ │ ├── excelscript.rangehyperlink.yml │ │ ├── excelscript.rangesort.yml │ │ ├── excelscript.rangeunderlinestyle.yml │ │ ├── excelscript.rangevaluetype.yml │ │ ├── excelscript.rangeview.yml │ │ ├── excelscript.readingorder.yml │ │ ├── excelscript.removeduplicatesresult.yml │ │ ├── excelscript.replacecriteria.yml │ │ ├── excelscript.rowcolumnpivothierarchy.yml │ │ ├── excelscript.searchcriteria.yml │ │ ├── excelscript.searchdirection.yml │ │ ├── excelscript.shape.yml │ │ ├── excelscript.shapeautosize.yml │ │ ├── excelscript.shapefill.yml │ │ ├── excelscript.shapefilltype.yml │ │ ├── excelscript.shapefont.yml │ │ ├── excelscript.shapefontunderlinestyle.yml │ │ ├── excelscript.shapegroup.yml │ │ ├── excelscript.shapelinedashstyle.yml │ │ ├── excelscript.shapelineformat.yml │ │ ├── excelscript.shapelinestyle.yml │ │ ├── excelscript.shapescalefrom.yml │ │ ├── excelscript.shapescaletype.yml │ │ ├── excelscript.shapetexthorizontalalignment.yml │ │ ├── excelscript.shapetexthorizontaloverflow.yml │ │ ├── excelscript.shapetextorientation.yml │ │ ├── excelscript.shapetextreadingorder.yml │ │ ├── excelscript.shapetextverticalalignment.yml │ │ ├── excelscript.shapetextverticaloverflow.yml │ │ ├── excelscript.shapetype.yml │ │ ├── excelscript.shapezorder.yml │ │ ├── excelscript.sheetvisibility.yml │ │ ├── excelscript.showascalculation.yml │ │ ├── excelscript.showasrule.yml │ │ ├── excelscript.slicer.yml │ │ ├── excelscript.sliceritem.yml │ │ ├── excelscript.slicersorttype.yml │ │ ├── excelscript.slicerstyle.yml │ │ ├── excelscript.sortby.yml │ │ ├── excelscript.sortdataoption.yml │ │ ├── excelscript.sortfield.yml │ │ ├── excelscript.sortmethod.yml │ │ ├── excelscript.sorton.yml │ │ ├── excelscript.sortorientation.yml │ │ ├── excelscript.specialcelltype.yml │ │ ├── excelscript.specialcellvaluetype.yml │ │ ├── excelscript.subtotallocationtype.yml │ │ ├── excelscript.subtotals.yml │ │ ├── excelscript.table.yml │ │ ├── excelscript.tablecolumn.yml │ │ ├── excelscript.tablesort.yml │ │ ├── excelscript.tablestyle.yml │ │ ├── excelscript.textconditionalformat.yml │ │ ├── excelscript.textframe.yml │ │ ├── excelscript.textrange.yml │ │ ├── excelscript.timelinestyle.yml │ │ ├── excelscript.topbottomconditionalformat.yml │ │ ├── excelscript.topbottomselectiontype.yml │ │ ├── excelscript.unknowncellcontrol.yml │ │ ├── excelscript.valuefiltercondition.yml │ │ ├── excelscript.verticalalignment.yml │ │ ├── excelscript.workbook.yml │ │ ├── excelscript.workbooklinksrefreshmode.yml │ │ ├── excelscript.workbookprotection.yml │ │ ├── excelscript.workbookrangeareas.yml │ │ ├── excelscript.worksheet.yml │ │ ├── excelscript.worksheetcustomproperty.yml │ │ ├── excelscript.worksheetfreezepanes.yml │ │ ├── excelscript.worksheetpositiontype.yml │ │ ├── excelscript.worksheetprotection.yml │ │ ├── excelscript.worksheetprotectionoptions.yml │ │ ├── excelscript.worksheetsearchcriteria.yml │ │ ├── global.officescript.emailattachment.yml │ │ ├── global.officescript.emailcontenttype.yml │ │ ├── global.officescript.emailimportance.yml │ │ └── global.officescript.mailproperties.yml │ │ ├── overview.md │ │ └── toc.yml └── sample-scripts │ └── excel-scripts.yaml └── generate-docs ├── .gitignore ├── API Coverage Report.csv ├── GenerateDocs.sh ├── api-extractor-inputs-excel ├── api-extractor.json ├── excel.d.ts ├── package.json ├── tsconfig.json └── tsdoc-metadata.json ├── package-lock.json ├── package.json ├── reference-coverage-tester.json ├── schemas └── api-extractor.schema.json ├── script-inputs └── excel.d.ts └── scripts ├── .gitignore ├── package-lock.json ├── package.json ├── postprocessor.ts ├── preprocessor.ts ├── simple-prompts.ts ├── tsconfig.json └── util.ts /.gitattributes: -------------------------------------------------------------------------------- 1 | *.sh text eol=lf 2 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/1_documentation-issue.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Documentation issue 3 | about: Tell us about a problem in the documentation 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Article URL** 11 | 12 | 13 | **Describe the problem** 14 | 15 | 16 | **Screenshots** 17 | 18 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/2_sample-request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Sample request 3 | about: Which features would you like to see more of? 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe your scenario** 11 | 12 | 13 | **Which APIs or Excel features?** 14 | 15 | -------------------------------------------------------------------------------- /.github/workflows/auto-publish.yml: -------------------------------------------------------------------------------- 1 | name: auto-publish 2 | run-name: Automatically publish documentation 3 | on: 4 | schedule: 5 | # Run at 2:15 AM UTC on Wednesday and Friday 6 | - cron: '15 2 * * WED,FRI' 7 | jobs: 8 | auto-publish: 9 | runs-on: ubuntu-latest 10 | permissions: 11 | contents: write 12 | defaults: 13 | run: 14 | shell: bash 15 | working-directory: ./ 16 | steps: 17 | - name: Check out repository 18 | uses: actions/checkout@v4 19 | with: 20 | fetch-depth: 0 21 | - name: Check out main 22 | run: | 23 | echo "Checking out main branch" 24 | git config user.name github-actions 25 | git config user.email github-actions@github.com 26 | git checkout main 27 | - name: Check out live 28 | run: | 29 | echo "Checking out live branch" 30 | git checkout live 31 | - name: Merge from main into live 32 | run: | 33 | echo "Merging from main to live" 34 | git merge main 35 | - name: Push changes 36 | run: | 37 | echo "Pushing changes to live branch" 38 | git push origin live 39 | 40 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | log/ 2 | obj/ 3 | _site/ 4 | .optemp/ 5 | _themes*/ 6 | _repo.*/ 7 | 8 | .openpublishing.buildcore.ps1 -------------------------------------------------------------------------------- /Issue_Template.md: -------------------------------------------------------------------------------- 1 | 14 | 15 | 16 | 17 | ## Article URL 18 | 19 | 20 | ## Issue 21 | 22 | -------------------------------------------------------------------------------- /LICENSE-CODE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | Copyright (c) Microsoft Corporation 3 | 4 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and 5 | associated documentation files (the "Software"), to deal in the Software without restriction, 6 | including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, 7 | and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, 8 | subject to the following conditions: 9 | 10 | The above copyright notice and this permission notice shall be included in all copies or substantial 11 | portions of the Software. 12 | 13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT 14 | NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 15 | IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 16 | WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 17 | SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -------------------------------------------------------------------------------- /ThirdPartyNotices: -------------------------------------------------------------------------------- 1 | ##Legal Notices 2 | Microsoft and any contributors grant you a license to the Microsoft documentation and other content 3 | in this repository under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/legalcode), 4 | see the [LICENSE](LICENSE) file, and grant you a license to any code in the repository under the [MIT License](https://opensource.org/licenses/MIT), see the 5 | [LICENSE-CODE](LICENSE-CODE) file. 6 | 7 | Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation 8 | may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. 9 | The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks. 10 | Microsoft's general trademark guidelines can be found at http://go.microsoft.com/fwlink/?LinkID=254653. 11 | 12 | Privacy information can be found at https://privacy.microsoft.com/en-us/ 13 | 14 | Microsoft and any contributors reserve all others rights, whether under their respective copyrights, patents, 15 | or trademarks, whether by implication, estoppel or otherwise. -------------------------------------------------------------------------------- /docs/breadcrumb/toc.yml: -------------------------------------------------------------------------------- 1 | - name: Office Scripts 2 | tocHref: / 3 | topicHref: /office/dev/scripts/ 4 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.alloweditrangeoptions.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.AllowEditRangeOptions 3 | uid: 'ExcelScript!ExcelScript.AllowEditRangeOptions:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.AllowEditRangeOptions 6 | summary: The interface used to construct optional fields of the `AllowEditRange` object. 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script adds a password-protected, editable range 15 | * to an otherwise protected worksheet. 16 | */ 17 | function main(workbook: ExcelScript.Workbook, password: string) { 18 | // Get the protection object for the "Data" worksheet. 19 | const dataSheet = workbook.getWorksheet("Data"); 20 | const sheetProtection = dataSheet.getProtection(); 21 | 22 | // Set the password needed to edit the range to be the user provided string. 23 | const editRangeProperties : ExcelScript.AllowEditRangeOptions = { 24 | password: password 25 | }; 26 | 27 | // Set range "D2:D6" to be editable if the password is provided. 28 | sheetProtection.addAllowEditRange("Notes Section", "D2:D6", editRangeProperties); 29 | 30 | // Protect the worksheet. 31 | sheetProtection.protect(); 32 | } 33 | ``` 34 | isPreview: false 35 | isDeprecated: false 36 | type: interface 37 | properties: 38 | - name: password 39 | uid: 'ExcelScript!ExcelScript.AllowEditRangeOptions#password:member' 40 | package: ExcelScript! 41 | fullName: password 42 | summary: The password associated with the `AllowEditRange`. 43 | remarks: '' 44 | isPreview: false 45 | isDeprecated: false 46 | syntax: 47 | content: 'password?: string;' 48 | return: 49 | type: string 50 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.arrowheadlength.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ArrowheadLength 3 | uid: 'ExcelScript!ExcelScript.ArrowheadLength:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ArrowheadLength 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script adds a line that goes from cell B2 to cell F4 on the current worksheet. 15 | */ 16 | function main(workbook: ExcelScript.Workbook) { 17 | // Get the current worksheet. 18 | const sheet = workbook.getActiveWorksheet(); 19 | 20 | // Get the ranges for the two cells. 21 | const b2Range = sheet.getRange("B2"); 22 | const f4Range = sheet.getRange("F4"); 23 | 24 | // Add a straight line that connects the top-left corners of both cells. 25 | const newShape = sheet.addLine( 26 | b2Range.getLeft(), 27 | b2Range.getTop(), 28 | f4Range.getLeft(), 29 | f4Range.getTop(), 30 | ExcelScript.ConnectorType.straight); 31 | 32 | // Add a long, open arrowhead to the end of the line, such that it points at F4. 33 | const line = newShape.getLine(); 34 | line.setEndArrowheadStyle(ExcelScript.ArrowheadStyle.open); 35 | line.setEndArrowheadLength(ExcelScript.ArrowheadLength.long); 36 | } 37 | ``` 38 | isPreview: false 39 | isDeprecated: false 40 | fields: 41 | - name: long 42 | uid: 'ExcelScript!ExcelScript.ArrowheadLength.long:member' 43 | package: ExcelScript! 44 | summary: '' 45 | - name: medium 46 | uid: 'ExcelScript!ExcelScript.ArrowheadLength.medium:member' 47 | package: ExcelScript! 48 | summary: '' 49 | - name: short 50 | uid: 'ExcelScript!ExcelScript.ArrowheadLength.short:member' 51 | package: ExcelScript! 52 | summary: '' 53 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.arrowheadstyle.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ArrowheadStyle 3 | uid: 'ExcelScript!ExcelScript.ArrowheadStyle:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ArrowheadStyle 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script adds a line that goes from cell B2 to cell F4 on the current worksheet. 15 | */ 16 | function main(workbook: ExcelScript.Workbook) { 17 | // Get the current worksheet. 18 | const sheet = workbook.getActiveWorksheet(); 19 | 20 | // Get the ranges for the two cells. 21 | const b2Range = sheet.getRange("B2"); 22 | const f4Range = sheet.getRange("F4"); 23 | 24 | // Add a straight line that connects the top-left corners of both cells. 25 | const newShape = sheet.addLine( 26 | b2Range.getLeft(), 27 | b2Range.getTop(), 28 | f4Range.getLeft(), 29 | f4Range.getTop(), 30 | ExcelScript.ConnectorType.straight); 31 | 32 | // Add an open arrowhead to the end of the line, such that it points at F4. 33 | const line = newShape.getLine(); 34 | line.setEndArrowheadStyle(ExcelScript.ArrowheadStyle.open); 35 | } 36 | ``` 37 | isPreview: false 38 | isDeprecated: false 39 | fields: 40 | - name: diamond 41 | uid: 'ExcelScript!ExcelScript.ArrowheadStyle.diamond:member' 42 | package: ExcelScript! 43 | summary: '' 44 | - name: none 45 | uid: 'ExcelScript!ExcelScript.ArrowheadStyle.none:member' 46 | package: ExcelScript! 47 | summary: '' 48 | - name: open 49 | uid: 'ExcelScript!ExcelScript.ArrowheadStyle.open:member' 50 | package: ExcelScript! 51 | summary: '' 52 | - name: oval 53 | uid: 'ExcelScript!ExcelScript.ArrowheadStyle.oval:member' 54 | package: ExcelScript! 55 | summary: '' 56 | - name: stealth 57 | uid: 'ExcelScript!ExcelScript.ArrowheadStyle.stealth:member' 58 | package: ExcelScript! 59 | summary: '' 60 | - name: triangle 61 | uid: 'ExcelScript!ExcelScript.ArrowheadStyle.triangle:member' 62 | package: ExcelScript! 63 | summary: '' 64 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.arrowheadwidth.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ArrowheadWidth 3 | uid: 'ExcelScript!ExcelScript.ArrowheadWidth:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ArrowheadWidth 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script adds a line that goes from cell B2 to cell F4 on the current worksheet. 15 | */ 16 | function main(workbook: ExcelScript.Workbook) { 17 | // Get the current worksheet. 18 | const sheet = workbook.getActiveWorksheet(); 19 | 20 | // Get the ranges for the two cells. 21 | const b2Range = sheet.getRange("B2"); 22 | const f4Range = sheet.getRange("F4"); 23 | 24 | // Add a straight line that connects the top-left corners of both cells. 25 | const newShape = sheet.addLine( 26 | b2Range.getLeft(), 27 | b2Range.getTop(), 28 | f4Range.getLeft(), 29 | f4Range.getTop(), 30 | ExcelScript.ConnectorType.straight); 31 | 32 | // Add a wide, triangular arrowhead to the end of the line, such that it points at F4. 33 | const line = newShape.getLine(); 34 | line.setEndArrowheadStyle(ExcelScript.ArrowheadStyle.triangle); 35 | line.setEndArrowheadWidth(ExcelScript.ArrowheadWidth.wide); 36 | } 37 | ``` 38 | isPreview: false 39 | isDeprecated: false 40 | fields: 41 | - name: medium 42 | uid: 'ExcelScript!ExcelScript.ArrowheadWidth.medium:member' 43 | package: ExcelScript! 44 | summary: '' 45 | - name: narrow 46 | uid: 'ExcelScript!ExcelScript.ArrowheadWidth.narrow:member' 47 | package: ExcelScript! 48 | summary: '' 49 | - name: wide 50 | uid: 'ExcelScript!ExcelScript.ArrowheadWidth.wide:member' 51 | package: ExcelScript! 52 | summary: '' 53 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.bindingtype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.BindingType 3 | uid: 'ExcelScript!ExcelScript.BindingType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.BindingType 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: range 12 | uid: 'ExcelScript!ExcelScript.BindingType.range:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: table 16 | uid: 'ExcelScript!ExcelScript.BindingType.table:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: text 20 | uid: 'ExcelScript!ExcelScript.BindingType.text:member' 21 | package: ExcelScript! 22 | summary: '' 23 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.calculationmode.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.CalculationMode 3 | uid: 'ExcelScript!ExcelScript.CalculationMode:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.CalculationMode 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script recalculates the used range of a specific worksheet. 15 | */ 16 | function main(workbook: ExcelScript.Workbook) { 17 | // Only recalculate if the calculation mode is not set to automatic. 18 | if (workbook.getApplication().getCalculationMode() !== ExcelScript.CalculationMode.automatic) { 19 | // Get the used range from a worksheet named "Monthly Report". 20 | const sheet = workbook.getWorksheet("Monthly Report"); 21 | const range = sheet.getUsedRange(); 22 | console.log(`Calculating ${range.getAddress()}`); 23 | 24 | // Force all the used cells in that worksheet to calculate. 25 | sheet.getUsedRange().calculate(); 26 | } 27 | } 28 | ``` 29 | isPreview: false 30 | isDeprecated: false 31 | fields: 32 | - name: automatic 33 | uid: 'ExcelScript!ExcelScript.CalculationMode.automatic:member' 34 | package: ExcelScript! 35 | summary: >- 36 | The default recalculation behavior where Excel calculates new formula results every time the relevant data is 37 | changed. 38 | - name: automaticExceptTables 39 | uid: 'ExcelScript!ExcelScript.CalculationMode.automaticExceptTables:member' 40 | package: ExcelScript! 41 | summary: 'Calculates new formula results every time the relevant data is changed, unless the formula is in a data table.' 42 | - name: manual 43 | uid: 'ExcelScript!ExcelScript.CalculationMode.manual:member' 44 | package: ExcelScript! 45 | summary: Calculations only occur when the user or add-in requests them. 46 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.calculationstate.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.CalculationState 3 | uid: 'ExcelScript!ExcelScript.CalculationState:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.CalculationState 6 | summary: Represents the state of calculation across the entire Excel application. 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script uses the fill color of the first cell to indicate the current 15 | * calculation state of the workbook. 16 | */ 17 | function main(workbook: ExcelScript.Workbook) { 18 | // Get the first cell in the first worksheet. 19 | const cell = workbook.getWorksheets()[0].getCell(0,0); 20 | 21 | // Get that cell's fill object. 22 | const cellFill = cell.getFormat().getFill(); 23 | 24 | // Set the cell fill based on the calculation state. 25 | const calcState = workbook.getApplication().getCalculationState(); 26 | switch (calcState) { 27 | case ExcelScript.CalculationState.pending: 28 | cellFill.setColor("Red"); 29 | break; 30 | case ExcelScript.CalculationState.calculating: 31 | cellFill.setColor("Yellow"); 32 | break; 33 | case ExcelScript.CalculationState.done: 34 | cellFill.setColor("Green"); 35 | break; 36 | } 37 | } 38 | ``` 39 | isPreview: false 40 | isDeprecated: false 41 | fields: 42 | - name: calculating 43 | uid: 'ExcelScript!ExcelScript.CalculationState.calculating:member' 44 | package: ExcelScript! 45 | summary: Calculations in progress. 46 | - name: done 47 | uid: 'ExcelScript!ExcelScript.CalculationState.done:member' 48 | package: ExcelScript! 49 | summary: Calculations complete. 50 | - name: pending 51 | uid: 'ExcelScript!ExcelScript.CalculationState.pending:member' 52 | package: ExcelScript! 53 | summary: 'Changes that trigger calculation have been made, but a recalculation has not yet been performed.' 54 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.calculationtype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.CalculationType 3 | uid: 'ExcelScript!ExcelScript.CalculationType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.CalculationType 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script fully recalculates the entire workbook. 15 | * This code is useful when automatic recalculation is turned off 16 | * but later parts of the script rely on updated values. 17 | */ 18 | function main(workbook: ExcelScript.Workbook, workbookURL: string) { 19 | const application = workbook.getApplication(); 20 | application.calculate(ExcelScript.CalculationType.fullRebuild); 21 | } 22 | ``` 23 | isPreview: false 24 | isDeprecated: false 25 | fields: 26 | - name: full 27 | uid: 'ExcelScript!ExcelScript.CalculationType.full:member' 28 | package: ExcelScript! 29 | summary: This will mark all cells as dirty and then recalculate them. 30 | - name: fullRebuild 31 | uid: 'ExcelScript!ExcelScript.CalculationType.fullRebuild:member' 32 | package: ExcelScript! 33 | summary: 'This will rebuild the full dependency chain, mark all cells as dirty and then recalculate them.' 34 | - name: recalculate 35 | uid: 'ExcelScript!ExcelScript.CalculationType.recalculate:member' 36 | package: ExcelScript! 37 | summary: >- 38 | Recalculates all cells that Excel has marked as dirty, that is, dependents of volatile or changed data, and cells 39 | programmatically marked as dirty. 40 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.cellcontrol.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSTypeAlias 2 | name: ExcelScript.CellControl 3 | uid: 'ExcelScript!ExcelScript.CellControl:type' 4 | package: ExcelScript! 5 | fullName: ExcelScript.CellControl 6 | summary: Represents an interactable control inside of a cell. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | syntax: |- 11 | type CellControl = 12 | | UnknownCellControl 13 | | EmptyCellControl 14 | | MixedCellControl 15 | | CheckboxCellControl; 16 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.cellcontroltype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.CellControlType 3 | uid: 'ExcelScript!ExcelScript.CellControlType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.CellControlType 6 | summary: Represents the type of cell control. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: checkbox 12 | uid: 'ExcelScript!ExcelScript.CellControlType.checkbox:member' 13 | package: ExcelScript! 14 | summary: Type representing a checkbox control. 15 | - name: empty 16 | uid: 'ExcelScript!ExcelScript.CellControlType.empty:member' 17 | package: ExcelScript! 18 | summary: Type representing an empty control. 19 | - name: mixed 20 | uid: 'ExcelScript!ExcelScript.CellControlType.mixed:member' 21 | package: ExcelScript! 22 | summary: Type representing a query that results in a mix of control results. 23 | - name: unknown 24 | uid: 'ExcelScript!ExcelScript.CellControlType.unknown:member' 25 | package: ExcelScript! 26 | summary: >- 27 | Type representing an unknown control. This represents a control that was added in a future version of Excel, and 28 | the current version of Excel doesn't know how to display this control. 29 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxiscategorytype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartAxisCategoryType 3 | uid: 'ExcelScript!ExcelScript.ChartAxisCategoryType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartAxisCategoryType 6 | summary: Specifies the type of the category axis. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: automatic 12 | uid: 'ExcelScript!ExcelScript.ChartAxisCategoryType.automatic:member' 13 | package: ExcelScript! 14 | summary: Excel controls the axis type. 15 | - name: dateAxis 16 | uid: 'ExcelScript!ExcelScript.ChartAxisCategoryType.dateAxis:member' 17 | package: ExcelScript! 18 | summary: Axis groups data on a time scale. 19 | - name: textAxis 20 | uid: 'ExcelScript!ExcelScript.ChartAxisCategoryType.textAxis:member' 21 | package: ExcelScript! 22 | summary: Axis groups data by an arbitrary set of categories. 23 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisformat.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.ChartAxisFormat 3 | uid: 'ExcelScript!ExcelScript.ChartAxisFormat:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartAxisFormat 6 | summary: Encapsulates the format properties for the chart axis. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | methods: 12 | - name: getFill() 13 | uid: 'ExcelScript!ExcelScript.ChartAxisFormat#getFill:member(1)' 14 | package: ExcelScript! 15 | fullName: getFill() 16 | summary: Specifies chart fill formatting. 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'getFill(): ChartFill;' 22 | return: 23 | type: '' 24 | description: '' 25 | - name: getFont() 26 | uid: 'ExcelScript!ExcelScript.ChartAxisFormat#getFont:member(1)' 27 | package: ExcelScript! 28 | fullName: getFont() 29 | summary: 'Specifies the font attributes (font name, font size, color, etc.) for a chart axis element.' 30 | remarks: '' 31 | isPreview: false 32 | isDeprecated: false 33 | syntax: 34 | content: 'getFont(): ChartFont;' 35 | return: 36 | type: '' 37 | description: '' 38 | - name: getLine() 39 | uid: 'ExcelScript!ExcelScript.ChartAxisFormat#getLine:member(1)' 40 | package: ExcelScript! 41 | fullName: getLine() 42 | summary: Specifies chart line formatting. 43 | remarks: '' 44 | isPreview: false 45 | isDeprecated: false 46 | syntax: 47 | content: 'getLine(): ChartLineFormat;' 48 | return: 49 | type: '' 50 | description: '' 51 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisgroup.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartAxisGroup 3 | uid: 'ExcelScript!ExcelScript.ChartAxisGroup:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartAxisGroup 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: primary 12 | uid: 'ExcelScript!ExcelScript.ChartAxisGroup.primary:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: secondary 16 | uid: 'ExcelScript!ExcelScript.ChartAxisGroup.secondary:member' 17 | package: ExcelScript! 18 | summary: '' 19 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisposition.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartAxisPosition 3 | uid: 'ExcelScript!ExcelScript.ChartAxisPosition:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartAxisPosition 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: automatic 12 | uid: 'ExcelScript!ExcelScript.ChartAxisPosition.automatic:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: custom 16 | uid: 'ExcelScript!ExcelScript.ChartAxisPosition.custom:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: maximum 20 | uid: 'ExcelScript!ExcelScript.ChartAxisPosition.maximum:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: minimum 24 | uid: 'ExcelScript!ExcelScript.ChartAxisPosition.minimum:member' 25 | package: ExcelScript! 26 | summary: '' 27 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisscaletype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartAxisScaleType 3 | uid: 'ExcelScript!ExcelScript.ChartAxisScaleType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartAxisScaleType 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: linear 12 | uid: 'ExcelScript!ExcelScript.ChartAxisScaleType.linear:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: logarithmic 16 | uid: 'ExcelScript!ExcelScript.ChartAxisScaleType.logarithmic:member' 17 | package: ExcelScript! 18 | summary: '' 19 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisticklabelposition.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartAxisTickLabelPosition 3 | uid: 'ExcelScript!ExcelScript.ChartAxisTickLabelPosition:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartAxisTickLabelPosition 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: high 12 | uid: 'ExcelScript!ExcelScript.ChartAxisTickLabelPosition.high:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: low 16 | uid: 'ExcelScript!ExcelScript.ChartAxisTickLabelPosition.low:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: nextToAxis 20 | uid: 'ExcelScript!ExcelScript.ChartAxisTickLabelPosition.nextToAxis:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: none 24 | uid: 'ExcelScript!ExcelScript.ChartAxisTickLabelPosition.none:member' 25 | package: ExcelScript! 26 | summary: '' 27 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxistickmark.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartAxisTickMark 3 | uid: 'ExcelScript!ExcelScript.ChartAxisTickMark:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartAxisTickMark 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: cross 12 | uid: 'ExcelScript!ExcelScript.ChartAxisTickMark.cross:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: inside 16 | uid: 'ExcelScript!ExcelScript.ChartAxisTickMark.inside:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: none 20 | uid: 'ExcelScript!ExcelScript.ChartAxisTickMark.none:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: outside 24 | uid: 'ExcelScript!ExcelScript.ChartAxisTickMark.outside:member' 25 | package: ExcelScript! 26 | summary: '' 27 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxistimeunit.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartAxisTimeUnit 3 | uid: 'ExcelScript!ExcelScript.ChartAxisTimeUnit:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartAxisTimeUnit 6 | summary: Specifies the unit of time for chart axes and data series. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: days 12 | uid: 'ExcelScript!ExcelScript.ChartAxisTimeUnit.days:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: months 16 | uid: 'ExcelScript!ExcelScript.ChartAxisTimeUnit.months:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: years 20 | uid: 'ExcelScript!ExcelScript.ChartAxisTimeUnit.years:member' 21 | package: ExcelScript! 22 | summary: '' 23 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxistitleformat.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.ChartAxisTitleFormat 3 | uid: 'ExcelScript!ExcelScript.ChartAxisTitleFormat:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartAxisTitleFormat 6 | summary: Represents the chart axis title formatting. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | methods: 12 | - name: getBorder() 13 | uid: 'ExcelScript!ExcelScript.ChartAxisTitleFormat#getBorder:member(1)' 14 | package: ExcelScript! 15 | fullName: getBorder() 16 | summary: 'Specifies the chart axis title''s border format, which includes color, linestyle, and weight.' 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'getBorder(): ChartBorder;' 22 | return: 23 | type: '' 24 | description: '' 25 | - name: getFill() 26 | uid: 'ExcelScript!ExcelScript.ChartAxisTitleFormat#getFill:member(1)' 27 | package: ExcelScript! 28 | fullName: getFill() 29 | summary: Specifies the chart axis title's fill formatting. 30 | remarks: '' 31 | isPreview: false 32 | isDeprecated: false 33 | syntax: 34 | content: 'getFill(): ChartFill;' 35 | return: 36 | type: '' 37 | description: '' 38 | - name: getFont() 39 | uid: 'ExcelScript!ExcelScript.ChartAxisTitleFormat#getFont:member(1)' 40 | package: ExcelScript! 41 | fullName: getFont() 42 | summary: >- 43 | Specifies the chart axis title's font attributes, such as font name, font size, or color, of the chart axis title 44 | object. 45 | remarks: '' 46 | isPreview: false 47 | isDeprecated: false 48 | syntax: 49 | content: 'getFont(): ChartFont;' 50 | return: 51 | type: '' 52 | description: '' 53 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxistype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartAxisType 3 | uid: 'ExcelScript!ExcelScript.ChartAxisType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartAxisType 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: category 12 | uid: 'ExcelScript!ExcelScript.ChartAxisType.category:member' 13 | package: ExcelScript! 14 | summary: Axis displays categories. 15 | - name: invalid 16 | uid: 'ExcelScript!ExcelScript.ChartAxisType.invalid:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: series 20 | uid: 'ExcelScript!ExcelScript.ChartAxisType.series:member' 21 | package: ExcelScript! 22 | summary: Axis displays data series. 23 | - name: value 24 | uid: 'ExcelScript!ExcelScript.ChartAxisType.value:member' 25 | package: ExcelScript! 26 | summary: Axis displays values. 27 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartbintype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartBinType 3 | uid: 'ExcelScript!ExcelScript.ChartBinType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartBinType 6 | summary: Specifies the bin type of a histogram chart or pareto chart series. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: auto 12 | uid: 'ExcelScript!ExcelScript.ChartBinType.auto:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: binCount 16 | uid: 'ExcelScript!ExcelScript.ChartBinType.binCount:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: binWidth 20 | uid: 'ExcelScript!ExcelScript.ChartBinType.binWidth:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: category 24 | uid: 'ExcelScript!ExcelScript.ChartBinType.category:member' 25 | package: ExcelScript! 26 | summary: '' 27 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartboxquartilecalculation.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartBoxQuartileCalculation 3 | uid: 'ExcelScript!ExcelScript.ChartBoxQuartileCalculation:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartBoxQuartileCalculation 6 | summary: Represents the quartile calculation type of chart series layout. Only applies to a box and whisker chart. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: exclusive 12 | uid: 'ExcelScript!ExcelScript.ChartBoxQuartileCalculation.exclusive:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: inclusive 16 | uid: 'ExcelScript!ExcelScript.ChartBoxQuartileCalculation.inclusive:member' 17 | package: ExcelScript! 18 | summary: '' 19 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatalabelformat.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.ChartDataLabelFormat 3 | uid: 'ExcelScript!ExcelScript.ChartDataLabelFormat:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartDataLabelFormat 6 | summary: Encapsulates the format properties for the chart data labels. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | methods: 12 | - name: getBorder() 13 | uid: 'ExcelScript!ExcelScript.ChartDataLabelFormat#getBorder:member(1)' 14 | package: ExcelScript! 15 | fullName: getBorder() 16 | summary: 'Represents the border format, which includes color, linestyle, and weight.' 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'getBorder(): ChartBorder;' 22 | return: 23 | type: '' 24 | description: '' 25 | - name: getFill() 26 | uid: 'ExcelScript!ExcelScript.ChartDataLabelFormat#getFill:member(1)' 27 | package: ExcelScript! 28 | fullName: getFill() 29 | summary: Represents the fill format of the current chart data label. 30 | remarks: '' 31 | isPreview: false 32 | isDeprecated: false 33 | syntax: 34 | content: 'getFill(): ChartFill;' 35 | return: 36 | type: '' 37 | description: '' 38 | - name: getFont() 39 | uid: 'ExcelScript!ExcelScript.ChartDataLabelFormat#getFont:member(1)' 40 | package: ExcelScript! 41 | fullName: getFont() 42 | summary: 'Represents the font attributes (such as font name, font size, and color) for a chart data label.' 43 | remarks: '' 44 | isPreview: false 45 | isDeprecated: false 46 | syntax: 47 | content: 'getFont(): ChartFont;' 48 | return: 49 | type: '' 50 | description: '' 51 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatalabelposition.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartDataLabelPosition 3 | uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartDataLabelPosition 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: bestFit 12 | uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.bestFit:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: bottom 16 | uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.bottom:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: callout 20 | uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.callout:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: center 24 | uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.center:member' 25 | package: ExcelScript! 26 | summary: '' 27 | - name: insideBase 28 | uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.insideBase:member' 29 | package: ExcelScript! 30 | summary: '' 31 | - name: insideEnd 32 | uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.insideEnd:member' 33 | package: ExcelScript! 34 | summary: '' 35 | - name: invalid 36 | uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.invalid:member' 37 | package: ExcelScript! 38 | summary: '' 39 | - name: left 40 | uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.left:member' 41 | package: ExcelScript! 42 | summary: '' 43 | - name: none 44 | uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.none:member' 45 | package: ExcelScript! 46 | summary: '' 47 | - name: outsideEnd 48 | uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.outsideEnd:member' 49 | package: ExcelScript! 50 | summary: '' 51 | - name: right 52 | uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.right:member' 53 | package: ExcelScript! 54 | summary: '' 55 | - name: top 56 | uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.top:member' 57 | package: ExcelScript! 58 | summary: '' 59 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatasourcetype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartDataSourceType 3 | uid: 'ExcelScript!ExcelScript.ChartDataSourceType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartDataSourceType 6 | summary: Specifies the data source type of the chart series. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: externalRange 12 | uid: 'ExcelScript!ExcelScript.ChartDataSourceType.externalRange:member' 13 | package: ExcelScript! 14 | summary: The data source type of the chart series is an external range. 15 | - name: list 16 | uid: 'ExcelScript!ExcelScript.ChartDataSourceType.list:member' 17 | package: ExcelScript! 18 | summary: The data source type of the chart series is a list. 19 | - name: localRange 20 | uid: 'ExcelScript!ExcelScript.ChartDataSourceType.localRange:member' 21 | package: ExcelScript! 22 | summary: The data source type of the chart series is a local range. 23 | - name: unknown 24 | uid: 'ExcelScript!ExcelScript.ChartDataSourceType.unknown:member' 25 | package: ExcelScript! 26 | summary: The data source type of the chart series is unknown or unsupported. 27 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatatableformat.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.ChartDataTableFormat 3 | uid: 'ExcelScript!ExcelScript.ChartDataTableFormat:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartDataTableFormat 6 | summary: Represents the format of a chart data table. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | methods: 12 | - name: getBorder() 13 | uid: 'ExcelScript!ExcelScript.ChartDataTableFormat#getBorder:member(1)' 14 | package: ExcelScript! 15 | fullName: getBorder() 16 | summary: 'Represents the border format of chart data table, which includes color, line style, and weight.' 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'getBorder(): ChartBorder;' 22 | return: 23 | type: '' 24 | description: '' 25 | - name: getFill() 26 | uid: 'ExcelScript!ExcelScript.ChartDataTableFormat#getFill:member(1)' 27 | package: ExcelScript! 28 | fullName: getFill() 29 | summary: 'Represents the fill format of an object, which includes background formatting information.' 30 | remarks: '' 31 | isPreview: false 32 | isDeprecated: false 33 | syntax: 34 | content: 'getFill(): ChartFill;' 35 | return: 36 | type: '' 37 | description: '' 38 | - name: getFont() 39 | uid: 'ExcelScript!ExcelScript.ChartDataTableFormat#getFont:member(1)' 40 | package: ExcelScript! 41 | fullName: getFont() 42 | summary: 'Represents the font attributes (such as font name, font size, and color) for the current object.' 43 | remarks: '' 44 | isPreview: false 45 | isDeprecated: false 46 | syntax: 47 | content: 'getFont(): ChartFont;' 48 | return: 49 | type: '' 50 | description: '' 51 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartdisplayblanksas.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartDisplayBlanksAs 3 | uid: 'ExcelScript!ExcelScript.ChartDisplayBlanksAs:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartDisplayBlanksAs 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: interplotted 12 | uid: 'ExcelScript!ExcelScript.ChartDisplayBlanksAs.interplotted:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: notPlotted 16 | uid: 'ExcelScript!ExcelScript.ChartDisplayBlanksAs.notPlotted:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: zero 20 | uid: 'ExcelScript!ExcelScript.ChartDisplayBlanksAs.zero:member' 21 | package: ExcelScript! 22 | summary: '' 23 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.charterrorbarsformat.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.ChartErrorBarsFormat 3 | uid: 'ExcelScript!ExcelScript.ChartErrorBarsFormat:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartErrorBarsFormat 6 | summary: Encapsulates the format properties for chart error bars. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | methods: 12 | - name: getLine() 13 | uid: 'ExcelScript!ExcelScript.ChartErrorBarsFormat#getLine:member(1)' 14 | package: ExcelScript! 15 | fullName: getLine() 16 | summary: Represents the chart line formatting. 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'getLine(): ChartLineFormat;' 22 | return: 23 | type: '' 24 | description: '' 25 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.charterrorbarsinclude.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartErrorBarsInclude 3 | uid: 'ExcelScript!ExcelScript.ChartErrorBarsInclude:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartErrorBarsInclude 6 | summary: Represents which parts of the error bar to include. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: both 12 | uid: 'ExcelScript!ExcelScript.ChartErrorBarsInclude.both:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: minusValues 16 | uid: 'ExcelScript!ExcelScript.ChartErrorBarsInclude.minusValues:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: plusValues 20 | uid: 'ExcelScript!ExcelScript.ChartErrorBarsInclude.plusValues:member' 21 | package: ExcelScript! 22 | summary: '' 23 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.charterrorbarstype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartErrorBarsType 3 | uid: 'ExcelScript!ExcelScript.ChartErrorBarsType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartErrorBarsType 6 | summary: Represents the range type for error bars. 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script adds error bars for the standard error of each chart series point. 15 | */ 16 | function main(workbook: ExcelScript.Workbook) { 17 | // Get the range for the chart. 18 | const worksheet = workbook.getWorksheet("Sample"); 19 | const dataRange = worksheet.getRange("A1:B15"); 20 | 21 | // Create a line chart. 22 | const chart = worksheet.addChart(ExcelScript.ChartType.line, dataRange); 23 | 24 | // For each series, add error bars for the standard error on each point. 25 | const allSeries = chart.getSeries(); 26 | allSeries.forEach((series) => { 27 | series.getYErrorBars().setType(ExcelScript.ChartErrorBarsType.stError); 28 | series.getYErrorBars().setVisible(true); 29 | }); 30 | } 31 | ``` 32 | isPreview: false 33 | isDeprecated: false 34 | fields: 35 | - name: custom 36 | uid: 'ExcelScript!ExcelScript.ChartErrorBarsType.custom:member' 37 | package: ExcelScript! 38 | summary: '' 39 | - name: fixedValue 40 | uid: 'ExcelScript!ExcelScript.ChartErrorBarsType.fixedValue:member' 41 | package: ExcelScript! 42 | summary: '' 43 | - name: percent 44 | uid: 'ExcelScript!ExcelScript.ChartErrorBarsType.percent:member' 45 | package: ExcelScript! 46 | summary: '' 47 | - name: stDev 48 | uid: 'ExcelScript!ExcelScript.ChartErrorBarsType.stDev:member' 49 | package: ExcelScript! 50 | summary: '' 51 | - name: stError 52 | uid: 'ExcelScript!ExcelScript.ChartErrorBarsType.stError:member' 53 | package: ExcelScript! 54 | summary: '' 55 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartfill.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.ChartFill 3 | uid: 'ExcelScript!ExcelScript.ChartFill:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartFill 6 | summary: Represents the fill formatting for a chart element. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | methods: 12 | - name: clear() 13 | uid: 'ExcelScript!ExcelScript.ChartFill#clear:member(1)' 14 | package: ExcelScript! 15 | fullName: clear() 16 | summary: Clears the fill color of a chart element. 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'clear(): void;' 22 | return: 23 | type: void 24 | description: '' 25 | - name: getSolidColor() 26 | uid: 'ExcelScript!ExcelScript.ChartFill#getSolidColor:member(1)' 27 | package: ExcelScript! 28 | fullName: getSolidColor() 29 | summary: Gets the uniform color fill formatting of a chart element. 30 | remarks: '' 31 | isPreview: false 32 | isDeprecated: false 33 | syntax: 34 | content: 'getSolidColor(): string;' 35 | return: 36 | type: string 37 | description: '' 38 | - name: setSolidColor(color) 39 | uid: 'ExcelScript!ExcelScript.ChartFill#setSolidColor:member(1)' 40 | package: ExcelScript! 41 | fullName: setSolidColor(color) 42 | summary: Sets the fill formatting of a chart element to a uniform color. 43 | remarks: '' 44 | isPreview: false 45 | isDeprecated: false 46 | syntax: 47 | content: 'setSolidColor(color: string): void;' 48 | parameters: 49 | - id: color 50 | description: >- 51 | HTML color code representing the color of the background, in the form \#RRGGBB (e.g., "FFA500") or as a 52 | named HTML color (e.g., "orange"). 53 | type: string 54 | return: 55 | type: void 56 | description: '' 57 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartformatstring.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.ChartFormatString 3 | uid: 'ExcelScript!ExcelScript.ChartFormatString:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartFormatString 6 | summary: >- 7 | Represents the substring in chart related objects that contain text, like a `ChartTitle` object or `ChartAxisTitle` 8 | object. 9 | remarks: '' 10 | isPreview: false 11 | isDeprecated: false 12 | type: interface 13 | methods: 14 | - name: getFont() 15 | uid: 'ExcelScript!ExcelScript.ChartFormatString#getFont:member(1)' 16 | package: ExcelScript! 17 | fullName: getFont() 18 | summary: 'Represents the font attributes, such as font name, font size, and color of a chart characters object.' 19 | remarks: '' 20 | isPreview: false 21 | isDeprecated: false 22 | syntax: 23 | content: 'getFont(): ChartFont;' 24 | return: 25 | type: '' 26 | description: '' 27 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartgradientstyle.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartGradientStyle 3 | uid: 'ExcelScript!ExcelScript.ChartGradientStyle:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartGradientStyle 6 | summary: Represents the gradient style of a chart series. This is only applicable for region map charts. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: threePhaseColor 12 | uid: 'ExcelScript!ExcelScript.ChartGradientStyle.threePhaseColor:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: twoPhaseColor 16 | uid: 'ExcelScript!ExcelScript.ChartGradientStyle.twoPhaseColor:member' 17 | package: ExcelScript! 18 | summary: '' 19 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartgradientstyletype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartGradientStyleType 3 | uid: 'ExcelScript!ExcelScript.ChartGradientStyleType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartGradientStyleType 6 | summary: Represents the gradient style type of a chart series. This is only applicable for region map charts. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: extremeValue 12 | uid: 'ExcelScript!ExcelScript.ChartGradientStyleType.extremeValue:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: number 16 | uid: 'ExcelScript!ExcelScript.ChartGradientStyleType.number:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: percent 20 | uid: 'ExcelScript!ExcelScript.ChartGradientStyleType.percent:member' 21 | package: ExcelScript! 22 | summary: '' 23 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartgridlines.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.ChartGridlines 3 | uid: 'ExcelScript!ExcelScript.ChartGridlines:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartGridlines 6 | summary: Represents major or minor gridlines on a chart axis. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | methods: 12 | - name: getFormat() 13 | uid: 'ExcelScript!ExcelScript.ChartGridlines#getFormat:member(1)' 14 | package: ExcelScript! 15 | fullName: getFormat() 16 | summary: Represents the formatting of chart gridlines. 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'getFormat(): ChartGridlinesFormat;' 22 | return: 23 | type: '' 24 | description: '' 25 | - name: getVisible() 26 | uid: 'ExcelScript!ExcelScript.ChartGridlines#getVisible:member(1)' 27 | package: ExcelScript! 28 | fullName: getVisible() 29 | summary: Specifies if the axis gridlines are visible. 30 | remarks: '' 31 | isPreview: false 32 | isDeprecated: false 33 | syntax: 34 | content: 'getVisible(): boolean;' 35 | return: 36 | type: boolean 37 | description: '' 38 | - name: setVisible(visible) 39 | uid: 'ExcelScript!ExcelScript.ChartGridlines#setVisible:member(1)' 40 | package: ExcelScript! 41 | fullName: setVisible(visible) 42 | summary: Specifies if the axis gridlines are visible. 43 | remarks: '' 44 | isPreview: false 45 | isDeprecated: false 46 | syntax: 47 | content: 'setVisible(visible: boolean): void;' 48 | parameters: 49 | - id: visible 50 | description: '' 51 | type: boolean 52 | return: 53 | type: void 54 | description: '' 55 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartgridlinesformat.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.ChartGridlinesFormat 3 | uid: 'ExcelScript!ExcelScript.ChartGridlinesFormat:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartGridlinesFormat 6 | summary: Encapsulates the format properties for chart gridlines. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | methods: 12 | - name: getLine() 13 | uid: 'ExcelScript!ExcelScript.ChartGridlinesFormat#getLine:member(1)' 14 | package: ExcelScript! 15 | fullName: getLine() 16 | summary: Represents chart line formatting. 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'getLine(): ChartLineFormat;' 22 | return: 23 | type: '' 24 | description: '' 25 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartleaderlines.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.ChartLeaderLines 3 | uid: 'ExcelScript!ExcelScript.ChartLeaderLines:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartLeaderLines 6 | summary: Gets an object that represents the formatting of chart leader lines. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | methods: 12 | - name: getFormat() 13 | uid: 'ExcelScript!ExcelScript.ChartLeaderLines#getFormat:member(1)' 14 | package: ExcelScript! 15 | fullName: getFormat() 16 | summary: Represents the formatting of leader lines of data labels in a series. 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'getFormat(): ChartLeaderLinesFormat;' 22 | return: 23 | type: '' 24 | description: '' 25 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartleaderlinesformat.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.ChartLeaderLinesFormat 3 | uid: 'ExcelScript!ExcelScript.ChartLeaderLinesFormat:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartLeaderLinesFormat 6 | summary: Encapsulates the format properties for leader lines. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | methods: 12 | - name: getLine() 13 | uid: 'ExcelScript!ExcelScript.ChartLeaderLinesFormat#getLine:member(1)' 14 | package: ExcelScript! 15 | fullName: getLine() 16 | summary: Gets an object that represents the line formatting of chart leader lines. 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'getLine(): ChartLineFormat;' 22 | return: 23 | type: '' 24 | description: '' 25 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartlegendformat.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.ChartLegendFormat 3 | uid: 'ExcelScript!ExcelScript.ChartLegendFormat:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartLegendFormat 6 | summary: Encapsulates the format properties of a chart legend. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | methods: 12 | - name: getBorder() 13 | uid: 'ExcelScript!ExcelScript.ChartLegendFormat#getBorder:member(1)' 14 | package: ExcelScript! 15 | fullName: getBorder() 16 | summary: 'Represents the border format, which includes color, linestyle, and weight.' 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'getBorder(): ChartBorder;' 22 | return: 23 | type: '' 24 | description: '' 25 | - name: getFill() 26 | uid: 'ExcelScript!ExcelScript.ChartLegendFormat#getFill:member(1)' 27 | package: ExcelScript! 28 | fullName: getFill() 29 | summary: 'Represents the fill format of an object, which includes background formatting information.' 30 | remarks: '' 31 | isPreview: false 32 | isDeprecated: false 33 | syntax: 34 | content: 'getFill(): ChartFill;' 35 | return: 36 | type: '' 37 | description: '' 38 | - name: getFont() 39 | uid: 'ExcelScript!ExcelScript.ChartLegendFormat#getFont:member(1)' 40 | package: ExcelScript! 41 | fullName: getFont() 42 | summary: 'Represents the font attributes such as font name, font size, and color of a chart legend.' 43 | remarks: '' 44 | isPreview: false 45 | isDeprecated: false 46 | syntax: 47 | content: 'getFont(): ChartFont;' 48 | return: 49 | type: '' 50 | description: '' 51 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartlegendposition.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartLegendPosition 3 | uid: 'ExcelScript!ExcelScript.ChartLegendPosition:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartLegendPosition 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: bottom 12 | uid: 'ExcelScript!ExcelScript.ChartLegendPosition.bottom:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: corner 16 | uid: 'ExcelScript!ExcelScript.ChartLegendPosition.corner:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: custom 20 | uid: 'ExcelScript!ExcelScript.ChartLegendPosition.custom:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: invalid 24 | uid: 'ExcelScript!ExcelScript.ChartLegendPosition.invalid:member' 25 | package: ExcelScript! 26 | summary: '' 27 | - name: left 28 | uid: 'ExcelScript!ExcelScript.ChartLegendPosition.left:member' 29 | package: ExcelScript! 30 | summary: '' 31 | - name: right 32 | uid: 'ExcelScript!ExcelScript.ChartLegendPosition.right:member' 33 | package: ExcelScript! 34 | summary: '' 35 | - name: top 36 | uid: 'ExcelScript!ExcelScript.ChartLegendPosition.top:member' 37 | package: ExcelScript! 38 | summary: '' 39 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartlinestyle.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartLineStyle 3 | uid: 'ExcelScript!ExcelScript.ChartLineStyle:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartLineStyle 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: automatic 12 | uid: 'ExcelScript!ExcelScript.ChartLineStyle.automatic:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: continuous 16 | uid: 'ExcelScript!ExcelScript.ChartLineStyle.continuous:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: dash 20 | uid: 'ExcelScript!ExcelScript.ChartLineStyle.dash:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: dashDot 24 | uid: 'ExcelScript!ExcelScript.ChartLineStyle.dashDot:member' 25 | package: ExcelScript! 26 | summary: '' 27 | - name: dashDotDot 28 | uid: 'ExcelScript!ExcelScript.ChartLineStyle.dashDotDot:member' 29 | package: ExcelScript! 30 | summary: '' 31 | - name: dot 32 | uid: 'ExcelScript!ExcelScript.ChartLineStyle.dot:member' 33 | package: ExcelScript! 34 | summary: '' 35 | - name: grey25 36 | uid: 'ExcelScript!ExcelScript.ChartLineStyle.grey25:member' 37 | package: ExcelScript! 38 | summary: '' 39 | - name: grey50 40 | uid: 'ExcelScript!ExcelScript.ChartLineStyle.grey50:member' 41 | package: ExcelScript! 42 | summary: '' 43 | - name: grey75 44 | uid: 'ExcelScript!ExcelScript.ChartLineStyle.grey75:member' 45 | package: ExcelScript! 46 | summary: '' 47 | - name: none 48 | uid: 'ExcelScript!ExcelScript.ChartLineStyle.none:member' 49 | package: ExcelScript! 50 | summary: '' 51 | - name: roundDot 52 | uid: 'ExcelScript!ExcelScript.ChartLineStyle.roundDot:member' 53 | package: ExcelScript! 54 | summary: '' 55 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartmaparealevel.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartMapAreaLevel 3 | uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartMapAreaLevel 6 | summary: Represents the mapping level of a chart series. This only applies to region map charts. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: automatic 12 | uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel.automatic:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: city 16 | uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel.city:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: continent 20 | uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel.continent:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: country 24 | uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel.country:member' 25 | package: ExcelScript! 26 | summary: '' 27 | - name: county 28 | uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel.county:member' 29 | package: ExcelScript! 30 | summary: '' 31 | - name: dataOnly 32 | uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel.dataOnly:member' 33 | package: ExcelScript! 34 | summary: '' 35 | - name: state 36 | uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel.state:member' 37 | package: ExcelScript! 38 | summary: '' 39 | - name: world 40 | uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel.world:member' 41 | package: ExcelScript! 42 | summary: '' 43 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartmaplabelstrategy.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartMapLabelStrategy 3 | uid: 'ExcelScript!ExcelScript.ChartMapLabelStrategy:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartMapLabelStrategy 6 | summary: Represents the region level of a chart series layout. This only applies to region map charts. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: bestFit 12 | uid: 'ExcelScript!ExcelScript.ChartMapLabelStrategy.bestFit:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: none 16 | uid: 'ExcelScript!ExcelScript.ChartMapLabelStrategy.none:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: showAll 20 | uid: 'ExcelScript!ExcelScript.ChartMapLabelStrategy.showAll:member' 21 | package: ExcelScript! 22 | summary: '' 23 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartmapprojectiontype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartMapProjectionType 3 | uid: 'ExcelScript!ExcelScript.ChartMapProjectionType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartMapProjectionType 6 | summary: Represents the region projection type of a chart series layout. This only applies to region map charts. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: albers 12 | uid: 'ExcelScript!ExcelScript.ChartMapProjectionType.albers:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: automatic 16 | uid: 'ExcelScript!ExcelScript.ChartMapProjectionType.automatic:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: mercator 20 | uid: 'ExcelScript!ExcelScript.ChartMapProjectionType.mercator:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: miller 24 | uid: 'ExcelScript!ExcelScript.ChartMapProjectionType.miller:member' 25 | package: ExcelScript! 26 | summary: '' 27 | - name: robinson 28 | uid: 'ExcelScript!ExcelScript.ChartMapProjectionType.robinson:member' 29 | package: ExcelScript! 30 | summary: '' 31 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartmarkerstyle.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartMarkerStyle 3 | uid: 'ExcelScript!ExcelScript.ChartMarkerStyle:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartMarkerStyle 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: automatic 12 | uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.automatic:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: circle 16 | uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.circle:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: dash 20 | uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.dash:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: diamond 24 | uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.diamond:member' 25 | package: ExcelScript! 26 | summary: '' 27 | - name: dot 28 | uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.dot:member' 29 | package: ExcelScript! 30 | summary: '' 31 | - name: invalid 32 | uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.invalid:member' 33 | package: ExcelScript! 34 | summary: '' 35 | - name: none 36 | uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.none:member' 37 | package: ExcelScript! 38 | summary: '' 39 | - name: picture 40 | uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.picture:member' 41 | package: ExcelScript! 42 | summary: '' 43 | - name: plus 44 | uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.plus:member' 45 | package: ExcelScript! 46 | summary: '' 47 | - name: square 48 | uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.square:member' 49 | package: ExcelScript! 50 | summary: '' 51 | - name: star 52 | uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.star:member' 53 | package: ExcelScript! 54 | summary: '' 55 | - name: triangle 56 | uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.triangle:member' 57 | package: ExcelScript! 58 | summary: '' 59 | - name: x 60 | uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.x:member' 61 | package: ExcelScript! 62 | summary: '' 63 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartparentlabelstrategy.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartParentLabelStrategy 3 | uid: 'ExcelScript!ExcelScript.ChartParentLabelStrategy:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartParentLabelStrategy 6 | summary: Represents the parent label strategy of the chart series layout. This only applies to treemap charts 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: banner 12 | uid: 'ExcelScript!ExcelScript.ChartParentLabelStrategy.banner:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: none 16 | uid: 'ExcelScript!ExcelScript.ChartParentLabelStrategy.none:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: overlapping 20 | uid: 'ExcelScript!ExcelScript.ChartParentLabelStrategy.overlapping:member' 21 | package: ExcelScript! 22 | summary: '' 23 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartplotareaformat.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.ChartPlotAreaFormat 3 | uid: 'ExcelScript!ExcelScript.ChartPlotAreaFormat:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartPlotAreaFormat 6 | summary: Represents the format properties for a chart plot area. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | methods: 12 | - name: getBorder() 13 | uid: 'ExcelScript!ExcelScript.ChartPlotAreaFormat#getBorder:member(1)' 14 | package: ExcelScript! 15 | fullName: getBorder() 16 | summary: Specifies the border attributes of a chart plot area. 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'getBorder(): ChartBorder;' 22 | return: 23 | type: '' 24 | description: '' 25 | - name: getFill() 26 | uid: 'ExcelScript!ExcelScript.ChartPlotAreaFormat#getFill:member(1)' 27 | package: ExcelScript! 28 | fullName: getFill() 29 | summary: 'Specifies the fill format of an object, which includes background formatting information.' 30 | remarks: '' 31 | isPreview: false 32 | isDeprecated: false 33 | syntax: 34 | content: 'getFill(): ChartFill;' 35 | return: 36 | type: '' 37 | description: '' 38 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartplotareaposition.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartPlotAreaPosition 3 | uid: 'ExcelScript!ExcelScript.ChartPlotAreaPosition:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartPlotAreaPosition 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: automatic 12 | uid: 'ExcelScript!ExcelScript.ChartPlotAreaPosition.automatic:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: custom 16 | uid: 'ExcelScript!ExcelScript.ChartPlotAreaPosition.custom:member' 17 | package: ExcelScript! 18 | summary: '' 19 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartplotby.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartPlotBy 3 | uid: 'ExcelScript!ExcelScript.ChartPlotBy:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartPlotBy 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This sample performs the "Switch Row/Column" action on a chart named "ColumnClusteredChart". 15 | */ 16 | function main(workbook: ExcelScript.Workbook) { 17 | // Get the current worksheet. 18 | let selectedSheet = workbook.getActiveWorksheet(); 19 | 20 | // Get an existing chart named "ColumnClusteredChart". 21 | let columnClusteredChart = selectedSheet.getChart("ColumnClusteredChart"); 22 | 23 | // Switch the row and column for the chart's data source. 24 | if (columnClusteredChart.getPlotBy() === ExcelScript.ChartPlotBy.columns) { 25 | // If the chart is grouped by columns, switch it to rows. 26 | columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.rows); 27 | } else { 28 | // If the chart is grouped by rows, switch it to columns. 29 | columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.columns); 30 | } 31 | } 32 | ``` 33 | isPreview: false 34 | isDeprecated: false 35 | fields: 36 | - name: columns 37 | uid: 'ExcelScript!ExcelScript.ChartPlotBy.columns:member' 38 | package: ExcelScript! 39 | summary: '' 40 | - name: rows 41 | uid: 'ExcelScript!ExcelScript.ChartPlotBy.rows:member' 42 | package: ExcelScript! 43 | summary: '' 44 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartpointformat.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.ChartPointFormat 3 | uid: 'ExcelScript!ExcelScript.ChartPointFormat:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartPointFormat 6 | summary: Represents the formatting object for chart points. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | methods: 12 | - name: getBorder() 13 | uid: 'ExcelScript!ExcelScript.ChartPointFormat#getBorder:member(1)' 14 | package: ExcelScript! 15 | fullName: getBorder() 16 | summary: 'Represents the border format of a chart data point, which includes color, style, and weight information.' 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'getBorder(): ChartBorder;' 22 | return: 23 | type: '' 24 | description: '' 25 | - name: getFill() 26 | uid: 'ExcelScript!ExcelScript.ChartPointFormat#getFill:member(1)' 27 | package: ExcelScript! 28 | fullName: getFill() 29 | summary: 'Represents the fill format of a chart, which includes background formatting information.' 30 | remarks: '' 31 | isPreview: false 32 | isDeprecated: false 33 | syntax: 34 | content: 'getFill(): ChartFill;' 35 | return: 36 | type: '' 37 | description: '' 38 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartseriesby.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartSeriesBy 3 | uid: 'ExcelScript!ExcelScript.ChartSeriesBy:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartSeriesBy 6 | summary: >- 7 | Specifies whether the series are by rows or by columns. In Excel on desktop, the "auto" option will inspect the source 8 | data shape to automatically guess whether the data is by rows or columns. In Excel on the web, "auto" will simply 9 | default to "columns". 10 | remarks: |- 11 | 12 | 13 | #### Examples 14 | 15 | ```TypeScript 16 | /** 17 | * This script creates a clustered-column chart using an existing table. 18 | */ 19 | function main(workbook: ExcelScript.Workbook) { 20 | // Get the first table on the current worksheet. 21 | const sheet = workbook.getActiveWorksheet(); 22 | const table = sheet.getTables()[0]; 23 | 24 | // Add a clustered-column chart that clusters the data based on the columns in the table. 25 | const chart = sheet.addChart( 26 | ExcelScript.ChartType.columnClustered, 27 | table.getRange(), 28 | ExcelScript.ChartSeriesBy.columns 29 | ); 30 | } 31 | ``` 32 | isPreview: false 33 | isDeprecated: false 34 | fields: 35 | - name: auto 36 | uid: 'ExcelScript!ExcelScript.ChartSeriesBy.auto:member' 37 | package: ExcelScript! 38 | summary: >- 39 | In Excel on desktop, the "auto" option will inspect the source data shape to automatically guess whether the data 40 | is by rows or columns. In Excel on the web, "auto" will simply default to "columns". 41 | - name: columns 42 | uid: 'ExcelScript!ExcelScript.ChartSeriesBy.columns:member' 43 | package: ExcelScript! 44 | summary: '' 45 | - name: rows 46 | uid: 'ExcelScript!ExcelScript.ChartSeriesBy.rows:member' 47 | package: ExcelScript! 48 | summary: '' 49 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartseriesdimension.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartSeriesDimension 3 | uid: 'ExcelScript!ExcelScript.ChartSeriesDimension:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartSeriesDimension 6 | summary: Represents the dimensions when getting values from chart series. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: bubbleSizes 12 | uid: 'ExcelScript!ExcelScript.ChartSeriesDimension.bubbleSizes:member' 13 | package: ExcelScript! 14 | summary: The chart series axis for the bubble sizes in bubble charts. 15 | - name: categories 16 | uid: 'ExcelScript!ExcelScript.ChartSeriesDimension.categories:member' 17 | package: ExcelScript! 18 | summary: The chart series axis for the categories. 19 | - name: values 20 | uid: 'ExcelScript!ExcelScript.ChartSeriesDimension.values:member' 21 | package: ExcelScript! 22 | summary: The chart series axis for the values. 23 | - name: xvalues 24 | uid: 'ExcelScript!ExcelScript.ChartSeriesDimension.xvalues:member' 25 | package: ExcelScript! 26 | summary: The chart series axis for the x-axis values in scatter and bubble charts. 27 | - name: yvalues 28 | uid: 'ExcelScript!ExcelScript.ChartSeriesDimension.yvalues:member' 29 | package: ExcelScript! 30 | summary: The chart series axis for the y-axis values in scatter and bubble charts. 31 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartseriesformat.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.ChartSeriesFormat 3 | uid: 'ExcelScript!ExcelScript.ChartSeriesFormat:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartSeriesFormat 6 | summary: Encapsulates the format properties for the chart series 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | methods: 12 | - name: getFill() 13 | uid: 'ExcelScript!ExcelScript.ChartSeriesFormat#getFill:member(1)' 14 | package: ExcelScript! 15 | fullName: getFill() 16 | summary: 'Represents the fill format of a chart series, which includes background formatting information.' 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'getFill(): ChartFill;' 22 | return: 23 | type: '' 24 | description: '' 25 | - name: getLine() 26 | uid: 'ExcelScript!ExcelScript.ChartSeriesFormat#getLine:member(1)' 27 | package: ExcelScript! 28 | fullName: getLine() 29 | summary: Represents line formatting. 30 | remarks: '' 31 | isPreview: false 32 | isDeprecated: false 33 | syntax: 34 | content: 'getLine(): ChartLineFormat;' 35 | return: 36 | type: '' 37 | description: '' 38 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartsplittype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartSplitType 3 | uid: 'ExcelScript!ExcelScript.ChartSplitType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartSplitType 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: splitByCustomSplit 12 | uid: 'ExcelScript!ExcelScript.ChartSplitType.splitByCustomSplit:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: splitByPercentValue 16 | uid: 'ExcelScript!ExcelScript.ChartSplitType.splitByPercentValue:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: splitByPosition 20 | uid: 'ExcelScript!ExcelScript.ChartSplitType.splitByPosition:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: splitByValue 24 | uid: 'ExcelScript!ExcelScript.ChartSplitType.splitByValue:member' 25 | package: ExcelScript! 26 | summary: '' 27 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.charttexthorizontalalignment.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartTextHorizontalAlignment 3 | uid: 'ExcelScript!ExcelScript.ChartTextHorizontalAlignment:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartTextHorizontalAlignment 6 | summary: Represents the horizontal alignment for the specified object. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: center 12 | uid: 'ExcelScript!ExcelScript.ChartTextHorizontalAlignment.center:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: distributed 16 | uid: 'ExcelScript!ExcelScript.ChartTextHorizontalAlignment.distributed:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: justify 20 | uid: 'ExcelScript!ExcelScript.ChartTextHorizontalAlignment.justify:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: left 24 | uid: 'ExcelScript!ExcelScript.ChartTextHorizontalAlignment.left:member' 25 | package: ExcelScript! 26 | summary: '' 27 | - name: right 28 | uid: 'ExcelScript!ExcelScript.ChartTextHorizontalAlignment.right:member' 29 | package: ExcelScript! 30 | summary: '' 31 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.charttextverticalalignment.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartTextVerticalAlignment 3 | uid: 'ExcelScript!ExcelScript.ChartTextVerticalAlignment:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartTextVerticalAlignment 6 | summary: Represents the vertical alignment for the specified object. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: bottom 12 | uid: 'ExcelScript!ExcelScript.ChartTextVerticalAlignment.bottom:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: center 16 | uid: 'ExcelScript!ExcelScript.ChartTextVerticalAlignment.center:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: distributed 20 | uid: 'ExcelScript!ExcelScript.ChartTextVerticalAlignment.distributed:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: justify 24 | uid: 'ExcelScript!ExcelScript.ChartTextVerticalAlignment.justify:member' 25 | package: ExcelScript! 26 | summary: '' 27 | - name: top 28 | uid: 'ExcelScript!ExcelScript.ChartTextVerticalAlignment.top:member' 29 | package: ExcelScript! 30 | summary: '' 31 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartticklabelalignment.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartTickLabelAlignment 3 | uid: 'ExcelScript!ExcelScript.ChartTickLabelAlignment:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartTickLabelAlignment 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: center 12 | uid: 'ExcelScript!ExcelScript.ChartTickLabelAlignment.center:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: left 16 | uid: 'ExcelScript!ExcelScript.ChartTickLabelAlignment.left:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: right 20 | uid: 'ExcelScript!ExcelScript.ChartTickLabelAlignment.right:member' 21 | package: ExcelScript! 22 | summary: '' 23 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.charttitleformat.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.ChartTitleFormat 3 | uid: 'ExcelScript!ExcelScript.ChartTitleFormat:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartTitleFormat 6 | summary: Provides access to the formatting options for a chart title. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | methods: 12 | - name: getBorder() 13 | uid: 'ExcelScript!ExcelScript.ChartTitleFormat#getBorder:member(1)' 14 | package: ExcelScript! 15 | fullName: getBorder() 16 | summary: 'Represents the border format of chart title, which includes color, linestyle, and weight.' 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'getBorder(): ChartBorder;' 22 | return: 23 | type: '' 24 | description: '' 25 | - name: getFill() 26 | uid: 'ExcelScript!ExcelScript.ChartTitleFormat#getFill:member(1)' 27 | package: ExcelScript! 28 | fullName: getFill() 29 | summary: 'Represents the fill format of an object, which includes background formatting information.' 30 | remarks: '' 31 | isPreview: false 32 | isDeprecated: false 33 | syntax: 34 | content: 'getFill(): ChartFill;' 35 | return: 36 | type: '' 37 | description: '' 38 | - name: getFont() 39 | uid: 'ExcelScript!ExcelScript.ChartTitleFormat#getFont:member(1)' 40 | package: ExcelScript! 41 | fullName: getFont() 42 | summary: 'Represents the font attributes (such as font name, font size, and color) for an object.' 43 | remarks: '' 44 | isPreview: false 45 | isDeprecated: false 46 | syntax: 47 | content: 'getFont(): ChartFont;' 48 | return: 49 | type: '' 50 | description: '' 51 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.charttitleposition.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartTitlePosition 3 | uid: 'ExcelScript!ExcelScript.ChartTitlePosition:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartTitlePosition 6 | summary: Represents the position of the chart title. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: automatic 12 | uid: 'ExcelScript!ExcelScript.ChartTitlePosition.automatic:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: bottom 16 | uid: 'ExcelScript!ExcelScript.ChartTitlePosition.bottom:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: left 20 | uid: 'ExcelScript!ExcelScript.ChartTitlePosition.left:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: right 24 | uid: 'ExcelScript!ExcelScript.ChartTitlePosition.right:member' 25 | package: ExcelScript! 26 | summary: '' 27 | - name: top 28 | uid: 'ExcelScript!ExcelScript.ChartTitlePosition.top:member' 29 | package: ExcelScript! 30 | summary: '' 31 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.charttrendlineformat.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.ChartTrendlineFormat 3 | uid: 'ExcelScript!ExcelScript.ChartTrendlineFormat:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartTrendlineFormat 6 | summary: Represents the format properties for the chart trendline. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | methods: 12 | - name: getLine() 13 | uid: 'ExcelScript!ExcelScript.ChartTrendlineFormat#getLine:member(1)' 14 | package: ExcelScript! 15 | fullName: getLine() 16 | summary: Represents chart line formatting. 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'getLine(): ChartLineFormat;' 22 | return: 23 | type: '' 24 | description: '' 25 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.charttrendlinelabelformat.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.ChartTrendlineLabelFormat 3 | uid: 'ExcelScript!ExcelScript.ChartTrendlineLabelFormat:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartTrendlineLabelFormat 6 | summary: Encapsulates the format properties for the chart trendline label. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | methods: 12 | - name: getBorder() 13 | uid: 'ExcelScript!ExcelScript.ChartTrendlineLabelFormat#getBorder:member(1)' 14 | package: ExcelScript! 15 | fullName: getBorder() 16 | summary: 'Specifies the border format, which includes color, linestyle, and weight.' 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'getBorder(): ChartBorder;' 22 | return: 23 | type: '' 24 | description: '' 25 | - name: getFill() 26 | uid: 'ExcelScript!ExcelScript.ChartTrendlineLabelFormat#getFill:member(1)' 27 | package: ExcelScript! 28 | fullName: getFill() 29 | summary: Specifies the fill format of the current chart trendline label. 30 | remarks: '' 31 | isPreview: false 32 | isDeprecated: false 33 | syntax: 34 | content: 'getFill(): ChartFill;' 35 | return: 36 | type: '' 37 | description: '' 38 | - name: getFont() 39 | uid: 'ExcelScript!ExcelScript.ChartTrendlineLabelFormat#getFont:member(1)' 40 | package: ExcelScript! 41 | fullName: getFont() 42 | summary: 'Specifies the font attributes (such as font name, font size, and color) for a chart trendline label.' 43 | remarks: '' 44 | isPreview: false 45 | isDeprecated: false 46 | syntax: 47 | content: 'getFont(): ChartFont;' 48 | return: 49 | type: '' 50 | description: '' 51 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.charttrendlinetype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartTrendlineType 3 | uid: 'ExcelScript!ExcelScript.ChartTrendlineType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartTrendlineType 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: exponential 12 | uid: 'ExcelScript!ExcelScript.ChartTrendlineType.exponential:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: linear 16 | uid: 'ExcelScript!ExcelScript.ChartTrendlineType.linear:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: logarithmic 20 | uid: 'ExcelScript!ExcelScript.ChartTrendlineType.logarithmic:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: movingAverage 24 | uid: 'ExcelScript!ExcelScript.ChartTrendlineType.movingAverage:member' 25 | package: ExcelScript! 26 | summary: '' 27 | - name: polynomial 28 | uid: 'ExcelScript!ExcelScript.ChartTrendlineType.polynomial:member' 29 | package: ExcelScript! 30 | summary: '' 31 | - name: power 32 | uid: 'ExcelScript!ExcelScript.ChartTrendlineType.power:member' 33 | package: ExcelScript! 34 | summary: '' 35 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.chartunderlinestyle.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ChartUnderlineStyle 3 | uid: 'ExcelScript!ExcelScript.ChartUnderlineStyle:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ChartUnderlineStyle 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: none 12 | uid: 'ExcelScript!ExcelScript.ChartUnderlineStyle.none:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: single 16 | uid: 'ExcelScript!ExcelScript.ChartUnderlineStyle.single:member' 17 | package: ExcelScript! 18 | summary: '' 19 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.checkboxcellcontrol.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.CheckboxCellControl 3 | uid: 'ExcelScript!ExcelScript.CheckboxCellControl:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.CheckboxCellControl 6 | summary: Represents a checkbox. This is a cell control that allows a user to toggle the boolean value in a cell. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | properties: 12 | - name: type 13 | uid: 'ExcelScript!ExcelScript.CheckboxCellControl#type:member' 14 | package: ExcelScript! 15 | fullName: type 16 | summary: '' 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'type: CellControlType.checkbox;' 22 | return: 23 | type: '' 24 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalcolorscalecriteria.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.ConditionalColorScaleCriteria 3 | uid: 'ExcelScript!ExcelScript.ConditionalColorScaleCriteria:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ConditionalColorScaleCriteria 6 | summary: Represents the criteria of the color scale. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | properties: 12 | - name: maximum 13 | uid: 'ExcelScript!ExcelScript.ConditionalColorScaleCriteria#maximum:member' 14 | package: ExcelScript! 15 | fullName: maximum 16 | summary: The maximum point of the color scale criterion. 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'maximum: ConditionalColorScaleCriterion;' 22 | return: 23 | type: '' 24 | - name: midpoint 25 | uid: 'ExcelScript!ExcelScript.ConditionalColorScaleCriteria#midpoint:member' 26 | package: ExcelScript! 27 | fullName: midpoint 28 | summary: 'The midpoint of the color scale criterion, if the color scale is a 3-color scale.' 29 | remarks: '' 30 | isPreview: false 31 | isDeprecated: false 32 | syntax: 33 | content: 'midpoint?: ConditionalColorScaleCriterion;' 34 | return: 35 | type: '' 36 | - name: minimum 37 | uid: 'ExcelScript!ExcelScript.ConditionalColorScaleCriteria#minimum:member' 38 | package: ExcelScript! 39 | fullName: minimum 40 | summary: The minimum point of the color scale criterion. 41 | remarks: '' 42 | isPreview: false 43 | isDeprecated: false 44 | syntax: 45 | content: 'minimum: ConditionalColorScaleCriterion;' 46 | return: 47 | type: '' 48 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalcolorscalecriterion.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.ConditionalColorScaleCriterion 3 | uid: 'ExcelScript!ExcelScript.ConditionalColorScaleCriterion:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ConditionalColorScaleCriterion 6 | summary: 'Represents a color scale criterion which contains a type, value, and a color.' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | properties: 12 | - name: color 13 | uid: 'ExcelScript!ExcelScript.ConditionalColorScaleCriterion#color:member' 14 | package: ExcelScript! 15 | fullName: color 16 | summary: 'HTML color code representation of the color scale color (e.g., \#FF0000 represents Red).' 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'color?: string;' 22 | return: 23 | type: string 24 | - name: formula 25 | uid: 'ExcelScript!ExcelScript.ConditionalColorScaleCriterion#formula:member' 26 | package: ExcelScript! 27 | fullName: formula 28 | summary: 'A number, a formula, or `null` (if `type` is `lowestValue`).' 29 | remarks: '' 30 | isPreview: false 31 | isDeprecated: false 32 | syntax: 33 | content: 'formula?: string;' 34 | return: 35 | type: string 36 | - name: type 37 | uid: 'ExcelScript!ExcelScript.ConditionalColorScaleCriterion#type:member' 38 | package: ExcelScript! 39 | fullName: type 40 | summary: What the criterion conditional formula should be based on. 41 | remarks: '' 42 | isPreview: false 43 | isDeprecated: false 44 | syntax: 45 | content: 'type: ConditionalFormatColorCriterionType;' 46 | return: 47 | type: '' 48 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaldatabaraxisformat.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ConditionalDataBarAxisFormat 3 | uid: 'ExcelScript!ExcelScript.ConditionalDataBarAxisFormat:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ConditionalDataBarAxisFormat 6 | summary: Represents the format options for a data bar axis. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: automatic 12 | uid: 'ExcelScript!ExcelScript.ConditionalDataBarAxisFormat.automatic:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: cellMidPoint 16 | uid: 'ExcelScript!ExcelScript.ConditionalDataBarAxisFormat.cellMidPoint:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: none 20 | uid: 'ExcelScript!ExcelScript.ConditionalDataBarAxisFormat.none:member' 21 | package: ExcelScript! 22 | summary: '' 23 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaldatabardirection.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ConditionalDataBarDirection 3 | uid: 'ExcelScript!ExcelScript.ConditionalDataBarDirection:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ConditionalDataBarDirection 6 | summary: Represents the data bar direction within a cell. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: context 12 | uid: 'ExcelScript!ExcelScript.ConditionalDataBarDirection.context:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: leftToRight 16 | uid: 'ExcelScript!ExcelScript.ConditionalDataBarDirection.leftToRight:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: rightToLeft 20 | uid: 'ExcelScript!ExcelScript.ConditionalDataBarDirection.rightToLeft:member' 21 | package: ExcelScript! 22 | summary: '' 23 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatdirection.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ConditionalFormatDirection 3 | uid: 'ExcelScript!ExcelScript.ConditionalFormatDirection:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ConditionalFormatDirection 6 | summary: Represents the direction for a selection. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: bottom 12 | uid: 'ExcelScript!ExcelScript.ConditionalFormatDirection.bottom:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: top 16 | uid: 'ExcelScript!ExcelScript.ConditionalFormatDirection.top:member' 17 | package: ExcelScript! 18 | summary: '' 19 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalpresetcriteriarule.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.ConditionalPresetCriteriaRule 3 | uid: 'ExcelScript!ExcelScript.ConditionalPresetCriteriaRule:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ConditionalPresetCriteriaRule 6 | summary: Represents the preset criteria conditional format rule. 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script applies a conditional format that uses a preset criterion. 15 | * Any cell in row 1 will have the color fill set to green if it is a duplicate value 16 | * (of anything else in row 1). 17 | */ 18 | function main(workbook: ExcelScript.Workbook) { 19 | // Get the range for row 1. 20 | const sheet = workbook.getActiveWorksheet(); 21 | const formattedRange = sheet.getRange("1:1"); 22 | 23 | // Add new conditional formatting to that range. 24 | const conditionalFormat = formattedRange.addConditionalFormat( 25 | ExcelScript.ConditionalFormatType.presetCriteria); 26 | 27 | // Set the conditional formatting to apply a green fill. 28 | const presetFormat = conditionalFormat.getPreset(); 29 | presetFormat.getFormat().getFill().setColor("green"); 30 | 31 | // Set a rule to apply the conditional format when values are duplicated in the range. 32 | const duplicateRule: ExcelScript.ConditionalPresetCriteriaRule = { 33 | criterion: ExcelScript.ConditionalFormatPresetCriterion.duplicateValues 34 | }; 35 | presetFormat.setRule(duplicateRule); 36 | } 37 | ``` 38 | isPreview: false 39 | isDeprecated: false 40 | type: interface 41 | properties: 42 | - name: criterion 43 | uid: 'ExcelScript!ExcelScript.ConditionalPresetCriteriaRule#criterion:member' 44 | package: ExcelScript! 45 | fullName: criterion 46 | summary: The criterion of the conditional format. 47 | remarks: '' 48 | isPreview: false 49 | isDeprecated: false 50 | syntax: 51 | content: 'criterion: ConditionalFormatPresetCriterion;' 52 | return: 53 | type: '' 54 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangeborderindex.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ConditionalRangeBorderIndex 3 | uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderIndex:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ConditionalRangeBorderIndex 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: edgeBottom 12 | uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderIndex.edgeBottom:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: edgeLeft 16 | uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderIndex.edgeLeft:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: edgeRight 20 | uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderIndex.edgeRight:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: edgeTop 24 | uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderIndex.edgeTop:member' 25 | package: ExcelScript! 26 | summary: '' 27 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangeborderlinestyle.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ConditionalRangeBorderLineStyle 3 | uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderLineStyle:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ConditionalRangeBorderLineStyle 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: continuous 12 | uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderLineStyle.continuous:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: dash 16 | uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderLineStyle.dash:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: dashDot 20 | uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderLineStyle.dashDot:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: dashDotDot 24 | uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderLineStyle.dashDotDot:member' 25 | package: ExcelScript! 26 | summary: '' 27 | - name: dot 28 | uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderLineStyle.dot:member' 29 | package: ExcelScript! 30 | summary: '' 31 | - name: none 32 | uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderLineStyle.none:member' 33 | package: ExcelScript! 34 | summary: '' 35 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangefontunderlinestyle.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ConditionalRangeFontUnderlineStyle 3 | uid: 'ExcelScript!ExcelScript.ConditionalRangeFontUnderlineStyle:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ConditionalRangeFontUnderlineStyle 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: double 12 | uid: 'ExcelScript!ExcelScript.ConditionalRangeFontUnderlineStyle.double:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: none 16 | uid: 'ExcelScript!ExcelScript.ConditionalRangeFontUnderlineStyle.none:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: single 20 | uid: 'ExcelScript!ExcelScript.ConditionalRangeFontUnderlineStyle.single:member' 21 | package: ExcelScript! 22 | summary: '' 23 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaltopbottomcriteriontype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ConditionalTopBottomCriterionType 3 | uid: 'ExcelScript!ExcelScript.ConditionalTopBottomCriterionType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ConditionalTopBottomCriterionType 6 | summary: Represents the criteria for the above/below average conditional format type. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: bottomItems 12 | uid: 'ExcelScript!ExcelScript.ConditionalTopBottomCriterionType.bottomItems:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: bottomPercent 16 | uid: 'ExcelScript!ExcelScript.ConditionalTopBottomCriterionType.bottomPercent:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: invalid 20 | uid: 'ExcelScript!ExcelScript.ConditionalTopBottomCriterionType.invalid:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: topItems 24 | uid: 'ExcelScript!ExcelScript.ConditionalTopBottomCriterionType.topItems:member' 25 | package: ExcelScript! 26 | summary: '' 27 | - name: topPercent 28 | uid: 'ExcelScript!ExcelScript.ConditionalTopBottomCriterionType.topPercent:member' 29 | package: ExcelScript! 30 | summary: '' 31 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.connectortype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ConnectorType 3 | uid: 'ExcelScript!ExcelScript.ConnectorType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ConnectorType 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script adds a line that goes from cell B2 to cell F4 on the current worksheet. 15 | */ 16 | function main(workbook: ExcelScript.Workbook) { 17 | // Get the current worksheet. 18 | const sheet = workbook.getActiveWorksheet(); 19 | 20 | // Get the ranges for the two cells. 21 | const b2Range = sheet.getRange("B2"); 22 | const f4Range = sheet.getRange("F4"); 23 | 24 | // Add a straight line that connects the top-left corners of both cells. 25 | const line = sheet.addLine( 26 | b2Range.getLeft(), 27 | b2Range.getTop(), 28 | f4Range.getLeft(), 29 | f4Range.getTop(), 30 | ExcelScript.ConnectorType.straight); 31 | } 32 | ``` 33 | isPreview: false 34 | isDeprecated: false 35 | fields: 36 | - name: curve 37 | uid: 'ExcelScript!ExcelScript.ConnectorType.curve:member' 38 | package: ExcelScript! 39 | summary: '' 40 | - name: elbow 41 | uid: 'ExcelScript!ExcelScript.ConnectorType.elbow:member' 42 | package: ExcelScript! 43 | summary: '' 44 | - name: straight 45 | uid: 'ExcelScript!ExcelScript.ConnectorType.straight:member' 46 | package: ExcelScript! 47 | summary: '' 48 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.contenttype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ContentType 3 | uid: 'ExcelScript!ExcelScript.ContentType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ContentType 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This sample creates a comment that mentions a specific person. 15 | * That person will get a notification and link to the workbook. 16 | */ 17 | function main(workbook: ExcelScript.Workbook) { 18 | // Get the first cell in the current worksheet. 19 | const currentSheet = workbook.getActiveWorksheet(); 20 | const cell = currentSheet.getCell(0,0); 21 | 22 | /* Create a CommentMention object for the comment. 23 | * 24 | * A CommentMention's properties are: 25 | * `name`: The name of the person being mentioned. 26 | * `id`: The zero-based index of this mention in the comment. 27 | * `email`: The email address of the person being mentioned. 28 | */ 29 | const mention: ExcelScript.CommentMention = { 30 | name: "Alex", 31 | id: 0, 32 | email: "alex@contoso.com" 33 | }; 34 | 35 | /* Create comment content that uses the mention. 36 | * The `` syntax embeds the mention with ID 0 in the comment text. 37 | * The name is displayed in the comment, 38 | * while an email is sent to the given address. 39 | */ 40 | const content: ExcelScript.CommentRichContent = { 41 | richContent: '' + mention.name + " - Hello!", 42 | mentions: [mention] 43 | }; 44 | 45 | // Add the comment. 46 | currentSheet.addComment(cell, content, ExcelScript.ContentType.mention); 47 | } 48 | ``` 49 | isPreview: false 50 | isDeprecated: false 51 | fields: 52 | - name: mention 53 | uid: 'ExcelScript!ExcelScript.ContentType.mention:member' 54 | package: ExcelScript! 55 | summary: Comment content containing mentions. 56 | - name: plain 57 | uid: 'ExcelScript!ExcelScript.ContentType.plain:member' 58 | package: ExcelScript! 59 | summary: Indicates a plain format type for the comment content. 60 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.customdatavalidation.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.CustomDataValidation 3 | uid: 'ExcelScript!ExcelScript.CustomDataValidation:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.CustomDataValidation 6 | summary: Represents the custom data validation criteria. 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script adds data validation to a range. 15 | * The validation prevents duplicate entries within that range. 16 | */ 17 | function main(workbook: ExcelScript.Workbook) { 18 | // Get the range "B2:B20". 19 | const sheet = workbook.getActiveWorksheet(); 20 | const range = sheet.getRange("B2:B20"); 21 | 22 | // Set data validation on the range to prevent duplicate, non-blank entries. 23 | const dataValidation = range.getDataValidation(); 24 | dataValidation.setIgnoreBlanks(true); 25 | const duplicateRule : ExcelScript.CustomDataValidation = { 26 | formula: "=COUNTIF($B$2:$B$20, B2)=1" 27 | }; 28 | dataValidation.setRule({ 29 | custom: duplicateRule 30 | }); 31 | } 32 | ``` 33 | isPreview: false 34 | isDeprecated: false 35 | type: interface 36 | properties: 37 | - name: formula 38 | uid: 'ExcelScript!ExcelScript.CustomDataValidation#formula:member' 39 | package: ExcelScript! 40 | fullName: formula 41 | summary: >- 42 | A custom data validation formula. This creates special input rules, such as preventing duplicates, or limiting the 43 | total in a range of cells. 44 | remarks: '' 45 | isPreview: false 46 | isDeprecated: false 47 | syntax: 48 | content: 'formula: string;' 49 | return: 50 | type: string 51 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.datasourcetype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.DataSourceType 3 | uid: 'ExcelScript!ExcelScript.DataSourceType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.DataSourceType 6 | summary: Represents a command type of `DataConnection`. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: localRange 12 | uid: 'ExcelScript!ExcelScript.DataSourceType.localRange:member' 13 | package: ExcelScript! 14 | summary: The data source type is a range in the current workbook. 15 | - name: localTable 16 | uid: 'ExcelScript!ExcelScript.DataSourceType.localTable:member' 17 | package: ExcelScript! 18 | summary: The data source type is a table in the current workbook. 19 | - name: unknown 20 | uid: 'ExcelScript!ExcelScript.DataSourceType.unknown:member' 21 | package: ExcelScript! 22 | summary: The data source type is unknown or unsupported. 23 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.deleteshiftdirection.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.DeleteShiftDirection 3 | uid: 'ExcelScript!ExcelScript.DeleteShiftDirection:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.DeleteShiftDirection 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This sample creates a sample range, then deletes 15 | * "A1" using different DeleteShiftDirection values. 16 | */ 17 | function main(workbook: ExcelScript.Workbook) { 18 | // Add sample data to better visualize the delete changes. 19 | const currentSheet = workbook.getActiveWorksheet(); 20 | currentSheet.getRange("A1:D4").setValues([ 21 | [1,2,3,4], 22 | [5,6,7,8], 23 | [9,10,11,12], 24 | [13,14,15,16]]); 25 | 26 | // Delete A1 and shift the cells from the right to fill the space. 27 | // The value being deleted is 1. 28 | currentSheet.getRange("A1").delete(ExcelScript.DeleteShiftDirection.left); 29 | 30 | // Delete A1 and shift the cells from the bottom to fill the space. 31 | // The value being deleted is 2. 32 | currentSheet.getRange("A1").delete(ExcelScript.DeleteShiftDirection.up); 33 | 34 | // Log the sample range. The values should be: 35 | /* 36 | 5, 3, 4, "", 37 | 9, 6, 7, 8, 38 | 13, 10, 11, 12, 39 | "", 14, 15, 16 40 | */ 41 | console.log(currentSheet.getRange("A1:D4").getValues()); 42 | } 43 | ``` 44 | isPreview: false 45 | isDeprecated: false 46 | fields: 47 | - name: left 48 | uid: 'ExcelScript!ExcelScript.DeleteShiftDirection.left:member' 49 | package: ExcelScript! 50 | summary: '' 51 | - name: up 52 | uid: 'ExcelScript!ExcelScript.DeleteShiftDirection.up:member' 53 | package: ExcelScript! 54 | summary: '' 55 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.documentpropertytype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.DocumentPropertyType 3 | uid: 'ExcelScript!ExcelScript.DocumentPropertyType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.DocumentPropertyType 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script uses a custom property to set the value and formatting of a cell. 15 | * If the value of "Routing Number" is not set or is not a number, the cell will be red. 16 | */ 17 | function main(workbook: ExcelScript.Workbook) { 18 | // Get the first cell from Sheet1. 19 | const cell = workbook.getWorksheet("Sheet1").getCell(0,0); 20 | 21 | // Get the "Routing Number" property. 22 | const properties = workbook.getProperties(); 23 | const routingNumber = properties.getCustomProperty("Routing Number"); 24 | 25 | // If the property is missing or is not a number, change the formatting to indicate a problem. 26 | if (!routingNumber || routingNumber.getType() != ExcelScript.DocumentPropertyType.number) { 27 | cell.getFormat().getFill().setColor("red"); 28 | } 29 | 30 | // If the property exists, use it to set the value of A1. 31 | if (routingNumber) { 32 | cell.setValue(routingNumber.getValue()); 33 | } 34 | } 35 | ``` 36 | isPreview: false 37 | isDeprecated: false 38 | fields: 39 | - name: boolean 40 | uid: 'ExcelScript!ExcelScript.DocumentPropertyType.boolean:member' 41 | package: ExcelScript! 42 | summary: '' 43 | - name: date 44 | uid: 'ExcelScript!ExcelScript.DocumentPropertyType.date:member' 45 | package: ExcelScript! 46 | summary: '' 47 | - name: float 48 | uid: 'ExcelScript!ExcelScript.DocumentPropertyType.float:member' 49 | package: ExcelScript! 50 | summary: '' 51 | - name: number 52 | uid: 'ExcelScript!ExcelScript.DocumentPropertyType.number:member' 53 | package: ExcelScript! 54 | summary: '' 55 | - name: string 56 | uid: 'ExcelScript!ExcelScript.DocumentPropertyType.string:member' 57 | package: ExcelScript! 58 | summary: '' 59 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.emptycellcontrol.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.EmptyCellControl 3 | uid: 'ExcelScript!ExcelScript.EmptyCellControl:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.EmptyCellControl 6 | summary: Represents an empty cell control. This represents the state where a cell does not have a control. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | properties: 12 | - name: type 13 | uid: 'ExcelScript!ExcelScript.EmptyCellControl#type:member' 14 | package: ExcelScript! 15 | fullName: type 16 | summary: '' 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'type: CellControlType.empty;' 22 | return: 23 | type: '' 24 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.filteroperator.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.FilterOperator 3 | uid: 'ExcelScript!ExcelScript.FilterOperator:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.FilterOperator 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * The script filters rows from a table based on a numerical range. 15 | */ 16 | function main(workbook: ExcelScript.Workbook) { 17 | // Get the first table in the current worksheet. 18 | const currentSheet = workbook.getActiveWorksheet(); 19 | const table = currentSheet.getTables()[0]; 20 | 21 | // Filter to only show rows with a value in the "Exam Score" column that is 22 | // greater than 0 and less than or equal to 60. 23 | table.getColumnByName("Exam Score").getFilter().applyCustomFilter(">0", "<=60", ExcelScript.FilterOperator.and); 24 | } 25 | ``` 26 | isPreview: false 27 | isDeprecated: false 28 | fields: 29 | - name: and 30 | uid: 'ExcelScript!ExcelScript.FilterOperator.and:member' 31 | package: ExcelScript! 32 | summary: '' 33 | - name: or 34 | uid: 'ExcelScript!ExcelScript.FilterOperator.or:member' 35 | package: ExcelScript! 36 | summary: '' 37 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.geometricshape.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.GeometricShape 3 | uid: 'ExcelScript!ExcelScript.GeometricShape:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.GeometricShape 6 | summary: >- 7 | Represents a geometric shape inside a worksheet. A geometric shape can be a rectangle, block arrow, equation symbol, 8 | flowchart item, star, banner, callout, or any other basic shape in Excel. 9 | remarks: '' 10 | isPreview: false 11 | isDeprecated: false 12 | type: interface 13 | methods: 14 | - name: getId() 15 | uid: 'ExcelScript!ExcelScript.GeometricShape#getId:member(1)' 16 | package: ExcelScript! 17 | fullName: getId() 18 | summary: Returns the shape identifier. 19 | remarks: '' 20 | isPreview: false 21 | isDeprecated: false 22 | syntax: 23 | content: 'getId(): string;' 24 | return: 25 | type: string 26 | description: '' 27 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.groupoption.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.GroupOption 3 | uid: 'ExcelScript!ExcelScript.GroupOption:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.GroupOption 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script creates a two-level column-based outline on Sheet1. 15 | */ 16 | function main(workbook: ExcelScript.Workbook) { 17 | // Group columns A-F in the worksheet named Sheet1. 18 | const sheet = workbook.getWorksheet("Sheet1"); 19 | const firstLevel = sheet.getRange("A:F"); 20 | firstLevel.group(ExcelScript.GroupOption.byColumns); 21 | 22 | // Create a second level to the outline by grouping subsections. 23 | sheet.getRange("A:B").group(ExcelScript.GroupOption.byColumns); 24 | sheet.getRange("D:E").group(ExcelScript.GroupOption.byColumns); 25 | } 26 | ``` 27 | isPreview: false 28 | isDeprecated: false 29 | fields: 30 | - name: byColumns 31 | uid: 'ExcelScript!ExcelScript.GroupOption.byColumns:member' 32 | package: ExcelScript! 33 | summary: Group by columns. 34 | - name: byRows 35 | uid: 'ExcelScript!ExcelScript.GroupOption.byRows:member' 36 | package: ExcelScript! 37 | summary: Group by rows. 38 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.headerfooterstate.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.HeaderFooterState 3 | uid: 'ExcelScript!ExcelScript.HeaderFooterState:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.HeaderFooterState 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: default 12 | uid: 'ExcelScript!ExcelScript.HeaderFooterState.default:member' 13 | package: ExcelScript! 14 | summary: Only one general header/footer is used for all pages printed. 15 | - name: firstAndDefault 16 | uid: 'ExcelScript!ExcelScript.HeaderFooterState.firstAndDefault:member' 17 | package: ExcelScript! 18 | summary: 'There is a separate first page header/footer, and a general header/footer used for all other pages.' 19 | - name: firstOddAndEven 20 | uid: 'ExcelScript!ExcelScript.HeaderFooterState.firstOddAndEven:member' 21 | package: ExcelScript! 22 | summary: 'There is a separate first page header/footer, then there is a separate header/footer for odd and even pages.' 23 | - name: oddAndEven 24 | uid: 'ExcelScript!ExcelScript.HeaderFooterState.oddAndEven:member' 25 | package: ExcelScript! 26 | summary: There is a different header/footer for odd and even pages. 27 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.horizontalalignment.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.HorizontalAlignment 3 | uid: 'ExcelScript!ExcelScript.HorizontalAlignment:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.HorizontalAlignment 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script centers the text in a table's header row cells. 15 | */ 16 | function main(workbook: ExcelScript.Workbook) { 17 | // Get the first table on the current worksheet. 18 | const currentSheet = workbook.getActiveWorksheet(); 19 | const table = currentSheet.getTables()[0]; 20 | 21 | // Get the header range. 22 | const headerRange = table.getHeaderRowRange(); 23 | 24 | // Set the horizontal text alignment to `center`. 25 | headerRange.getFormat().setHorizontalAlignment(ExcelScript.HorizontalAlignment.center); 26 | } 27 | ``` 28 | isPreview: false 29 | isDeprecated: false 30 | fields: 31 | - name: center 32 | uid: 'ExcelScript!ExcelScript.HorizontalAlignment.center:member' 33 | package: ExcelScript! 34 | summary: '' 35 | - name: centerAcrossSelection 36 | uid: 'ExcelScript!ExcelScript.HorizontalAlignment.centerAcrossSelection:member' 37 | package: ExcelScript! 38 | summary: '' 39 | - name: distributed 40 | uid: 'ExcelScript!ExcelScript.HorizontalAlignment.distributed:member' 41 | package: ExcelScript! 42 | summary: '' 43 | - name: fill 44 | uid: 'ExcelScript!ExcelScript.HorizontalAlignment.fill:member' 45 | package: ExcelScript! 46 | summary: '' 47 | - name: general 48 | uid: 'ExcelScript!ExcelScript.HorizontalAlignment.general:member' 49 | package: ExcelScript! 50 | summary: '' 51 | - name: justify 52 | uid: 'ExcelScript!ExcelScript.HorizontalAlignment.justify:member' 53 | package: ExcelScript! 54 | summary: '' 55 | - name: left 56 | uid: 'ExcelScript!ExcelScript.HorizontalAlignment.left:member' 57 | package: ExcelScript! 58 | summary: '' 59 | - name: right 60 | uid: 'ExcelScript!ExcelScript.HorizontalAlignment.right:member' 61 | package: ExcelScript! 62 | summary: '' 63 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.icon.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.Icon 3 | uid: 'ExcelScript!ExcelScript.Icon:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.Icon 6 | summary: Represents a cell icon. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | properties: 12 | - name: index 13 | uid: 'ExcelScript!ExcelScript.Icon#index:member' 14 | package: ExcelScript! 15 | fullName: index 16 | summary: Specifies the index of the icon in the given set. 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'index: number;' 22 | return: 23 | type: number 24 | - name: set 25 | uid: 'ExcelScript!ExcelScript.Icon#set:member' 26 | package: ExcelScript! 27 | fullName: set 28 | summary: Specifies the set that the icon is part of. 29 | remarks: '' 30 | isPreview: false 31 | isDeprecated: false 32 | syntax: 33 | content: 'set: IconSet;' 34 | return: 35 | type: '' 36 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.imagefittingmode.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ImageFittingMode 3 | uid: 'ExcelScript!ExcelScript.ImageFittingMode:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ImageFittingMode 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script returns an image of the first chart in the first worksheet. 15 | * That image is 600x400 pixels and the chart will be 16 | * stretched to fill those dimensions. 17 | * The returned image can be used in a Power Automate flow. 18 | */ 19 | function main(workbook: ExcelScript.Workbook): string { 20 | // Get the first chart in the first worksheet. 21 | const firstSheet = workbook.getFirstWorksheet(); 22 | const firstChart = firstSheet.getCharts()[0]; 23 | 24 | // Get an image of the chart as a base64-encoded string. 25 | const base64String = firstChart.getImage( 26 | 600, /* Width */ 27 | 400, /* Height */ 28 | ExcelScript.ImageFittingMode.fill /* Fill to match the dimensions. */ 29 | ); 30 | 31 | return base64String; 32 | } 33 | ``` 34 | isPreview: false 35 | isDeprecated: false 36 | fields: 37 | - name: fill 38 | uid: 'ExcelScript!ExcelScript.ImageFittingMode.fill:member' 39 | package: ExcelScript! 40 | summary: '' 41 | - name: fit 42 | uid: 'ExcelScript!ExcelScript.ImageFittingMode.fit:member' 43 | package: ExcelScript! 44 | summary: '' 45 | - name: fitAndCenter 46 | uid: 'ExcelScript!ExcelScript.ImageFittingMode.fitAndCenter:member' 47 | package: ExcelScript! 48 | summary: '' 49 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.insertshiftdirection.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.InsertShiftDirection 3 | uid: 'ExcelScript!ExcelScript.InsertShiftDirection:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.InsertShiftDirection 6 | summary: Determines the direction in which existing cells will be shifted to accommodate what is being inserted. 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script inserts headers at the top of the worksheet. 15 | */ 16 | function main(workbook: ExcelScript.Workbook) 17 | { 18 | let currentSheet = workbook.getActiveWorksheet(); 19 | 20 | // Create headers for 3 columns. 21 | let myHeaders = [["NAME", "ID", "ROLE"]]; 22 | 23 | // Add a blank first row and push existing data down a row. 24 | let firstRow = currentSheet.getRange("1:1"); 25 | firstRow.insert(ExcelScript.InsertShiftDirection.down); 26 | 27 | // Add the headers. 28 | currentSheet.getRange("A1:C1").setValues(myHeaders); 29 | } 30 | ``` 31 | isPreview: false 32 | isDeprecated: false 33 | fields: 34 | - name: down 35 | uid: 'ExcelScript!ExcelScript.InsertShiftDirection.down:member' 36 | package: ExcelScript! 37 | summary: '' 38 | - name: right 39 | uid: 'ExcelScript!ExcelScript.InsertShiftDirection.right:member' 40 | package: ExcelScript! 41 | summary: '' 42 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.keyboarddirection.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.KeyboardDirection 3 | uid: 'ExcelScript!ExcelScript.KeyboardDirection:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.KeyboardDirection 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script makes the font bold on all the contiguous cells between 15 | * A1 and the bottom of the used range of the first column. 16 | */ 17 | function main(workbook: ExcelScript.Workbook) 18 | { 19 | // Get the current worksheet. 20 | let selectedSheet = workbook.getActiveWorksheet(); 21 | 22 | // Get every cell that's used between A1 and the end of the column. 23 | // This recreates the Ctrl+Shift+Down arrow key behavior. 24 | let firstCell = selectedSheet.getRange("A1"); 25 | let firstColumn = firstCell.getExtendedRange(ExcelScript.KeyboardDirection.down); 26 | 27 | // Set the font to bold in that range. 28 | firstColumn.getFormat().getFont().setBold(true); 29 | } 30 | ``` 31 | isPreview: false 32 | isDeprecated: false 33 | fields: 34 | - name: down 35 | uid: 'ExcelScript!ExcelScript.KeyboardDirection.down:member' 36 | package: ExcelScript! 37 | summary: '' 38 | - name: left 39 | uid: 'ExcelScript!ExcelScript.KeyboardDirection.left:member' 40 | package: ExcelScript! 41 | summary: '' 42 | - name: right 43 | uid: 'ExcelScript!ExcelScript.KeyboardDirection.right:member' 44 | package: ExcelScript! 45 | summary: '' 46 | - name: up 47 | uid: 'ExcelScript!ExcelScript.KeyboardDirection.up:member' 48 | package: ExcelScript! 49 | summary: '' 50 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.linkeddatatypestate.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.LinkedDataTypeState 3 | uid: 'ExcelScript!ExcelScript.LinkedDataTypeState:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.LinkedDataTypeState 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: brokenLinkedData 12 | uid: 'ExcelScript!ExcelScript.LinkedDataTypeState.brokenLinkedData:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: disambiguationNeeded 16 | uid: 'ExcelScript!ExcelScript.LinkedDataTypeState.disambiguationNeeded:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: fetchingData 20 | uid: 'ExcelScript!ExcelScript.LinkedDataTypeState.fetchingData:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: none 24 | uid: 'ExcelScript!ExcelScript.LinkedDataTypeState.none:member' 25 | package: ExcelScript! 26 | summary: '' 27 | - name: validLinkedData 28 | uid: 'ExcelScript!ExcelScript.LinkedDataTypeState.validLinkedData:member' 29 | package: ExcelScript! 30 | summary: '' 31 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.loadtotype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.LoadToType 3 | uid: 'ExcelScript!ExcelScript.LoadToType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.LoadToType 6 | summary: An enum that specifies the query load to destination. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: connectionOnly 12 | uid: 'ExcelScript!ExcelScript.LoadToType.connectionOnly:member' 13 | package: ExcelScript! 14 | summary: Load to connection only. 15 | - name: pivotChart 16 | uid: 'ExcelScript!ExcelScript.LoadToType.pivotChart:member' 17 | package: ExcelScript! 18 | summary: Load to PivotChart. 19 | - name: pivotTable 20 | uid: 'ExcelScript!ExcelScript.LoadToType.pivotTable:member' 21 | package: ExcelScript! 22 | summary: Load to PivotTable. 23 | - name: table 24 | uid: 'ExcelScript!ExcelScript.LoadToType.table:member' 25 | package: ExcelScript! 26 | summary: Load to a table. 27 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.mixedcellcontrol.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.MixedCellControl 3 | uid: 'ExcelScript!ExcelScript.MixedCellControl:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.MixedCellControl 6 | summary: >- 7 | Represents the result of a query that resulted in multiple cell controls. If the result has multiple controls, then 8 | they can't be represented as a single result. 9 | remarks: '' 10 | isPreview: false 11 | isDeprecated: false 12 | type: interface 13 | properties: 14 | - name: type 15 | uid: 'ExcelScript!ExcelScript.MixedCellControl#type:member' 16 | package: ExcelScript! 17 | fullName: type 18 | summary: '' 19 | remarks: '' 20 | isPreview: false 21 | isDeprecated: false 22 | syntax: 23 | content: 'type: CellControlType.mixed;' 24 | return: 25 | type: '' 26 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.nameditemarrayvalues.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.NamedItemArrayValues 3 | uid: 'ExcelScript!ExcelScript.NamedItemArrayValues:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.NamedItemArrayValues 6 | summary: Represents an object containing values and types of a named item. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | methods: 12 | - name: getTypes() 13 | uid: 'ExcelScript!ExcelScript.NamedItemArrayValues#getTypes:member(1)' 14 | package: ExcelScript! 15 | fullName: getTypes() 16 | summary: Represents the types for each item in the named item array 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'getTypes(): RangeValueType[][];' 22 | return: 23 | type: '[][]' 24 | description: '' 25 | - name: getValues() 26 | uid: 'ExcelScript!ExcelScript.NamedItemArrayValues#getValues:member(1)' 27 | package: ExcelScript! 28 | fullName: getValues() 29 | summary: Represents the values of each item in the named item array. 30 | remarks: '' 31 | isPreview: false 32 | isDeprecated: false 33 | syntax: 34 | content: 'getValues(): (string | number | boolean)[][];' 35 | return: 36 | type: '(string | number | boolean)[][]' 37 | description: '' 38 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.nameditemscope.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.NamedItemScope 3 | uid: 'ExcelScript!ExcelScript.NamedItemScope:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.NamedItemScope 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: workbook 12 | uid: 'ExcelScript!ExcelScript.NamedItemScope.workbook:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: worksheet 16 | uid: 'ExcelScript!ExcelScript.NamedItemScope.worksheet:member' 17 | package: ExcelScript! 18 | summary: '' 19 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.nameditemtype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.NamedItemType 3 | uid: 'ExcelScript!ExcelScript.NamedItemType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.NamedItemType 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script looks for every named range with "Review" in the name 15 | * and marks the range with a yellow fill. 16 | */ 17 | function main(workbook: ExcelScript.Workbook) { 18 | // Look at every named item in the workbook. 19 | workbook.getNames().forEach((namedItem) => { 20 | // Find names containing "Review". 21 | if (namedItem.getName().includes("Review")) { 22 | // Only change the fill color if the named item is a range (not a formula). 23 | let itemType: ExcelScript.NamedItemType = namedItem.getType(); 24 | if (itemType === ExcelScript.NamedItemType.range) { 25 | // Set the range's fill color to yellow. 26 | namedItem.getRange().getFormat().getFill().setColor("yellow"); 27 | } 28 | } 29 | }); 30 | } 31 | ``` 32 | isPreview: false 33 | isDeprecated: false 34 | fields: 35 | - name: array 36 | uid: 'ExcelScript!ExcelScript.NamedItemType.array:member' 37 | package: ExcelScript! 38 | summary: '' 39 | - name: boolean 40 | uid: 'ExcelScript!ExcelScript.NamedItemType.boolean:member' 41 | package: ExcelScript! 42 | summary: '' 43 | - name: double 44 | uid: 'ExcelScript!ExcelScript.NamedItemType.double:member' 45 | package: ExcelScript! 46 | summary: '' 47 | - name: error 48 | uid: 'ExcelScript!ExcelScript.NamedItemType.error:member' 49 | package: ExcelScript! 50 | summary: '' 51 | - name: integer 52 | uid: 'ExcelScript!ExcelScript.NamedItemType.integer:member' 53 | package: ExcelScript! 54 | summary: '' 55 | - name: range 56 | uid: 'ExcelScript!ExcelScript.NamedItemType.range:member' 57 | package: ExcelScript! 58 | summary: '' 59 | - name: string 60 | uid: 'ExcelScript!ExcelScript.NamedItemType.string:member' 61 | package: ExcelScript! 62 | summary: '' 63 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.numberformatinfo.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.NumberFormatInfo 3 | uid: 'ExcelScript!ExcelScript.NumberFormatInfo:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.NumberFormatInfo 6 | summary: Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | methods: 12 | - name: getCurrencySymbol() 13 | uid: 'ExcelScript!ExcelScript.NumberFormatInfo#getCurrencySymbol:member(1)' 14 | package: ExcelScript! 15 | fullName: getCurrencySymbol() 16 | summary: Gets the currency symbol for currency values. This is based on current system settings. 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'getCurrencySymbol(): string;' 22 | return: 23 | type: string 24 | description: '' 25 | - name: getNumberDecimalSeparator() 26 | uid: 'ExcelScript!ExcelScript.NumberFormatInfo#getNumberDecimalSeparator:member(1)' 27 | package: ExcelScript! 28 | fullName: getNumberDecimalSeparator() 29 | summary: Gets the string used as the decimal separator for numeric values. This is based on current system settings. 30 | remarks: '' 31 | isPreview: false 32 | isDeprecated: false 33 | syntax: 34 | content: 'getNumberDecimalSeparator(): string;' 35 | return: 36 | type: string 37 | description: '' 38 | - name: getNumberGroupSeparator() 39 | uid: 'ExcelScript!ExcelScript.NumberFormatInfo#getNumberGroupSeparator:member(1)' 40 | package: ExcelScript! 41 | fullName: getNumberGroupSeparator() 42 | summary: >- 43 | Gets the string used to separate groups of digits to the left of the decimal for numeric values. This is based on 44 | current system settings. 45 | remarks: '' 46 | isPreview: false 47 | isDeprecated: false 48 | syntax: 49 | content: 'getNumberGroupSeparator(): string;' 50 | return: 51 | type: string 52 | description: '' 53 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.pagebreak.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.PageBreak 3 | uid: 'ExcelScript!ExcelScript.PageBreak:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.PageBreak 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | type: interface 11 | methods: 12 | - name: delete() 13 | uid: 'ExcelScript!ExcelScript.PageBreak#delete:member(1)' 14 | package: ExcelScript! 15 | fullName: delete() 16 | summary: Deletes a page break object. 17 | remarks: '' 18 | isPreview: false 19 | isDeprecated: false 20 | syntax: 21 | content: 'delete(): void;' 22 | return: 23 | type: void 24 | description: '' 25 | - name: getCellAfterBreak() 26 | uid: 'ExcelScript!ExcelScript.PageBreak#getCellAfterBreak:member(1)' 27 | package: ExcelScript! 28 | fullName: getCellAfterBreak() 29 | summary: Gets the first cell after the page break. 30 | remarks: '' 31 | isPreview: false 32 | isDeprecated: false 33 | syntax: 34 | content: 'getCellAfterBreak(): Range;' 35 | return: 36 | type: '' 37 | description: '' 38 | - name: getColumnIndex() 39 | uid: 'ExcelScript!ExcelScript.PageBreak#getColumnIndex:member(1)' 40 | package: ExcelScript! 41 | fullName: getColumnIndex() 42 | summary: Specifies the column index for the page break. 43 | remarks: '' 44 | isPreview: false 45 | isDeprecated: false 46 | syntax: 47 | content: 'getColumnIndex(): number;' 48 | return: 49 | type: number 50 | description: '' 51 | - name: getRowIndex() 52 | uid: 'ExcelScript!ExcelScript.PageBreak#getRowIndex:member(1)' 53 | package: ExcelScript! 54 | fullName: getRowIndex() 55 | summary: Specifies the row index for the page break. 56 | remarks: '' 57 | isPreview: false 58 | isDeprecated: false 59 | syntax: 60 | content: 'getRowIndex(): number;' 61 | return: 62 | type: number 63 | description: '' 64 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.pageorientation.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.PageOrientation 3 | uid: 'ExcelScript!ExcelScript.PageOrientation:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.PageOrientation 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script sets the printing orientation for the entire workbook. 15 | */ 16 | function main(workbook: ExcelScript.Workbook) { 17 | // Go to each worksheet so the print settings are consistent. 18 | workbook.getWorksheets().forEach((sheet) => { 19 | const pageLayout = sheet.getPageLayout(); 20 | 21 | // Print every page with a landscape orientation. 22 | pageLayout.setOrientation(ExcelScript.PageOrientation.landscape); 23 | }); 24 | } 25 | ``` 26 | isPreview: false 27 | isDeprecated: false 28 | fields: 29 | - name: landscape 30 | uid: 'ExcelScript!ExcelScript.PageOrientation.landscape:member' 31 | package: ExcelScript! 32 | summary: '' 33 | - name: portrait 34 | uid: 'ExcelScript!ExcelScript.PageOrientation.portrait:member' 35 | package: ExcelScript! 36 | summary: '' 37 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.pivotaxis.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.PivotAxis 3 | uid: 'ExcelScript!ExcelScript.PivotAxis:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.PivotAxis 6 | summary: Represents the axis from which to get the PivotItems. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: column 12 | uid: 'ExcelScript!ExcelScript.PivotAxis.column:member' 13 | package: ExcelScript! 14 | summary: The column axis. 15 | - name: data 16 | uid: 'ExcelScript!ExcelScript.PivotAxis.data:member' 17 | package: ExcelScript! 18 | summary: The data axis. 19 | - name: filter 20 | uid: 'ExcelScript!ExcelScript.PivotAxis.filter:member' 21 | package: ExcelScript! 22 | summary: The filter axis. 23 | - name: row 24 | uid: 'ExcelScript!ExcelScript.PivotAxis.row:member' 25 | package: ExcelScript! 26 | summary: The row axis. 27 | - name: unknown 28 | uid: 'ExcelScript!ExcelScript.PivotAxis.unknown:member' 29 | package: ExcelScript! 30 | summary: The axis or region is unknown or unsupported. 31 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.pivotfiltertopbottomcriterion.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.PivotFilterTopBottomCriterion 3 | uid: 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.PivotFilterTopBottomCriterion 6 | summary: Represents the criteria for the top/bottom values filter. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: bottomItems 12 | uid: 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion.bottomItems:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: bottomPercent 16 | uid: 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion.bottomPercent:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: bottomSum 20 | uid: 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion.bottomSum:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: invalid 24 | uid: 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion.invalid:member' 25 | package: ExcelScript! 26 | summary: '' 27 | - name: topItems 28 | uid: 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion.topItems:member' 29 | package: ExcelScript! 30 | summary: '' 31 | - name: topPercent 32 | uid: 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion.topPercent:member' 33 | package: ExcelScript! 34 | summary: '' 35 | - name: topSum 36 | uid: 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion.topSum:member' 37 | package: ExcelScript! 38 | summary: '' 39 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.pivotlayouttype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.PivotLayoutType 3 | uid: 'ExcelScript!ExcelScript.PivotLayoutType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.PivotLayoutType 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script sets the layout of the "Farms Sales" PivotTable to the "tabular" 15 | * setting. This places the fields from the Rows area in separate columns. 16 | */ 17 | function main(workbook: ExcelScript.Workbook) { 18 | // Get the PivotTable named "Farm Sales". 19 | const pivot = workbook.getPivotTable("Farm Sales"); 20 | 21 | // Get the PivotLayout object. 22 | const layout = pivot.getLayout(); 23 | 24 | // Set the layout type to "tabular". 25 | layout.setLayoutType(ExcelScript.PivotLayoutType.tabular); 26 | } 27 | ``` 28 | isPreview: false 29 | isDeprecated: false 30 | fields: 31 | - name: compact 32 | uid: 'ExcelScript!ExcelScript.PivotLayoutType.compact:member' 33 | package: ExcelScript! 34 | summary: A horizontally compressed form with labels from the next field in the same column. 35 | - name: outline 36 | uid: 'ExcelScript!ExcelScript.PivotLayoutType.outline:member' 37 | package: ExcelScript! 38 | summary: Inner fields' items are on same row as outer fields' items and subtotals are always on the bottom. 39 | - name: tabular 40 | uid: 'ExcelScript!ExcelScript.PivotLayoutType.tabular:member' 41 | package: ExcelScript! 42 | summary: Inner fields' items are always on a new line relative to the outer fields' items. 43 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.pivotmanualfilter.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.PivotManualFilter 3 | uid: 'ExcelScript!ExcelScript.PivotManualFilter:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.PivotManualFilter 6 | summary: >- 7 | Configurable template for a manual filter to apply to a PivotField. The `condition` defines what criteria need to be 8 | set in order for the filter to operate. 9 | remarks: |- 10 | 11 | 12 | #### Examples 13 | 14 | ```TypeScript 15 | /** 16 | * This script adds a manual filter to a PivotTable. 17 | */ 18 | function main(workbook: ExcelScript.Workbook) 19 | { 20 | // Get the first PivotTable in the workbook. 21 | const pivot = workbook.getPivotTables()[0]; 22 | 23 | // Get the hierarchy to use as the filter. 24 | const location = pivot.getHierarchy("Location"); 25 | 26 | // Use "Location" as the FilterHierarchy. 27 | pivot.addFilterHierarchy(location); 28 | 29 | // Select items for the filter. 30 | const cityFilter: ExcelScript.PivotManualFilter = { 31 | selectedItems: ["Seattle", "Chicago"] 32 | }; 33 | 34 | // Apply the filter 35 | // Note that hierarchies and fields have a 1:1 relationship in Excel, so `getFields()[0]` always gets the correct field. 36 | location.getFields()[0].applyFilter({ 37 | manualFilter: cityFilter 38 | }); 39 | } 40 | ``` 41 | isPreview: false 42 | isDeprecated: false 43 | type: interface 44 | properties: 45 | - name: selectedItems 46 | uid: 'ExcelScript!ExcelScript.PivotManualFilter#selectedItems:member' 47 | package: ExcelScript! 48 | fullName: selectedItems 49 | summary: A list of selected items to manually filter. These must be existing and valid items from the chosen field. 50 | remarks: '' 51 | isPreview: false 52 | isDeprecated: false 53 | syntax: 54 | content: 'selectedItems?: (string | PivotItem)[];' 55 | return: 56 | type: '(string | )[]' 57 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.placement.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.Placement 3 | uid: 'ExcelScript!ExcelScript.Placement:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.Placement 6 | summary: Specifies the way that an object is attached to its underlying cells. 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script creates a diamond shape at cell C3. 15 | * The shape moves and resizes as the grid underneath it changes. 16 | */ 17 | function main(workbook: ExcelScript.Workbook) { 18 | // Get cell C3 in the current worksheet. 19 | const sheet = workbook.getActiveWorksheet(); 20 | const cell = sheet.getRange("C3"); 21 | 22 | // Create a diamond that slightly overlaps the cell C3. 23 | const diamond = sheet.addGeometricShape(ExcelScript.GeometricShapeType.diamond); 24 | // Set each dimension so that the shape extends 5 pixels beyond the cell borders. 25 | diamond.setLeft(cell.getLeft() - 5); 26 | diamond.setTop(cell.getTop() - 5); 27 | diamond.setHeight(cell.getHeight() + 10); 28 | diamond.setWidth(cell.getWidth() + 10); 29 | 30 | // Set the placement of the shape so that it resizes and moves with the grid. 31 | diamond.setPlacement(ExcelScript.Placement.twoCell); 32 | } 33 | ``` 34 | isPreview: false 35 | isDeprecated: false 36 | fields: 37 | - name: absolute 38 | uid: 'ExcelScript!ExcelScript.Placement.absolute:member' 39 | package: ExcelScript! 40 | summary: The object is free floating. 41 | - name: oneCell 42 | uid: 'ExcelScript!ExcelScript.Placement.oneCell:member' 43 | package: ExcelScript! 44 | summary: The object is moved with the cells. 45 | - name: twoCell 46 | uid: 'ExcelScript!ExcelScript.Placement.twoCell:member' 47 | package: ExcelScript! 48 | summary: The object is moved and sized with the cells. 49 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.printcomments.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.PrintComments 3 | uid: 'ExcelScript!ExcelScript.PrintComments:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.PrintComments 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script makes the comments print at the end of the worksheet 15 | * when the workbook is printed. 16 | */ 17 | function main(workbook: ExcelScript.Workbook) { 18 | // Access every worksheet in the workbook. 19 | workbook.getWorksheets().forEach(worksheet => { 20 | // Get the page layout for each sheet. 21 | const layout = worksheet.getPageLayout(); 22 | 23 | // Change the comment printing settings to print them at the end of the sheet. 24 | layout.setPrintComments(ExcelScript.PrintComments.endSheet); 25 | }); 26 | } 27 | ``` 28 | isPreview: false 29 | isDeprecated: false 30 | fields: 31 | - name: endSheet 32 | uid: 'ExcelScript!ExcelScript.PrintComments.endSheet:member' 33 | package: ExcelScript! 34 | summary: Comments will be printed as end notes at the end of the worksheet. 35 | - name: inPlace 36 | uid: 'ExcelScript!ExcelScript.PrintComments.inPlace:member' 37 | package: ExcelScript! 38 | summary: Comments will be printed where they were inserted in the worksheet. 39 | - name: noComments 40 | uid: 'ExcelScript!ExcelScript.PrintComments.noComments:member' 41 | package: ExcelScript! 42 | summary: Comments will not be printed. 43 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.printerrortype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.PrintErrorType 3 | uid: 'ExcelScript!ExcelScript.PrintErrorType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.PrintErrorType 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: asDisplayed 12 | uid: 'ExcelScript!ExcelScript.PrintErrorType.asDisplayed:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: blank 16 | uid: 'ExcelScript!ExcelScript.PrintErrorType.blank:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: dash 20 | uid: 'ExcelScript!ExcelScript.PrintErrorType.dash:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: notAvailable 24 | uid: 'ExcelScript!ExcelScript.PrintErrorType.notAvailable:member' 25 | package: ExcelScript! 26 | summary: '' 27 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.printmarginunit.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.PrintMarginUnit 3 | uid: 'ExcelScript!ExcelScript.PrintMarginUnit:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.PrintMarginUnit 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: centimeters 12 | uid: 'ExcelScript!ExcelScript.PrintMarginUnit.centimeters:member' 13 | package: ExcelScript! 14 | summary: Assign the page margins in centimeters. 15 | - name: inches 16 | uid: 'ExcelScript!ExcelScript.PrintMarginUnit.inches:member' 17 | package: ExcelScript! 18 | summary: Assign the page margins in inches. 19 | - name: points 20 | uid: 'ExcelScript!ExcelScript.PrintMarginUnit.points:member' 21 | package: ExcelScript! 22 | summary: Assign the page margins in points. A point is 1/72 of an inch. 23 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.printorder.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.PrintOrder 3 | uid: 'ExcelScript!ExcelScript.PrintOrder:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.PrintOrder 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script sets the print order for every worksheet in the workbook. 15 | * The order of printed content will go over (e.g., left-to-right) 16 | * then down (i.e., top-to-bottom). 17 | */ 18 | function main(workbook: ExcelScript.Workbook) { 19 | // Access every worksheet in the workbook. 20 | workbook.getWorksheets().forEach(worksheet => { 21 | // Get the page layout for each sheet. 22 | const layout: ExcelScript.PageLayout = worksheet.getPageLayout(); 23 | 24 | // Set the print order to over-then-down. 25 | layout.setPrintOrder(ExcelScript.PrintOrder.overThenDown); 26 | }); 27 | } 28 | ``` 29 | isPreview: false 30 | isDeprecated: false 31 | fields: 32 | - name: downThenOver 33 | uid: 'ExcelScript!ExcelScript.PrintOrder.downThenOver:member' 34 | package: ExcelScript! 35 | summary: Process down the rows before processing across pages or page fields to the right. 36 | - name: overThenDown 37 | uid: 'ExcelScript!ExcelScript.PrintOrder.overThenDown:member' 38 | package: ExcelScript! 39 | summary: Process across pages or page fields to the right before moving down the rows. 40 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.protectionselectionmode.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ProtectionSelectionMode 3 | uid: 'ExcelScript!ExcelScript.ProtectionSelectionMode:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ProtectionSelectionMode 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script protects cells from being selected on the current worksheet. 15 | */ 16 | function main(workbook: ExcelScript.Workbook) { 17 | // Get the protection settings for the current worksheet. 18 | const currentSheet = workbook.getActiveWorksheet(); 19 | const sheetProtection = currentSheet.getProtection(); 20 | 21 | // Create a new WorksheetProtectionOptions object with the selectionMode property set to `none`. 22 | let protectionOptions : ExcelScript.WorksheetProtectionOptions = { 23 | selectionMode: ExcelScript.ProtectionSelectionMode.none 24 | } 25 | 26 | // Apply the given protection options. 27 | sheetProtection.protect(protectionOptions); 28 | } 29 | ``` 30 | isPreview: false 31 | isDeprecated: false 32 | fields: 33 | - name: none 34 | uid: 'ExcelScript!ExcelScript.ProtectionSelectionMode.none:member' 35 | package: ExcelScript! 36 | summary: Selection is not allowed for any cells. 37 | - name: normal 38 | uid: 'ExcelScript!ExcelScript.ProtectionSelectionMode.normal:member' 39 | package: ExcelScript! 40 | summary: Selection is allowed for all cells. 41 | - name: unlocked 42 | uid: 'ExcelScript!ExcelScript.ProtectionSelectionMode.unlocked:member' 43 | package: ExcelScript! 44 | summary: Selection is allowed only for cells that are not locked. 45 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.queryerror.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.QueryError 3 | uid: 'ExcelScript!ExcelScript.QueryError:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.QueryError 6 | summary: An enum that specifies the query load error message. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: failedDownload 12 | uid: 'ExcelScript!ExcelScript.QueryError.failedDownload:member' 13 | package: ExcelScript! 14 | summary: Download failed. 15 | - name: failedLoadToDataModel 16 | uid: 'ExcelScript!ExcelScript.QueryError.failedLoadToDataModel:member' 17 | package: ExcelScript! 18 | summary: Load to the data model failed. 19 | - name: failedLoadToWorksheet 20 | uid: 'ExcelScript!ExcelScript.QueryError.failedLoadToWorksheet:member' 21 | package: ExcelScript! 22 | summary: Load to the worksheet failed. 23 | - name: failedToCompleteDownload 24 | uid: 'ExcelScript!ExcelScript.QueryError.failedToCompleteDownload:member' 25 | package: ExcelScript! 26 | summary: Download did not complete. 27 | - name: none 28 | uid: 'ExcelScript!ExcelScript.QueryError.none:member' 29 | package: ExcelScript! 30 | summary: No error. 31 | - name: unknown 32 | uid: 'ExcelScript!ExcelScript.QueryError.unknown:member' 33 | package: ExcelScript! 34 | summary: Unknown error. 35 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.rangecopytype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.RangeCopyType 3 | uid: 'ExcelScript!ExcelScript.RangeCopyType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.RangeCopyType 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script copies all of the values from the current worksheet to a new worksheet. 15 | */ 16 | function main(workbook: ExcelScript.Workbook) { 17 | // Get the used range on the current worksheet. 18 | let usedRange = workbook.getActiveWorksheet().getUsedRange(); 19 | 20 | // Create a new worksheet with a default name. 21 | let newSheet = workbook.addWorksheet(); 22 | 23 | // Copy the values from the used range to the new worksheet. 24 | let copyType = ExcelScript.RangeCopyType.values; /* Change this to copy different information, such as formats. */ 25 | let targetRange = newSheet.getRangeByIndexes( 26 | usedRange.getRowIndex(), 27 | usedRange.getColumnIndex(), 28 | usedRange.getRowCount(), 29 | usedRange.getColumnCount()); 30 | targetRange.copyFrom(usedRange, copyType); 31 | 32 | // Switch the view to the new worksheet. 33 | newSheet.activate(); 34 | } 35 | ``` 36 | isPreview: false 37 | isDeprecated: false 38 | fields: 39 | - name: all 40 | uid: 'ExcelScript!ExcelScript.RangeCopyType.all:member' 41 | package: ExcelScript! 42 | summary: '' 43 | - name: formats 44 | uid: 'ExcelScript!ExcelScript.RangeCopyType.formats:member' 45 | package: ExcelScript! 46 | summary: '' 47 | - name: formulas 48 | uid: 'ExcelScript!ExcelScript.RangeCopyType.formulas:member' 49 | package: ExcelScript! 50 | summary: '' 51 | - name: link 52 | uid: 'ExcelScript!ExcelScript.RangeCopyType.link:member' 53 | package: ExcelScript! 54 | summary: '' 55 | - name: values 56 | uid: 'ExcelScript!ExcelScript.RangeCopyType.values:member' 57 | package: ExcelScript! 58 | summary: '' 59 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.rangeunderlinestyle.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.RangeUnderlineStyle 3 | uid: 'ExcelScript!ExcelScript.RangeUnderlineStyle:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.RangeUnderlineStyle 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: double 12 | uid: 'ExcelScript!ExcelScript.RangeUnderlineStyle.double:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: doubleAccountant 16 | uid: 'ExcelScript!ExcelScript.RangeUnderlineStyle.doubleAccountant:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: none 20 | uid: 'ExcelScript!ExcelScript.RangeUnderlineStyle.none:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: single 24 | uid: 'ExcelScript!ExcelScript.RangeUnderlineStyle.single:member' 25 | package: ExcelScript! 26 | summary: '' 27 | - name: singleAccountant 28 | uid: 'ExcelScript!ExcelScript.RangeUnderlineStyle.singleAccountant:member' 29 | package: ExcelScript! 30 | summary: '' 31 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.readingorder.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ReadingOrder 3 | uid: 'ExcelScript!ExcelScript.ReadingOrder:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ReadingOrder 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: context 12 | uid: 'ExcelScript!ExcelScript.ReadingOrder.context:member' 13 | package: ExcelScript! 14 | summary: >- 15 | Reading order is determined by the language of the first character entered. If a right-to-left language character 16 | is entered first, reading order is right to left. If a left-to-right language character is entered first, reading 17 | order is left to right. 18 | - name: leftToRight 19 | uid: 'ExcelScript!ExcelScript.ReadingOrder.leftToRight:member' 20 | package: ExcelScript! 21 | summary: Left to right reading order 22 | - name: rightToLeft 23 | uid: 'ExcelScript!ExcelScript.ReadingOrder.rightToLeft:member' 24 | package: ExcelScript! 25 | summary: Right to left reading order 26 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.removeduplicatesresult.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.RemoveDuplicatesResult 3 | uid: 'ExcelScript!ExcelScript.RemoveDuplicatesResult:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.RemoveDuplicatesResult 6 | summary: Represents the results from `Range.removeDuplicates`. 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script removes duplicate rows from a range. 15 | */ 16 | function main(workbook: ExcelScript.Workbook) { 17 | // Get the used range of the active worksheet. 18 | const usedRange = workbook.getActiveWorksheet().getUsedRange(); 19 | 20 | // Remove any row that has a same value in the 0-indexed column as a previous row. 21 | const removedResults: ExcelScript.RemoveDuplicatesResult = usedRange.removeDuplicates([0], true); 22 | 23 | // Log the count of removed rows. 24 | console.log(`Rows removed: ${removedResults.getRemoved()}.`); 25 | } 26 | ``` 27 | isPreview: false 28 | isDeprecated: false 29 | type: interface 30 | methods: 31 | - name: getRemoved() 32 | uid: 'ExcelScript!ExcelScript.RemoveDuplicatesResult#getRemoved:member(1)' 33 | package: ExcelScript! 34 | fullName: getRemoved() 35 | summary: Number of duplicated rows removed by the operation. 36 | remarks: '' 37 | isPreview: false 38 | isDeprecated: false 39 | syntax: 40 | content: 'getRemoved(): number;' 41 | return: 42 | type: number 43 | description: '' 44 | - name: getUniqueRemaining() 45 | uid: 'ExcelScript!ExcelScript.RemoveDuplicatesResult#getUniqueRemaining:member(1)' 46 | package: ExcelScript! 47 | fullName: getUniqueRemaining() 48 | summary: Number of remaining unique rows present in the resulting range. 49 | remarks: '' 50 | isPreview: false 51 | isDeprecated: false 52 | syntax: 53 | content: 'getUniqueRemaining(): number;' 54 | return: 55 | type: number 56 | description: '' 57 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.searchdirection.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.SearchDirection 3 | uid: 'ExcelScript!ExcelScript.SearchDirection:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.SearchDirection 6 | summary: Specifies the search direction. 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script searches for the next instance of the text "TK" on the current worksheet. 15 | * It then selects that cell and removes "TK" and all formatting from the cell. 16 | */ 17 | function main(workbook: ExcelScript.Workbook) { 18 | // Get the used range on the current worksheet. 19 | let range = workbook.getActiveWorksheet().getUsedRange(); 20 | 21 | // Get the next cell that contains "TK". 22 | let tkCell = range.find("TK", { 23 | completeMatch: true, /* Don't match if the cell text only contains "TK" as part of another string. */ 24 | matchCase: false, 25 | searchDirection: ExcelScript.SearchDirection.forward /* Start at the beginning of the range and go to later columns and rows. */ 26 | }); 27 | 28 | // Set focus on the found cell. 29 | tkCell.select(); 30 | 31 | // Remove the "TK" text value from the cell, as well as any formatting that may have been added. 32 | tkCell.clear(ExcelScript.ClearApplyTo.all); 33 | } 34 | ``` 35 | isPreview: false 36 | isDeprecated: false 37 | fields: 38 | - name: backwards 39 | uid: 'ExcelScript!ExcelScript.SearchDirection.backwards:member' 40 | package: ExcelScript! 41 | summary: Search in reverse order. 42 | - name: forward 43 | uid: 'ExcelScript!ExcelScript.SearchDirection.forward:member' 44 | package: ExcelScript! 45 | summary: Search in forward order. 46 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.shapeautosize.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ShapeAutoSize 3 | uid: 'ExcelScript!ExcelScript.ShapeAutoSize:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ShapeAutoSize 6 | summary: Determines the type of automatic sizing allowed. 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script creates a star shape with the value from cell A1. 15 | */ 16 | function main(workbook: ExcelScript.Workbook) { 17 | // Get the value of A1 from the worksheet named Sheet1. 18 | const sheet = workbook.getWorksheet("Sheet1"); 19 | const value = sheet.getRange("A1").getValue(); 20 | 21 | // Create a Shape object that looks like a 5-pointed star. 22 | const star = sheet.addGeometricShape(ExcelScript.GeometricShapeType.star5); 23 | 24 | // Set the text of star and make sure the shape fits the text. 25 | const textFrame = star.getTextFrame(); 26 | textFrame.getTextRange().setText(value.toString()); 27 | textFrame.setAutoSizeSetting(ExcelScript.ShapeAutoSize.autoSizeShapeToFitText); 28 | } 29 | ``` 30 | isPreview: false 31 | isDeprecated: false 32 | fields: 33 | - name: autoSizeMixed 34 | uid: 'ExcelScript!ExcelScript.ShapeAutoSize.autoSizeMixed:member' 35 | package: ExcelScript! 36 | summary: A combination of automatic sizing schemes are used. 37 | - name: autoSizeNone 38 | uid: 'ExcelScript!ExcelScript.ShapeAutoSize.autoSizeNone:member' 39 | package: ExcelScript! 40 | summary: No autosizing. 41 | - name: autoSizeShapeToFitText 42 | uid: 'ExcelScript!ExcelScript.ShapeAutoSize.autoSizeShapeToFitText:member' 43 | package: ExcelScript! 44 | summary: The shape is adjusted to fit the text. 45 | - name: autoSizeTextToFitShape 46 | uid: 'ExcelScript!ExcelScript.ShapeAutoSize.autoSizeTextToFitShape:member' 47 | package: ExcelScript! 48 | summary: The text is adjusted to fit the shape. 49 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.shapefilltype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ShapeFillType 3 | uid: 'ExcelScript!ExcelScript.ShapeFillType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ShapeFillType 6 | summary: Specifies a shape's fill type. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: gradient 12 | uid: 'ExcelScript!ExcelScript.ShapeFillType.gradient:member' 13 | package: ExcelScript! 14 | summary: Gradient fill. 15 | - name: mixed 16 | uid: 'ExcelScript!ExcelScript.ShapeFillType.mixed:member' 17 | package: ExcelScript! 18 | summary: Mixed fill. 19 | - name: noFill 20 | uid: 'ExcelScript!ExcelScript.ShapeFillType.noFill:member' 21 | package: ExcelScript! 22 | summary: No fill. 23 | - name: pattern 24 | uid: 'ExcelScript!ExcelScript.ShapeFillType.pattern:member' 25 | package: ExcelScript! 26 | summary: Pattern fill. 27 | - name: pictureAndTexture 28 | uid: 'ExcelScript!ExcelScript.ShapeFillType.pictureAndTexture:member' 29 | package: ExcelScript! 30 | summary: Picture and texture fill. 31 | - name: solid 32 | uid: 'ExcelScript!ExcelScript.ShapeFillType.solid:member' 33 | package: ExcelScript! 34 | summary: Solid fill. 35 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.shapelinedashstyle.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ShapeLineDashStyle 3 | uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ShapeLineDashStyle 6 | summary: The dash style for a line. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: dash 12 | uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.dash:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: dashDot 16 | uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.dashDot:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: dashDotDot 20 | uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.dashDotDot:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: longDash 24 | uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.longDash:member' 25 | package: ExcelScript! 26 | summary: '' 27 | - name: longDashDot 28 | uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.longDashDot:member' 29 | package: ExcelScript! 30 | summary: '' 31 | - name: longDashDotDot 32 | uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.longDashDotDot:member' 33 | package: ExcelScript! 34 | summary: '' 35 | - name: roundDot 36 | uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.roundDot:member' 37 | package: ExcelScript! 38 | summary: '' 39 | - name: solid 40 | uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.solid:member' 41 | package: ExcelScript! 42 | summary: '' 43 | - name: squareDot 44 | uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.squareDot:member' 45 | package: ExcelScript! 46 | summary: '' 47 | - name: systemDash 48 | uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.systemDash:member' 49 | package: ExcelScript! 50 | summary: '' 51 | - name: systemDashDot 52 | uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.systemDashDot:member' 53 | package: ExcelScript! 54 | summary: '' 55 | - name: systemDot 56 | uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.systemDot:member' 57 | package: ExcelScript! 58 | summary: '' 59 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.shapelinestyle.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ShapeLineStyle 3 | uid: 'ExcelScript!ExcelScript.ShapeLineStyle:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ShapeLineStyle 6 | summary: The style for a line. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: single 12 | uid: 'ExcelScript!ExcelScript.ShapeLineStyle.single:member' 13 | package: ExcelScript! 14 | summary: Single line. 15 | - name: thickBetweenThin 16 | uid: 'ExcelScript!ExcelScript.ShapeLineStyle.thickBetweenThin:member' 17 | package: ExcelScript! 18 | summary: Thick line with a thin line on each side. 19 | - name: thickThin 20 | uid: 'ExcelScript!ExcelScript.ShapeLineStyle.thickThin:member' 21 | package: ExcelScript! 22 | summary: >- 23 | Thick line next to thin line. For horizontal lines, the thick line is above the thin line. For vertical lines, the 24 | thick line is to the left of the thin line. 25 | - name: thinThick 26 | uid: 'ExcelScript!ExcelScript.ShapeLineStyle.thinThick:member' 27 | package: ExcelScript! 28 | summary: >- 29 | Thick line next to thin line. For horizontal lines, the thick line is below the thin line. For vertical lines, the 30 | thick line is to the right of the thin line. 31 | - name: thinThin 32 | uid: 'ExcelScript!ExcelScript.ShapeLineStyle.thinThin:member' 33 | package: ExcelScript! 34 | summary: Two thin lines. 35 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.shapescalefrom.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ShapeScaleFrom 3 | uid: 'ExcelScript!ExcelScript.ShapeScaleFrom:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ShapeScaleFrom 6 | summary: Specifies which part of the shape retains its position when the shape is scaled. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: scaleFromBottomRight 12 | uid: 'ExcelScript!ExcelScript.ShapeScaleFrom.scaleFromBottomRight:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: scaleFromMiddle 16 | uid: 'ExcelScript!ExcelScript.ShapeScaleFrom.scaleFromMiddle:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: scaleFromTopLeft 20 | uid: 'ExcelScript!ExcelScript.ShapeScaleFrom.scaleFromTopLeft:member' 21 | package: ExcelScript! 22 | summary: '' 23 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.shapescaletype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ShapeScaleType 3 | uid: 'ExcelScript!ExcelScript.ShapeScaleType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ShapeScaleType 6 | summary: Specifies whether the shape is scaled relative to its original or current size. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: currentSize 12 | uid: 'ExcelScript!ExcelScript.ShapeScaleType.currentSize:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: originalSize 16 | uid: 'ExcelScript!ExcelScript.ShapeScaleType.originalSize:member' 17 | package: ExcelScript! 18 | summary: '' 19 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.shapetexthorizontalalignment.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ShapeTextHorizontalAlignment 3 | uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ShapeTextHorizontalAlignment 6 | summary: Specifies the horizontal alignment for the text frame in a shape. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: center 12 | uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment.center:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: distributed 16 | uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment.distributed:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: justify 20 | uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment.justify:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: justifyLow 24 | uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment.justifyLow:member' 25 | package: ExcelScript! 26 | summary: '' 27 | - name: left 28 | uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment.left:member' 29 | package: ExcelScript! 30 | summary: '' 31 | - name: right 32 | uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment.right:member' 33 | package: ExcelScript! 34 | summary: '' 35 | - name: thaiDistributed 36 | uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment.thaiDistributed:member' 37 | package: ExcelScript! 38 | summary: '' 39 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.shapetexthorizontaloverflow.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ShapeTextHorizontalOverflow 3 | uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalOverflow:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ShapeTextHorizontalOverflow 6 | summary: Specifies the horizontal overflow for the text frame in a shape. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: clip 12 | uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalOverflow.clip:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: overflow 16 | uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalOverflow.overflow:member' 17 | package: ExcelScript! 18 | summary: '' 19 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.shapetextorientation.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ShapeTextOrientation 3 | uid: 'ExcelScript!ExcelScript.ShapeTextOrientation:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ShapeTextOrientation 6 | summary: Specifies the orientation for the text frame in a shape. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: eastAsianVertical 12 | uid: 'ExcelScript!ExcelScript.ShapeTextOrientation.eastAsianVertical:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: horizontal 16 | uid: 'ExcelScript!ExcelScript.ShapeTextOrientation.horizontal:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: mongolianVertical 20 | uid: 'ExcelScript!ExcelScript.ShapeTextOrientation.mongolianVertical:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: vertical 24 | uid: 'ExcelScript!ExcelScript.ShapeTextOrientation.vertical:member' 25 | package: ExcelScript! 26 | summary: '' 27 | - name: vertical270 28 | uid: 'ExcelScript!ExcelScript.ShapeTextOrientation.vertical270:member' 29 | package: ExcelScript! 30 | summary: '' 31 | - name: wordArtVertical 32 | uid: 'ExcelScript!ExcelScript.ShapeTextOrientation.wordArtVertical:member' 33 | package: ExcelScript! 34 | summary: '' 35 | - name: wordArtVerticalRTL 36 | uid: 'ExcelScript!ExcelScript.ShapeTextOrientation.wordArtVerticalRTL:member' 37 | package: ExcelScript! 38 | summary: '' 39 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.shapetextreadingorder.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ShapeTextReadingOrder 3 | uid: 'ExcelScript!ExcelScript.ShapeTextReadingOrder:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ShapeTextReadingOrder 6 | summary: Specifies the reading order for the text frame in a shape. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: leftToRight 12 | uid: 'ExcelScript!ExcelScript.ShapeTextReadingOrder.leftToRight:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: rightToLeft 16 | uid: 'ExcelScript!ExcelScript.ShapeTextReadingOrder.rightToLeft:member' 17 | package: ExcelScript! 18 | summary: '' 19 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.shapetextverticalalignment.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ShapeTextVerticalAlignment 3 | uid: 'ExcelScript!ExcelScript.ShapeTextVerticalAlignment:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ShapeTextVerticalAlignment 6 | summary: Specifies the vertical alignment for the text frame in a shape. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: bottom 12 | uid: 'ExcelScript!ExcelScript.ShapeTextVerticalAlignment.bottom:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: distributed 16 | uid: 'ExcelScript!ExcelScript.ShapeTextVerticalAlignment.distributed:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: justified 20 | uid: 'ExcelScript!ExcelScript.ShapeTextVerticalAlignment.justified:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: middle 24 | uid: 'ExcelScript!ExcelScript.ShapeTextVerticalAlignment.middle:member' 25 | package: ExcelScript! 26 | summary: '' 27 | - name: top 28 | uid: 'ExcelScript!ExcelScript.ShapeTextVerticalAlignment.top:member' 29 | package: ExcelScript! 30 | summary: '' 31 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.shapetextverticaloverflow.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ShapeTextVerticalOverflow 3 | uid: 'ExcelScript!ExcelScript.ShapeTextVerticalOverflow:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ShapeTextVerticalOverflow 6 | summary: Specifies the vertical overflow for the text frame in a shape. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: clip 12 | uid: 'ExcelScript!ExcelScript.ShapeTextVerticalOverflow.clip:member' 13 | package: ExcelScript! 14 | summary: Hide text that does not fit vertically within the text frame. 15 | - name: ellipsis 16 | uid: 'ExcelScript!ExcelScript.ShapeTextVerticalOverflow.ellipsis:member' 17 | package: ExcelScript! 18 | summary: >- 19 | Hide text that does not fit vertically within the text frame, and add an ellipsis (...) at the end of the visible 20 | text. 21 | - name: overflow 22 | uid: 'ExcelScript!ExcelScript.ShapeTextVerticalOverflow.overflow:member' 23 | package: ExcelScript! 24 | summary: >- 25 | Allow text to overflow the text frame vertically (can be from the top, bottom, or both depending on the text 26 | alignment). 27 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.shapetype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ShapeType 3 | uid: 'ExcelScript!ExcelScript.ShapeType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ShapeType 6 | summary: Specifies the type of a shape. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: geometricShape 12 | uid: 'ExcelScript!ExcelScript.ShapeType.geometricShape:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: group 16 | uid: 'ExcelScript!ExcelScript.ShapeType.group:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: image 20 | uid: 'ExcelScript!ExcelScript.ShapeType.image:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: line 24 | uid: 'ExcelScript!ExcelScript.ShapeType.line:member' 25 | package: ExcelScript! 26 | summary: '' 27 | - name: unsupported 28 | uid: 'ExcelScript!ExcelScript.ShapeType.unsupported:member' 29 | package: ExcelScript! 30 | summary: '' 31 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.shapezorder.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.ShapeZOrder 3 | uid: 'ExcelScript!ExcelScript.ShapeZOrder:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.ShapeZOrder 6 | summary: Specifies where in the z-order a shape should be moved relative to other shapes. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: bringForward 12 | uid: 'ExcelScript!ExcelScript.ShapeZOrder.bringForward:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: bringToFront 16 | uid: 'ExcelScript!ExcelScript.ShapeZOrder.bringToFront:member' 17 | package: ExcelScript! 18 | summary: '' 19 | - name: sendBackward 20 | uid: 'ExcelScript!ExcelScript.ShapeZOrder.sendBackward:member' 21 | package: ExcelScript! 22 | summary: '' 23 | - name: sendToBack 24 | uid: 'ExcelScript!ExcelScript.ShapeZOrder.sendToBack:member' 25 | package: ExcelScript! 26 | summary: '' 27 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.sheetvisibility.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.SheetVisibility 3 | uid: 'ExcelScript!ExcelScript.SheetVisibility:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.SheetVisibility 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script unhides all the worksheets in the workbook. 15 | */ 16 | function main(workbook: ExcelScript.Workbook) { 17 | // Iterate over each worksheet. 18 | workbook.getWorksheets().forEach((worksheet) => { 19 | // Set the worksheet visibility to visible. 20 | worksheet.setVisibility(ExcelScript.SheetVisibility.visible); 21 | }); 22 | } 23 | ``` 24 | isPreview: false 25 | isDeprecated: false 26 | fields: 27 | - name: hidden 28 | uid: 'ExcelScript!ExcelScript.SheetVisibility.hidden:member' 29 | package: ExcelScript! 30 | summary: '' 31 | - name: veryHidden 32 | uid: 'ExcelScript!ExcelScript.SheetVisibility.veryHidden:member' 33 | package: ExcelScript! 34 | summary: '' 35 | - name: visible 36 | uid: 'ExcelScript!ExcelScript.SheetVisibility.visible:member' 37 | package: ExcelScript! 38 | summary: '' 39 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.slicersorttype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.SlicerSortType 3 | uid: 'ExcelScript!ExcelScript.SlicerSortType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.SlicerSortType 6 | summary: Specifies the slicer sort behavior for `Slicer.sortBy`. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: ascending 12 | uid: 'ExcelScript!ExcelScript.SlicerSortType.ascending:member' 13 | package: ExcelScript! 14 | summary: Sort slicer items in ascending order by item captions. 15 | - name: dataSourceOrder 16 | uid: 'ExcelScript!ExcelScript.SlicerSortType.dataSourceOrder:member' 17 | package: ExcelScript! 18 | summary: Sort slicer items in the order provided by the data source. 19 | - name: descending 20 | uid: 'ExcelScript!ExcelScript.SlicerSortType.descending:member' 21 | package: ExcelScript! 22 | summary: Sort slicer items in descending order by item captions. 23 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.sortby.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.SortBy 3 | uid: 'ExcelScript!ExcelScript.SortBy:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.SortBy 6 | summary: Represents the sort direction. 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: ascending 12 | uid: 'ExcelScript!ExcelScript.SortBy.ascending:member' 13 | package: ExcelScript! 14 | summary: Ascending sort. Smallest to largest or A to Z. 15 | - name: descending 16 | uid: 'ExcelScript!ExcelScript.SortBy.descending:member' 17 | package: ExcelScript! 18 | summary: Descending sort. Largest to smallest or Z to A. 19 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.sortdataoption.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.SortDataOption 3 | uid: 'ExcelScript!ExcelScript.SortDataOption:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.SortDataOption 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script sorts a table based on the values in column 1. 15 | * If the text of a column-1 value can be treated as a number, 16 | * it will be sorted in numerical order, rather than Unicode order 17 | * (so 123 will come before 12.3). 18 | */ 19 | function main(workbook: ExcelScript.Workbook) { 20 | // Get the first table on the current worksheet. 21 | const currentSheet = workbook.getActiveWorksheet(); 22 | const table = currentSheet.getTables()[0]; 23 | 24 | // Create the sorting parameters. 25 | const countSortField: ExcelScript.SortField = { 26 | key: 1, 27 | ascending: true, 28 | dataOption: ExcelScript.SortDataOption.textAsNumber 29 | }; 30 | 31 | // Apply the sort to the table. 32 | const sort = table.getSort(); 33 | sort.apply([countSortField]); 34 | } 35 | ``` 36 | isPreview: false 37 | isDeprecated: false 38 | fields: 39 | - name: normal 40 | uid: 'ExcelScript!ExcelScript.SortDataOption.normal:member' 41 | package: ExcelScript! 42 | summary: '' 43 | - name: textAsNumber 44 | uid: 'ExcelScript!ExcelScript.SortDataOption.textAsNumber:member' 45 | package: ExcelScript! 46 | summary: '' 47 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.sortmethod.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.SortMethod 3 | uid: 'ExcelScript!ExcelScript.SortMethod:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.SortMethod 6 | summary: Represents the ordering method to be used when sorting Chinese characters. 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script sorts a range using the values in the first column. 15 | */ 16 | function main(workbook: ExcelScript.Workbook) { 17 | // Get the range (A1:D8) to sort from the current worksheet. 18 | const worksheet = workbook.getActiveWorksheet(); 19 | const rangeToSort = worksheet.getRange("A1:D8"); 20 | 21 | // Create a SortField for text sorting. 22 | let valueSort: ExcelScript.SortField = { 23 | ascending: true, 24 | key: 0, /* First column */ 25 | sortOn: ExcelScript.SortOn.value 26 | }; 27 | 28 | // Apply the SortField to the range. 29 | rangeToSort.getSort().apply( 30 | [valueSort], 31 | false, /* Don't let casing have an impact of sorting. */ 32 | true, /* The range has headers. */ 33 | ExcelScript.SortOrientation.rows, 34 | ExcelScript.SortMethod.pinYin /* Use phonetic sorting for Chinese characters. */ 35 | ); 36 | } 37 | ``` 38 | isPreview: false 39 | isDeprecated: false 40 | fields: 41 | - name: pinYin 42 | uid: 'ExcelScript!ExcelScript.SortMethod.pinYin:member' 43 | package: ExcelScript! 44 | summary: '' 45 | - name: strokeCount 46 | uid: 'ExcelScript!ExcelScript.SortMethod.strokeCount:member' 47 | package: ExcelScript! 48 | summary: '' 49 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.sorton.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.SortOn 3 | uid: 'ExcelScript!ExcelScript.SortOn:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.SortOn 6 | summary: Represents the part of the cell used as the sorting criteria. 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script sorts a range based on the color of the cells. 15 | * It brings all red cells to the top of the range. 16 | */ 17 | function main(workbook: ExcelScript.Workbook) { 18 | // Get the range (A1:D8) to sort from the current worksheet. 19 | const worksheet = workbook.getActiveWorksheet(); 20 | const rangeToSort = worksheet.getRange("A1:D8"); 21 | 22 | // Create a SortField for color sorting. 23 | // This sorts the rows based on the fill color of each row's cell in the first column. 24 | let colorSort: ExcelScript.SortField = { 25 | ascending: true, 26 | color: "FF0000", /* red */ 27 | key: 0, 28 | sortOn: ExcelScript.SortOn.cellColor 29 | }; 30 | 31 | // Apply the SortField to the range. 32 | rangeToSort.getSort().apply([colorSort]); 33 | } 34 | ``` 35 | isPreview: false 36 | isDeprecated: false 37 | fields: 38 | - name: cellColor 39 | uid: 'ExcelScript!ExcelScript.SortOn.cellColor:member' 40 | package: ExcelScript! 41 | summary: '' 42 | - name: fontColor 43 | uid: 'ExcelScript!ExcelScript.SortOn.fontColor:member' 44 | package: ExcelScript! 45 | summary: '' 46 | - name: icon 47 | uid: 'ExcelScript!ExcelScript.SortOn.icon:member' 48 | package: ExcelScript! 49 | summary: '' 50 | - name: value 51 | uid: 'ExcelScript!ExcelScript.SortOn.value:member' 52 | package: ExcelScript! 53 | summary: '' 54 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.sortorientation.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.SortOrientation 3 | uid: 'ExcelScript!ExcelScript.SortOrientation:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.SortOrientation 6 | summary: '' 7 | remarks: '' 8 | isPreview: false 9 | isDeprecated: false 10 | fields: 11 | - name: columns 12 | uid: 'ExcelScript!ExcelScript.SortOrientation.columns:member' 13 | package: ExcelScript! 14 | summary: '' 15 | - name: rows 16 | uid: 'ExcelScript!ExcelScript.SortOrientation.rows:member' 17 | package: ExcelScript! 18 | summary: '' 19 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.subtotallocationtype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.SubtotalLocationType 3 | uid: 'ExcelScript!ExcelScript.SubtotalLocationType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.SubtotalLocationType 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script displays group subtotals of the "Farms Sales" PivotTable. 15 | */ 16 | function main(workbook: ExcelScript.Workbook) { 17 | // Get the PivotTable named "Farm Sales". 18 | const pivot = workbook.getPivotTable("Farm Sales"); 19 | 20 | // Get the PivotLayout object. 21 | const layout = pivot.getLayout(); 22 | 23 | // Show all the subtotals at the bottom of each group. 24 | layout.setSubtotalLocation(ExcelScript.SubtotalLocationType.atBottom); 25 | } 26 | ``` 27 | isPreview: false 28 | isDeprecated: false 29 | fields: 30 | - name: atBottom 31 | uid: 'ExcelScript!ExcelScript.SubtotalLocationType.atBottom:member' 32 | package: ExcelScript! 33 | summary: Subtotals are at the bottom. 34 | - name: atTop 35 | uid: 'ExcelScript!ExcelScript.SubtotalLocationType.atTop:member' 36 | package: ExcelScript! 37 | summary: Subtotals are at the top. 38 | - name: 'off' 39 | uid: 'ExcelScript!ExcelScript.SubtotalLocationType.off:member' 40 | package: ExcelScript! 41 | summary: Subtotals are off. 42 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.topbottomselectiontype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.TopBottomSelectionType 3 | uid: 'ExcelScript!ExcelScript.TopBottomSelectionType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.TopBottomSelectionType 6 | summary: >- 7 | A simple enum for top/bottom filters to select whether to filter by the top N or bottom N percent, number, or sum of 8 | values. 9 | remarks: '' 10 | isPreview: false 11 | isDeprecated: false 12 | fields: 13 | - name: items 14 | uid: 'ExcelScript!ExcelScript.TopBottomSelectionType.items:member' 15 | package: ExcelScript! 16 | summary: Filter the top/bottom N number of items as measured by the chosen value. 17 | - name: percent 18 | uid: 'ExcelScript!ExcelScript.TopBottomSelectionType.percent:member' 19 | package: ExcelScript! 20 | summary: Filter the top/bottom N percent of items as measured by the chosen value. 21 | - name: sum 22 | uid: 'ExcelScript!ExcelScript.TopBottomSelectionType.sum:member' 23 | package: ExcelScript! 24 | summary: Filter the top/bottom N sum as measured by the chosen value. 25 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.unknowncellcontrol.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: ExcelScript.UnknownCellControl 3 | uid: 'ExcelScript!ExcelScript.UnknownCellControl:interface' 4 | package: ExcelScript! 5 | fullName: ExcelScript.UnknownCellControl 6 | summary: >- 7 | Represents an unknown cell control. This represents a control that was added in a future version of Excel, and the 8 | current version of Excel doesn't know how to display this control. 9 | remarks: '' 10 | isPreview: false 11 | isDeprecated: false 12 | type: interface 13 | properties: 14 | - name: type 15 | uid: 'ExcelScript!ExcelScript.UnknownCellControl#type:member' 16 | package: ExcelScript! 17 | fullName: type 18 | summary: '' 19 | remarks: '' 20 | isPreview: false 21 | isDeprecated: false 22 | syntax: 23 | content: 'type: CellControlType.unknown;' 24 | return: 25 | type: '' 26 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.verticalalignment.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.VerticalAlignment 3 | uid: 'ExcelScript!ExcelScript.VerticalAlignment:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.VerticalAlignment 6 | summary: '' 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script sets the vertical alignment formatting to "top" 15 | * for every cell in the row. 16 | */ 17 | function main(workbook: ExcelScript.Workbook) { 18 | // Get row 1 for the current worksheet. 19 | const sheet = workbook.getActiveWorksheet(); 20 | const firstRow = sheet.getRange("1:1"); 21 | 22 | // Set the vertical alignment formatting on the row. 23 | firstRow.getFormat().setVerticalAlignment(ExcelScript.VerticalAlignment.top); 24 | } 25 | ``` 26 | isPreview: false 27 | isDeprecated: false 28 | fields: 29 | - name: bottom 30 | uid: 'ExcelScript!ExcelScript.VerticalAlignment.bottom:member' 31 | package: ExcelScript! 32 | summary: '' 33 | - name: center 34 | uid: 'ExcelScript!ExcelScript.VerticalAlignment.center:member' 35 | package: ExcelScript! 36 | summary: '' 37 | - name: distributed 38 | uid: 'ExcelScript!ExcelScript.VerticalAlignment.distributed:member' 39 | package: ExcelScript! 40 | summary: '' 41 | - name: justify 42 | uid: 'ExcelScript!ExcelScript.VerticalAlignment.justify:member' 43 | package: ExcelScript! 44 | summary: '' 45 | - name: top 46 | uid: 'ExcelScript!ExcelScript.VerticalAlignment.top:member' 47 | package: ExcelScript! 48 | summary: '' 49 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.workbooklinksrefreshmode.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.WorkbookLinksRefreshMode 3 | uid: 'ExcelScript!ExcelScript.WorkbookLinksRefreshMode:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.WorkbookLinksRefreshMode 6 | summary: Represents the refresh mode of the workbook links. 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script refreshes all the links to external workbooks, 15 | * if the linked workbook refresh mode is set to manual. 16 | * To learn about linked workbooks, see https://support.microsoft.com/office/c98d1803-dd75-4668-ac6a-d7cca2a9b95f. 17 | */ 18 | function main(workbook: ExcelScript.Workbook) { 19 | // Check the refresh mode. 20 | if (workbook.getLinkedWorkbookRefreshMode() === ExcelScript.WorkbookLinksRefreshMode.manual) { 21 | console.log("Refreshing workbook links"); 22 | 23 | // Trigger a refresh of linked workbook content. 24 | workbook.refreshAllLinksToLinkedWorkbooks(); 25 | } 26 | } 27 | ``` 28 | isPreview: false 29 | isDeprecated: false 30 | fields: 31 | - name: automatic 32 | uid: 'ExcelScript!ExcelScript.WorkbookLinksRefreshMode.automatic:member' 33 | package: ExcelScript! 34 | summary: The workbook links are updated at a set interval determined by the Excel application. 35 | - name: manual 36 | uid: 'ExcelScript!ExcelScript.WorkbookLinksRefreshMode.manual:member' 37 | package: ExcelScript! 38 | summary: The workbook links are updated manually. 39 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetpositiontype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: ExcelScript.WorksheetPositionType 3 | uid: 'ExcelScript!ExcelScript.WorksheetPositionType:enum' 4 | package: ExcelScript! 5 | fullName: ExcelScript.WorksheetPositionType 6 | summary: The position of a worksheet relative to another worksheet or the entire worksheet collection. 7 | remarks: |- 8 | 9 | 10 | #### Examples 11 | 12 | ```TypeScript 13 | /** 14 | * This script duplicates a worksheet named "Template". 15 | * The new worksheet is added after the template. 16 | */ 17 | function main(workbook: ExcelScript.Workbook) { 18 | // Get the worksheet named "Template". 19 | let template = workbook.getWorksheet("Template"); 20 | 21 | // Copy the worksheet. 22 | let newSheet = template.copy( 23 | ExcelScript.WorksheetPositionType.after, 24 | template 25 | ); 26 | 27 | // Name the worksheet using the current date. 28 | let date = new Date(Date.now()); 29 | newSheet.setName(`${date.toDateString()}`); 30 | } 31 | ``` 32 | isPreview: false 33 | isDeprecated: false 34 | fields: 35 | - name: after 36 | uid: 'ExcelScript!ExcelScript.WorksheetPositionType.after:member' 37 | package: ExcelScript! 38 | summary: '' 39 | - name: before 40 | uid: 'ExcelScript!ExcelScript.WorksheetPositionType.before:member' 41 | package: ExcelScript! 42 | summary: '' 43 | - name: beginning 44 | uid: 'ExcelScript!ExcelScript.WorksheetPositionType.beginning:member' 45 | package: ExcelScript! 46 | summary: '' 47 | - name: end 48 | uid: 'ExcelScript!ExcelScript.WorksheetPositionType.end:member' 49 | package: ExcelScript! 50 | summary: '' 51 | - name: none 52 | uid: 'ExcelScript!ExcelScript.WorksheetPositionType.none:member' 53 | package: ExcelScript! 54 | summary: '' 55 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/global.officescript.emailattachment.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSType 2 | name: Global.OfficeScript.EmailAttachment 3 | uid: 'ExcelScript!Global.OfficeScript.EmailAttachment:interface' 4 | package: ExcelScript! 5 | fullName: Global.OfficeScript.EmailAttachment 6 | summary: >- 7 | The attachment to send with the email. A value must be specified for at least one of the `to`, `cc`, 8 | or `bcc` parameters. If no recipient is specified, the following error is shown: "The message has no recipient. Please 9 | enter a value for at least one of the "to", "cc", or "bcc" parameters." 10 | remarks: '' 11 | isPreview: true 12 | isDeprecated: false 13 | type: interface 14 | properties: 15 | - name: content 16 | uid: 'ExcelScript!Global.OfficeScript.EmailAttachment#content:member' 17 | package: ExcelScript! 18 | fullName: content 19 | summary: The contents of the file. 20 | remarks: '' 21 | isPreview: true 22 | isDeprecated: false 23 | syntax: 24 | content: 'content: string;' 25 | return: 26 | type: string 27 | - name: name 28 | uid: 'ExcelScript!Global.OfficeScript.EmailAttachment#name:member' 29 | package: ExcelScript! 30 | fullName: name 31 | summary: >- 32 | The text that is displayed below the icon representing the attachment. This string doesn't need to match the file 33 | name. 34 | remarks: '' 35 | isPreview: true 36 | isDeprecated: false 37 | syntax: 38 | content: 'name: string;' 39 | return: 40 | type: string 41 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/global.officescript.emailcontenttype.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: Global.OfficeScript.EmailContentType 3 | uid: 'ExcelScript!Global.OfficeScript.EmailContentType:enum' 4 | package: ExcelScript! 5 | fullName: Global.OfficeScript.EmailContentType 6 | summary: The type of the content. Possible values are text or HTML. 7 | remarks: '' 8 | isPreview: true 9 | isDeprecated: false 10 | fields: 11 | - name: html 12 | uid: 'ExcelScript!Global.OfficeScript.EmailContentType.html:member' 13 | package: ExcelScript! 14 | summary: The email message body is in HTML format. 15 | value: '"html"' 16 | - name: text 17 | uid: 'ExcelScript!Global.OfficeScript.EmailContentType.text:member' 18 | package: ExcelScript! 19 | summary: The email message body is in plain text format. 20 | value: '"text"' 21 | -------------------------------------------------------------------------------- /docs/docs-ref-autogen/excel/excelscript/global.officescript.emailimportance.yml: -------------------------------------------------------------------------------- 1 | ### YamlMime:TSEnum 2 | name: Global.OfficeScript.EmailImportance 3 | uid: 'ExcelScript!Global.OfficeScript.EmailImportance:enum' 4 | package: ExcelScript! 5 | fullName: Global.OfficeScript.EmailImportance 6 | summary: >- 7 | The importance value of the email. Corresponds to "high", "normal", and "low" importance values available in the 8 | Outlook UI. 9 | remarks: '' 10 | isPreview: true 11 | isDeprecated: false 12 | fields: 13 | - name: high 14 | uid: 'ExcelScript!Global.OfficeScript.EmailImportance.high:member' 15 | package: ExcelScript! 16 | summary: Email is marked as high importance. 17 | value: '"high"' 18 | - name: low 19 | uid: 'ExcelScript!Global.OfficeScript.EmailImportance.low:member' 20 | package: ExcelScript! 21 | summary: Email is marked as low importance. 22 | value: '"low"' 23 | - name: normal 24 | uid: 'ExcelScript!Global.OfficeScript.EmailImportance.normal:member' 25 | package: ExcelScript! 26 | summary: Email does not have any importance specified. 27 | value: '"normal"' 28 | -------------------------------------------------------------------------------- /generate-docs/.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | json 3 | yaml -------------------------------------------------------------------------------- /generate-docs/GenerateDocs.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | if [ -d "node_modules" ]; then 3 | rm -rf "node_modules" 4 | fi 5 | 6 | if [ -d "scripts/node_modules" ]; then 7 | rm -rf "scripts/node_modules" 8 | fi 9 | 10 | if [ -d "json" ]; then 11 | rm -rf "json" 12 | fi 13 | 14 | mkdir json 15 | 16 | if [ -d "yaml" ]; then 17 | rm -rf "yaml" 18 | fi 19 | 20 | mkdir yaml 21 | 22 | npm install 23 | 24 | pushd scripts 25 | npm install 26 | npm run build 27 | node preprocessor.js 28 | popd 29 | 30 | pushd api-extractor-inputs-excel 31 | ../node_modules/.bin/api-extractor run 32 | popd 33 | 34 | ./node_modules/.bin/api-documenter yaml --input-folder ./json/excel --output-folder ./yaml/excel --office 35 | 36 | pushd scripts 37 | node postprocessor.js 38 | popd 39 | 40 | ./node_modules/.bin/reference-coverage-tester reference-coverage-tester.json 41 | 42 | wait 43 | -------------------------------------------------------------------------------- /generate-docs/api-extractor-inputs-excel/api-extractor.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", 3 | "mainEntryPointFilePath": "excel.d.ts", 4 | "apiReport": { 5 | "enabled": false 6 | }, 7 | "docModel": { 8 | "enabled": true, 9 | "apiJsonFilePath": "../json/excel/.api.json" 10 | }, 11 | "dtsRollup": { 12 | "enabled": false 13 | }, 14 | "messages": { 15 | "extractorMessageReporting": { 16 | "ae-missing-release-tag": { 17 | "logLevel": "none" 18 | }, 19 | "ae-forgotten-export": { 20 | "logLevel": "none" 21 | } 22 | }, 23 | "tsdocMessageReporting": { 24 | "tsdoc-escape-right-brace": { 25 | "logLevel": "none" 26 | }, 27 | "tsdoc-escape-greater-than": { 28 | "logLevel": "none" 29 | }, 30 | "tsdoc-malformed-inline-tag": { 31 | "logLevel": "none" 32 | }, 33 | "tsdoc-unnecessary-backslash": { 34 | "logLevel": "none" 35 | } 36 | } 37 | } 38 | } -------------------------------------------------------------------------------- /generate-docs/api-extractor-inputs-excel/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "ExcelScript", 3 | "version": "2.0.0" 4 | } -------------------------------------------------------------------------------- /generate-docs/api-extractor-inputs-excel/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "es6", 4 | "forceConsistentCasingInFileNames": true, 5 | "module": "commonjs", 6 | "declaration": true, 7 | "sourceMap": true, 8 | "experimentalDecorators": true, 9 | "types": [ 10 | "node" 11 | ], 12 | "lib": [ 13 | "es5", 14 | "scripthost", 15 | "es2015.collection", 16 | "es2015.promise", 17 | "es2015.iterable", 18 | "dom" 19 | ] 20 | }, 21 | "include": [ "excel.d.ts" ] 22 | } 23 | -------------------------------------------------------------------------------- /generate-docs/api-extractor-inputs-excel/tsdoc-metadata.json: -------------------------------------------------------------------------------- 1 | // This file is read by tools that parse documentation comments conforming to the TSDoc standard. 2 | // It should be published with your NPM package. It should not be tracked by Git. 3 | { 4 | "tsdocVersion": "0.12", 5 | "toolPackages": [ 6 | { 7 | "packageName": "@microsoft/api-extractor", 8 | "packageVersion": "7.52.1" 9 | } 10 | ] 11 | } 12 | -------------------------------------------------------------------------------- /generate-docs/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "generate-docs", 3 | "version": "1.0.0", 4 | "dependencies": { 5 | "@microsoft/api-extractor": "^7.52.1", 6 | "@microsoft/api-documenter": "^7.26.17", 7 | "reference-coverage-tester": "^0.1.0" 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /generate-docs/reference-coverage-tester.json: -------------------------------------------------------------------------------- 1 | { 2 | "inputFolders": [ 3 | "../docs/docs-ref-autogen/excel/excelscript" 4 | ], 5 | "outputFolder": "", 6 | "notIncludedPatterns": [ 7 | ".interfaces." 8 | ] 9 | } -------------------------------------------------------------------------------- /generate-docs/scripts/.gitignore: -------------------------------------------------------------------------------- 1 | *.js 2 | *.js.map -------------------------------------------------------------------------------- /generate-docs/scripts/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "scripts", 3 | "version": "1.0.0", 4 | "description": "", 5 | "main": "index.js", 6 | "scripts": { 7 | "build": "tsc -p tsconfig.json", 8 | "start": "tsc -p tsconfig.json --watch", 9 | "lint": "eslint -c .eslintrc.js --ext .ts" 10 | }, 11 | "author": "", 12 | "license": "ISC", 13 | "devDependencies": { 14 | "@types/fs-extra": "11.0.4", 15 | "@types/js-yaml": "4.0.9", 16 | "@types/lodash": "4.17.0", 17 | "@types/node": "20.12.5", 18 | "@typescript-eslint/eslint-plugin": "^6.16.0", 19 | "@typescript-eslint/parser": "^6.16.0", 20 | "del": "7.1.0", 21 | "eslint": "^8.56.0", 22 | "eslint-config-prettier": "^9.1.0", 23 | "eslint-plugin-prefer-arrow": "^1.2.3", 24 | "typescript": "5.4.4" 25 | }, 26 | "dependencies": { 27 | "fs-extra": "11.2.0", 28 | "inquirer": "^9.2.17", 29 | "isomorphic-fetch": "^3.0.0", 30 | "js-yaml": "4.1.0", 31 | "lodash": "^4.17.21" 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /generate-docs/scripts/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "module": "commonjs", 4 | "target": "es6", 5 | "sourceMap": true, 6 | "typeRoots": [ 7 | "node_modules/**" 8 | ], 9 | "strict": false, 10 | "noUnusedLocals": true 11 | }, 12 | "exclude": [ 13 | "node_modules/**" 14 | ] 15 | } --------------------------------------------------------------------------------