ExcelScript package

Interfaces

ExcelScript.AllowEditRange	Represents an AllowEditRange object found in a worksheet. This object works with worksheet protection properties. When worksheet protection is enabled, an AllowEditRange object can be used to allow editing of a specific range, while maintaining protection on the rest of the worksheet.
ExcelScript.AllowEditRangeOptions	The interface used to construct optional fields of the AllowEditRange object.
ExcelScript.Application	Represents the Excel application that manages the workbook.
ExcelScript.AutoFilter	Represents the AutoFilter object. AutoFilter turns the values in Excel column into specific filters based on the cell contents.
ExcelScript.BasicDataValidation	Represents the basic type data validation criteria.
ExcelScript.Binding	Represents an Office.js binding that is defined in the workbook.
ExcelScript.CellValueConditionalFormat	Represents a cell value conditional format.
ExcelScript.Chart	Represents a chart object in a workbook.
ExcelScript.ChartAreaFormat	Encapsulates the format properties for the overall chart area.
ExcelScript.ChartAxes	Represents the chart axes.
ExcelScript.ChartAxis	Represents a single axis in a chart.
ExcelScript.ChartAxisFormat	Encapsulates the format properties for the chart axis.
ExcelScript.ChartAxisTitle	Represents the title of a chart axis.
ExcelScript.ChartAxisTitleFormat	Represents the chart axis title formatting.
ExcelScript.ChartBinOptions	Encapsulates the bin options for histogram charts and pareto charts.
ExcelScript.ChartBorder	Represents the border formatting of a chart element.
ExcelScript.ChartBoxwhiskerOptions	Represents the properties of a box and whisker chart.
ExcelScript.ChartDataLabel	Represents the data label of a chart point.
ExcelScript.ChartDataLabelFormat	Encapsulates the format properties for the chart data labels.
ExcelScript.ChartDataLabels	Represents a collection of all the data labels on a chart point.
ExcelScript.ChartDataTable	Represents the data table object of a chart.
ExcelScript.ChartDataTableFormat	Represents the format of a chart data table.
ExcelScript.ChartErrorBars	This object represents the attributes for a chart's error bars.
ExcelScript.ChartErrorBarsFormat	Encapsulates the format properties for chart error bars.
ExcelScript.ChartFill	Represents the fill formatting for a chart element.
ExcelScript.ChartFont	This object represents the font attributes (such as font name, font size, and color) for a chart object.
ExcelScript.ChartFormatString	Represents the substring in chart related objects that contain text, like a ChartTitle object or ChartAxisTitle object.
ExcelScript.ChartGridlines	Represents major or minor gridlines on a chart axis.
ExcelScript.ChartGridlinesFormat	Encapsulates the format properties for chart gridlines.
ExcelScript.ChartLegend	Represents the legend in a chart.
ExcelScript.ChartLegendEntry	Represents the legend entry in legendEntryCollection.
ExcelScript.ChartLegendFormat	Encapsulates the format properties of a chart legend.
ExcelScript.ChartLineFormat	Encapsulates the formatting options for line elements.
ExcelScript.ChartMapOptions	Encapsulates the properties for a region map chart.
ExcelScript.ChartPivotOptions	Encapsulates the options for the pivot chart.
ExcelScript.ChartPlotArea	This object represents the attributes for a chart plot area.
ExcelScript.ChartPlotAreaFormat	Represents the format properties for a chart plot area.
ExcelScript.ChartPoint	Represents a point of a series in a chart.
ExcelScript.ChartPointFormat	Represents the formatting object for chart points.
ExcelScript.ChartSeries	Represents a series in a chart.
ExcelScript.ChartSeriesFormat	Encapsulates the format properties for the chart series
ExcelScript.ChartTitle	Represents a chart title object of a chart.
ExcelScript.ChartTitleFormat	Provides access to the formatting options for a chart title.
ExcelScript.ChartTrendline	This object represents the attributes for a chart trendline object.
ExcelScript.ChartTrendlineFormat	Represents the format properties for the chart trendline.
ExcelScript.ChartTrendlineLabel	This object represents the attributes for a chart trendline label object.
ExcelScript.ChartTrendlineLabelFormat	Encapsulates the format properties for the chart trendline label.
ExcelScript.ColorScaleConditionalFormat	Represents the color scale criteria for conditional formatting.
ExcelScript.Comment	Represents a comment in the workbook.
ExcelScript.CommentMention	Represents the entity that is mentioned in comments.
ExcelScript.CommentReply	Represents a comment reply in the workbook.
ExcelScript.CommentRichContent	Represents the content contained within a comment or comment reply. Rich content incudes the text string and any other objects contained within the comment body, such as mentions.
ExcelScript.ConditionalCellValueRule	Represents a cell value conditional format rule.
ExcelScript.ConditionalColorScaleCriteria	Represents the criteria of the color scale.
ExcelScript.ConditionalColorScaleCriterion	Represents a color scale criterion which contains a type, value, and a color.
ExcelScript.ConditionalDataBarNegativeFormat	Represents a conditional format for the negative side of the data bar.
ExcelScript.ConditionalDataBarPositiveFormat	Represents a conditional format for the positive side of the data bar.
ExcelScript.ConditionalDataBarRule	Represents a rule-type for a data bar.
ExcelScript.ConditionalFormat	An object encapsulating a conditional format's range, format, rule, and other properties.
ExcelScript.ConditionalFormatRule	Represents a rule, for all traditional rule/format pairings.
ExcelScript.ConditionalIconCriterion	Represents an icon criterion which contains a type, value, an operator, and an optional custom icon, if not using an icon set.
ExcelScript.ConditionalPresetCriteriaRule	Represents the preset criteria conditional format rule.
ExcelScript.ConditionalRangeBorder	Represents the border of an object.
ExcelScript.ConditionalRangeFill	Represents the background of a conditional range object.
ExcelScript.ConditionalRangeFont	This object represents the font attributes (font style, color, etc.) for an object.
ExcelScript.ConditionalRangeFormat	A format object encapsulating the conditional formats range's font, fill, borders, and other properties.
ExcelScript.ConditionalTextComparisonRule	Represents a cell value conditional format rule.
ExcelScript.ConditionalTopBottomRule	Represents the rule of the top/bottom conditional format.
ExcelScript.CultureInfo	Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings.
ExcelScript.CustomConditionalFormat	Represents a custom conditional format type.
ExcelScript.CustomDataValidation	Represents the custom data validation criteria.
ExcelScript.CustomProperty	Represents a custom property.
ExcelScript.CustomXmlPart	Represents a custom XML part object in a workbook.
ExcelScript.DataBarConditionalFormat	Represents an Excel conditional data bar type.
ExcelScript.DataPivotHierarchy	Represents the Excel DataPivotHierarchy.
ExcelScript.DataValidation	Represents the data validation applied to the current range.
ExcelScript.DataValidationErrorAlert	Represents the error alert properties for the data validation.
ExcelScript.DataValidationPrompt	Represents the user prompt properties for the data validation.
ExcelScript.DataValidationRule	A data validation rule contains different types of data validation. You can only use one of them at a time according the ExcelScript.DataValidationType.
ExcelScript.DateTimeDataValidation	Represents the date data validation criteria.
ExcelScript.DatetimeFormatInfo	Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings.
ExcelScript.DocumentProperties	Represents workbook properties.
ExcelScript.Filter	Manages the filtering of a table's column.
ExcelScript.FilterCriteria	Represents the filtering criteria applied to a column.
ExcelScript.FilterDatetime	Represents how to filter a date when filtering on values.
ExcelScript.FilterPivotHierarchy	Represents the Excel FilterPivotHierarchy.
ExcelScript.FormatProtection	Represents the format protection of a range object.
ExcelScript.GeometricShape	Represents a geometric shape inside a worksheet. A geometric shape can be a rectangle, block arrow, equation symbol, flowchart item, star, banner, callout, or any other basic shape in Excel.
ExcelScript.HeaderFooter
ExcelScript.HeaderFooterGroup
ExcelScript.Icon	Represents a cell icon.
ExcelScript.IconSetConditionalFormat	Represents an icon set criteria for conditional formatting.
ExcelScript.Image	Represents an image in the worksheet. To get the corresponding Shape object, use Image.getShape.
ExcelScript.IterativeCalculation	Represents the iterative calculation settings.
ExcelScript.Line	Represents a line inside a worksheet. To get the corresponding Shape object, use Line.shape.
ExcelScript.LinkedWorkbook	Contains information about a linked workbook. If a workbook has links pointing to data in another workbook, the second workbook is linked to the first workbook. In this scenario, the second workbook is called the "linked workbook".
ExcelScript.ListDataValidation	Represents the List data validation criteria.
ExcelScript.NamedItem	Represents a defined name for a range of cells or value. Names can be primitive named objects (as seen in the type below), range object, or a reference to a range. This object can be used to obtain range object associated with names.
ExcelScript.NamedItemArrayValues	Represents an object containing values and types of a named item.
ExcelScript.NamedSheetView	Represents a named sheet view of a worksheet. A sheet view stores the sort and filter rules for a particular worksheet. Every sheet view (even a temporary sheet view) has a unique, worksheet-scoped name that is used to access the view.
ExcelScript.NumberFormatInfo	Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings.
ExcelScript.PageBreak
ExcelScript.PageLayout	Represents layout and print settings that are not dependent on any printer-specific implementation. These settings include margins, orientation, page numbering, title rows, and print area.
ExcelScript.PageLayoutMarginOptions	Represents the options in page layout margins.
ExcelScript.PageLayoutZoomOptions	Represents page zoom properties.
ExcelScript.PivotDateFilter	Configurable template for a date filter to apply to a PivotField. The condition defines what criteria need to be set in order for the filter to operate.
ExcelScript.PivotField	Represents the Excel PivotField.
ExcelScript.PivotFilters	An interface representing all PivotFilters currently applied to a given PivotField.
ExcelScript.PivotHierarchy	Represents the Excel PivotHierarchy.
ExcelScript.PivotItem	Represents the Excel PivotItem.
ExcelScript.PivotLabelFilter	Configurable template for a label filter to apply to a PivotField. The condition defines what criteria need to be set in order for the filter to operate.
ExcelScript.PivotLayout	Represents the visual layout of the PivotTable.
ExcelScript.PivotManualFilter	Configurable template for a manual filter to apply to a PivotField. The condition defines what criteria need to be set in order for the filter to operate.
ExcelScript.PivotTable	Represents an Excel PivotTable.
ExcelScript.PivotTableStyle	Represents a PivotTable style, which defines style elements by PivotTable region.
ExcelScript.PivotValueFilter	Configurable template for a value filter to apply to a PivotField. The condition defines what criteria need to be set in order for the filter to operate.
ExcelScript.PredefinedCellStyle	An object encapsulating a style's format and other properties.
ExcelScript.PresetCriteriaConditionalFormat	Represents the preset criteria conditional format such as above average, below average, unique values, contains blank, nonblank, error, and noerror.
ExcelScript.Query	Represents a Power Query query.
ExcelScript.Range	Range represents a set of one or more contiguous cells such as a cell, a row, a column, or a block of cells.
ExcelScript.RangeAreas	RangeAreas represents a collection of one or more rectangular ranges in the same worksheet.
ExcelScript.RangeBorder	Represents the border of an object.
ExcelScript.RangeFill	Represents the background of a range object.
ExcelScript.RangeFont	This object represents the font attributes (font name, font size, color, etc.) for an object.
ExcelScript.RangeFormat	A format object encapsulating the range's font, fill, borders, alignment, and other properties.
ExcelScript.RangeHyperlink	Represents the necessary strings to get/set a hyperlink (XHL) object.
ExcelScript.RangeSort	Manages sorting operations on Range objects.
ExcelScript.RangeView	RangeView represents a set of visible cells of the parent range.
ExcelScript.RemoveDuplicatesResult	Represents the results from Range.removeDuplicates.
ExcelScript.ReplaceCriteria	Represents the replace criteria to be used.
ExcelScript.RowColumnPivotHierarchy	Represents the Excel RowColumnPivotHierarchy.
ExcelScript.SearchCriteria	Represents the search criteria to be used.
ExcelScript.Shape	Represents a generic shape object in the worksheet. A shape could be a geometric shape, a line, a group of shapes, etc.
ExcelScript.ShapeFill	Represents the fill formatting of a shape object.
ExcelScript.ShapeFont	Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
ExcelScript.ShapeGroup	Represents a shape group inside a worksheet. To get the corresponding Shape object, use ShapeGroup.shape.
ExcelScript.ShapeLineFormat	Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.
ExcelScript.ShowAsRule
ExcelScript.Slicer	Represents a Slicer object in the workbook.
ExcelScript.SlicerItem	Represents a slicer item in a slicer.
ExcelScript.SlicerStyle	Represents a slicer style, which defines style elements by region of the slicer.
ExcelScript.SortField	Represents a condition in a sorting operation.
ExcelScript.Subtotals	Subtotals for the Pivot Field.
ExcelScript.Table	Represents an Excel table.
ExcelScript.TableColumn	Represents a column in a table.
ExcelScript.TableSort	Manages sorting operations on Table objects.
ExcelScript.TableStyle	Represents a table style, which defines the style elements by region of the table.
ExcelScript.TextConditionalFormat	Represents a specific text conditional format.
ExcelScript.TextFrame	Represents the text frame of a shape object.
ExcelScript.TextRange	Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.
ExcelScript.TimelineStyle	Represents a TimelineStyle, which defines style elements by region in the timeline.
ExcelScript.TopBottomConditionalFormat	Represents a top/bottom conditional format.
ExcelScript.Workbook	Workbook is the top level object which contains related workbook objects such as worksheets, tables, and ranges.
ExcelScript.WorkbookProtection	Represents the protection of a workbook object.
ExcelScript.WorkbookRangeAreas	Represents a collection of one or more rectangular ranges in multiple worksheets.
ExcelScript.Worksheet	An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc.
ExcelScript.WorksheetCustomProperty	Represents a worksheet-level custom property.
ExcelScript.WorksheetFreezePanes
ExcelScript.WorksheetProtection	Represents the protection of a worksheet object.
ExcelScript.WorksheetProtectionOptions	Represents the options in sheet protection.
ExcelScript.WorksheetSearchCriteria	Represents the worksheet search criteria to be used.

Enums

ExcelScript.AggregationFunction	Aggregation function for the DataPivotHierarchy.
ExcelScript.ArrowheadLength
ExcelScript.ArrowheadStyle
ExcelScript.ArrowheadWidth
ExcelScript.AutoFillType	The behavior types when AutoFill is used on a range in the workbook.
ExcelScript.BindingType
ExcelScript.BorderIndex
ExcelScript.BorderLineStyle
ExcelScript.BorderWeight
ExcelScript.BuiltInStyle
ExcelScript.CalculationMode
ExcelScript.CalculationState	Represents the state of calculation across the entire Excel application.
ExcelScript.CalculationType
ExcelScript.ChartAxisCategoryType	Specifies the type of the category axis.
ExcelScript.ChartAxisDisplayUnit
ExcelScript.ChartAxisGroup
ExcelScript.ChartAxisPosition
ExcelScript.ChartAxisScaleType
ExcelScript.ChartAxisTickLabelPosition
ExcelScript.ChartAxisTickMark
ExcelScript.ChartAxisTimeUnit	Specifies the unit of time for chart axes and data series.
ExcelScript.ChartAxisType
ExcelScript.ChartBinType	Specifies the bin type of a histogram chart or pareto chart series.
ExcelScript.ChartBoxQuartileCalculation	Represents the quartile calculation type of chart series layout. Only applies to a box and whisker chart.
ExcelScript.ChartColorScheme
ExcelScript.ChartDataLabelPosition
ExcelScript.ChartDataSourceType	Specifies the data source type of the chart series.
ExcelScript.ChartDisplayBlanksAs
ExcelScript.ChartErrorBarsInclude	Represents which parts of the error bar to include.
ExcelScript.ChartErrorBarsType	Represents the range type for error bars.
ExcelScript.ChartGradientStyle	Represents the gradient style of a chart series. This is only applicable for region map charts.
ExcelScript.ChartGradientStyleType	Represents the gradient style type of a chart series. This is only applicable for region map charts.
ExcelScript.ChartLegendPosition
ExcelScript.ChartLineStyle
ExcelScript.ChartMapAreaLevel	Represents the mapping level of a chart series. This only applies to region map charts.
ExcelScript.ChartMapLabelStrategy	Represents the region level of a chart series layout. This only applies to region map charts.
ExcelScript.ChartMapProjectionType	Represents the region projection type of a chart series layout. This only applies to region map charts.
ExcelScript.ChartMarkerStyle
ExcelScript.ChartParentLabelStrategy	Represents the parent label strategy of the chart series layout. This only applies to treemap charts
ExcelScript.ChartPlotAreaPosition
ExcelScript.ChartPlotBy
ExcelScript.ChartSeriesBy	Specifies whether the series are by rows or by columns. In Excel on desktop, the "auto" option will inspect the source data shape to automatically guess whether the data is by rows or columns. In Excel on the web, "auto" will simply default to "columns".
ExcelScript.ChartSeriesDimension	Represents the dimensions when getting values from chart series.
ExcelScript.ChartSplitType
ExcelScript.ChartTextHorizontalAlignment	Represents the horizontal alignment for the specified object.
ExcelScript.ChartTextVerticalAlignment	Represents the vertical alignment for the specified object.
ExcelScript.ChartTickLabelAlignment
ExcelScript.ChartTitlePosition	Represents the position of the chart title.
ExcelScript.ChartTrendlineType
ExcelScript.ChartType
ExcelScript.ChartUnderlineStyle
ExcelScript.ClearApplyTo
ExcelScript.ConditionalCellValueOperator	Represents the operator of the text conditional format type.
ExcelScript.ConditionalDataBarAxisFormat	Represents the format options for a data bar axis.
ExcelScript.ConditionalDataBarDirection	Represents the data bar direction within a cell.
ExcelScript.ConditionalFormatColorCriterionType	Represents the types of color criterion for conditional formatting.
ExcelScript.ConditionalFormatDirection	Represents the direction for a selection.
ExcelScript.ConditionalFormatIconRuleType	Represents the types of icon conditional format.
ExcelScript.ConditionalFormatPresetCriterion	Represents the criteria of the preset criteria conditional format type.
ExcelScript.ConditionalFormatRuleType	Represents the types of conditional format values.
ExcelScript.ConditionalFormatType
ExcelScript.ConditionalIconCriterionOperator	Represents the operator for each icon criteria.
ExcelScript.ConditionalRangeBorderIndex
ExcelScript.ConditionalRangeBorderLineStyle
ExcelScript.ConditionalRangeFontUnderlineStyle
ExcelScript.ConditionalTextOperator	Represents the operator of the text conditional format type.
ExcelScript.ConditionalTopBottomCriterionType	Represents the criteria for the above/below average conditional format type.
ExcelScript.ConnectorType
ExcelScript.ContentType
ExcelScript.DataValidationAlertStyle	Represents the data validation error alert style. The default is Stop.
ExcelScript.DataValidationOperator	Represents the data validation operator enum.
ExcelScript.DataValidationType	Represents the data validation type enum.
ExcelScript.DateFilterCondition	Enum representing all accepted conditions by which a date filter can be applied. Used to configure the type of PivotFilter that is applied to the field.
ExcelScript.DeleteShiftDirection
ExcelScript.DocumentPropertyType
ExcelScript.DynamicFilterCriteria
ExcelScript.FillPattern
ExcelScript.FilterDatetimeSpecificity
ExcelScript.FilterOn
ExcelScript.FilterOperator
ExcelScript.GeometricShapeType	Specifies the shape type for a GeometricShape object.
ExcelScript.GroupOption
ExcelScript.HeaderFooterState
ExcelScript.HorizontalAlignment
ExcelScript.IconSet
ExcelScript.ImageFittingMode
ExcelScript.InsertShiftDirection	Determines the direction in which existing cells will be shifted to accommodate what is being inserted.
ExcelScript.KeyboardDirection
ExcelScript.LabelFilterCondition	Enum representing all accepted conditions by which a label filter can be applied. Used to configure the type of PivotFilter that is applied to the field. PivotFilter.criteria.exclusive can be set to true to invert many of these conditions.
ExcelScript.LinkedDataTypeState
ExcelScript.LoadToType	An enum that specifies the query load to destination.
ExcelScript.NamedItemScope
ExcelScript.NamedItemType
ExcelScript.NumberFormatCategory	Represents a category of number formats.
ExcelScript.PageOrientation
ExcelScript.PaperType
ExcelScript.PictureFormat	The format of the image.
ExcelScript.PivotAxis	Represents the axis from which to get the PivotItems.
ExcelScript.PivotFilterTopBottomCriterion	Represents the criteria for the top/bottom values filter.
ExcelScript.PivotFilterType	A simple enum that represents a type of filter for a PivotField.
ExcelScript.PivotLayoutType
ExcelScript.Placement	Specifies the way that an object is attached to its underlying cells.
ExcelScript.PrintComments
ExcelScript.PrintErrorType
ExcelScript.PrintMarginUnit
ExcelScript.PrintOrder
ExcelScript.ProtectionSelectionMode
ExcelScript.QueryError	An enum that specifies the query load error message.
ExcelScript.RangeCopyType
ExcelScript.RangeUnderlineStyle
ExcelScript.RangeValueType
ExcelScript.ReadingOrder
ExcelScript.SearchDirection	Specifies the search direction.
ExcelScript.ShapeAutoSize	Determines the type of automatic sizing allowed.
ExcelScript.ShapeFillType	Specifies a shape's fill type.
ExcelScript.ShapeFontUnderlineStyle	The type of underline applied to a font.
ExcelScript.ShapeLineDashStyle	The dash style for a line.
ExcelScript.ShapeLineStyle	The style for a line.
ExcelScript.ShapeScaleFrom	Specifies which part of the shape retains its position when the shape is scaled.
ExcelScript.ShapeScaleType	Specifies whether the shape is scaled relative to its original or current size.
ExcelScript.ShapeTextHorizontalAlignment	Specifies the horizontal alignment for the text frame in a shape.
ExcelScript.ShapeTextHorizontalOverflow	Specifies the horizontal overflow for the text frame in a shape.
ExcelScript.ShapeTextOrientation	Specifies the orientation for the text frame in a shape.
ExcelScript.ShapeTextReadingOrder	Specifies the reading order for the text frame in a shape.
ExcelScript.ShapeTextVerticalAlignment	Specifies the vertical alignment for the text frame in a shape.
ExcelScript.ShapeTextVerticalOverflow	Specifies the vertical overflow for the text frame in a shape.
ExcelScript.ShapeType	Specifies the type of a shape.
ExcelScript.ShapeZOrder	Specifies where in the z-order a shape should be moved relative to other shapes.
ExcelScript.SheetVisibility
ExcelScript.ShowAsCalculation	The ShowAs calculation function for the DataPivotField.
ExcelScript.SlicerSortType	Specifies the slicer sort behavior for Slicer.sortBy.
ExcelScript.SortBy	Represents the sort direction.
ExcelScript.SortDataOption
ExcelScript.SortMethod	Represents the ordering method to be used when sorting Chinese characters.
ExcelScript.SortOn	Represents the part of the cell used as the sorting criteria.
ExcelScript.SortOrientation
ExcelScript.SpecialCellType
ExcelScript.SpecialCellValueType
ExcelScript.SubtotalLocationType
ExcelScript.TopBottomSelectionType	A simple enum for top/bottom filters to select whether to filter by the top N or bottom N percent, number, or sum of values.
ExcelScript.ValueFilterCondition	Enum representing all accepted conditions by which a value filter can be applied. Used to configure the type of PivotFilter that is applied to the field. PivotFilter.exclusive can be set to true to invert many of these conditions.
ExcelScript.VerticalAlignment
ExcelScript.WorkbookLinksRefreshMode	Represents the refresh mode of the workbook links.
ExcelScript.WorksheetPositionType	The position of a worksheet relative to another worksheet or the entire worksheet collection.