excel.yaml

- id: excel-basics-basic-api-call
  name: Basic API call (TypeScript)
  fileName: basic-api-call.yaml
  description: Performs a basic Excel API call using TypeScript.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/01-basics/basic-api-call.yaml
  group: Basics
  api_set:
    ExcelApi: '1.1'
- id: excel-basics-basic-api-call-es5
  name: Basic API call (JavaScript)
  fileName: basic-api-call-es5.yaml
  description: Performs a basic Excel API call using plain JavaScript & Promises.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/01-basics/basic-api-call-es5.yaml
  group: Basics
  api_set:
    ExcelApi: '1.1'
- id: excel-basics-basic-common-api-call
  name: Basic API call (Office 2013)
  fileName: basic-common-api-call.yaml
  description: >-
    Performs a basic Excel API call using JavaScript with the "common API"
    syntax (compatible with Office 2013).
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/01-basics/basic-common-api-call.yaml
  group: Basics
  api_set:
    Selection: 1.1
- id: excel-chart-axis
  name: Axis details
  fileName: chart-axis.yaml
  description: Gets, sets, and removes axis unit, label, and title in a chart.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/10-chart/chart-axis.yaml
  group: Chart
  api_set:
    ExcelApi: '1.7'
- id: excel-chart-axis-formatting
  name: Axis formatting
  fileName: chart-axis-formatting.yaml
  description: Formats the vertical and horizontal axes in a chart.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/10-chart/chart-axis-formatting.yaml
  group: Chart
  api_set:
    ExcelApi: '1.8'
- id: excel-chart-data-table
  name: Chart data table
  fileName: chart-data-table.yaml
  description: Add a data table to a chart and then format that data table.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/10-chart/chart-data-table.yaml
  group: Chart
  api_set:
    ExcelApi: '1.14'
- id: excel-chart-bubble-chart
  name: Create bubble chart
  fileName: chart-bubble-chart.yaml
  description: >-
    Creates a bubble chart with each data row represented as a single chart
    series (bubble).
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/10-chart/chart-bubble-chart.yaml
  group: Chart
  api_set:
    ExcelApi: '1.12'
- id: excel-chart-create-several-charts
  name: Create charts
  fileName: chart-create-several-charts.yaml
  description: >-
    Creates column-clustered, line, XY-scatter, area, radar, pie, 3D, cylinder,
    and 100% charts.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/10-chart/chart-create-several-charts.yaml
  group: Chart
  api_set:
    ExcelApi: '1.4'
- id: excel-chart-create-doughnut-chart
  name: Doughnut chart
  fileName: create-doughnut-chart.yaml
  description: Creates a doughnut chart and adjusts its size.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/10-chart/create-doughnut-chart.yaml
  group: Chart
  api_set:
    ExcelApi: '1.7'
- id: excel-chart-formatting
  name: Formatting
  fileName: chart-formatting.yaml
  description: Formats labels and lines of a slope chart.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/10-chart/chart-formatting.yaml
  group: Chart
  api_set:
    ExcelApi: '1.8'
- id: excel-chart-legend
  name: Legend
  fileName: chart-legend.yaml
  description: Formats the legend's font.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/10-chart/chart-legend.yaml
  group: Chart
  api_set:
    ExcelApi: '1.7'
- id: excel-chart-point
  name: Points
  fileName: chart-point.yaml
  description: Sets the color of a point on the chart.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/10-chart/chart-point.yaml
  group: Chart
  api_set:
    ExcelApi: '1.7'
- id: excel-chart-series
  name: Series
  fileName: chart-series.yaml
  description: Adds and deletes series in a chart.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/10-chart/chart-series.yaml
  group: Chart
  api_set:
    ExcelApi: '1.7'
- id: excel-chart-series-markers
  name: Series markers
  fileName: chart-series-markers.yaml
  description: Sets the chart series marker properties.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/10-chart/chart-series-markers.yaml
  group: Chart
  api_set:
    ExcelApi: '1.7'
- id: excel-chart-series-plotorder
  name: Series plot order
  fileName: chart-series-plotorder.yaml
  description: Orders the plotting of series in a chart.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/10-chart/chart-series-plotorder.yaml
  group: Chart
  api_set:
    ExcelApi: '1.7'
- id: excel-chart-title-format
  name: Title format
  fileName: chart-title-format.yaml
  description: Adjust a chart title's format.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/10-chart/chart-title-format.yaml
  group: Chart
  api_set:
    ExcelApi: '1.7'
- id: excel-chart-data-source
  name: Chart series data source
  fileName: chart-data-source.yaml
  description: >-
    This sample shows how to get information about the data source of a chart
    series.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/10-chart/chart-data-source.yaml
  group: Chart
  api_set:
    ExcelApi: '1.15'
- id: excel-chart-trendlines
  name: Trendlines
  fileName: chart-trendlines.yaml
  description: Adds, gets, and formats trendlines in a chart.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/10-chart/chart-trendlines.yaml
  group: Chart
  api_set:
    ExcelApi: '1.7'
- id: excel-chart-data-labels
  name: Data labels
  fileName: chart-data-labels.yaml
  description: Add and style data labels for your charts.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/10-chart/chart-data-labels.yaml
  group: Chart
  api_set:
    ExcelApi: '1.19'
- id: excel-chart-leader-lines
  name: Leader lines
  fileName: chart-leader-lines.yaml
  description: Show and hide leader lines for chart labels.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/10-chart/chart-leader-lines.yaml
  group: Chart
  api_set:
    ExcelApi: '1.19'
- id: excel-comment-basics
  name: Comment basics
  fileName: comment-basics.yaml
  description: Adds, edits, and removes comments.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/12-comments-and-notes/comment-basics.yaml
  group: Comments And Notes
  api_set:
    ExcelApi: '1.10'
- id: excel-comment-mentions
  name: Comment mentions
  fileName: comment-mentions.yaml
  description: Mentions someone in a comment.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/12-comments-and-notes/comment-mentions.yaml
  group: Comments And Notes
  api_set:
    ExcelApi: '1.11'
- id: excel-comment-replies
  name: Comment replies
  fileName: comment-replies.yaml
  description: Adds, edits, and removes comment replies.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/12-comments-and-notes/comment-replies.yaml
  group: Comments And Notes
  api_set:
    ExcelApi: '1.10'
- id: excel-comment-resolution
  name: Comment resolution
  fileName: comment-resolution.yaml
  description: Resolves and reopens a comment thread.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/12-comments-and-notes/comment-resolution.yaml
  group: Comments And Notes
  api_set:
    ExcelApi: '1.10'
- id: excel-note-basics
  name: Notes
  fileName: excel-note-basics.yaml
  description: Adds, edits, and removes notes.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/12-comments-and-notes/excel-note-basics.yaml
  group: Comments And Notes
  api_set:
    ExcelApi: '1.18'
- id: excel-range-conditional-formatting-basic
  name: Basic conditional formatting
  fileName: conditional-formatting-basic.yaml
  description: Applies common types of conditional formatting to ranges.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml
  group: Conditional Formatting
  api_set:
    ExcelApi: '1.6'
- id: excel-range-conditional-formatting-advanced
  name: Advanced conditional formatting
  fileName: conditional-formatting-advanced.yaml
  description: Applies more than one conditional format on the same range.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/14-conditional-formatting/conditional-formatting-advanced.yaml
  group: Conditional Formatting
  api_set:
    ExcelApi: '1.6'
- id: excel-custom-functions-basic
  name: Basic custom function
  fileName: basic-function.yaml
  description: Calculates the volume of a sphere.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/16-custom-functions/basic-function.yaml
  group: Custom Functions
  api_set:
    CustomFunctionsRuntime: 1.1
- id: excel-custom-functions-volatile
  name: Volatile function
  fileName: volatile-function.yaml
  description: Rolls a 6 sided die that returns a possible new value every calculation.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/16-custom-functions/volatile-function.yaml
  group: Custom Functions
  api_set:
    CustomFunctionsRuntime: 1.1
- id: excel-custom-functions-streaming
  name: Streaming function
  fileName: streaming-function.yaml
  description: A streaming function that continuously increments the cell value.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/16-custom-functions/streaming-function.yaml
  group: Custom Functions
  api_set:
    CustomFunctionsRuntime: 1.1
- id: excel-custom-functions-invocation-address
  name: Invocation address sample
  fileName: invocation-address.yaml
  description: Reference the custom function's cell location to adjust behavior.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/16-custom-functions/invocation-address.yaml
  group: Custom Functions
  api_set:
    CustomFunctionsRuntime: 1.5
- id: excel-custom-functions-web-call
  name: Web request to GitHub API
  fileName: web-call-function.yaml
  description: Calls the GitHub API to get the star count for an org/user and repository.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/16-custom-functions/web-call-function.yaml
  group: Custom Functions
  api_set:
    CustomFunctionsRuntime: 1.1
- id: excel-custom-functions-errors
  name: Custom functions errors
  fileName: custom-functions-errors.yaml
  description: Returns the "#NUM!" error as part of a 2-dimensional array.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/16-custom-functions/custom-functions-errors.yaml
  group: Custom Functions
  api_set:
    CustomFunctionsRuntime: 1.2
- id: excel-data-types-custom-functions
  name: 'Data types: Custom functions'
  fileName: data-types-custom-functions.yaml
  description: >-
    This sample shows how to write custom functions that return entity value
    data types.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/16-custom-functions/data-types-custom-functions.yaml
  group: Custom Functions
  api_set:
    CustomFunctionsRuntime: 1.4
- id: excel-custom-functions-custom-enum
  name: Function with custom enums
  fileName: custom-enum.yaml
  description: >-
    Use custom enums as parameters in a custom function that searches for
    flights.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/16-custom-functions/custom-enum.yaml
  group: Custom Functions
  api_set:
    CustomFunctionsRuntime: 1.5
- id: excel-custom-xml-parts-create-set-get-and-delete-custom-xml-parts
  name: Using custom XML parts
  fileName: create-set-get-and-delete-custom-xml-parts.yaml
  description: Creates, sets, gets, and deletes a custom XML part.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/18-custom-xml-parts/create-set-get-and-delete-custom-xml-parts.yaml
  group: Custom XML Parts
  api_set:
    ExcelApi: '1.5'
- id: excel-custom-xml-parts-test-xml-for-unique-namespace
  name: Unique namespaces in custom XML
  fileName: test-xml-for-unique-namespace.yaml
  description: Tests to see if there is only one XML part for a specified namespace.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/18-custom-xml-parts/test-xml-for-unique-namespace.yaml
  group: Custom XML Parts
  api_set:
    ExcelApi: '1.5'
- id: excel-data-types-doubles
  name: 'Data types: Formatted numbers'
  fileName: data-types-formatted-number.yaml
  description: >-
    This sample shows how to set and get formatted numbers using double data
    types.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/20-data-types/data-types-formatted-number.yaml
  group: Data Types
  api_set:
    ExcelApi: '1.16'
- id: excel-data-types-web-image
  name: 'Data types: Web images'
  fileName: data-types-web-image.yaml
  description: >-
    This sample shows how to set and get web images in a worksheet using data
    types.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/20-data-types/data-types-web-image.yaml
  group: Data Types
  api_set:
    ExcelApi: '1.16'
- id: excel-data-types-entity-values
  name: 'Data types: Create entity cards from data in a table'
  fileName: data-types-entity-values.yaml
  description: >-
    This sample shows how to create entity cards for each row in a table. An
    entity is a container for data types, similar to an object in
    object-oriented programming.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/20-data-types/data-types-entity-values.yaml
  group: Data Types
  api_set:
    ExcelApi: '1.16'
- id: excel-data-types-error-values
  name: 'Data types: Set and change error values'
  fileName: data-types-error-values.yaml
  description: >-
    This sample shows how to set a cell value to an error data type, and then
    update the value of cells that contain an error data type.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/20-data-types/data-types-error-values.yaml
  group: Data Types
  api_set:
    ExcelApi: '1.16'
- id: excel-data-types-icons
  name: 'Data types: Create entity icons'
  fileName: data-types-entity-icons.yaml
  description: Display all the icons available for entity data types.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/20-data-types/data-types-entity-icons.yaml
  group: Data Types
  api_set:
    ExcelApi: '1.16'
- id: excel-data-types-entity-attribution
  name: 'Data types: Entity card attributions and layout types'
  fileName: data-types-entity-attribution.yaml
  description: >-
    Set data provider attributions on entity values and use different card
    layout types including list, two-column, and table.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/20-data-types/data-types-entity-attribution.yaml
  group: Data Types
  api_set:
    ExcelApi: '1.19'
- id: excel-data-types-references
  name: 'Data types: Entity values with references'
  fileName: data-types-references.yaml
  description: >-
    This sample shows how to create entity values with references to other
    entity values. An entity value is a container for data, and this container
    can reference (or contain) other entities within the original entity. One
    entity can contain multiple additional entities.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/20-data-types/data-types-references.yaml
  group: Data Types
  api_set:
    ExcelApi: '1.16'
- id: excel-data-types-basic-types
  name: Basic types with metadata
  fileName: data-types-basic-types.yaml
  description: This sample shows how to work with metadata on basic types.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/20-data-types/data-types-basic-types.yaml
  group: Data Types
  api_set:
    ExcelApi: '1.19'
- id: excel-data-validation
  name: Data validation
  fileName: data-validation.yaml
  description: >-
    Sets data validation rules on ranges, prompts users to enter valid data, and
    displays messages when invalid data is entered.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/22-data-validation/data-validation.yaml
  group: Data Validation
  api_set:
    ExcelApi: '1.8'
- id: excel-document-get-file-in-slices-async
  name: Get file using slicing
  fileName: get-file-in-slices-async.yaml
  description: >-
    Uses slicing to get the byte array and Base64-encoded string that represent
    the current document.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/26-document/get-file-in-slices-async.yaml
  group: Document
  api_set:
    ExcelApi: '1.4'
- id: excel-document-properties
  name: Properties
  fileName: properties.yaml
  description: Gets and sets document properties.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/26-document/properties.yaml
  group: Document
  api_set:
    ExcelApi: '1.7'
- id: excel-document-custom-properties
  name: Custom properties
  fileName: custom-properties.yaml
  description: Gets and sets custom properties at the document and worksheet levels.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/26-document/custom-properties.yaml
  group: Document
  api_set:
    ExcelAPI: '1.12'
- id: excel-events-chartcollection-added-activated
  name: Chart collection events
  fileName: events-chartcollection-added-activated.yaml
  description: >-
    Registers event handlers on a worksheet's chart collection that run when any
    chart within is activated or deactivated, as well as when charts are added
    to or deleted from the collection.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/30-events/events-chartcollection-added-activated.yaml
  group: Events
  api_set:
    ExcelApi: '1.8'
- id: excel-events-chart-activated
  name: Chart events
  fileName: events-chart-activated.yaml
  description: >-
    Registers event handlers on an individual chart that run when the chart is
    activated or deactivated.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/30-events/events-chart-activated.yaml
  group: Events
  api_set:
    ExcelApi: '1.8'
- id: excel-event-column-and-row-sort
  name: Column and row sort events
  fileName: event-column-and-row-sort.yaml
  description: >-
    Registers event handlers that run when column or row sorting events occur in
    the current worksheet.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/30-events/event-column-and-row-sort.yaml
  group: Events
  api_set:
    ExcelApi: '1.10'
- id: excel-events-comments
  name: Comment events
  fileName: events-comment-event-handler.yaml
  description: >-
    Registers event handlers to listen for comment additions, changes, and
    deletions.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/30-events/events-comment-event-handler.yaml
  group: Events
  api_set:
    ExcelAPI: '1.12'
- id: excel-events-data-changed
  name: Data changed event
  fileName: data-changed.yaml
  description: Registers an event handler that runs when data is changed.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/30-events/data-changed.yaml
  group: Events
  api_set:
    ExcelApi: '1.4'
- id: excel-data-change-event-details
  name: Data changed event details
  fileName: data-change-event-details.yaml
  description: Uses the onChanged event of a table to determine the specifics of changes.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/30-events/data-change-event-details.yaml
  group: Events
  api_set:
    ExcelApi: '1.9'
- id: excel-events-disable-events
  name: Enable and disable events
  fileName: events-disable-events.yaml
  description: Toggles event firing on and off.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/30-events/events-disable-events.yaml
  group: Events
  api_set:
    ExcelApi: '1.8'
- id: excel-events-formula-changed
  name: Formula changed event
  fileName: events-formula-changed.yaml
  description: Registers an event handler to detect changes to formulas.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/30-events/events-formula-changed.yaml
  group: Events
  api_set:
    ExcelAPI: '1.13'
- id: excel-selection-changed-events
  name: Selection changed events
  fileName: selection-changed-events.yaml
  description: >-
    Registers handlers all the different `onSelectionChanged` events and
    displays how each event reports the selected addresses.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/30-events/selection-changed-events.yaml
  group: Events
  api_set:
    ExcelApi: '1.7'
- id: excel-events-tablecollection-changed
  name: Table collection events
  fileName: events-tablecollection-changed.yaml
  description: Registers an event handler that runs when a table collection is changed.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/30-events/events-tablecollection-changed.yaml
  group: Events
  api_set:
    ExcelApi: '1.7'
- id: excel-event-worksheet-single-click
  name: Single click event
  fileName: event-worksheet-single-click.yaml
  description: >-
    Registers an event handler that runs when a single-click event occurs in the
    current worksheet.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/30-events/event-worksheet-single-click.yaml
  group: Events
  api_set:
    ExcelApi: '1.10'
- id: excel-events-table-changed
  name: Table events
  fileName: events-table-changed.yaml
  description: Registers event handlers that run when a table is changed or selected.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/30-events/events-table-changed.yaml
  group: Events
  api_set:
    ExcelApi: '1.7'
- id: excel-events-workbook-activated
  name: Workbook activated event
  fileName: events-workbook-activated.yaml
  description: This sample shows how to register a workbook activated event handler.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/30-events/events-workbook-activated.yaml
  group: Events
  api_set:
    ExcelAPI: '1.13'
- id: excel-events-workbook-and-worksheet-collection
  name: Workbook and worksheet collection events
  fileName: events-workbook-and-worksheet-collection.yaml
  description: >-
    Registers event handlers that run when a worksheet is added, activated,
    deactivated, moved, or when the settings of a workbook are changed.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml
  group: Events
  api_set:
    ExcelApi: '1.17'
- id: excel-events-worksheet
  name: Worksheet events
  fileName: events-worksheet.yaml
  description: Registers event handlers that run when worksheet events occur.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/30-events/events-worksheet.yaml
  group: Events
  api_set:
    ExcelApi: '1.17'
- id: excel-events-worksheet-protection
  name: Worksheet protection events
  fileName: events-worksheet-protection.yaml
  description: >-
    Registers an event handler to listen for worksheet protection status
    changes.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/30-events/events-worksheet-protection.yaml
  group: Events
  api_set:
    ExcelAPI: '1.14'
- id: excel-named-item-create-and-remove-named-item
  name: Create, access, and remove
  fileName: create-and-remove-named-item.yaml
  description: Creates, accesses, and removes named items in a worksheet.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/34-named-item/create-and-remove-named-item.yaml
  group: Named Item
  api_set:
    ExcelApi: '1.4'
- id: excel-update-named-item
  name: Update
  fileName: update-named-item.yaml
  description: Creates and then updates a named item.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/34-named-item/update-named-item.yaml
  group: Named Item
  api_set:
    ExcelApi: '1.7'
- id: excel-pivottable-calculations
  name: Calculations
  fileName: pivottable-calculations.yaml
  description: Changes the calculations the PivotTable performs.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/38-pivottable/pivottable-calculations.yaml
  group: PivotTable
  api_set:
    ExcelApi: '1.8'
- id: excel-pivottable-create-and-modify
  name: Create and modify
  fileName: pivottable-create-and-modify.yaml
  description: Creates and modifies a PivotTable.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/38-pivottable/pivottable-create-and-modify.yaml
  group: PivotTable
  api_set:
    ExcelApi: '1.8'
- id: excel-pivottable-filters-and-summaries
  name: Filters and summaries
  fileName: pivottable-filters-and-summaries.yaml
  description: Filters PivotTable data and shows different summarizations.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/38-pivottable/pivottable-filters-and-summaries.yaml
  group: PivotTable
  api_set:
    ExcelApi: '1.8'
- id: excel-pivottables-get-pivottables
  name: Get PivotTables
  fileName: pivottable-get-pivottables.yaml
  description: >-
    Get existing PivotTables in the workbook through their collections and
    through the ranges they occupy.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/38-pivottable/pivottable-get-pivottables.yaml
  group: PivotTable
  api_set:
    ExcelAPI: '1.12'
- id: excel-pivottables-pivotfilters
  name: PivotFilters
  fileName: pivottable-pivotfilters.yaml
  description: Applies PivotFilters to a PivotTable.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/38-pivottable/pivottable-pivotfilters.yaml
  group: PivotTable
  api_set:
    ExcelAPI: '1.12'
- id: excel-pivottable-pivotlayout
  name: PivotLayout
  fileName: pivottable-pivotlayout.yaml
  description: Sets PivotTable layout settings through the PivotLayout.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/38-pivottable/pivottable-pivotlayout.yaml
  group: PivotTable
  api_set:
    ExcelAPI: '1.13'
- id: excel-pivottable-data-source
  name: PivotTable data source
  fileName: pivottable-source-data.yaml
  description: Gets information about the data source of a PivotTable.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/38-pivottable/pivottable-source-data.yaml
  group: PivotTable
  api_set:
    ExcelApi: '1.15'
- id: excel-pivottable-refresh
  name: Refresh
  fileName: pivottable-refresh.yaml
  description: Refreshes a PivotTable based on table row additions.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/38-pivottable/pivottable-refresh.yaml
  group: PivotTable
  api_set:
    ExcelApi: '1.8'
- id: excel-pivottable-slicer
  name: Slicer
  fileName: pivottable-slicer.yaml
  description: Adds a slicer to a PivotTable.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/38-pivottable/pivottable-slicer.yaml
  group: PivotTable
  api_set:
    ExcelApi: '1.10'
- id: excel-range-auto-fill
  name: Auto fill
  fileName: range-auto-fill.yaml
  description: Writes to cells with the auto fill feature.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/42-range/range-auto-fill.yaml
  group: Range
  api_set:
    ExcelApi: '1.10'
- id: excel-range-copyfrom
  name: Copy and paste ranges
  fileName: range-copyfrom.yaml
  description: Copies or moves data and formatting from one range to another.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/42-range/range-copyfrom.yaml
  group: Range
  api_set:
    ExcelApi: '1.10'
- id: excel-range-areas
  name: Discontiguous ranges (RangeAreas) and special cells
  fileName: range-areas.yaml
  description: >-
    Creates and uses RangeAreas, which are sets of ranges that need not be
    contiguous, through user selection and programmatic selection of special
    cells.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/42-range/range-areas.yaml
  group: Range
  api_set:
    ExcelApi: '1.9'
- id: excel-range-find
  name: Find text matches within a range
  fileName: range-find.yaml
  description: Finds a cell within a range based on string matching.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/42-range/range-find.yaml
  group: Range
  api_set:
    ExcelApi: '1.9'
- id: excel-range-formatting
  name: Formatting
  fileName: formatting.yaml
  description: Formats a range.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/42-range/formatting.yaml
  group: Range
  api_set:
    ExcelApi: '1.4'
- id: excel-range-cell-properties
  name: Get and set cell properties
  fileName: cell-properties.yaml
  description: Sets different properties across a range then retrieves those properties.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/42-range/cell-properties.yaml
  group: Range
  api_set:
    ExcelApi: '1.9'
- id: excel-range-hyperlink
  name: Hyperlinks
  fileName: range-hyperlink.yaml
  description: Creates, updates, and clears hyperlinks in a range.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/42-range/range-hyperlink.yaml
  group: Range
  api_set:
    ExcelApi: '1.7'
- id: excel-range-insert-delete-and-clear-range
  name: Insert, delete, and clear
  fileName: insert-delete-clear-range.yaml
  description: Inserts, deletes, and clears a range.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/42-range/insert-delete-clear-range.yaml
  group: Range
  api_set:
    ExcelApi: '1.4'
- id: excel-outline
  name: Outline
  fileName: outline.yaml
  description: Creates an outline by grouping rows and columns.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/42-range/outline.yaml
  group: Range
  api_set:
    ExcelApi: '1.10'
- id: excel-range-range-relationships
  name: Range relationships
  fileName: range-relationships.yaml
  description: >-
    Shows relationships between ranges, such as bounding rectangles and
    intersections.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/42-range/range-relationships.yaml
  group: Range
  api_set:
    ExcelApi: '1.4'
- id: excel-range-remove-duplicates
  name: Remove duplicates
  fileName: range-remove-duplicates.yaml
  description: Removes duplicate entries from a range.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/42-range/range-remove-duplicates.yaml
  group: Range
  api_set:
    ExcelApi: '1.9'
- id: excel-range-selected-range
  name: Selected range
  fileName: selected-range.yaml
  description: Gets and sets the currently selected range.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/42-range/selected-range.yaml
  group: Range
  api_set:
    ExcelApi: '1.1'
- id: excel-precedents
  name: Precedents
  fileName: precedents.yaml
  description: >-
    This sample shows how to find and highlight the precedents of the currently
    selected cell. Precedents are cells referenced by the formula in a cell.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/42-range/precedents.yaml
  group: Range
  api_set:
    ExcelApi: '1.14'
- id: excel-range-style
  name: Style
  fileName: style.yaml
  description: >-
    Creates a custom style, applies a custom and built-in styles to a range,
    gets style properties, and deletes the custom style.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/42-range/style.yaml
  group: Range
  api_set:
    ExcelApi: '1.7'
- id: excel-range-text-orientation
  name: Text orientation
  fileName: range-text-orientation.yaml
  description: Gets and sets the text orientation within a range.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/42-range/range-text-orientation.yaml
  group: Range
  api_set:
    ExcelApi: '1.7'
- id: excel-range-dynamic-arrays
  name: Dynamic arrays
  fileName: dynamic-arrays.yaml
  description: >-
    Applies formulas that use dynamic arrays and displays information about the
    ranges used to display the data.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/42-range/dynamic-arrays.yaml
  group: Range
  api_set:
    ExcelAPI: '1.12'
- id: excel-range-used-range
  name: Used range
  fileName: used-range.yaml
  description: >-
    Tests for a used range and creates a chart from a table only if there's data
    in the table.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/42-range/used-range.yaml
  group: Range
  api_set:
    ExcelApi: '1.4'
- id: excel-range-values-and-formulas
  name: Values and formulas
  fileName: set-get-values.yaml
  description: Gets and sets values and formulas for a range.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/42-range/set-get-values.yaml
  group: Range
  api_set:
    ExcelApi: '1.4'
- id: excel-merged-ranges
  name: Merged ranges
  fileName: range-merged-ranges.yaml
  description: This sample shows how to create and find merged ranges in a worksheet.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/42-range/range-merged-ranges.yaml
  group: Range
  api_set:
    ExcelAPI: '1.13'
- id: excel-range-get-range-edge
  name: Select used range edge
  fileName: range-get-range-edge.yaml
  description: >-
    This sample shows how to select the edges of the used range, based on the
    currently selected range.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/42-range/range-get-range-edge.yaml
  group: Range
  api_set:
    ExcelAPI: '1.13'
- id: excel-direct-dependents
  name: Direct dependents
  fileName: range-direct-dependents.yaml
  description: >-
    This sample shows how to find and highlight the direct dependents of the
    currently selected cell. Dependent cells contain formulas that refer to
    other cells.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/42-range/range-direct-dependents.yaml
  group: Range
  api_set:
    ExcelAPI: '1.13'
- id: excel-range-dependents
  name: Dependents
  fileName: range-dependents.yaml
  description: >-
    This sample shows how to find and highlight the dependents of the currently
    selected cell. Dependent cells contain formulas that refer to other cells.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/42-range/range-dependents.yaml
  group: Range
  api_set:
    ExcelAPI: '1.15'
- id: excel-cell-controls
  name: Checkboxes
  fileName: range-cell-control.yaml
  description: This sample shows how to add and remove checkboxes from a table.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/42-range/range-cell-control.yaml
  group: Range
  api_set:
    ExcelApi: '1.18'
- id: excel-shape-create-and-delete
  name: Create and delete geometric shapes
  fileName: shape-create-and-delete.yaml
  description: >-
    Creates a few different geometric shapes and deletes them from the
    worksheet.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/44-shape/shape-create-and-delete.yaml
  group: Shape
  api_set:
    ExcelApi: '1.9'
- id: excel-shape-images
  name: Image shapes
  fileName: shape-images.yaml
  description: Creates and adjusts image-based shapes.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/44-shape/shape-images.yaml
  group: Shape
  api_set:
    ExcelApi: '1.9'
- id: excel-shape-lines
  name: Lines
  fileName: shape-lines.yaml
  description: Creates and modifies line shapes.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/44-shape/shape-lines.yaml
  group: Shape
  api_set:
    ExcelApi: '1.9'
- id: excel-shape-move-and-order
  name: Move and order shapes
  fileName: shape-move-and-order.yaml
  description: Moves created shapes around the worksheet and adjusts their z-order.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/44-shape/shape-move-and-order.yaml
  group: Shape
  api_set:
    ExcelApi: '1.9'
- id: excel-shape-groups
  name: Shape groups
  fileName: shape-groups.yaml
  description: Groups and ungroups shapes.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/44-shape/shape-groups.yaml
  group: Shape
  api_set:
    ExcelApi: '1.9'
- id: excel-shape-textboxes
  name: Textboxes
  fileName: shape-textboxes.yaml
  description: Creates a textbox shape and works with the text in it and other shapes.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/44-shape/shape-textboxes.yaml
  group: Shape
  api_set:
    ExcelApi: '1.9'
- id: excel-shape-get-active
  name: Get active shape image
  fileName: shape-get-active.yaml
  description: Get an image of the active shape in your workbook.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/44-shape/shape-get-active.yaml
  group: Shape
  api_set:
    ExcelApi: '1.19'
- id: excel-table-add-rows-and-columns-to-a-table
  name: Add rows and columns
  fileName: add-rows-and-columns-to-a-table.yaml
  description: Adds rows and columns to a table.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/46-table/add-rows-and-columns-to-a-table.yaml
  group: Table
  api_set:
    ExcelApi: '1.4'
- id: excel-table-convert-range-to-table
  name: Convert a range
  fileName: convert-range-to-table.yaml
  description: Converts a range to a table.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/46-table/convert-range-to-table.yaml
  group: Table
  api_set:
    ExcelApi: '1.4'
- id: excel-table-create-table
  name: Create a table
  fileName: create-table.yaml
  description: Creates a table.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/46-table/create-table.yaml
  group: Table
  api_set:
    ExcelApi: '1.4'
- id: excel-table-filter-data
  name: Filter data
  fileName: filter-data.yaml
  description: Filters table data.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/46-table/filter-data.yaml
  group: Table
  api_set:
    ExcelApi: '1.4'
- id: excel-table-formatting
  name: Formatting
  fileName: formatting.yaml
  description: Formats a table.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/46-table/formatting.yaml
  group: Table
  api_set:
    ExcelApi: '1.4'
- id: excel-table-get-data-from-table
  name: Get data
  fileName: get-data-from-table.yaml
  description: Gets data from a table.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/46-table/get-data-from-table.yaml
  group: Table
  api_set:
    ExcelApi: '1.4'
- id: excel-table-get-visible-range-of-a-filtered-table
  name: Get visible range
  fileName: get-visible-range-of-a-filtered-table.yaml
  description: Gets the visible range from a filtered table.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/46-table/get-visible-range-of-a-filtered-table.yaml
  group: Table
  api_set:
    ExcelApi: '1.4'
- id: excel-table-import-json-data
  name: Import JSON data
  fileName: import-json-data.yaml
  description: Imports JSON data into a table.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/46-table/import-json-data.yaml
  group: Table
  api_set:
    ExcelApi: '1.4'
- id: excel-table-sort-data
  name: Sort data
  fileName: sort-data.yaml
  description: Sorts the data within a table.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/46-table/sort-data.yaml
  group: Table
  api_set:
    ExcelApi: '1.4'
- id: excel-table-resize
  name: Resize a table
  fileName: resize-table.yaml
  description: This sample shows how to resize a table.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/46-table/resize-table.yaml
  group: Table
  api_set:
    ExcelAPI: '1.13'
- id: excel-workbook-get-active-cell
  name: Active cell
  fileName: workbook-get-active-cell.yaml
  description: Gets the active cell of the entire workbook.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/50-workbook/workbook-get-active-cell.yaml
  group: Workbook
  api_set:
    ExcelApi: '1.7'
- id: excel-settings-create-get-change-delete-settings
  name: Add-in settings
  fileName: create-get-change-delete-settings.yaml
  description: >-
    Creates, gets, changes, and deletes settings that are unique to the specific
    workbook and add-in combination.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/50-workbook/create-get-change-delete-settings.yaml
  group: Workbook
  api_set:
    ExcelApi: '1.4'
- id: excel-workbook-calculation
  name: Calculations
  fileName: workbook-calculation.yaml
  description: >-
    Demonstrates the calculation APIs of the workbook: events for when the
    worksheet recalculates and application-level calculation controls.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/50-workbook/workbook-calculation.yaml
  group: Workbook
  api_set:
    ExcelApi: '1.11'
- id: excel-workbook-create-workbook
  name: Create workbook
  fileName: create-workbook.yaml
  description: >-
    Creates a new, empty workbook and creates a new workbook by copying an
    existing one.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/50-workbook/create-workbook.yaml
  group: Workbook
  api_set:
    ExcelApi: '1.8'
- id: excel-culture-info
  name: Culture info
  fileName: culture-info.yaml
  description: >-
    This sample shows how to apply the cultural settings APIs to help normalize
    data.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/50-workbook/culture-info.yaml
  group: Workbook
  api_set:
    ExcelApi: '1.11'
- id: excel-culture-info-date-time
  name: 'Culture info: date and time'
  fileName: culture-info-date-time.yaml
  description: >-
    This sample shows how to use the read-only cultural settings APIs to
    retrieve system date and time settings.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/50-workbook/culture-info-date-time.yaml
  group: Workbook
  api_set:
    ExcelAPI: '1.12'
- id: excel-workbook-data-protection
  name: Data protection
  fileName: data-protection.yaml
  description: Protects data in a worksheet and the workbook structure.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/50-workbook/data-protection.yaml
  group: Workbook
  api_set:
    ExcelApi: '1.7'
- id: excel-workbook-save-and-close
  name: Save and close
  fileName: workbook-save-and-close.yaml
  description: Saves and closes a workbook.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/50-workbook/workbook-save-and-close.yaml
  group: Workbook
  api_set:
    ExcelAPI: '1.11'
- id: excel-workbook-insert-external-worksheets
  name: Insert external worksheets
  fileName: workbook-insert-external-worksheets.yaml
  description: Inserts worksheets from another workbook into the current workbook.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/50-workbook/workbook-insert-external-worksheets.yaml
  group: Workbook
  api_set:
    ExcelAPI: '1.13'
- id: excel-workbook-built-in-function
  name: Use built-in Excel functions
  fileName: workbook-built-in-functions.yaml
  description: Use the VLOOKUP and SUM built-in Excel functions.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/50-workbook/workbook-built-in-functions.yaml
  group: Workbook
  api_set:
    ExcelAPI: '1.2'
- id: excel-workbook-undo-grouping
  name: Undo grouping
  fileName: workbook-undo-grouping.yaml
  description: Group multiple API operations into a single undoable action.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/50-workbook/workbook-undo-grouping.yaml
  group: Workbook
  api_set:
    ExcelApi: '1.20'
- id: excel-worksheet-active-worksheet
  name: Active worksheet
  fileName: active-worksheet.yaml
  description: Gets and sets the active worksheet.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/54-worksheet/active-worksheet.yaml
  group: Worksheet
  api_set:
    ExcelApi: '1.1'
- id: excel-worksheet-add-delete-rename-move-worksheet
  name: Add, delete, rename, and move worksheet
  fileName: add-delete-rename-move-worksheet.yaml
  description: Adds, deletes, renames, and moves a worksheet.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/54-worksheet/add-delete-rename-move-worksheet.yaml
  group: Worksheet
  api_set:
    ExcelApi: '1.1'
- id: excel-worksheet-auto-filter
  name: AutoFilter
  fileName: worksheet-auto-filter.yaml
  description: Adds an AutoFilter to a worksheet.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/54-worksheet/worksheet-auto-filter.yaml
  group: Worksheet
  api_set:
    ExcelApi: '1.9'
- id: excel-worksheet-copy
  name: Copy worksheet
  fileName: worksheet-copy.yaml
  description: Copies the active worksheet to the specified location.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/54-worksheet/worksheet-copy.yaml
  group: Worksheet
  api_set:
    ExcelApi: '1.7'
- id: excel-worksheet-find-all
  name: Find text matches within a worksheet
  fileName: worksheet-find-all.yaml
  description: Finds cells within a worksheet based on string matching.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/54-worksheet/worksheet-find-all.yaml
  group: Worksheet
  api_set:
    ExcelApi: '1.9'
- id: excel-worksheet-freeze-panes
  name: Frozen panes
  fileName: worksheet-freeze-panes.yaml
  description: >-
    Freezes columns, rows, and a range of cells. Gets the address of the frozen
    pane. Unfreezes frozen panes.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/54-worksheet/worksheet-freeze-panes.yaml
  group: Worksheet
  api_set:
    ExcelApi: '1.7'
- id: excel-worksheet-worksheet-range-cell
  name: Get range or cell
  fileName: worksheet-range-cell.yaml
  description: >-
    Gets the used range, the entire range of a worksheet, the specified range,
    and the specified cell.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/54-worksheet/worksheet-range-cell.yaml
  group: Worksheet
  api_set:
    ExcelApi: '1.4'
- id: excel-worksheet-gridlines
  name: Gridlines
  fileName: gridlines.yaml
  description: Hides and shows a worksheet's gridlines.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/54-worksheet/gridlines.yaml
  group: Worksheet
  api_set:
    ExcelApi: '1.8'
- id: excel-worksheet-list-worksheets
  name: List worksheets
  fileName: list-worksheets.yaml
  description: Lists the worksheets in the workbook.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/54-worksheet/list-worksheets.yaml
  group: Worksheet
  api_set:
    ExcelApi: '1.1'
- id: excel-worksheet-page-layout
  name: Page layout and print settings
  fileName: worksheet-page-layout.yaml
  description: Changes the page layout and other settings for printing a worksheet.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/54-worksheet/worksheet-page-layout.yaml
  group: Worksheet
  api_set:
    ExcelApi: '1.9'
- id: excel-worksheet-reference-worksheets-by-relative-position
  name: Reference worksheets by relative position
  fileName: reference-worksheets-by-relative-position.yaml
  description: Gets a worksheet by using its relative position within the workbook.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/54-worksheet/reference-worksheets-by-relative-position.yaml
  group: Worksheet
  api_set:
    ExcelApi: '1.5'
- id: excel-worksheet-tab-color
  name: Tab color
  fileName: tab-color.yaml
  description: Gets and sets the tab color of a worksheet.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/54-worksheet/tab-color.yaml
  group: Worksheet
  api_set:
    ExcelApi: '1.7'
- id: excel-worksheet-visibility
  name: Visibility
  fileName: worksheet-visibility.yaml
  description: Hides and unhides a worksheet.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/54-worksheet/worksheet-visibility.yaml
  group: Worksheet
  api_set:
    ExcelApi: '1.1'
- id: excel-performance-optimization
  name: Performance optimization
  fileName: performance-optimization.yaml
  description: >-
    Optimizes performance by untracking ranges, turning off screen painting, and
    switching the calculation mode.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/90-scenarios/performance-optimization.yaml
  group: Scenarios
  api_set:
    ExcelApi: '1.9'
- id: excel-scenarios-report-generation
  name: Report generation
  fileName: report-generation.yaml
  description: >-
    Writes data to the workbook, reads and applies basic formatting, and adds a
    chart bound to that data.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/90-scenarios/report-generation.yaml
  group: Scenarios
  api_set:
    ExcelApi: '1.1'
- id: excel-scenarios-multiple-property-set
  name: Set multiple properties
  fileName: multiple-property-set.yaml
  description: Sets multiple properties at once with the API object set() method.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/90-scenarios/multiple-property-set.yaml
  group: Scenarios
  api_set:
    ExcelApi: '1.4'
- id: excel-scenarios-working-with-dates
  name: Working with dates
  fileName: working-with-dates.yaml
  description: >-
    Shows how to work with dates by converting between JavaScript timestamps and
    Excel's OLE Automation date format.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/90-scenarios/working-with-dates.yaml
  group: Scenarios
  api_set:
    ExcelApi: '1.4'
- id: excel-scenarios-currency-converter
  name: Currency Converter
  fileName: currency-converter.yaml
  description: >-
    Uses an exchange rate API to convert currency values based on their original
    transaction times.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/90-scenarios/currency-converter.yaml
  group: Scenarios
  api_set:
    ExcelApi: '1.4'
- id: excel-just-for-fun-patterns
  name: Colorful Patterns
  fileName: patterns.yaml
  description: >-
    Uses range formatting to draw interesting pattern. Contributed by Alexander
    Zlatkovski.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/99-just-for-fun/patterns.yaml
  group: Just For Fun
  api_set:
    ExcelApi: '1.4'
- id: excel-just-for-fun-gradient
  name: Gradient
  fileName: gradient.yaml
  description: >-
    Uses range formatting and external libraries to draw a colorful gradient
    within a range. Contributed by Alexander Zlatkovski.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/99-just-for-fun/gradient.yaml
  group: Just For Fun
  api_set:
    ExcelApi: '1.4'
- id: excel-just-for-fun-path-finder-game
  name: Path finder
  fileName: path-finder-game.yaml
  description: >-
    Uses range formatting to play a "pathfinder game". Contributed by Alexander
    Zlatkovski.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/99-just-for-fun/path-finder-game.yaml
  group: Just For Fun
  api_set:
    ExcelApi: '1.4'
- id: excel-just-for-fun-tetrominos
  name: Tetromino stacking
  fileName: tetrominos.yaml
  description: Arrange moving tetromino shapes to form lines.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/99-just-for-fun/tetrominos.yaml
  group: Just For Fun
  api_set:
    ExcelApi: '1.9'
- id: excel-just-for-fun-color-wheel
  name: Wheel of colors
  fileName: color-wheel.yaml
  description: >-
    Uses chart formatting to draw a wheel with changing colors. Contributed by
    Alexander Zlatkovski.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/99-just-for-fun/color-wheel.yaml
  group: Just For Fun
  api_set:
    ExcelApi: '1.4'
- id: excel-custom-functions-sync
  name: Synchronous custom function
  fileName: synchronous-function.yaml
  description: >-
    A synchronous custom function that reads a cell value in tandem with Excel's
    calculation process.
  rawUrl: >-
    https://raw.githubusercontent.com/OfficeDev/office-js-snippets/main/samples/excel/preview-apis/synchronous-function.yaml
  group: Preview APIs
  api_set:
    CustomFunctionsRuntime: 1.5