diff --git a/docs/docs-ref-autogen/excel/excelscript.yml b/docs/docs-ref-autogen/excel/excelscript.yml
index 80f49fef..8b73268e 100644
--- a/docs/docs-ref-autogen/excel/excelscript.yml
+++ b/docs/docs-ref-autogen/excel/excelscript.yml
@@ -1,312 +1,407 @@
-### YamlMime:TSPackage
-uid: ExcelScript!
-name: ExcelScript
-type: package
-summary: ''
-enums:
- - 'ExcelScript!ExcelScript.AggregationFunction:enum'
- - 'ExcelScript!ExcelScript.ArrowheadLength:enum'
- - 'ExcelScript!ExcelScript.ArrowheadStyle:enum'
- - 'ExcelScript!ExcelScript.ArrowheadWidth:enum'
- - 'ExcelScript!ExcelScript.AutoFillType:enum'
- - 'ExcelScript!ExcelScript.BindingType:enum'
- - 'ExcelScript!ExcelScript.BorderIndex:enum'
- - 'ExcelScript!ExcelScript.BorderLineStyle:enum'
- - 'ExcelScript!ExcelScript.BorderWeight:enum'
- - 'ExcelScript!ExcelScript.BuiltInStyle:enum'
- - 'ExcelScript!ExcelScript.CalculationMode:enum'
- - 'ExcelScript!ExcelScript.CalculationState:enum'
- - 'ExcelScript!ExcelScript.CalculationType:enum'
- - 'ExcelScript!ExcelScript.ChartAxisCategoryType:enum'
- - 'ExcelScript!ExcelScript.ChartAxisDisplayUnit:enum'
- - 'ExcelScript!ExcelScript.ChartAxisGroup:enum'
- - 'ExcelScript!ExcelScript.ChartAxisPosition:enum'
- - 'ExcelScript!ExcelScript.ChartAxisScaleType:enum'
- - 'ExcelScript!ExcelScript.ChartAxisTickLabelPosition:enum'
- - 'ExcelScript!ExcelScript.ChartAxisTickMark:enum'
- - 'ExcelScript!ExcelScript.ChartAxisTimeUnit:enum'
- - 'ExcelScript!ExcelScript.ChartAxisType:enum'
- - 'ExcelScript!ExcelScript.ChartBinType:enum'
- - 'ExcelScript!ExcelScript.ChartBoxQuartileCalculation:enum'
- - 'ExcelScript!ExcelScript.ChartColorScheme:enum'
- - 'ExcelScript!ExcelScript.ChartDataLabelPosition:enum'
- - 'ExcelScript!ExcelScript.ChartDataSourceType:enum'
- - 'ExcelScript!ExcelScript.ChartDisplayBlanksAs:enum'
- - 'ExcelScript!ExcelScript.ChartErrorBarsInclude:enum'
- - 'ExcelScript!ExcelScript.ChartErrorBarsType:enum'
- - 'ExcelScript!ExcelScript.ChartGradientStyle:enum'
- - 'ExcelScript!ExcelScript.ChartGradientStyleType:enum'
- - 'ExcelScript!ExcelScript.ChartLegendPosition:enum'
- - 'ExcelScript!ExcelScript.ChartLineStyle:enum'
- - 'ExcelScript!ExcelScript.ChartMapAreaLevel:enum'
- - 'ExcelScript!ExcelScript.ChartMapLabelStrategy:enum'
- - 'ExcelScript!ExcelScript.ChartMapProjectionType:enum'
- - 'ExcelScript!ExcelScript.ChartMarkerStyle:enum'
- - 'ExcelScript!ExcelScript.ChartParentLabelStrategy:enum'
- - 'ExcelScript!ExcelScript.ChartPlotAreaPosition:enum'
- - 'ExcelScript!ExcelScript.ChartPlotBy:enum'
- - 'ExcelScript!ExcelScript.ChartSeriesBy:enum'
- - 'ExcelScript!ExcelScript.ChartSeriesDimension:enum'
- - 'ExcelScript!ExcelScript.ChartSplitType:enum'
- - 'ExcelScript!ExcelScript.ChartTextHorizontalAlignment:enum'
- - 'ExcelScript!ExcelScript.ChartTextVerticalAlignment:enum'
- - 'ExcelScript!ExcelScript.ChartTickLabelAlignment:enum'
- - 'ExcelScript!ExcelScript.ChartTitlePosition:enum'
- - 'ExcelScript!ExcelScript.ChartTrendlineType:enum'
- - 'ExcelScript!ExcelScript.ChartType:enum'
- - 'ExcelScript!ExcelScript.ChartUnderlineStyle:enum'
- - 'ExcelScript!ExcelScript.ClearApplyTo:enum'
- - 'ExcelScript!ExcelScript.ConditionalCellValueOperator:enum'
- - 'ExcelScript!ExcelScript.ConditionalDataBarAxisFormat:enum'
- - 'ExcelScript!ExcelScript.ConditionalDataBarDirection:enum'
- - 'ExcelScript!ExcelScript.ConditionalFormatColorCriterionType:enum'
- - 'ExcelScript!ExcelScript.ConditionalFormatDirection:enum'
- - 'ExcelScript!ExcelScript.ConditionalFormatIconRuleType:enum'
- - 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion:enum'
- - 'ExcelScript!ExcelScript.ConditionalFormatRuleType:enum'
- - 'ExcelScript!ExcelScript.ConditionalFormatType:enum'
- - 'ExcelScript!ExcelScript.ConditionalIconCriterionOperator:enum'
- - 'ExcelScript!ExcelScript.ConditionalRangeBorderIndex:enum'
- - 'ExcelScript!ExcelScript.ConditionalRangeBorderLineStyle:enum'
- - 'ExcelScript!ExcelScript.ConditionalRangeFontUnderlineStyle:enum'
- - 'ExcelScript!ExcelScript.ConditionalTextOperator:enum'
- - 'ExcelScript!ExcelScript.ConditionalTopBottomCriterionType:enum'
- - 'ExcelScript!ExcelScript.ConnectorType:enum'
- - 'ExcelScript!ExcelScript.ContentType:enum'
- - 'ExcelScript!ExcelScript.DataValidationAlertStyle:enum'
- - 'ExcelScript!ExcelScript.DataValidationOperator:enum'
- - 'ExcelScript!ExcelScript.DataValidationType:enum'
- - 'ExcelScript!ExcelScript.DateFilterCondition:enum'
- - 'ExcelScript!ExcelScript.DeleteShiftDirection:enum'
- - 'ExcelScript!ExcelScript.DocumentPropertyType:enum'
- - 'ExcelScript!ExcelScript.DynamicFilterCriteria:enum'
- - 'ExcelScript!ExcelScript.FillPattern:enum'
- - 'ExcelScript!ExcelScript.FilterDatetimeSpecificity:enum'
- - 'ExcelScript!ExcelScript.FilterOn:enum'
- - 'ExcelScript!ExcelScript.FilterOperator:enum'
- - 'ExcelScript!ExcelScript.GeometricShapeType:enum'
- - 'ExcelScript!ExcelScript.GroupOption:enum'
- - 'ExcelScript!ExcelScript.HeaderFooterState:enum'
- - 'ExcelScript!ExcelScript.HorizontalAlignment:enum'
- - 'ExcelScript!ExcelScript.IconSet:enum'
- - 'ExcelScript!ExcelScript.ImageFittingMode:enum'
- - 'ExcelScript!ExcelScript.InsertShiftDirection:enum'
- - 'ExcelScript!ExcelScript.KeyboardDirection:enum'
- - 'ExcelScript!ExcelScript.LabelFilterCondition:enum'
- - 'ExcelScript!ExcelScript.LinkedDataTypeState:enum'
- - 'ExcelScript!ExcelScript.LoadToType:enum'
- - 'ExcelScript!ExcelScript.NamedItemScope:enum'
- - 'ExcelScript!ExcelScript.NamedItemType:enum'
- - 'ExcelScript!ExcelScript.NumberFormatCategory:enum'
- - 'ExcelScript!ExcelScript.PageOrientation:enum'
- - 'ExcelScript!ExcelScript.PaperType:enum'
- - 'ExcelScript!ExcelScript.PictureFormat:enum'
- - 'ExcelScript!ExcelScript.PivotAxis:enum'
- - 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion:enum'
- - 'ExcelScript!ExcelScript.PivotFilterType:enum'
- - 'ExcelScript!ExcelScript.PivotLayoutType:enum'
- - 'ExcelScript!ExcelScript.Placement:enum'
- - 'ExcelScript!ExcelScript.PrintComments:enum'
- - 'ExcelScript!ExcelScript.PrintErrorType:enum'
- - 'ExcelScript!ExcelScript.PrintMarginUnit:enum'
- - 'ExcelScript!ExcelScript.PrintOrder:enum'
- - 'ExcelScript!ExcelScript.ProtectionSelectionMode:enum'
- - 'ExcelScript!ExcelScript.QueryError:enum'
- - 'ExcelScript!ExcelScript.RangeCopyType:enum'
- - 'ExcelScript!ExcelScript.RangeUnderlineStyle:enum'
- - 'ExcelScript!ExcelScript.RangeValueType:enum'
- - 'ExcelScript!ExcelScript.ReadingOrder:enum'
- - 'ExcelScript!ExcelScript.SearchDirection:enum'
- - 'ExcelScript!ExcelScript.ShapeAutoSize:enum'
- - 'ExcelScript!ExcelScript.ShapeFillType:enum'
- - 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle:enum'
- - 'ExcelScript!ExcelScript.ShapeLineDashStyle:enum'
- - 'ExcelScript!ExcelScript.ShapeLineStyle:enum'
- - 'ExcelScript!ExcelScript.ShapeScaleFrom:enum'
- - 'ExcelScript!ExcelScript.ShapeScaleType:enum'
- - 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment:enum'
- - 'ExcelScript!ExcelScript.ShapeTextHorizontalOverflow:enum'
- - 'ExcelScript!ExcelScript.ShapeTextOrientation:enum'
- - 'ExcelScript!ExcelScript.ShapeTextReadingOrder:enum'
- - 'ExcelScript!ExcelScript.ShapeTextVerticalAlignment:enum'
- - 'ExcelScript!ExcelScript.ShapeTextVerticalOverflow:enum'
- - 'ExcelScript!ExcelScript.ShapeType:enum'
- - 'ExcelScript!ExcelScript.ShapeZOrder:enum'
- - 'ExcelScript!ExcelScript.SheetVisibility:enum'
- - 'ExcelScript!ExcelScript.ShowAsCalculation:enum'
- - 'ExcelScript!ExcelScript.SlicerSortType:enum'
- - 'ExcelScript!ExcelScript.SortBy:enum'
- - 'ExcelScript!ExcelScript.SortDataOption:enum'
- - 'ExcelScript!ExcelScript.SortMethod:enum'
- - 'ExcelScript!ExcelScript.SortOn:enum'
- - 'ExcelScript!ExcelScript.SortOrientation:enum'
- - 'ExcelScript!ExcelScript.SpecialCellType:enum'
- - 'ExcelScript!ExcelScript.SpecialCellValueType:enum'
- - 'ExcelScript!ExcelScript.SubtotalLocationType:enum'
- - 'ExcelScript!ExcelScript.TopBottomSelectionType:enum'
- - 'ExcelScript!ExcelScript.ValueFilterCondition:enum'
- - 'ExcelScript!ExcelScript.VerticalAlignment:enum'
- - 'ExcelScript!ExcelScript.WorkbookLinksRefreshMode:enum'
- - 'ExcelScript!ExcelScript.WorksheetPositionType:enum'
-interfaces:
- - 'ExcelScript!ExcelScript.AllowEditRange:interface'
- - 'ExcelScript!ExcelScript.AllowEditRangeOptions:interface'
- - 'ExcelScript!ExcelScript.Application:interface'
- - 'ExcelScript!ExcelScript.AutoFilter:interface'
- - 'ExcelScript!ExcelScript.BasicDataValidation:interface'
- - 'ExcelScript!ExcelScript.Binding:interface'
- - 'ExcelScript!ExcelScript.CellValueConditionalFormat:interface'
- - 'ExcelScript!ExcelScript.Chart:interface'
- - 'ExcelScript!ExcelScript.ChartAreaFormat:interface'
- - 'ExcelScript!ExcelScript.ChartAxes:interface'
- - 'ExcelScript!ExcelScript.ChartAxis:interface'
- - 'ExcelScript!ExcelScript.ChartAxisFormat:interface'
- - 'ExcelScript!ExcelScript.ChartAxisTitle:interface'
- - 'ExcelScript!ExcelScript.ChartAxisTitleFormat:interface'
- - 'ExcelScript!ExcelScript.ChartBinOptions:interface'
- - 'ExcelScript!ExcelScript.ChartBorder:interface'
- - 'ExcelScript!ExcelScript.ChartBoxwhiskerOptions:interface'
- - 'ExcelScript!ExcelScript.ChartDataLabel:interface'
- - 'ExcelScript!ExcelScript.ChartDataLabelFormat:interface'
- - 'ExcelScript!ExcelScript.ChartDataLabels:interface'
- - 'ExcelScript!ExcelScript.ChartDataTable:interface'
- - 'ExcelScript!ExcelScript.ChartDataTableFormat:interface'
- - 'ExcelScript!ExcelScript.ChartErrorBars:interface'
- - 'ExcelScript!ExcelScript.ChartErrorBarsFormat:interface'
- - 'ExcelScript!ExcelScript.ChartFill:interface'
- - 'ExcelScript!ExcelScript.ChartFont:interface'
- - 'ExcelScript!ExcelScript.ChartFormatString:interface'
- - 'ExcelScript!ExcelScript.ChartGridlines:interface'
- - 'ExcelScript!ExcelScript.ChartGridlinesFormat:interface'
- - 'ExcelScript!ExcelScript.ChartLegend:interface'
- - 'ExcelScript!ExcelScript.ChartLegendEntry:interface'
- - 'ExcelScript!ExcelScript.ChartLegendFormat:interface'
- - 'ExcelScript!ExcelScript.ChartLineFormat:interface'
- - 'ExcelScript!ExcelScript.ChartMapOptions:interface'
- - 'ExcelScript!ExcelScript.ChartPivotOptions:interface'
- - 'ExcelScript!ExcelScript.ChartPlotArea:interface'
- - 'ExcelScript!ExcelScript.ChartPlotAreaFormat:interface'
- - 'ExcelScript!ExcelScript.ChartPoint:interface'
- - 'ExcelScript!ExcelScript.ChartPointFormat:interface'
- - 'ExcelScript!ExcelScript.ChartSeries:interface'
- - 'ExcelScript!ExcelScript.ChartSeriesFormat:interface'
- - 'ExcelScript!ExcelScript.ChartTitle:interface'
- - 'ExcelScript!ExcelScript.ChartTitleFormat:interface'
- - 'ExcelScript!ExcelScript.ChartTrendline:interface'
- - 'ExcelScript!ExcelScript.ChartTrendlineFormat:interface'
- - 'ExcelScript!ExcelScript.ChartTrendlineLabel:interface'
- - 'ExcelScript!ExcelScript.ChartTrendlineLabelFormat:interface'
- - 'ExcelScript!ExcelScript.ColorScaleConditionalFormat:interface'
- - 'ExcelScript!ExcelScript.Comment:interface'
- - 'ExcelScript!ExcelScript.CommentMention:interface'
- - 'ExcelScript!ExcelScript.CommentReply:interface'
- - 'ExcelScript!ExcelScript.CommentRichContent:interface'
- - 'ExcelScript!ExcelScript.ConditionalCellValueRule:interface'
- - 'ExcelScript!ExcelScript.ConditionalColorScaleCriteria:interface'
- - 'ExcelScript!ExcelScript.ConditionalColorScaleCriterion:interface'
- - 'ExcelScript!ExcelScript.ConditionalDataBarNegativeFormat:interface'
- - 'ExcelScript!ExcelScript.ConditionalDataBarPositiveFormat:interface'
- - 'ExcelScript!ExcelScript.ConditionalDataBarRule:interface'
- - 'ExcelScript!ExcelScript.ConditionalFormat:interface'
- - 'ExcelScript!ExcelScript.ConditionalFormatRule:interface'
- - 'ExcelScript!ExcelScript.ConditionalIconCriterion:interface'
- - 'ExcelScript!ExcelScript.ConditionalPresetCriteriaRule:interface'
- - 'ExcelScript!ExcelScript.ConditionalRangeBorder:interface'
- - 'ExcelScript!ExcelScript.ConditionalRangeFill:interface'
- - 'ExcelScript!ExcelScript.ConditionalRangeFont:interface'
- - 'ExcelScript!ExcelScript.ConditionalRangeFormat:interface'
- - 'ExcelScript!ExcelScript.ConditionalTextComparisonRule:interface'
- - 'ExcelScript!ExcelScript.ConditionalTopBottomRule:interface'
- - 'ExcelScript!ExcelScript.CultureInfo:interface'
- - 'ExcelScript!ExcelScript.CustomConditionalFormat:interface'
- - 'ExcelScript!ExcelScript.CustomDataValidation:interface'
- - 'ExcelScript!ExcelScript.CustomProperty:interface'
- - 'ExcelScript!ExcelScript.CustomXmlPart:interface'
- - 'ExcelScript!ExcelScript.DataBarConditionalFormat:interface'
- - 'ExcelScript!ExcelScript.DataPivotHierarchy:interface'
- - 'ExcelScript!ExcelScript.DataValidation:interface'
- - 'ExcelScript!ExcelScript.DataValidationErrorAlert:interface'
- - 'ExcelScript!ExcelScript.DataValidationPrompt:interface'
- - 'ExcelScript!ExcelScript.DataValidationRule:interface'
- - 'ExcelScript!ExcelScript.DateTimeDataValidation:interface'
- - 'ExcelScript!ExcelScript.DatetimeFormatInfo:interface'
- - 'ExcelScript!ExcelScript.DocumentProperties:interface'
- - 'ExcelScript!ExcelScript.Filter:interface'
- - 'ExcelScript!ExcelScript.FilterCriteria:interface'
- - 'ExcelScript!ExcelScript.FilterDatetime:interface'
- - 'ExcelScript!ExcelScript.FilterPivotHierarchy:interface'
- - 'ExcelScript!ExcelScript.FormatProtection:interface'
- - 'ExcelScript!ExcelScript.GeometricShape:interface'
- - 'ExcelScript!ExcelScript.HeaderFooter:interface'
- - 'ExcelScript!ExcelScript.HeaderFooterGroup:interface'
- - 'ExcelScript!ExcelScript.Icon:interface'
- - 'ExcelScript!ExcelScript.IconSetConditionalFormat:interface'
- - 'ExcelScript!ExcelScript.Image:interface'
- - 'ExcelScript!ExcelScript.IterativeCalculation:interface'
- - 'ExcelScript!ExcelScript.Line:interface'
- - 'ExcelScript!ExcelScript.LinkedWorkbook:interface'
- - 'ExcelScript!ExcelScript.ListDataValidation:interface'
- - 'ExcelScript!ExcelScript.NamedItem:interface'
- - 'ExcelScript!ExcelScript.NamedItemArrayValues:interface'
- - 'ExcelScript!ExcelScript.NamedSheetView:interface'
- - 'ExcelScript!ExcelScript.NumberFormatInfo:interface'
- - 'ExcelScript!ExcelScript.PageBreak:interface'
- - 'ExcelScript!ExcelScript.PageLayout:interface'
- - 'ExcelScript!ExcelScript.PageLayoutMarginOptions:interface'
- - 'ExcelScript!ExcelScript.PageLayoutZoomOptions:interface'
- - 'ExcelScript!ExcelScript.PivotDateFilter:interface'
- - 'ExcelScript!ExcelScript.PivotField:interface'
- - 'ExcelScript!ExcelScript.PivotFilters:interface'
- - 'ExcelScript!ExcelScript.PivotHierarchy:interface'
- - 'ExcelScript!ExcelScript.PivotItem:interface'
- - 'ExcelScript!ExcelScript.PivotLabelFilter:interface'
- - 'ExcelScript!ExcelScript.PivotLayout:interface'
- - 'ExcelScript!ExcelScript.PivotManualFilter:interface'
- - 'ExcelScript!ExcelScript.PivotTable:interface'
- - 'ExcelScript!ExcelScript.PivotTableStyle:interface'
- - 'ExcelScript!ExcelScript.PivotValueFilter:interface'
- - 'ExcelScript!ExcelScript.PredefinedCellStyle:interface'
- - 'ExcelScript!ExcelScript.PresetCriteriaConditionalFormat:interface'
- - 'ExcelScript!ExcelScript.Query:interface'
- - 'ExcelScript!ExcelScript.Range:interface'
- - 'ExcelScript!ExcelScript.RangeAreas:interface'
- - 'ExcelScript!ExcelScript.RangeBorder:interface'
- - 'ExcelScript!ExcelScript.RangeFill:interface'
- - 'ExcelScript!ExcelScript.RangeFont:interface'
- - 'ExcelScript!ExcelScript.RangeFormat:interface'
- - 'ExcelScript!ExcelScript.RangeHyperlink:interface'
- - 'ExcelScript!ExcelScript.RangeSort:interface'
- - 'ExcelScript!ExcelScript.RangeView:interface'
- - 'ExcelScript!ExcelScript.RemoveDuplicatesResult:interface'
- - 'ExcelScript!ExcelScript.ReplaceCriteria:interface'
- - 'ExcelScript!ExcelScript.RowColumnPivotHierarchy:interface'
- - 'ExcelScript!ExcelScript.SearchCriteria:interface'
- - 'ExcelScript!ExcelScript.Shape:interface'
- - 'ExcelScript!ExcelScript.ShapeFill:interface'
- - 'ExcelScript!ExcelScript.ShapeFont:interface'
- - 'ExcelScript!ExcelScript.ShapeGroup:interface'
- - 'ExcelScript!ExcelScript.ShapeLineFormat:interface'
- - 'ExcelScript!ExcelScript.ShowAsRule:interface'
- - 'ExcelScript!ExcelScript.Slicer:interface'
- - 'ExcelScript!ExcelScript.SlicerItem:interface'
- - 'ExcelScript!ExcelScript.SlicerStyle:interface'
- - 'ExcelScript!ExcelScript.SortField:interface'
- - 'ExcelScript!ExcelScript.Subtotals:interface'
- - 'ExcelScript!ExcelScript.Table:interface'
- - 'ExcelScript!ExcelScript.TableColumn:interface'
- - 'ExcelScript!ExcelScript.TableSort:interface'
- - 'ExcelScript!ExcelScript.TableStyle:interface'
- - 'ExcelScript!ExcelScript.TextConditionalFormat:interface'
- - 'ExcelScript!ExcelScript.TextFrame:interface'
- - 'ExcelScript!ExcelScript.TextRange:interface'
- - 'ExcelScript!ExcelScript.TimelineStyle:interface'
- - 'ExcelScript!ExcelScript.TopBottomConditionalFormat:interface'
- - 'ExcelScript!ExcelScript.Workbook:interface'
- - 'ExcelScript!ExcelScript.WorkbookProtection:interface'
- - 'ExcelScript!ExcelScript.WorkbookRangeAreas:interface'
- - 'ExcelScript!ExcelScript.Worksheet:interface'
- - 'ExcelScript!ExcelScript.WorksheetCustomProperty:interface'
- - 'ExcelScript!ExcelScript.WorksheetFreezePanes:interface'
- - 'ExcelScript!ExcelScript.WorksheetProtection:interface'
- - 'ExcelScript!ExcelScript.WorksheetProtectionOptions:interface'
- - 'ExcelScript!ExcelScript.WorksheetSearchCriteria:interface'
+### YamlMime:TSPackage
+uid: ExcelScript!
+name: ExcelScript
+type: package
+summary: ''
+enums:
+ - 'ExcelScript!ExcelScript.AggregationFunction:enum'
+ - 'ExcelScript!ExcelScript.ArrowheadLength:enum'
+ - 'ExcelScript!ExcelScript.ArrowheadStyle:enum'
+ - 'ExcelScript!ExcelScript.ArrowheadWidth:enum'
+ - 'ExcelScript!ExcelScript.AutoFillType:enum'
+ - 'ExcelScript!ExcelScript.BindingType:enum'
+ - 'ExcelScript!ExcelScript.BorderIndex:enum'
+ - 'ExcelScript!ExcelScript.BorderLineStyle:enum'
+ - 'ExcelScript!ExcelScript.BorderWeight:enum'
+ - 'ExcelScript!ExcelScript.BuiltInStyle:enum'
+ - 'ExcelScript!ExcelScript.CalculationMode:enum'
+ - 'ExcelScript!ExcelScript.CalculationState:enum'
+ - 'ExcelScript!ExcelScript.CalculationType:enum'
+ - 'ExcelScript!ExcelScript.CellControlType:enum'
+ - 'ExcelScript!ExcelScript.ChartAxisCategoryType:enum'
+ - 'ExcelScript!ExcelScript.ChartAxisDisplayUnit:enum'
+ - 'ExcelScript!ExcelScript.ChartAxisGroup:enum'
+ - 'ExcelScript!ExcelScript.ChartAxisPosition:enum'
+ - 'ExcelScript!ExcelScript.ChartAxisScaleType:enum'
+ - 'ExcelScript!ExcelScript.ChartAxisTickLabelPosition:enum'
+ - 'ExcelScript!ExcelScript.ChartAxisTickMark:enum'
+ - 'ExcelScript!ExcelScript.ChartAxisTimeUnit:enum'
+ - 'ExcelScript!ExcelScript.ChartAxisType:enum'
+ - 'ExcelScript!ExcelScript.ChartBinType:enum'
+ - 'ExcelScript!ExcelScript.ChartBoxQuartileCalculation:enum'
+ - 'ExcelScript!ExcelScript.ChartColorScheme:enum'
+ - 'ExcelScript!ExcelScript.ChartDataLabelPosition:enum'
+ - 'ExcelScript!ExcelScript.ChartDataSourceType:enum'
+ - 'ExcelScript!ExcelScript.ChartDisplayBlanksAs:enum'
+ - 'ExcelScript!ExcelScript.ChartErrorBarsInclude:enum'
+ - 'ExcelScript!ExcelScript.ChartErrorBarsType:enum'
+ - 'ExcelScript!ExcelScript.ChartGradientStyle:enum'
+ - 'ExcelScript!ExcelScript.ChartGradientStyleType:enum'
+ - 'ExcelScript!ExcelScript.ChartLegendPosition:enum'
+ - 'ExcelScript!ExcelScript.ChartLineStyle:enum'
+ - 'ExcelScript!ExcelScript.ChartMapAreaLevel:enum'
+ - 'ExcelScript!ExcelScript.ChartMapLabelStrategy:enum'
+ - 'ExcelScript!ExcelScript.ChartMapProjectionType:enum'
+ - 'ExcelScript!ExcelScript.ChartMarkerStyle:enum'
+ - 'ExcelScript!ExcelScript.ChartParentLabelStrategy:enum'
+ - 'ExcelScript!ExcelScript.ChartPlotAreaPosition:enum'
+ - 'ExcelScript!ExcelScript.ChartPlotBy:enum'
+ - 'ExcelScript!ExcelScript.ChartSeriesBy:enum'
+ - 'ExcelScript!ExcelScript.ChartSeriesDimension:enum'
+ - 'ExcelScript!ExcelScript.ChartSplitType:enum'
+ - 'ExcelScript!ExcelScript.ChartTextHorizontalAlignment:enum'
+ - 'ExcelScript!ExcelScript.ChartTextVerticalAlignment:enum'
+ - 'ExcelScript!ExcelScript.ChartTickLabelAlignment:enum'
+ - 'ExcelScript!ExcelScript.ChartTitlePosition:enum'
+ - 'ExcelScript!ExcelScript.ChartTrendlineType:enum'
+ - 'ExcelScript!ExcelScript.ChartType:enum'
+ - 'ExcelScript!ExcelScript.ChartUnderlineStyle:enum'
+ - 'ExcelScript!ExcelScript.ClearApplyTo:enum'
+ - 'ExcelScript!ExcelScript.ConditionalCellValueOperator:enum'
+ - 'ExcelScript!ExcelScript.ConditionalDataBarAxisFormat:enum'
+ - 'ExcelScript!ExcelScript.ConditionalDataBarDirection:enum'
+ - 'ExcelScript!ExcelScript.ConditionalFormatColorCriterionType:enum'
+ - 'ExcelScript!ExcelScript.ConditionalFormatDirection:enum'
+ - 'ExcelScript!ExcelScript.ConditionalFormatIconRuleType:enum'
+ - 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion:enum'
+ - 'ExcelScript!ExcelScript.ConditionalFormatRuleType:enum'
+ - 'ExcelScript!ExcelScript.ConditionalFormatType:enum'
+ - 'ExcelScript!ExcelScript.ConditionalIconCriterionOperator:enum'
+ - 'ExcelScript!ExcelScript.ConditionalRangeBorderIndex:enum'
+ - 'ExcelScript!ExcelScript.ConditionalRangeBorderLineStyle:enum'
+ - 'ExcelScript!ExcelScript.ConditionalRangeFontUnderlineStyle:enum'
+ - 'ExcelScript!ExcelScript.ConditionalTextOperator:enum'
+ - 'ExcelScript!ExcelScript.ConditionalTopBottomCriterionType:enum'
+ - 'ExcelScript!ExcelScript.ConnectorType:enum'
+ - 'ExcelScript!ExcelScript.ContentType:enum'
+ - 'ExcelScript!ExcelScript.DataSourceType:enum'
+ - 'ExcelScript!ExcelScript.DataValidationAlertStyle:enum'
+ - 'ExcelScript!ExcelScript.DataValidationOperator:enum'
+ - 'ExcelScript!ExcelScript.DataValidationType:enum'
+ - 'ExcelScript!ExcelScript.DateFilterCondition:enum'
+ - 'ExcelScript!ExcelScript.DeleteShiftDirection:enum'
+ - 'ExcelScript!ExcelScript.DocumentPropertyType:enum'
+ - 'ExcelScript!ExcelScript.DynamicFilterCriteria:enum'
+ - 'ExcelScript!ExcelScript.FillPattern:enum'
+ - 'ExcelScript!ExcelScript.FilterDatetimeSpecificity:enum'
+ - 'ExcelScript!ExcelScript.FilterOn:enum'
+ - 'ExcelScript!ExcelScript.FilterOperator:enum'
+ - 'ExcelScript!ExcelScript.GeometricShapeType:enum'
+ - 'ExcelScript!ExcelScript.GroupOption:enum'
+ - 'ExcelScript!ExcelScript.HeaderFooterState:enum'
+ - 'ExcelScript!ExcelScript.HorizontalAlignment:enum'
+ - 'ExcelScript!ExcelScript.IconSet:enum'
+ - 'ExcelScript!ExcelScript.ImageFittingMode:enum'
+ - 'ExcelScript!ExcelScript.InsertShiftDirection:enum'
+ - 'ExcelScript!ExcelScript.KeyboardDirection:enum'
+ - 'ExcelScript!ExcelScript.LabelFilterCondition:enum'
+ - 'ExcelScript!ExcelScript.LinkedDataTypeState:enum'
+ - 'ExcelScript!ExcelScript.LoadToType:enum'
+ - 'ExcelScript!ExcelScript.NamedItemScope:enum'
+ - 'ExcelScript!ExcelScript.NamedItemType:enum'
+ - 'ExcelScript!ExcelScript.NumberFormatCategory:enum'
+ - 'ExcelScript!ExcelScript.PageOrientation:enum'
+ - 'ExcelScript!ExcelScript.PaperType:enum'
+ - 'ExcelScript!ExcelScript.PictureFormat:enum'
+ - 'ExcelScript!ExcelScript.PivotAxis:enum'
+ - 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion:enum'
+ - 'ExcelScript!ExcelScript.PivotFilterType:enum'
+ - 'ExcelScript!ExcelScript.PivotLayoutType:enum'
+ - 'ExcelScript!ExcelScript.Placement:enum'
+ - 'ExcelScript!ExcelScript.PrintComments:enum'
+ - 'ExcelScript!ExcelScript.PrintErrorType:enum'
+ - 'ExcelScript!ExcelScript.PrintMarginUnit:enum'
+ - 'ExcelScript!ExcelScript.PrintOrder:enum'
+ - 'ExcelScript!ExcelScript.ProtectionSelectionMode:enum'
+ - 'ExcelScript!ExcelScript.QueryError:enum'
+ - 'ExcelScript!ExcelScript.RangeCopyType:enum'
+ - 'ExcelScript!ExcelScript.RangeUnderlineStyle:enum'
+ - 'ExcelScript!ExcelScript.RangeValueType:enum'
+ - 'ExcelScript!ExcelScript.ReadingOrder:enum'
+ - 'ExcelScript!ExcelScript.SearchDirection:enum'
+ - 'ExcelScript!ExcelScript.ShapeAutoSize:enum'
+ - 'ExcelScript!ExcelScript.ShapeFillType:enum'
+ - 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle:enum'
+ - 'ExcelScript!ExcelScript.ShapeLineDashStyle:enum'
+ - 'ExcelScript!ExcelScript.ShapeLineStyle:enum'
+ - 'ExcelScript!ExcelScript.ShapeScaleFrom:enum'
+ - 'ExcelScript!ExcelScript.ShapeScaleType:enum'
+ - 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment:enum'
+ - 'ExcelScript!ExcelScript.ShapeTextHorizontalOverflow:enum'
+ - 'ExcelScript!ExcelScript.ShapeTextOrientation:enum'
+ - 'ExcelScript!ExcelScript.ShapeTextReadingOrder:enum'
+ - 'ExcelScript!ExcelScript.ShapeTextVerticalAlignment:enum'
+ - 'ExcelScript!ExcelScript.ShapeTextVerticalOverflow:enum'
+ - 'ExcelScript!ExcelScript.ShapeType:enum'
+ - 'ExcelScript!ExcelScript.ShapeZOrder:enum'
+ - 'ExcelScript!ExcelScript.SheetVisibility:enum'
+ - 'ExcelScript!ExcelScript.ShowAsCalculation:enum'
+ - 'ExcelScript!ExcelScript.SlicerSortType:enum'
+ - 'ExcelScript!ExcelScript.SortBy:enum'
+ - 'ExcelScript!ExcelScript.SortDataOption:enum'
+ - 'ExcelScript!ExcelScript.SortMethod:enum'
+ - 'ExcelScript!ExcelScript.SortOn:enum'
+ - 'ExcelScript!ExcelScript.SortOrientation:enum'
+ - 'ExcelScript!ExcelScript.SpecialCellType:enum'
+ - 'ExcelScript!ExcelScript.SpecialCellValueType:enum'
+ - 'ExcelScript!ExcelScript.SubtotalLocationType:enum'
+ - 'ExcelScript!ExcelScript.TopBottomSelectionType:enum'
+ - 'ExcelScript!ExcelScript.ValueFilterCondition:enum'
+ - 'ExcelScript!ExcelScript.VerticalAlignment:enum'
+ - 'ExcelScript!ExcelScript.WorkbookLinksRefreshMode:enum'
+ - 'ExcelScript!ExcelScript.WorksheetPositionType:enum'
+ - 'ExcelScript!Global.OfficeScript.EmailContentType:enum'
+ - 'ExcelScript!Global.OfficeScript.EmailImportance:enum'
+interfaces:
+ - 'ExcelScript!ExcelScript.AllowEditRange:interface'
+ - 'ExcelScript!ExcelScript.AllowEditRangeOptions:interface'
+ - 'ExcelScript!ExcelScript.Application:interface'
+ - 'ExcelScript!ExcelScript.AutoFilter:interface'
+ - 'ExcelScript!ExcelScript.BasicDataValidation:interface'
+ - 'ExcelScript!ExcelScript.Binding:interface'
+ - 'ExcelScript!ExcelScript.CellValueConditionalFormat:interface'
+ - 'ExcelScript!ExcelScript.Chart:interface'
+ - 'ExcelScript!ExcelScript.ChartAreaFormat:interface'
+ - 'ExcelScript!ExcelScript.ChartAxes:interface'
+ - 'ExcelScript!ExcelScript.ChartAxis:interface'
+ - 'ExcelScript!ExcelScript.ChartAxisFormat:interface'
+ - 'ExcelScript!ExcelScript.ChartAxisTitle:interface'
+ - 'ExcelScript!ExcelScript.ChartAxisTitleFormat:interface'
+ - 'ExcelScript!ExcelScript.ChartBinOptions:interface'
+ - 'ExcelScript!ExcelScript.ChartBorder:interface'
+ - 'ExcelScript!ExcelScript.ChartBoxwhiskerOptions:interface'
+ - 'ExcelScript!ExcelScript.ChartDataLabel:interface'
+ - 'ExcelScript!ExcelScript.ChartDataLabelAnchor:interface'
+ - 'ExcelScript!ExcelScript.ChartDataLabelFormat:interface'
+ - 'ExcelScript!ExcelScript.ChartDataLabels:interface'
+ - 'ExcelScript!ExcelScript.ChartDataTable:interface'
+ - 'ExcelScript!ExcelScript.ChartDataTableFormat:interface'
+ - 'ExcelScript!ExcelScript.ChartErrorBars:interface'
+ - 'ExcelScript!ExcelScript.ChartErrorBarsFormat:interface'
+ - 'ExcelScript!ExcelScript.ChartFill:interface'
+ - 'ExcelScript!ExcelScript.ChartFont:interface'
+ - 'ExcelScript!ExcelScript.ChartFormatString:interface'
+ - 'ExcelScript!ExcelScript.ChartGridlines:interface'
+ - 'ExcelScript!ExcelScript.ChartGridlinesFormat:interface'
+ - 'ExcelScript!ExcelScript.ChartLeaderLines:interface'
+ - 'ExcelScript!ExcelScript.ChartLeaderLinesFormat:interface'
+ - 'ExcelScript!ExcelScript.ChartLegend:interface'
+ - 'ExcelScript!ExcelScript.ChartLegendEntry:interface'
+ - 'ExcelScript!ExcelScript.ChartLegendFormat:interface'
+ - 'ExcelScript!ExcelScript.ChartLineFormat:interface'
+ - 'ExcelScript!ExcelScript.ChartMapOptions:interface'
+ - 'ExcelScript!ExcelScript.ChartPivotOptions:interface'
+ - 'ExcelScript!ExcelScript.ChartPlotArea:interface'
+ - 'ExcelScript!ExcelScript.ChartPlotAreaFormat:interface'
+ - 'ExcelScript!ExcelScript.ChartPoint:interface'
+ - 'ExcelScript!ExcelScript.ChartPointFormat:interface'
+ - 'ExcelScript!ExcelScript.ChartSeries:interface'
+ - 'ExcelScript!ExcelScript.ChartSeriesFormat:interface'
+ - 'ExcelScript!ExcelScript.ChartTitle:interface'
+ - 'ExcelScript!ExcelScript.ChartTitleFormat:interface'
+ - 'ExcelScript!ExcelScript.ChartTrendline:interface'
+ - 'ExcelScript!ExcelScript.ChartTrendlineFormat:interface'
+ - 'ExcelScript!ExcelScript.ChartTrendlineLabel:interface'
+ - 'ExcelScript!ExcelScript.ChartTrendlineLabelFormat:interface'
+ - 'ExcelScript!ExcelScript.CheckboxCellControl:interface'
+ - 'ExcelScript!ExcelScript.ColorScaleConditionalFormat:interface'
+ - 'ExcelScript!ExcelScript.Comment:interface'
+ - 'ExcelScript!ExcelScript.CommentMention:interface'
+ - 'ExcelScript!ExcelScript.CommentReply:interface'
+ - 'ExcelScript!ExcelScript.CommentRichContent:interface'
+ - 'ExcelScript!ExcelScript.ConditionalCellValueRule:interface'
+ - 'ExcelScript!ExcelScript.ConditionalColorScaleCriteria:interface'
+ - 'ExcelScript!ExcelScript.ConditionalColorScaleCriterion:interface'
+ - 'ExcelScript!ExcelScript.ConditionalDataBarNegativeFormat:interface'
+ - 'ExcelScript!ExcelScript.ConditionalDataBarPositiveFormat:interface'
+ - 'ExcelScript!ExcelScript.ConditionalDataBarRule:interface'
+ - 'ExcelScript!ExcelScript.ConditionalFormat:interface'
+ - 'ExcelScript!ExcelScript.ConditionalFormatRule:interface'
+ - 'ExcelScript!ExcelScript.ConditionalIconCriterion:interface'
+ - 'ExcelScript!ExcelScript.ConditionalPresetCriteriaRule:interface'
+ - 'ExcelScript!ExcelScript.ConditionalRangeBorder:interface'
+ - 'ExcelScript!ExcelScript.ConditionalRangeFill:interface'
+ - 'ExcelScript!ExcelScript.ConditionalRangeFont:interface'
+ - 'ExcelScript!ExcelScript.ConditionalRangeFormat:interface'
+ - 'ExcelScript!ExcelScript.ConditionalTextComparisonRule:interface'
+ - 'ExcelScript!ExcelScript.ConditionalTopBottomRule:interface'
+ - 'ExcelScript!ExcelScript.CultureInfo:interface'
+ - 'ExcelScript!ExcelScript.CustomConditionalFormat:interface'
+ - 'ExcelScript!ExcelScript.CustomDataValidation:interface'
+ - 'ExcelScript!ExcelScript.CustomProperty:interface'
+ - 'ExcelScript!ExcelScript.CustomXmlPart:interface'
+ - 'ExcelScript!ExcelScript.DataBarConditionalFormat:interface'
+ - 'ExcelScript!ExcelScript.DataPivotHierarchy:interface'
+ - 'ExcelScript!ExcelScript.DataValidation:interface'
+ - 'ExcelScript!ExcelScript.DataValidationErrorAlert:interface'
+ - 'ExcelScript!ExcelScript.DataValidationPrompt:interface'
+ - 'ExcelScript!ExcelScript.DataValidationRule:interface'
+ - 'ExcelScript!ExcelScript.DateTimeDataValidation:interface'
+ - 'ExcelScript!ExcelScript.DatetimeFormatInfo:interface'
+ - 'ExcelScript!ExcelScript.DocumentProperties:interface'
+ - 'ExcelScript!ExcelScript.EmptyCellControl:interface'
+ - 'ExcelScript!ExcelScript.Filter:interface'
+ - 'ExcelScript!ExcelScript.FilterCriteria:interface'
+ - 'ExcelScript!ExcelScript.FilterDatetime:interface'
+ - 'ExcelScript!ExcelScript.FilterPivotHierarchy:interface'
+ - 'ExcelScript!ExcelScript.FormatProtection:interface'
+ - 'ExcelScript!ExcelScript.GeometricShape:interface'
+ - 'ExcelScript!ExcelScript.HeaderFooter:interface'
+ - 'ExcelScript!ExcelScript.HeaderFooterGroup:interface'
+ - 'ExcelScript!ExcelScript.Icon:interface'
+ - 'ExcelScript!ExcelScript.IconSetConditionalFormat:interface'
+ - 'ExcelScript!ExcelScript.Image:interface'
+ - 'ExcelScript!ExcelScript.IterativeCalculation:interface'
+ - 'ExcelScript!ExcelScript.Line:interface'
+ - 'ExcelScript!ExcelScript.LinkedWorkbook:interface'
+ - 'ExcelScript!ExcelScript.ListDataValidation:interface'
+ - 'ExcelScript!ExcelScript.MixedCellControl:interface'
+ - 'ExcelScript!ExcelScript.NamedItem:interface'
+ - 'ExcelScript!ExcelScript.NamedItemArrayValues:interface'
+ - 'ExcelScript!ExcelScript.NamedSheetView:interface'
+ - 'ExcelScript!ExcelScript.NumberFormatInfo:interface'
+ - 'ExcelScript!ExcelScript.PageBreak:interface'
+ - 'ExcelScript!ExcelScript.PageLayout:interface'
+ - 'ExcelScript!ExcelScript.PageLayoutMarginOptions:interface'
+ - 'ExcelScript!ExcelScript.PageLayoutZoomOptions:interface'
+ - 'ExcelScript!ExcelScript.PivotDateFilter:interface'
+ - 'ExcelScript!ExcelScript.PivotField:interface'
+ - 'ExcelScript!ExcelScript.PivotFilters:interface'
+ - 'ExcelScript!ExcelScript.PivotHierarchy:interface'
+ - 'ExcelScript!ExcelScript.PivotItem:interface'
+ - 'ExcelScript!ExcelScript.PivotLabelFilter:interface'
+ - 'ExcelScript!ExcelScript.PivotLayout:interface'
+ - 'ExcelScript!ExcelScript.PivotManualFilter:interface'
+ - 'ExcelScript!ExcelScript.PivotTable:interface'
+ - 'ExcelScript!ExcelScript.PivotTableStyle:interface'
+ - 'ExcelScript!ExcelScript.PivotValueFilter:interface'
+ - 'ExcelScript!ExcelScript.PredefinedCellStyle:interface'
+ - 'ExcelScript!ExcelScript.PresetCriteriaConditionalFormat:interface'
+ - 'ExcelScript!ExcelScript.Query:interface'
+ - 'ExcelScript!ExcelScript.Range:interface'
+ - 'ExcelScript!ExcelScript.RangeAreas:interface'
+ - 'ExcelScript!ExcelScript.RangeBorder:interface'
+ - 'ExcelScript!ExcelScript.RangeFill:interface'
+ - 'ExcelScript!ExcelScript.RangeFont:interface'
+ - 'ExcelScript!ExcelScript.RangeFormat:interface'
+ - 'ExcelScript!ExcelScript.RangeHyperlink:interface'
+ - 'ExcelScript!ExcelScript.RangeSort:interface'
+ - 'ExcelScript!ExcelScript.RangeView:interface'
+ - 'ExcelScript!ExcelScript.RemoveDuplicatesResult:interface'
+ - 'ExcelScript!ExcelScript.ReplaceCriteria:interface'
+ - 'ExcelScript!ExcelScript.RowColumnPivotHierarchy:interface'
+ - 'ExcelScript!ExcelScript.SearchCriteria:interface'
+ - 'ExcelScript!ExcelScript.Shape:interface'
+ - 'ExcelScript!ExcelScript.ShapeFill:interface'
+ - 'ExcelScript!ExcelScript.ShapeFont:interface'
+ - 'ExcelScript!ExcelScript.ShapeGroup:interface'
+ - 'ExcelScript!ExcelScript.ShapeLineFormat:interface'
+ - 'ExcelScript!ExcelScript.ShowAsRule:interface'
+ - 'ExcelScript!ExcelScript.Slicer:interface'
+ - 'ExcelScript!ExcelScript.SlicerItem:interface'
+ - 'ExcelScript!ExcelScript.SlicerStyle:interface'
+ - 'ExcelScript!ExcelScript.SortField:interface'
+ - 'ExcelScript!ExcelScript.Subtotals:interface'
+ - 'ExcelScript!ExcelScript.Table:interface'
+ - 'ExcelScript!ExcelScript.TableColumn:interface'
+ - 'ExcelScript!ExcelScript.TableSort:interface'
+ - 'ExcelScript!ExcelScript.TableStyle:interface'
+ - 'ExcelScript!ExcelScript.TextConditionalFormat:interface'
+ - 'ExcelScript!ExcelScript.TextFrame:interface'
+ - 'ExcelScript!ExcelScript.TextRange:interface'
+ - 'ExcelScript!ExcelScript.TimelineStyle:interface'
+ - 'ExcelScript!ExcelScript.TopBottomConditionalFormat:interface'
+ - 'ExcelScript!ExcelScript.UnknownCellControl:interface'
+ - 'ExcelScript!ExcelScript.Workbook:interface'
+ - 'ExcelScript!ExcelScript.WorkbookProtection:interface'
+ - 'ExcelScript!ExcelScript.WorkbookRangeAreas:interface'
+ - 'ExcelScript!ExcelScript.Worksheet:interface'
+ - 'ExcelScript!ExcelScript.WorksheetCustomProperty:interface'
+ - 'ExcelScript!ExcelScript.WorksheetFreezePanes:interface'
+ - 'ExcelScript!ExcelScript.WorksheetProtection:interface'
+ - 'ExcelScript!ExcelScript.WorksheetProtectionOptions:interface'
+ - 'ExcelScript!ExcelScript.WorksheetSearchCriteria:interface'
+ - 'ExcelScript!Global.OfficeScript.EmailAttachment:interface'
+ - 'ExcelScript!Global.OfficeScript.MailProperties:interface'
+typeAliases:
+ - 'ExcelScript!ExcelScript.CellControl:type'
+functions:
+ - name: Global.OfficeScript.convertToPdf()
+ uid: 'ExcelScript!Global.OfficeScript.convertToPdf:function(1)'
+ package: ExcelScript!
+ summary: >-
+ Return the text encoding of the document as a PDF. If the document is empty, then the following error is shown:
+ "We didn't find anything to print".
+ remarks: ''
+ isPreview: true
+ isDeprecated: false
+ syntax:
+ content: 'export function convertToPdf(): string;'
+ return:
+ type: string
+ description: 'The content of the workbook as a string, in PDF format.'
+ - name: |-
+ Global.OfficeScript.downloadFile({
+ name,
+ content,
+ })
+ uid: 'ExcelScript!Global.OfficeScript.downloadFile:function(1)'
+ package: ExcelScript!
+ summary: Downloads a specified file to the default download location specified by the local machine.
+ remarks: ''
+ isPreview: true
+ isDeprecated: false
+ syntax:
+ content: |-
+ export function downloadFile({
+ name,
+ content,
+ }: {
+ name: string;
+ content: string;
+ }): void;
+ parameters:
+ - id: |-
+ {
+ name,
+ content,
+ }
+ description: ''
+ type: |-
+ {
+ name: string;
+ content: string;
+ }
+ return:
+ type: void
+ description: ''
+ - name: Global.OfficeScript.Metadata.getScriptName()
+ uid: 'ExcelScript!Global.OfficeScript.Metadata.getScriptName:function(1)'
+ package: ExcelScript!
+ summary: Get the current executing scripts name.
+ remarks: ''
+ isPreview: true
+ isDeprecated: false
+ syntax:
+ content: 'export function getScriptName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: Global.OfficeScript.sendMail(mailProperties)
+ uid: 'ExcelScript!Global.OfficeScript.sendMail:function(1)'
+ package: ExcelScript!
+ summary: >-
+ Send an email with an Office Script. Use `MailProperties` to specify the content and recipients of the email. If
+ the request body includes content, this method returns 400 Bad request.
+ remarks: ''
+ isPreview: true
+ isDeprecated: false
+ syntax:
+ content: 'export function sendMail(mailProperties: MailProperties): void;'
+ parameters:
+ - id: mailProperties
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.aggregationfunction.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.aggregationfunction.yml
index 17a81404..f02a1b9f 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.aggregationfunction.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.aggregationfunction.yml
@@ -1,79 +1,79 @@
-### YamlMime:TSEnum
-name: ExcelScript.AggregationFunction
-uid: 'ExcelScript!ExcelScript.AggregationFunction:enum'
-package: ExcelScript!
-fullName: ExcelScript.AggregationFunction
-summary: Aggregation function for the `DataPivotHierarchy`.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script changes how the data in a PivotTable is aggregated.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first PivotTable in the workbook.
- const pivotTable = workbook.getPivotTables()[0];
-
- // Set the first data hierarchy to summarize with an average value, instead of a sum.
- const dataHierarchy = pivotTable.getDataHierarchies()[0];
- dataHierarchy.setSummarizeBy(ExcelScript.AggregationFunction.average);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: automatic
- uid: 'ExcelScript!ExcelScript.AggregationFunction.automatic:member'
- package: ExcelScript!
- summary: Excel will automatically select the aggregation based on the data items.
- - name: average
- uid: 'ExcelScript!ExcelScript.AggregationFunction.average:member'
- package: ExcelScript!
- summary: 'Aggregate using the average of the data, equivalent to the AVERAGE function.'
- - name: count
- uid: 'ExcelScript!ExcelScript.AggregationFunction.count:member'
- package: ExcelScript!
- summary: 'Aggregate using the count of items in the data, equivalent to the COUNTA function.'
- - name: countNumbers
- uid: 'ExcelScript!ExcelScript.AggregationFunction.countNumbers:member'
- package: ExcelScript!
- summary: 'Aggregate using the count of numbers in the data, equivalent to the COUNT function.'
- - name: max
- uid: 'ExcelScript!ExcelScript.AggregationFunction.max:member'
- package: ExcelScript!
- summary: 'Aggregate using the maximum value of the data, equivalent to the MAX function.'
- - name: min
- uid: 'ExcelScript!ExcelScript.AggregationFunction.min:member'
- package: ExcelScript!
- summary: 'Aggregate using the minimum value of the data, equivalent to the MIN function.'
- - name: product
- uid: 'ExcelScript!ExcelScript.AggregationFunction.product:member'
- package: ExcelScript!
- summary: 'Aggregate using the product of the data, equivalent to the PRODUCT function.'
- - name: standardDeviation
- uid: 'ExcelScript!ExcelScript.AggregationFunction.standardDeviation:member'
- package: ExcelScript!
- summary: 'Aggregate using the standard deviation of the data, equivalent to the STDEV function.'
- - name: standardDeviationP
- uid: 'ExcelScript!ExcelScript.AggregationFunction.standardDeviationP:member'
- package: ExcelScript!
- summary: 'Aggregate using the standard deviation of the data, equivalent to the STDEVP function.'
- - name: sum
- uid: 'ExcelScript!ExcelScript.AggregationFunction.sum:member'
- package: ExcelScript!
- summary: 'Aggregate using the sum of the data, equivalent to the SUM function.'
- - name: unknown
- uid: 'ExcelScript!ExcelScript.AggregationFunction.unknown:member'
- package: ExcelScript!
- summary: Aggregation function is unknown or unsupported.
- - name: variance
- uid: 'ExcelScript!ExcelScript.AggregationFunction.variance:member'
- package: ExcelScript!
- summary: 'Aggregate using the variance of the data, equivalent to the VAR function.'
- - name: varianceP
- uid: 'ExcelScript!ExcelScript.AggregationFunction.varianceP:member'
- package: ExcelScript!
- summary: 'Aggregate using the variance of the data, equivalent to the VARP function.'
+### YamlMime:TSEnum
+name: ExcelScript.AggregationFunction
+uid: 'ExcelScript!ExcelScript.AggregationFunction:enum'
+package: ExcelScript!
+fullName: ExcelScript.AggregationFunction
+summary: Aggregation function for the `DataPivotHierarchy`.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script changes how the data in a PivotTable is aggregated.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first PivotTable in the workbook.
+ const pivotTable = workbook.getPivotTables()[0];
+
+ // Set the first data hierarchy to summarize with an average value, instead of a sum.
+ const dataHierarchy = pivotTable.getDataHierarchies()[0];
+ dataHierarchy.setSummarizeBy(ExcelScript.AggregationFunction.average);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: automatic
+ uid: 'ExcelScript!ExcelScript.AggregationFunction.automatic:member'
+ package: ExcelScript!
+ summary: Excel will automatically select the aggregation based on the data items.
+ - name: average
+ uid: 'ExcelScript!ExcelScript.AggregationFunction.average:member'
+ package: ExcelScript!
+ summary: 'Aggregate using the average of the data, equivalent to the AVERAGE function.'
+ - name: count
+ uid: 'ExcelScript!ExcelScript.AggregationFunction.count:member'
+ package: ExcelScript!
+ summary: 'Aggregate using the count of items in the data, equivalent to the COUNTA function.'
+ - name: countNumbers
+ uid: 'ExcelScript!ExcelScript.AggregationFunction.countNumbers:member'
+ package: ExcelScript!
+ summary: 'Aggregate using the count of numbers in the data, equivalent to the COUNT function.'
+ - name: max
+ uid: 'ExcelScript!ExcelScript.AggregationFunction.max:member'
+ package: ExcelScript!
+ summary: 'Aggregate using the maximum value of the data, equivalent to the MAX function.'
+ - name: min
+ uid: 'ExcelScript!ExcelScript.AggregationFunction.min:member'
+ package: ExcelScript!
+ summary: 'Aggregate using the minimum value of the data, equivalent to the MIN function.'
+ - name: product
+ uid: 'ExcelScript!ExcelScript.AggregationFunction.product:member'
+ package: ExcelScript!
+ summary: 'Aggregate using the product of the data, equivalent to the PRODUCT function.'
+ - name: standardDeviation
+ uid: 'ExcelScript!ExcelScript.AggregationFunction.standardDeviation:member'
+ package: ExcelScript!
+ summary: 'Aggregate using the standard deviation of the data, equivalent to the STDEV function.'
+ - name: standardDeviationP
+ uid: 'ExcelScript!ExcelScript.AggregationFunction.standardDeviationP:member'
+ package: ExcelScript!
+ summary: 'Aggregate using the standard deviation of the data, equivalent to the STDEVP function.'
+ - name: sum
+ uid: 'ExcelScript!ExcelScript.AggregationFunction.sum:member'
+ package: ExcelScript!
+ summary: 'Aggregate using the sum of the data, equivalent to the SUM function.'
+ - name: unknown
+ uid: 'ExcelScript!ExcelScript.AggregationFunction.unknown:member'
+ package: ExcelScript!
+ summary: Aggregation function is unknown or unsupported.
+ - name: variance
+ uid: 'ExcelScript!ExcelScript.AggregationFunction.variance:member'
+ package: ExcelScript!
+ summary: 'Aggregate using the variance of the data, equivalent to the VAR function.'
+ - name: varianceP
+ uid: 'ExcelScript!ExcelScript.AggregationFunction.varianceP:member'
+ package: ExcelScript!
+ summary: 'Aggregate using the variance of the data, equivalent to the VARP function.'
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.alloweditrange.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.alloweditrange.yml
index ea91802c..960b553a 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.alloweditrange.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.alloweditrange.yml
@@ -1,154 +1,154 @@
-### YamlMime:TSType
-name: ExcelScript.AllowEditRange
-uid: 'ExcelScript!ExcelScript.AllowEditRange:interface'
-package: ExcelScript!
-fullName: ExcelScript.AllowEditRange
-summary: >-
- 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.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: delete()
- uid: 'ExcelScript!ExcelScript.AllowEditRange#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: >-
- Deletes the object from the `AllowEditRangeCollection`. Worksheet protection must be disabled or paused
- for this method to work properly. If worksheet protection is enabled and not paused, this method throws an
- `AccessDenied` error and fails the delete operation.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: ''
- - name: getAddress()
- uid: 'ExcelScript!ExcelScript.AllowEditRange#getAddress:member(1)'
- package: ExcelScript!
- fullName: getAddress()
- summary: Specifies the range associated with the object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAddress(): string;'
- return:
- type: string
- description: ''
- - name: getIsPasswordProtected()
- uid: 'ExcelScript!ExcelScript.AllowEditRange#getIsPasswordProtected:member(1)'
- package: ExcelScript!
- fullName: getIsPasswordProtected()
- summary: Specifies if the object is password protected.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIsPasswordProtected(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getTitle()
- uid: 'ExcelScript!ExcelScript.AllowEditRange#getTitle:member(1)'
- package: ExcelScript!
- fullName: getTitle()
- summary: Specifies the title of the object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTitle(): string;'
- return:
- type: string
- description: ''
- - name: pauseProtection(password)
- uid: 'ExcelScript!ExcelScript.AllowEditRange#pauseProtection:member(1)'
- package: ExcelScript!
- fullName: pauseProtection(password)
- summary: >-
- Pauses worksheet protection for the object for the user in the current session. This method does nothing if
- worksheet protection isn't enabled or is already paused. If worksheet protection cannot be paused, this method
- throws an `UnsupportedOperation` error and fails to pause protection for the object. If the password is incorrect,
- then this method throws a `BadPassword` error and fails to pause protection for the object. If a password is
- supplied but the object does not require a password, the inputted password will be ignored and the operation will
- succeed.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'pauseProtection(password?: string): void;'
- parameters:
- - id: password
- description: The password associated with the `AllowEditRange` object.
- type: string
- return:
- type: void
- description: ''
- - name: setAddress(address)
- uid: 'ExcelScript!ExcelScript.AllowEditRange#setAddress:member(1)'
- package: ExcelScript!
- fullName: setAddress(address)
- summary: >-
- Specifies the range associated with the object. Worksheet protection must be disabled or paused for this method to
- work properly. If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and
- fails to set the range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setAddress(address: string): void;'
- parameters:
- - id: address
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setPassword(password)
- uid: 'ExcelScript!ExcelScript.AllowEditRange#setPassword:member(1)'
- package: ExcelScript!
- fullName: setPassword(password)
- summary: >-
- Changes the password associated with the object. Setting the password string as empty ("") or `null` will remove
- password protection from the object. Worksheet protection must be disabled or paused for this method to work
- properly. If worksheet protection is enabled and not paused, then this method throws an `AccessDenied` error and
- the set operation fails.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPassword(password?: string): void;'
- parameters:
- - id: password
- description: The password associated with the `AllowEditRange` object.
- type: string
- return:
- type: void
- description: ''
- - name: setTitle(title)
- uid: 'ExcelScript!ExcelScript.AllowEditRange#setTitle:member(1)'
- package: ExcelScript!
- fullName: setTitle(title)
- summary: >-
- Specifies the title of the object. Worksheet protection must be disabled or paused for this method to work
- properly. If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and fails
- to set the title. If there is already an existing `AllowEditRange` with the same string, or if the string is
- `null` or empty (""), then this method throws an `InvalidArgument` error and fails to set the title.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTitle(title: string): void;'
- parameters:
- - id: title
- description: ''
- type: string
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.AllowEditRange
+uid: 'ExcelScript!ExcelScript.AllowEditRange:interface'
+package: ExcelScript!
+fullName: ExcelScript.AllowEditRange
+summary: >-
+ 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.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.AllowEditRange#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: >-
+ Deletes the object from the `AllowEditRangeCollection`. Worksheet protection must be disabled or paused
+ for this method to work properly. If worksheet protection is enabled and not paused, this method throws an
+ `AccessDenied` error and fails the delete operation.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getAddress()
+ uid: 'ExcelScript!ExcelScript.AllowEditRange#getAddress:member(1)'
+ package: ExcelScript!
+ fullName: getAddress()
+ summary: Specifies the range associated with the object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAddress(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getIsPasswordProtected()
+ uid: 'ExcelScript!ExcelScript.AllowEditRange#getIsPasswordProtected:member(1)'
+ package: ExcelScript!
+ fullName: getIsPasswordProtected()
+ summary: Specifies if the object is password protected.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIsPasswordProtected(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getTitle()
+ uid: 'ExcelScript!ExcelScript.AllowEditRange#getTitle:member(1)'
+ package: ExcelScript!
+ fullName: getTitle()
+ summary: Specifies the title of the object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTitle(): string;'
+ return:
+ type: string
+ description: ''
+ - name: pauseProtection(password)
+ uid: 'ExcelScript!ExcelScript.AllowEditRange#pauseProtection:member(1)'
+ package: ExcelScript!
+ fullName: pauseProtection(password)
+ summary: >-
+ Pauses worksheet protection for the object for the user in the current session. This method does nothing if
+ worksheet protection isn't enabled or is already paused. If worksheet protection cannot be paused, this method
+ throws an `UnsupportedOperation` error and fails to pause protection for the object. If the password is incorrect,
+ then this method throws a `BadPassword` error and fails to pause protection for the object. If a password is
+ supplied but the object does not require a password, the inputted password will be ignored and the operation will
+ succeed.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'pauseProtection(password?: string): void;'
+ parameters:
+ - id: password
+ description: The password associated with the `AllowEditRange` object.
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setAddress(address)
+ uid: 'ExcelScript!ExcelScript.AllowEditRange#setAddress:member(1)'
+ package: ExcelScript!
+ fullName: setAddress(address)
+ summary: >-
+ Specifies the range associated with the object. Worksheet protection must be disabled or paused for this method to
+ work properly. If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and
+ fails to set the range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setAddress(address: string): void;'
+ parameters:
+ - id: address
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setPassword(password)
+ uid: 'ExcelScript!ExcelScript.AllowEditRange#setPassword:member(1)'
+ package: ExcelScript!
+ fullName: setPassword(password)
+ summary: >-
+ Changes the password associated with the object. Setting the password string as empty ("") or `null` will remove
+ password protection from the object. Worksheet protection must be disabled or paused for this method to work
+ properly. If worksheet protection is enabled and not paused, then this method throws an `AccessDenied` error and
+ the set operation fails.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPassword(password?: string): void;'
+ parameters:
+ - id: password
+ description: The password associated with the `AllowEditRange` object.
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setTitle(title)
+ uid: 'ExcelScript!ExcelScript.AllowEditRange#setTitle:member(1)'
+ package: ExcelScript!
+ fullName: setTitle(title)
+ summary: >-
+ Specifies the title of the object. Worksheet protection must be disabled or paused for this method to work
+ properly. If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and fails
+ to set the title. If there is already an existing `AllowEditRange` with the same string, or if the string is
+ `null` or empty (""), then this method throws an `InvalidArgument` error and fails to set the title.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTitle(title: string): void;'
+ parameters:
+ - id: title
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.alloweditrangeoptions.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.alloweditrangeoptions.yml
index b19f6334..89ae2aab 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.alloweditrangeoptions.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.alloweditrangeoptions.yml
@@ -1,49 +1,49 @@
-### YamlMime:TSType
-name: ExcelScript.AllowEditRangeOptions
-uid: 'ExcelScript!ExcelScript.AllowEditRangeOptions:interface'
-package: ExcelScript!
-fullName: ExcelScript.AllowEditRangeOptions
-summary: The interface used to construct optional fields of the `AllowEditRange` object.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a password-protected, editable range
- * to an otherwise protected worksheet.
- */
- function main(workbook: ExcelScript.Workbook, password: string) {
- // Get the protection object for the "Data" worksheet.
- const dataSheet = workbook.getWorksheet("Data");
- const sheetProtection = dataSheet.getProtection();
-
- // Set the password needed to edit the range to be the user provided string.
- const editRangeProperties : ExcelScript.AllowEditRangeOptions = {
- password: password
- };
-
- // Set range "D2:D6" to be editable if the password is provided.
- sheetProtection.addAllowEditRange("Notes Section", "D2:D6", editRangeProperties);
-
- // Protect the worksheet.
- sheetProtection.protect();
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: password
- uid: 'ExcelScript!ExcelScript.AllowEditRangeOptions#password:member'
- package: ExcelScript!
- fullName: password
- summary: The password associated with the `AllowEditRange`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'password?: string;'
- return:
- type: string
+### YamlMime:TSType
+name: ExcelScript.AllowEditRangeOptions
+uid: 'ExcelScript!ExcelScript.AllowEditRangeOptions:interface'
+package: ExcelScript!
+fullName: ExcelScript.AllowEditRangeOptions
+summary: The interface used to construct optional fields of the `AllowEditRange` object.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a password-protected, editable range
+ * to an otherwise protected worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook, password: string) {
+ // Get the protection object for the "Data" worksheet.
+ const dataSheet = workbook.getWorksheet("Data");
+ const sheetProtection = dataSheet.getProtection();
+
+ // Set the password needed to edit the range to be the user provided string.
+ const editRangeProperties : ExcelScript.AllowEditRangeOptions = {
+ password: password
+ };
+
+ // Set range "D2:D6" to be editable if the password is provided.
+ sheetProtection.addAllowEditRange("Notes Section", "D2:D6", editRangeProperties);
+
+ // Protect the worksheet.
+ sheetProtection.protect();
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: password
+ uid: 'ExcelScript!ExcelScript.AllowEditRangeOptions#password:member'
+ package: ExcelScript!
+ fullName: password
+ summary: The password associated with the `AllowEditRange`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'password?: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.application.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.application.yml
index d3ec570a..988b99a3 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.application.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.application.yml
@@ -1,211 +1,211 @@
-### YamlMime:TSType
-name: ExcelScript.Application
-uid: 'ExcelScript!ExcelScript.Application:interface'
-package: ExcelScript!
-fullName: ExcelScript.Application
-summary: Represents the Excel application that manages the workbook.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: calculate(calculationType)
- uid: 'ExcelScript!ExcelScript.Application#calculate:member(1)'
- package: ExcelScript!
- fullName: calculate(calculationType)
- summary: Recalculate all currently opened workbooks in Excel.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'calculate(calculationType: CalculationType): void;'
- parameters:
- - id: calculationType
- description: Specifies the calculation type to use. See `ExcelScript.CalculationType` for details.
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script fully recalculates the entire workbook.
- * This code is useful when automatic recalculation is turned off
- * but later parts of the script rely on updated values.
- */
- function main(workbook: ExcelScript.Workbook, workbookURL: string) {
- const application = workbook.getApplication();
- application.calculate(ExcelScript.CalculationType.fullRebuild);
- }
- ```
- - name: getCalculationEngineVersion()
- uid: 'ExcelScript!ExcelScript.Application#getCalculationEngineVersion:member(1)'
- package: ExcelScript!
- fullName: getCalculationEngineVersion()
- summary: Returns the Excel calculation engine version used for the last full recalculation.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCalculationEngineVersion(): number;'
- return:
- type: number
- description: ''
- - name: getCalculationMode()
- uid: 'ExcelScript!ExcelScript.Application#getCalculationMode:member(1)'
- package: ExcelScript!
- fullName: getCalculationMode()
- summary: >-
- Returns the calculation mode used in the workbook, as defined by the constants in
- `ExcelScript.CalculationMode`. Possible values are: `Automatic`, where Excel controls
- recalculation; `AutomaticExceptTables`, where Excel controls recalculation but ignores changes in tables;
- `Manual`, where calculation is done when the user requests it.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCalculationMode(): CalculationMode;'
- return:
- type: ''
- description: ''
- - name: getCalculationState()
- uid: 'ExcelScript!ExcelScript.Application#getCalculationState:member(1)'
- package: ExcelScript!
- fullName: getCalculationState()
- summary: Returns the calculation state of the application. See `ExcelScript.CalculationState` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCalculationState(): CalculationState;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script uses the fill color of the first cell to indicate the current
- * calculation state of the workbook.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first cell in the first worksheet.
- const cell = workbook.getWorksheets()[0].getCell(0,0);
-
- // Get that cell's fill object.
- const cellFill = cell.getFormat().getFill();
-
- // Set the cell fill based on the calculation state.
- const calcState = workbook.getApplication().getCalculationState();
- switch (calcState) {
- case ExcelScript.CalculationState.pending:
- cellFill.setColor("Red");
- break;
- case ExcelScript.CalculationState.calculating:
- cellFill.setColor("Yellow");
- break;
- case ExcelScript.CalculationState.done:
- cellFill.setColor("Green");
- break;
- }
- }
- ```
- - name: getCultureInfo()
- uid: 'ExcelScript!ExcelScript.Application#getCultureInfo:member(1)'
- package: ExcelScript!
- fullName: getCultureInfo()
- summary: >-
- Provides information based on current system culture settings. This includes the culture names, number formatting,
- and other culturally dependent settings.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCultureInfo(): CultureInfo;'
- return:
- type: ''
- description: ''
- - name: getDecimalSeparator()
- uid: 'ExcelScript!ExcelScript.Application#getDecimalSeparator:member(1)'
- package: ExcelScript!
- fullName: getDecimalSeparator()
- summary: Gets the string used as the decimal separator for numeric values. This is based on the local Excel settings.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDecimalSeparator(): string;'
- return:
- type: string
- description: ''
- - name: getIterativeCalculation()
- uid: 'ExcelScript!ExcelScript.Application#getIterativeCalculation:member(1)'
- package: ExcelScript!
- fullName: getIterativeCalculation()
- summary: >-
- Returns the iterative calculation settings. In Excel on Windows and Mac, the settings will apply to the Excel
- Application. In Excel on the web and other platforms, the settings will apply to the active workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIterativeCalculation(): IterativeCalculation;'
- return:
- type: ''
- description: ''
- - name: getThousandsSeparator()
- uid: 'ExcelScript!ExcelScript.Application#getThousandsSeparator:member(1)'
- package: ExcelScript!
- fullName: getThousandsSeparator()
- summary: >-
- Gets the string used to separate groups of digits to the left of the decimal for numeric values. This is based on
- the local Excel settings.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getThousandsSeparator(): string;'
- return:
- type: string
- description: ''
- - name: getUseSystemSeparators()
- uid: 'ExcelScript!ExcelScript.Application#getUseSystemSeparators:member(1)'
- package: ExcelScript!
- fullName: getUseSystemSeparators()
- summary: >-
- Specifies if the system separators of Excel are enabled. System separators include the decimal separator and
- thousands separator.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getUseSystemSeparators(): boolean;'
- return:
- type: boolean
- description: ''
- - name: setCalculationMode(calculationMode)
- uid: 'ExcelScript!ExcelScript.Application#setCalculationMode:member(1)'
- package: ExcelScript!
- fullName: setCalculationMode(calculationMode)
- summary: >-
- Returns the calculation mode used in the workbook, as defined by the constants in
- `ExcelScript.CalculationMode`. Possible values are: `Automatic`, where Excel controls
- recalculation; `AutomaticExceptTables`, where Excel controls recalculation but ignores changes in tables;
- `Manual`, where calculation is done when the user requests it.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setCalculationMode(calculationMode: CalculationMode): void;'
- parameters:
- - id: calculationMode
- description: ''
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.Application
+uid: 'ExcelScript!ExcelScript.Application:interface'
+package: ExcelScript!
+fullName: ExcelScript.Application
+summary: Represents the Excel application that manages the workbook.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: calculate(calculationType)
+ uid: 'ExcelScript!ExcelScript.Application#calculate:member(1)'
+ package: ExcelScript!
+ fullName: calculate(calculationType)
+ summary: Recalculate all currently opened workbooks in Excel.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'calculate(calculationType: CalculationType): void;'
+ parameters:
+ - id: calculationType
+ description: Specifies the calculation type to use. See `ExcelScript.CalculationType` for details.
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script fully recalculates the entire workbook.
+ * This code is useful when automatic recalculation is turned off
+ * but later parts of the script rely on updated values.
+ */
+ function main(workbook: ExcelScript.Workbook, workbookURL: string) {
+ const application = workbook.getApplication();
+ application.calculate(ExcelScript.CalculationType.fullRebuild);
+ }
+ ```
+ - name: getCalculationEngineVersion()
+ uid: 'ExcelScript!ExcelScript.Application#getCalculationEngineVersion:member(1)'
+ package: ExcelScript!
+ fullName: getCalculationEngineVersion()
+ summary: Returns the Excel calculation engine version used for the last full recalculation.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCalculationEngineVersion(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getCalculationMode()
+ uid: 'ExcelScript!ExcelScript.Application#getCalculationMode:member(1)'
+ package: ExcelScript!
+ fullName: getCalculationMode()
+ summary: >-
+ Returns the calculation mode used in the workbook, as defined by the constants in
+ `ExcelScript.CalculationMode`. Possible values are: `Automatic`, where Excel controls
+ recalculation; `AutomaticExceptTables`, where Excel controls recalculation but ignores changes in tables;
+ `Manual`, where calculation is done when the user requests it.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCalculationMode(): CalculationMode;'
+ return:
+ type: ''
+ description: ''
+ - name: getCalculationState()
+ uid: 'ExcelScript!ExcelScript.Application#getCalculationState:member(1)'
+ package: ExcelScript!
+ fullName: getCalculationState()
+ summary: Returns the calculation state of the application. See `ExcelScript.CalculationState` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCalculationState(): CalculationState;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script uses the fill color of the first cell to indicate the current
+ * calculation state of the workbook.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first cell in the first worksheet.
+ const cell = workbook.getWorksheets()[0].getCell(0,0);
+
+ // Get that cell's fill object.
+ const cellFill = cell.getFormat().getFill();
+
+ // Set the cell fill based on the calculation state.
+ const calcState = workbook.getApplication().getCalculationState();
+ switch (calcState) {
+ case ExcelScript.CalculationState.pending:
+ cellFill.setColor("Red");
+ break;
+ case ExcelScript.CalculationState.calculating:
+ cellFill.setColor("Yellow");
+ break;
+ case ExcelScript.CalculationState.done:
+ cellFill.setColor("Green");
+ break;
+ }
+ }
+ ```
+ - name: getCultureInfo()
+ uid: 'ExcelScript!ExcelScript.Application#getCultureInfo:member(1)'
+ package: ExcelScript!
+ fullName: getCultureInfo()
+ summary: >-
+ Provides information based on current system culture settings. This includes the culture names, number formatting,
+ and other culturally dependent settings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCultureInfo(): CultureInfo;'
+ return:
+ type: ''
+ description: ''
+ - name: getDecimalSeparator()
+ uid: 'ExcelScript!ExcelScript.Application#getDecimalSeparator:member(1)'
+ package: ExcelScript!
+ fullName: getDecimalSeparator()
+ summary: Gets the string used as the decimal separator for numeric values. This is based on the local Excel settings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDecimalSeparator(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getIterativeCalculation()
+ uid: 'ExcelScript!ExcelScript.Application#getIterativeCalculation:member(1)'
+ package: ExcelScript!
+ fullName: getIterativeCalculation()
+ summary: >-
+ Returns the iterative calculation settings. In Excel on Windows and Mac, the settings will apply to the Excel
+ Application. In Excel on the web and other platforms, the settings will apply to the active workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIterativeCalculation(): IterativeCalculation;'
+ return:
+ type: ''
+ description: ''
+ - name: getThousandsSeparator()
+ uid: 'ExcelScript!ExcelScript.Application#getThousandsSeparator:member(1)'
+ package: ExcelScript!
+ fullName: getThousandsSeparator()
+ summary: >-
+ Gets the string used to separate groups of digits to the left of the decimal for numeric values. This is based on
+ the local Excel settings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getThousandsSeparator(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getUseSystemSeparators()
+ uid: 'ExcelScript!ExcelScript.Application#getUseSystemSeparators:member(1)'
+ package: ExcelScript!
+ fullName: getUseSystemSeparators()
+ summary: >-
+ Specifies if the system separators of Excel are enabled. System separators include the decimal separator and
+ thousands separator.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getUseSystemSeparators(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: setCalculationMode(calculationMode)
+ uid: 'ExcelScript!ExcelScript.Application#setCalculationMode:member(1)'
+ package: ExcelScript!
+ fullName: setCalculationMode(calculationMode)
+ summary: >-
+ Returns the calculation mode used in the workbook, as defined by the constants in
+ `ExcelScript.CalculationMode`. Possible values are: `Automatic`, where Excel controls
+ recalculation; `AutomaticExceptTables`, where Excel controls recalculation but ignores changes in tables;
+ `Manual`, where calculation is done when the user requests it.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setCalculationMode(calculationMode: CalculationMode): void;'
+ parameters:
+ - id: calculationMode
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.arrowheadlength.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.arrowheadlength.yml
index ad41fe6a..9e8dea18 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.arrowheadlength.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.arrowheadlength.yml
@@ -1,52 +1,52 @@
-### YamlMime:TSEnum
-name: ExcelScript.ArrowheadLength
-uid: 'ExcelScript!ExcelScript.ArrowheadLength:enum'
-package: ExcelScript!
-fullName: ExcelScript.ArrowheadLength
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a line that goes from cell B2 to cell F4 on the current worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- const sheet = workbook.getActiveWorksheet();
-
- // Get the ranges for the two cells.
- const b2Range = sheet.getRange("B2");
- const f4Range = sheet.getRange("F4");
-
- // Add a straight line that connects the top-left corners of both cells.
- const newShape = sheet.addLine(
- b2Range.getLeft(),
- b2Range.getTop(),
- f4Range.getLeft(),
- f4Range.getTop(),
- ExcelScript.ConnectorType.straight);
-
- // Add a long, open arrowhead to the end of the line, such that it points at F4.
- const line = newShape.getLine();
- line.setEndArrowheadStyle(ExcelScript.ArrowheadStyle.open);
- line.setEndArrowheadLength(ExcelScript.ArrowheadLength.long);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: long
- uid: 'ExcelScript!ExcelScript.ArrowheadLength.long:member'
- package: ExcelScript!
- summary: ''
- - name: medium
- uid: 'ExcelScript!ExcelScript.ArrowheadLength.medium:member'
- package: ExcelScript!
- summary: ''
- - name: short
- uid: 'ExcelScript!ExcelScript.ArrowheadLength.short:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ArrowheadLength
+uid: 'ExcelScript!ExcelScript.ArrowheadLength:enum'
+package: ExcelScript!
+fullName: ExcelScript.ArrowheadLength
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a line that goes from cell B2 to cell F4 on the current worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ const sheet = workbook.getActiveWorksheet();
+
+ // Get the ranges for the two cells.
+ const b2Range = sheet.getRange("B2");
+ const f4Range = sheet.getRange("F4");
+
+ // Add a straight line that connects the top-left corners of both cells.
+ const newShape = sheet.addLine(
+ b2Range.getLeft(),
+ b2Range.getTop(),
+ f4Range.getLeft(),
+ f4Range.getTop(),
+ ExcelScript.ConnectorType.straight);
+
+ // Add a long, open arrowhead to the end of the line, such that it points at F4.
+ const line = newShape.getLine();
+ line.setEndArrowheadStyle(ExcelScript.ArrowheadStyle.open);
+ line.setEndArrowheadLength(ExcelScript.ArrowheadLength.long);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: long
+ uid: 'ExcelScript!ExcelScript.ArrowheadLength.long:member'
+ package: ExcelScript!
+ summary: ''
+ - name: medium
+ uid: 'ExcelScript!ExcelScript.ArrowheadLength.medium:member'
+ package: ExcelScript!
+ summary: ''
+ - name: short
+ uid: 'ExcelScript!ExcelScript.ArrowheadLength.short:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.arrowheadstyle.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.arrowheadstyle.yml
index 6096d17c..e5eb3604 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.arrowheadstyle.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.arrowheadstyle.yml
@@ -1,63 +1,63 @@
-### YamlMime:TSEnum
-name: ExcelScript.ArrowheadStyle
-uid: 'ExcelScript!ExcelScript.ArrowheadStyle:enum'
-package: ExcelScript!
-fullName: ExcelScript.ArrowheadStyle
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a line that goes from cell B2 to cell F4 on the current worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- const sheet = workbook.getActiveWorksheet();
-
- // Get the ranges for the two cells.
- const b2Range = sheet.getRange("B2");
- const f4Range = sheet.getRange("F4");
-
- // Add a straight line that connects the top-left corners of both cells.
- const newShape = sheet.addLine(
- b2Range.getLeft(),
- b2Range.getTop(),
- f4Range.getLeft(),
- f4Range.getTop(),
- ExcelScript.ConnectorType.straight);
-
- // Add an open arrowhead to the end of the line, such that it points at F4.
- const line = newShape.getLine();
- line.setEndArrowheadStyle(ExcelScript.ArrowheadStyle.open);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: diamond
- uid: 'ExcelScript!ExcelScript.ArrowheadStyle.diamond:member'
- package: ExcelScript!
- summary: ''
- - name: none
- uid: 'ExcelScript!ExcelScript.ArrowheadStyle.none:member'
- package: ExcelScript!
- summary: ''
- - name: open
- uid: 'ExcelScript!ExcelScript.ArrowheadStyle.open:member'
- package: ExcelScript!
- summary: ''
- - name: oval
- uid: 'ExcelScript!ExcelScript.ArrowheadStyle.oval:member'
- package: ExcelScript!
- summary: ''
- - name: stealth
- uid: 'ExcelScript!ExcelScript.ArrowheadStyle.stealth:member'
- package: ExcelScript!
- summary: ''
- - name: triangle
- uid: 'ExcelScript!ExcelScript.ArrowheadStyle.triangle:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ArrowheadStyle
+uid: 'ExcelScript!ExcelScript.ArrowheadStyle:enum'
+package: ExcelScript!
+fullName: ExcelScript.ArrowheadStyle
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a line that goes from cell B2 to cell F4 on the current worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ const sheet = workbook.getActiveWorksheet();
+
+ // Get the ranges for the two cells.
+ const b2Range = sheet.getRange("B2");
+ const f4Range = sheet.getRange("F4");
+
+ // Add a straight line that connects the top-left corners of both cells.
+ const newShape = sheet.addLine(
+ b2Range.getLeft(),
+ b2Range.getTop(),
+ f4Range.getLeft(),
+ f4Range.getTop(),
+ ExcelScript.ConnectorType.straight);
+
+ // Add an open arrowhead to the end of the line, such that it points at F4.
+ const line = newShape.getLine();
+ line.setEndArrowheadStyle(ExcelScript.ArrowheadStyle.open);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: diamond
+ uid: 'ExcelScript!ExcelScript.ArrowheadStyle.diamond:member'
+ package: ExcelScript!
+ summary: ''
+ - name: none
+ uid: 'ExcelScript!ExcelScript.ArrowheadStyle.none:member'
+ package: ExcelScript!
+ summary: ''
+ - name: open
+ uid: 'ExcelScript!ExcelScript.ArrowheadStyle.open:member'
+ package: ExcelScript!
+ summary: ''
+ - name: oval
+ uid: 'ExcelScript!ExcelScript.ArrowheadStyle.oval:member'
+ package: ExcelScript!
+ summary: ''
+ - name: stealth
+ uid: 'ExcelScript!ExcelScript.ArrowheadStyle.stealth:member'
+ package: ExcelScript!
+ summary: ''
+ - name: triangle
+ uid: 'ExcelScript!ExcelScript.ArrowheadStyle.triangle:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.arrowheadwidth.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.arrowheadwidth.yml
index a2356500..0da1d13f 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.arrowheadwidth.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.arrowheadwidth.yml
@@ -1,52 +1,52 @@
-### YamlMime:TSEnum
-name: ExcelScript.ArrowheadWidth
-uid: 'ExcelScript!ExcelScript.ArrowheadWidth:enum'
-package: ExcelScript!
-fullName: ExcelScript.ArrowheadWidth
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a line that goes from cell B2 to cell F4 on the current worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- const sheet = workbook.getActiveWorksheet();
-
- // Get the ranges for the two cells.
- const b2Range = sheet.getRange("B2");
- const f4Range = sheet.getRange("F4");
-
- // Add a straight line that connects the top-left corners of both cells.
- const newShape = sheet.addLine(
- b2Range.getLeft(),
- b2Range.getTop(),
- f4Range.getLeft(),
- f4Range.getTop(),
- ExcelScript.ConnectorType.straight);
-
- // Add a wide, triangular arrowhead to the end of the line, such that it points at F4.
- const line = newShape.getLine();
- line.setEndArrowheadStyle(ExcelScript.ArrowheadStyle.triangle);
- line.setEndArrowheadWidth(ExcelScript.ArrowheadWidth.wide);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: medium
- uid: 'ExcelScript!ExcelScript.ArrowheadWidth.medium:member'
- package: ExcelScript!
- summary: ''
- - name: narrow
- uid: 'ExcelScript!ExcelScript.ArrowheadWidth.narrow:member'
- package: ExcelScript!
- summary: ''
- - name: wide
- uid: 'ExcelScript!ExcelScript.ArrowheadWidth.wide:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ArrowheadWidth
+uid: 'ExcelScript!ExcelScript.ArrowheadWidth:enum'
+package: ExcelScript!
+fullName: ExcelScript.ArrowheadWidth
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a line that goes from cell B2 to cell F4 on the current worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ const sheet = workbook.getActiveWorksheet();
+
+ // Get the ranges for the two cells.
+ const b2Range = sheet.getRange("B2");
+ const f4Range = sheet.getRange("F4");
+
+ // Add a straight line that connects the top-left corners of both cells.
+ const newShape = sheet.addLine(
+ b2Range.getLeft(),
+ b2Range.getTop(),
+ f4Range.getLeft(),
+ f4Range.getTop(),
+ ExcelScript.ConnectorType.straight);
+
+ // Add a wide, triangular arrowhead to the end of the line, such that it points at F4.
+ const line = newShape.getLine();
+ line.setEndArrowheadStyle(ExcelScript.ArrowheadStyle.triangle);
+ line.setEndArrowheadWidth(ExcelScript.ArrowheadWidth.wide);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: medium
+ uid: 'ExcelScript!ExcelScript.ArrowheadWidth.medium:member'
+ package: ExcelScript!
+ summary: ''
+ - name: narrow
+ uid: 'ExcelScript!ExcelScript.ArrowheadWidth.narrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: wide
+ uid: 'ExcelScript!ExcelScript.ArrowheadWidth.wide:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.autofilltype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.autofilltype.yml
index 4ed8dda1..ec2f3df8 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.autofilltype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.autofilltype.yml
@@ -1,85 +1,85 @@
-### YamlMime:TSEnum
-name: ExcelScript.AutoFillType
-uid: 'ExcelScript!ExcelScript.AutoFillType:enum'
-package: ExcelScript!
-fullName: ExcelScript.AutoFillType
-summary: The behavior types when AutoFill is used on a range in the workbook.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script uses the autofill feature to complete a table with days of the month.
- * See https://support.microsoft.com/office/74e31bdd-d993-45da-aa82-35a236c5b5db
- * for examples of autofill scenarios.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current, active worksheet.
- let currentWorksheet = workbook.getActiveWorksheet();
-
- // Get the data range that shows the pattern.
- let dataRange = currentWorksheet.getRange("C2:C3");
-
- // Autofill the connected range. C2:C3 are filled in with dates. C4:C54 are blank.
- dataRange.autoFill("C2:C54", ExcelScript.AutoFillType.fillDays);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: fillCopy
- uid: 'ExcelScript!ExcelScript.AutoFillType.fillCopy:member'
- package: ExcelScript!
- summary: Populates the adjacent cells with data based on the selected data.
- - name: fillDays
- uid: 'ExcelScript!ExcelScript.AutoFillType.fillDays:member'
- package: ExcelScript!
- summary: >-
- A version of "FillSeries" for dates that bases the pattern on either the day of the month or the day of the week,
- depending on the context.
- - name: fillDefault
- uid: 'ExcelScript!ExcelScript.AutoFillType.fillDefault:member'
- package: ExcelScript!
- summary: Populates the adjacent cells based on the surrounding data (the standard AutoFill behavior).
- - name: fillFormats
- uid: 'ExcelScript!ExcelScript.AutoFillType.fillFormats:member'
- package: ExcelScript!
- summary: Populates the adjacent cells with the selected formats.
- - name: fillMonths
- uid: 'ExcelScript!ExcelScript.AutoFillType.fillMonths:member'
- package: ExcelScript!
- summary: A version of "FillSeries" for dates that bases the pattern on the month.
- - name: fillSeries
- uid: 'ExcelScript!ExcelScript.AutoFillType.fillSeries:member'
- package: ExcelScript!
- summary: Populates the adjacent cells with data that follows a pattern in the copied cells.
- - name: fillValues
- uid: 'ExcelScript!ExcelScript.AutoFillType.fillValues:member'
- package: ExcelScript!
- summary: Populates the adjacent cells with the selected values.
- - name: fillWeekdays
- uid: 'ExcelScript!ExcelScript.AutoFillType.fillWeekdays:member'
- package: ExcelScript!
- summary: A version of "FillSeries" for dates that bases the pattern on the day of the week and only includes weekdays.
- - name: fillYears
- uid: 'ExcelScript!ExcelScript.AutoFillType.fillYears:member'
- package: ExcelScript!
- summary: A version of "FillSeries" for dates that bases the pattern on the year.
- - name: flashFill
- uid: 'ExcelScript!ExcelScript.AutoFillType.flashFill:member'
- package: ExcelScript!
- summary: Populates the adjacent cells by using Excel's Flash Fill feature.
- - name: growthTrend
- uid: 'ExcelScript!ExcelScript.AutoFillType.growthTrend:member'
- package: ExcelScript!
- summary: >-
- A version of "FillSeries" for numbers that fills out the values in the adjacent cells according to a growth trend
- model.
- - name: linearTrend
- uid: 'ExcelScript!ExcelScript.AutoFillType.linearTrend:member'
- package: ExcelScript!
- summary: >-
- A version of "FillSeries" for numbers that fills out the values in the adjacent cells according to a linear trend
- model.
+### YamlMime:TSEnum
+name: ExcelScript.AutoFillType
+uid: 'ExcelScript!ExcelScript.AutoFillType:enum'
+package: ExcelScript!
+fullName: ExcelScript.AutoFillType
+summary: The behavior types when AutoFill is used on a range in the workbook.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script uses the autofill feature to complete a table with days of the month.
+ * See https://support.microsoft.com/office/74e31bdd-d993-45da-aa82-35a236c5b5db
+ * for examples of autofill scenarios.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current, active worksheet.
+ let currentWorksheet = workbook.getActiveWorksheet();
+
+ // Get the data range that shows the pattern.
+ let dataRange = currentWorksheet.getRange("C2:C3");
+
+ // Autofill the connected range. C2:C3 are filled in with dates. C4:C54 are blank.
+ dataRange.autoFill("C2:C54", ExcelScript.AutoFillType.fillDays);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: fillCopy
+ uid: 'ExcelScript!ExcelScript.AutoFillType.fillCopy:member'
+ package: ExcelScript!
+ summary: Populates the adjacent cells with data based on the selected data.
+ - name: fillDays
+ uid: 'ExcelScript!ExcelScript.AutoFillType.fillDays:member'
+ package: ExcelScript!
+ summary: >-
+ A version of "FillSeries" for dates that bases the pattern on either the day of the month or the day of the week,
+ depending on the context.
+ - name: fillDefault
+ uid: 'ExcelScript!ExcelScript.AutoFillType.fillDefault:member'
+ package: ExcelScript!
+ summary: Populates the adjacent cells based on the surrounding data (the standard AutoFill behavior).
+ - name: fillFormats
+ uid: 'ExcelScript!ExcelScript.AutoFillType.fillFormats:member'
+ package: ExcelScript!
+ summary: Populates the adjacent cells with the selected formats.
+ - name: fillMonths
+ uid: 'ExcelScript!ExcelScript.AutoFillType.fillMonths:member'
+ package: ExcelScript!
+ summary: A version of "FillSeries" for dates that bases the pattern on the month.
+ - name: fillSeries
+ uid: 'ExcelScript!ExcelScript.AutoFillType.fillSeries:member'
+ package: ExcelScript!
+ summary: Populates the adjacent cells with data that follows a pattern in the copied cells.
+ - name: fillValues
+ uid: 'ExcelScript!ExcelScript.AutoFillType.fillValues:member'
+ package: ExcelScript!
+ summary: Populates the adjacent cells with the selected values.
+ - name: fillWeekdays
+ uid: 'ExcelScript!ExcelScript.AutoFillType.fillWeekdays:member'
+ package: ExcelScript!
+ summary: A version of "FillSeries" for dates that bases the pattern on the day of the week and only includes weekdays.
+ - name: fillYears
+ uid: 'ExcelScript!ExcelScript.AutoFillType.fillYears:member'
+ package: ExcelScript!
+ summary: A version of "FillSeries" for dates that bases the pattern on the year.
+ - name: flashFill
+ uid: 'ExcelScript!ExcelScript.AutoFillType.flashFill:member'
+ package: ExcelScript!
+ summary: Populates the adjacent cells by using Excel's Flash Fill feature.
+ - name: growthTrend
+ uid: 'ExcelScript!ExcelScript.AutoFillType.growthTrend:member'
+ package: ExcelScript!
+ summary: >-
+ A version of "FillSeries" for numbers that fills out the values in the adjacent cells according to a growth trend
+ model.
+ - name: linearTrend
+ uid: 'ExcelScript!ExcelScript.AutoFillType.linearTrend:member'
+ package: ExcelScript!
+ summary: >-
+ A version of "FillSeries" for numbers that fills out the values in the adjacent cells according to a linear trend
+ model.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.autofilter.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.autofilter.yml
index f7110c6a..45a51e64 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.autofilter.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.autofilter.yml
@@ -1,217 +1,217 @@
-### YamlMime:TSType
-name: ExcelScript.AutoFilter
-uid: 'ExcelScript!ExcelScript.AutoFilter:interface'
-package: ExcelScript!
-fullName: ExcelScript.AutoFilter
-summary: >-
- Represents the `AutoFilter` object. AutoFilter turns the values in Excel column into specific filters based on the
- cell contents.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates an autoFilter on the worksheet that filters out rows based on column values.
- * The autoFilter filters to only include rows that have a value in column C in the lowest 10 values
- * (of column C values).
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the autoFilter of the first table in the current worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const dataRange = currentSheet.getUsedRange();
- const autoFilter = currentSheet.getAutoFilter();
-
- // Add a filter that will only show the rows with the lowest 10 values in column C
- // (index 2, assuming the used range spans from at least A:C).
- autoFilter.apply(dataRange, 2, {
- criterion1: "10",
- filterOn: ExcelScript.FilterOn.bottomItems
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: 'apply(range, columnIndex, criteria)'
- uid: 'ExcelScript!ExcelScript.AutoFilter#apply:member(1)'
- package: ExcelScript!
- fullName: 'apply(range, columnIndex, criteria)'
- summary: Applies the AutoFilter to a range. This filters the column if column index and filter criteria are specified.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- apply(
- range: Range | string,
- columnIndex?: number,
- criteria?: FilterCriteria
- ): void;
- parameters:
- - id: range
- description: The range on which the AutoFilter will apply.
- type: ' | string'
- - id: columnIndex
- description: The zero-based column index to which the AutoFilter is applied.
- type: number
- - id: criteria
- description: The filter criteria.
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a filter to a table so that
- * only rows with values in column 1 that start with "L" are shown.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the autoFilter of the first table in the current worksheet.
- const table = workbook.getActiveWorksheet().getTables()[0];
- const autoFilter = table.getAutoFilter();
-
- // Filter to only include values that start with "L".
- const filterCriteria: ExcelScript.FilterCriteria = {
- filterOn: ExcelScript.FilterOn.custom,
- criterion1: "L*"
- };
-
- // Apply the filter to column 1 (zero-based).
- autoFilter.apply(table.getRange(), 1, filterCriteria);
- }
- ```
- - name: clearColumnCriteria(columnIndex)
- uid: 'ExcelScript!ExcelScript.AutoFilter#clearColumnCriteria:member(1)'
- package: ExcelScript!
- fullName: clearColumnCriteria(columnIndex)
- summary: Clears the column filter criteria of the AutoFilter.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'clearColumnCriteria(columnIndex: number): void;'
- parameters:
- - id: columnIndex
- description: >-
- The zero-based column index, which represents which column filter needs to be cleared. If the index value is
- not supported (for example, if the value is a negative number, or if the value is greater than the number of
- available columns in the range), then an `InvalidArgument` error will be thrown.
- type: number
- return:
- type: void
- description: ''
- - name: clearCriteria()
- uid: 'ExcelScript!ExcelScript.AutoFilter#clearCriteria:member(1)'
- package: ExcelScript!
- fullName: clearCriteria()
- summary: Clears the filter criteria and sort state of the AutoFilter.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'clearCriteria(): void;'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script clears any applied criteria from the worksheet's autoFilter.
- */
- function main(workbook: ExcelScript.Workbook) {
- const currentSheet = workbook.getActiveWorksheet();
-
- // Clear all the criteria currently applied to the autoFilter.
- currentSheet.getAutoFilter().clearCriteria();
- }
- ```
- - name: getCriteria()
- uid: 'ExcelScript!ExcelScript.AutoFilter#getCriteria:member(1)'
- package: ExcelScript!
- fullName: getCriteria()
- summary: An array that holds all the filter criteria in the autofiltered range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCriteria(): FilterCriteria[];'
- return:
- type: '[]'
- description: ''
- - name: getEnabled()
- uid: 'ExcelScript!ExcelScript.AutoFilter#getEnabled:member(1)'
- package: ExcelScript!
- fullName: getEnabled()
- summary: Specifies if the AutoFilter is enabled.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getEnabled(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getIsDataFiltered()
- uid: 'ExcelScript!ExcelScript.AutoFilter#getIsDataFiltered:member(1)'
- package: ExcelScript!
- fullName: getIsDataFiltered()
- summary: Specifies if the AutoFilter has filter criteria.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIsDataFiltered(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getRange()
- uid: 'ExcelScript!ExcelScript.AutoFilter#getRange:member(1)'
- package: ExcelScript!
- fullName: getRange()
- summary: >-
- Returns the `Range` object that represents the range to which the AutoFilter applies. If there is no `Range`
- object associated with the AutoFilter, then this method returns `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRange(): Range;'
- return:
- type: ''
- description: ''
- - name: reapply()
- uid: 'ExcelScript!ExcelScript.AutoFilter#reapply:member(1)'
- package: ExcelScript!
- fullName: reapply()
- summary: Applies the specified AutoFilter object currently on the range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'reapply(): void;'
- return:
- type: void
- description: ''
- - name: remove()
- uid: 'ExcelScript!ExcelScript.AutoFilter#remove:member(1)'
- package: ExcelScript!
- fullName: remove()
- summary: Removes the AutoFilter for the range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'remove(): void;'
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.AutoFilter
+uid: 'ExcelScript!ExcelScript.AutoFilter:interface'
+package: ExcelScript!
+fullName: ExcelScript.AutoFilter
+summary: >-
+ Represents the `AutoFilter` object. AutoFilter turns the values in Excel column into specific filters based on the
+ cell contents.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates an autoFilter on the worksheet that filters out rows based on column values.
+ * The autoFilter filters to only include rows that have a value in column C in the lowest 10 values
+ * (of column C values).
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the autoFilter of the first table in the current worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const dataRange = currentSheet.getUsedRange();
+ const autoFilter = currentSheet.getAutoFilter();
+
+ // Add a filter that will only show the rows with the lowest 10 values in column C
+ // (index 2, assuming the used range spans from at least A:C).
+ autoFilter.apply(dataRange, 2, {
+ criterion1: "10",
+ filterOn: ExcelScript.FilterOn.bottomItems
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: 'apply(range, columnIndex, criteria)'
+ uid: 'ExcelScript!ExcelScript.AutoFilter#apply:member(1)'
+ package: ExcelScript!
+ fullName: 'apply(range, columnIndex, criteria)'
+ summary: Applies the AutoFilter to a range. This filters the column if column index and filter criteria are specified.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ apply(
+ range: Range | string,
+ columnIndex?: number,
+ criteria?: FilterCriteria
+ ): void;
+ parameters:
+ - id: range
+ description: The range on which the AutoFilter will apply.
+ type: ' | string'
+ - id: columnIndex
+ description: The zero-based column index to which the AutoFilter is applied.
+ type: number
+ - id: criteria
+ description: The filter criteria.
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a filter to a table so that
+ * only rows with values in column 1 that start with "L" are shown.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the autoFilter of the first table in the current worksheet.
+ const table = workbook.getActiveWorksheet().getTables()[0];
+ const autoFilter = table.getAutoFilter();
+
+ // Filter to only include values that start with "L".
+ const filterCriteria: ExcelScript.FilterCriteria = {
+ filterOn: ExcelScript.FilterOn.custom,
+ criterion1: "L*"
+ };
+
+ // Apply the filter to column 1 (zero-based).
+ autoFilter.apply(table.getRange(), 1, filterCriteria);
+ }
+ ```
+ - name: clearColumnCriteria(columnIndex)
+ uid: 'ExcelScript!ExcelScript.AutoFilter#clearColumnCriteria:member(1)'
+ package: ExcelScript!
+ fullName: clearColumnCriteria(columnIndex)
+ summary: Clears the column filter criteria of the AutoFilter.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clearColumnCriteria(columnIndex: number): void;'
+ parameters:
+ - id: columnIndex
+ description: >-
+ The zero-based column index, which represents which column filter needs to be cleared. If the index value is
+ not supported (for example, if the value is a negative number, or if the value is greater than the number of
+ available columns in the range), then an `InvalidArgument` error will be thrown.
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: clearCriteria()
+ uid: 'ExcelScript!ExcelScript.AutoFilter#clearCriteria:member(1)'
+ package: ExcelScript!
+ fullName: clearCriteria()
+ summary: Clears the filter criteria and sort state of the AutoFilter.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clearCriteria(): void;'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script clears any applied criteria from the worksheet's autoFilter.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ const currentSheet = workbook.getActiveWorksheet();
+
+ // Clear all the criteria currently applied to the autoFilter.
+ currentSheet.getAutoFilter().clearCriteria();
+ }
+ ```
+ - name: getCriteria()
+ uid: 'ExcelScript!ExcelScript.AutoFilter#getCriteria:member(1)'
+ package: ExcelScript!
+ fullName: getCriteria()
+ summary: An array that holds all the filter criteria in the autofiltered range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCriteria(): FilterCriteria[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getEnabled()
+ uid: 'ExcelScript!ExcelScript.AutoFilter#getEnabled:member(1)'
+ package: ExcelScript!
+ fullName: getEnabled()
+ summary: Specifies if the AutoFilter is enabled.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getEnabled(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getIsDataFiltered()
+ uid: 'ExcelScript!ExcelScript.AutoFilter#getIsDataFiltered:member(1)'
+ package: ExcelScript!
+ fullName: getIsDataFiltered()
+ summary: Specifies if the AutoFilter has filter criteria.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIsDataFiltered(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getRange()
+ uid: 'ExcelScript!ExcelScript.AutoFilter#getRange:member(1)'
+ package: ExcelScript!
+ fullName: getRange()
+ summary: >-
+ Returns the `Range` object that represents the range to which the AutoFilter applies. If there is no `Range`
+ object associated with the AutoFilter, then this method returns `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRange(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: reapply()
+ uid: 'ExcelScript!ExcelScript.AutoFilter#reapply:member(1)'
+ package: ExcelScript!
+ fullName: reapply()
+ summary: Applies the specified AutoFilter object currently on the range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'reapply(): void;'
+ return:
+ type: void
+ description: ''
+ - name: remove()
+ uid: 'ExcelScript!ExcelScript.AutoFilter#remove:member(1)'
+ package: ExcelScript!
+ fullName: remove()
+ summary: Removes the AutoFilter for the range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'remove(): void;'
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.basicdatavalidation.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.basicdatavalidation.yml
index 1dea046f..249ae130 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.basicdatavalidation.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.basicdatavalidation.yml
@@ -1,97 +1,97 @@
-### YamlMime:TSType
-name: ExcelScript.BasicDataValidation
-uid: 'ExcelScript!ExcelScript.BasicDataValidation:interface'
-package: ExcelScript!
-fullName: ExcelScript.BasicDataValidation
-summary: Represents the basic type data validation criteria.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a data validation rule for the range B1:B5.
- * All values in that range must be a positive number.
- * Attempts to enter other values are blocked and an error message appears.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range B1:B5 in the active worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const positiveNumberOnlyCells = currentSheet.getRange("B1:B5");
-
- // Create a data validation rule to only allow positive numbers.
- const positiveNumberValidation: ExcelScript.BasicDataValidation = {
- formula1: "0",
- operator: ExcelScript.DataValidationOperator.greaterThan
- };
- const positiveNumberOnlyRule: ExcelScript.DataValidationRule = {
- wholeNumber: positiveNumberValidation
- };
-
- // Set the rule on the range.
- const rangeDataValidation = positiveNumberOnlyCells.getDataValidation();
- rangeDataValidation.setRule(positiveNumberOnlyRule);
-
- // Create an alert to appear when data other than positive numbers are entered.
- const positiveNumberOnlyAlert: ExcelScript.DataValidationErrorAlert = {
- message: "Positive numbers only",
- showAlert: true,
- style: ExcelScript.DataValidationAlertStyle.stop,
- title: "Invalid data"
- };
- rangeDataValidation.setErrorAlert(positiveNumberOnlyAlert);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: formula1
- uid: 'ExcelScript!ExcelScript.BasicDataValidation#formula1:member'
- package: ExcelScript!
- fullName: formula1
- summary: >-
- Specifies the right-hand operand when the operator property is set to a binary operator such as GreaterThan (the
- left-hand operand is the value the user tries to enter in the cell). With the ternary operators Between and
- NotBetween, specifies the lower bound operand. For example, setting formula1 to 10 and operator to GreaterThan
- means that valid data for the range must be greater than 10. When setting the value, it can be passed in as a
- number, a range object, or a string formula (where the string is either a stringified number, a cell reference
- like "=A1", or a formula like "=MIN(A1, B1)"). When retrieving the value, it will always be returned as a string
- formula, for example: "=10", "=A1", "=SUM(A1:B5)", etc.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'formula1: string | number | Range;'
- return:
- type: 'string | number | '
- - name: formula2
- uid: 'ExcelScript!ExcelScript.BasicDataValidation#formula2:member'
- package: ExcelScript!
- fullName: formula2
- summary: >-
- With the ternary operators Between and NotBetween, specifies the upper bound operand. Is not used with the binary
- operators, such as GreaterThan. When setting the value, it can be passed in as a number, a range object, or a
- string formula (where the string is either a stringified number, a cell reference like "=A1", or a formula like
- "=MIN(A1, B1)"). When retrieving the value, it will always be returned as a string formula, for example: "=10",
- "=A1", "=SUM(A1:B5)", etc.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'formula2?: string | number | Range;'
- return:
- type: 'string | number | '
- - name: operator
- uid: 'ExcelScript!ExcelScript.BasicDataValidation#operator:member'
- package: ExcelScript!
- fullName: operator
- summary: The operator to use for validating the data.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'operator: DataValidationOperator;'
- return:
- type: ''
+### YamlMime:TSType
+name: ExcelScript.BasicDataValidation
+uid: 'ExcelScript!ExcelScript.BasicDataValidation:interface'
+package: ExcelScript!
+fullName: ExcelScript.BasicDataValidation
+summary: Represents the basic type data validation criteria.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a data validation rule for the range B1:B5.
+ * All values in that range must be a positive number.
+ * Attempts to enter other values are blocked and an error message appears.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range B1:B5 in the active worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const positiveNumberOnlyCells = currentSheet.getRange("B1:B5");
+
+ // Create a data validation rule to only allow positive numbers.
+ const positiveNumberValidation: ExcelScript.BasicDataValidation = {
+ formula1: "0",
+ operator: ExcelScript.DataValidationOperator.greaterThan
+ };
+ const positiveNumberOnlyRule: ExcelScript.DataValidationRule = {
+ wholeNumber: positiveNumberValidation
+ };
+
+ // Set the rule on the range.
+ const rangeDataValidation = positiveNumberOnlyCells.getDataValidation();
+ rangeDataValidation.setRule(positiveNumberOnlyRule);
+
+ // Create an alert to appear when data other than positive numbers are entered.
+ const positiveNumberOnlyAlert: ExcelScript.DataValidationErrorAlert = {
+ message: "Positive numbers only",
+ showAlert: true,
+ style: ExcelScript.DataValidationAlertStyle.stop,
+ title: "Invalid data"
+ };
+ rangeDataValidation.setErrorAlert(positiveNumberOnlyAlert);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: formula1
+ uid: 'ExcelScript!ExcelScript.BasicDataValidation#formula1:member'
+ package: ExcelScript!
+ fullName: formula1
+ summary: >-
+ Specifies the right-hand operand when the operator property is set to a binary operator such as GreaterThan (the
+ left-hand operand is the value the user tries to enter in the cell). With the ternary operators Between and
+ NotBetween, specifies the lower bound operand. For example, setting formula1 to 10 and operator to GreaterThan
+ means that valid data for the range must be greater than 10. When setting the value, it can be passed in as a
+ number, a range object, or a string formula (where the string is either a stringified number, a cell reference
+ like "=A1", or a formula like "=MIN(A1, B1)"). When retrieving the value, it will always be returned as a string
+ formula, for example: "=10", "=A1", "=SUM(A1:B5)", etc.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'formula1: string | number | Range;'
+ return:
+ type: 'string | number | '
+ - name: formula2
+ uid: 'ExcelScript!ExcelScript.BasicDataValidation#formula2:member'
+ package: ExcelScript!
+ fullName: formula2
+ summary: >-
+ With the ternary operators Between and NotBetween, specifies the upper bound operand. Is not used with the binary
+ operators, such as GreaterThan. When setting the value, it can be passed in as a number, a range object, or a
+ string formula (where the string is either a stringified number, a cell reference like "=A1", or a formula like
+ "=MIN(A1, B1)"). When retrieving the value, it will always be returned as a string formula, for example: "=10",
+ "=A1", "=SUM(A1:B5)", etc.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'formula2?: string | number | Range;'
+ return:
+ type: 'string | number | '
+ - name: operator
+ uid: 'ExcelScript!ExcelScript.BasicDataValidation#operator:member'
+ package: ExcelScript!
+ fullName: operator
+ summary: The operator to use for validating the data.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'operator: DataValidationOperator;'
+ return:
+ type: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.binding.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.binding.yml
index e2f4ee9f..e2d1ed17 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.binding.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.binding.yml
@@ -1,89 +1,89 @@
-### YamlMime:TSType
-name: ExcelScript.Binding
-uid: 'ExcelScript!ExcelScript.Binding:interface'
-package: ExcelScript!
-fullName: ExcelScript.Binding
-summary: Represents an Office.js binding that is defined in the workbook.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: delete()
- uid: 'ExcelScript!ExcelScript.Binding#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: Deletes the binding.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: ''
- - name: getId()
- uid: 'ExcelScript!ExcelScript.Binding#getId:member(1)'
- package: ExcelScript!
- fullName: getId()
- summary: Represents the binding identifier.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getId(): string;'
- return:
- type: string
- description: ''
- - name: getRange()
- uid: 'ExcelScript!ExcelScript.Binding#getRange:member(1)'
- package: ExcelScript!
- fullName: getRange()
- summary: Returns the range represented by the binding. Will throw an error if the binding is not of the correct type.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRange(): Range;'
- return:
- type: ''
- description: ''
- - name: getTable()
- uid: 'ExcelScript!ExcelScript.Binding#getTable:member(1)'
- package: ExcelScript!
- fullName: getTable()
- summary: Returns the table represented by the binding. Will throw an error if the binding is not of the correct type.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTable(): Table;'
- return:
- type: ''
- description: ''
- - name: getText()
- uid: 'ExcelScript!ExcelScript.Binding#getText:member(1)'
- package: ExcelScript!
- fullName: getText()
- summary: Returns the text represented by the binding. Will throw an error if the binding is not of the correct type.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getText(): string;'
- return:
- type: string
- description: ''
- - name: getType()
- uid: 'ExcelScript!ExcelScript.Binding#getType:member(1)'
- package: ExcelScript!
- fullName: getType()
- summary: Returns the type of the binding. See `ExcelScript.BindingType` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getType(): BindingType;'
- return:
- type: ''
- description: ''
+### YamlMime:TSType
+name: ExcelScript.Binding
+uid: 'ExcelScript!ExcelScript.Binding:interface'
+package: ExcelScript!
+fullName: ExcelScript.Binding
+summary: Represents an Office.js binding that is defined in the workbook.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.Binding#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: Deletes the binding.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getId()
+ uid: 'ExcelScript!ExcelScript.Binding#getId:member(1)'
+ package: ExcelScript!
+ fullName: getId()
+ summary: Represents the binding identifier.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getId(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getRange()
+ uid: 'ExcelScript!ExcelScript.Binding#getRange:member(1)'
+ package: ExcelScript!
+ fullName: getRange()
+ summary: Returns the range represented by the binding. Will throw an error if the binding is not of the correct type.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRange(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getTable()
+ uid: 'ExcelScript!ExcelScript.Binding#getTable:member(1)'
+ package: ExcelScript!
+ fullName: getTable()
+ summary: Returns the table represented by the binding. Will throw an error if the binding is not of the correct type.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTable(): Table;'
+ return:
+ type: ''
+ description: ''
+ - name: getText()
+ uid: 'ExcelScript!ExcelScript.Binding#getText:member(1)'
+ package: ExcelScript!
+ fullName: getText()
+ summary: Returns the text represented by the binding. Will throw an error if the binding is not of the correct type.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getText(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getType()
+ uid: 'ExcelScript!ExcelScript.Binding#getType:member(1)'
+ package: ExcelScript!
+ fullName: getType()
+ summary: Returns the type of the binding. See `ExcelScript.BindingType` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getType(): BindingType;'
+ return:
+ type: ''
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.bindingtype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.bindingtype.yml
index 96ccb5ff..bf705042 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.bindingtype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.bindingtype.yml
@@ -1,22 +1,22 @@
-### YamlMime:TSEnum
-name: ExcelScript.BindingType
-uid: 'ExcelScript!ExcelScript.BindingType:enum'
-package: ExcelScript!
-fullName: ExcelScript.BindingType
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: range
- uid: 'ExcelScript!ExcelScript.BindingType.range:member'
- package: ExcelScript!
- summary: ''
- - name: table
- uid: 'ExcelScript!ExcelScript.BindingType.table:member'
- package: ExcelScript!
- summary: ''
- - name: text
- uid: 'ExcelScript!ExcelScript.BindingType.text:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.BindingType
+uid: 'ExcelScript!ExcelScript.BindingType:enum'
+package: ExcelScript!
+fullName: ExcelScript.BindingType
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: range
+ uid: 'ExcelScript!ExcelScript.BindingType.range:member'
+ package: ExcelScript!
+ summary: ''
+ - name: table
+ uid: 'ExcelScript!ExcelScript.BindingType.table:member'
+ package: ExcelScript!
+ summary: ''
+ - name: text
+ uid: 'ExcelScript!ExcelScript.BindingType.text:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.borderindex.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.borderindex.yml
index a648e0ca..62bab449 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.borderindex.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.borderindex.yml
@@ -1,74 +1,74 @@
-### YamlMime:TSEnum
-name: ExcelScript.BorderIndex
-uid: 'ExcelScript!ExcelScript.BorderIndex:enum'
-package: ExcelScript!
-fullName: ExcelScript.BorderIndex
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a border around a range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the RangeFormat object for the range "B2:G10".
- const currentSheet = workbook.getActiveWorksheet();
- const rangeForBorder = currentSheet.getRange("B2:G10");
- const format = rangeForBorder.getFormat();
-
- // Get a RangeBorder object for each edge of the range and set the border properties.
- let edgeTop = format.getRangeBorder(ExcelScript.BorderIndex.edgeTop);
- edgeTop.setStyle(ExcelScript.BorderLineStyle.dashDot);
- edgeTop.setWeight(ExcelScript.BorderWeight.thick);
-
- let edgeBottom = format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom);
- edgeBottom.setStyle(ExcelScript.BorderLineStyle.dashDot);
- edgeBottom.setWeight(ExcelScript.BorderWeight.thick);
-
- let edgeLeft = format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft);
- edgeLeft.setStyle(ExcelScript.BorderLineStyle.dashDot);
- edgeLeft.setWeight(ExcelScript.BorderWeight.thick);
-
- let edgeRight = format.getRangeBorder(ExcelScript.BorderIndex.edgeRight);
- edgeRight.setStyle(ExcelScript.BorderLineStyle.dashDot);
- edgeRight.setWeight(ExcelScript.BorderWeight.thick);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: diagonalDown
- uid: 'ExcelScript!ExcelScript.BorderIndex.diagonalDown:member'
- package: ExcelScript!
- summary: ''
- - name: diagonalUp
- uid: 'ExcelScript!ExcelScript.BorderIndex.diagonalUp:member'
- package: ExcelScript!
- summary: ''
- - name: edgeBottom
- uid: 'ExcelScript!ExcelScript.BorderIndex.edgeBottom:member'
- package: ExcelScript!
- summary: ''
- - name: edgeLeft
- uid: 'ExcelScript!ExcelScript.BorderIndex.edgeLeft:member'
- package: ExcelScript!
- summary: ''
- - name: edgeRight
- uid: 'ExcelScript!ExcelScript.BorderIndex.edgeRight:member'
- package: ExcelScript!
- summary: ''
- - name: edgeTop
- uid: 'ExcelScript!ExcelScript.BorderIndex.edgeTop:member'
- package: ExcelScript!
- summary: ''
- - name: insideHorizontal
- uid: 'ExcelScript!ExcelScript.BorderIndex.insideHorizontal:member'
- package: ExcelScript!
- summary: ''
- - name: insideVertical
- uid: 'ExcelScript!ExcelScript.BorderIndex.insideVertical:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.BorderIndex
+uid: 'ExcelScript!ExcelScript.BorderIndex:enum'
+package: ExcelScript!
+fullName: ExcelScript.BorderIndex
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a border around a range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the RangeFormat object for the range "B2:G10".
+ const currentSheet = workbook.getActiveWorksheet();
+ const rangeForBorder = currentSheet.getRange("B2:G10");
+ const format = rangeForBorder.getFormat();
+
+ // Get a RangeBorder object for each edge of the range and set the border properties.
+ let edgeTop = format.getRangeBorder(ExcelScript.BorderIndex.edgeTop);
+ edgeTop.setStyle(ExcelScript.BorderLineStyle.dashDot);
+ edgeTop.setWeight(ExcelScript.BorderWeight.thick);
+
+ let edgeBottom = format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom);
+ edgeBottom.setStyle(ExcelScript.BorderLineStyle.dashDot);
+ edgeBottom.setWeight(ExcelScript.BorderWeight.thick);
+
+ let edgeLeft = format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft);
+ edgeLeft.setStyle(ExcelScript.BorderLineStyle.dashDot);
+ edgeLeft.setWeight(ExcelScript.BorderWeight.thick);
+
+ let edgeRight = format.getRangeBorder(ExcelScript.BorderIndex.edgeRight);
+ edgeRight.setStyle(ExcelScript.BorderLineStyle.dashDot);
+ edgeRight.setWeight(ExcelScript.BorderWeight.thick);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: diagonalDown
+ uid: 'ExcelScript!ExcelScript.BorderIndex.diagonalDown:member'
+ package: ExcelScript!
+ summary: ''
+ - name: diagonalUp
+ uid: 'ExcelScript!ExcelScript.BorderIndex.diagonalUp:member'
+ package: ExcelScript!
+ summary: ''
+ - name: edgeBottom
+ uid: 'ExcelScript!ExcelScript.BorderIndex.edgeBottom:member'
+ package: ExcelScript!
+ summary: ''
+ - name: edgeLeft
+ uid: 'ExcelScript!ExcelScript.BorderIndex.edgeLeft:member'
+ package: ExcelScript!
+ summary: ''
+ - name: edgeRight
+ uid: 'ExcelScript!ExcelScript.BorderIndex.edgeRight:member'
+ package: ExcelScript!
+ summary: ''
+ - name: edgeTop
+ uid: 'ExcelScript!ExcelScript.BorderIndex.edgeTop:member'
+ package: ExcelScript!
+ summary: ''
+ - name: insideHorizontal
+ uid: 'ExcelScript!ExcelScript.BorderIndex.insideHorizontal:member'
+ package: ExcelScript!
+ summary: ''
+ - name: insideVertical
+ uid: 'ExcelScript!ExcelScript.BorderIndex.insideVertical:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.borderlinestyle.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.borderlinestyle.yml
index 43263552..b82c3250 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.borderlinestyle.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.borderlinestyle.yml
@@ -1,74 +1,74 @@
-### YamlMime:TSEnum
-name: ExcelScript.BorderLineStyle
-uid: 'ExcelScript!ExcelScript.BorderLineStyle:enum'
-package: ExcelScript!
-fullName: ExcelScript.BorderLineStyle
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a border around a range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the RangeFormat object for the range "B2:G10".
- const currentSheet = workbook.getActiveWorksheet();
- const rangeForBorder = currentSheet.getRange("B2:G10");
- const format = rangeForBorder.getFormat();
-
- // Get a RangeBorder object for each edge of the range and set the border properties.
- let edgeTop = format.getRangeBorder(ExcelScript.BorderIndex.edgeTop);
- edgeTop.setStyle(ExcelScript.BorderLineStyle.dashDot);
- edgeTop.setWeight(ExcelScript.BorderWeight.thick);
-
- let edgeBottom = format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom);
- edgeBottom.setStyle(ExcelScript.BorderLineStyle.dashDot);
- edgeBottom.setWeight(ExcelScript.BorderWeight.thick);
-
- let edgeLeft = format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft);
- edgeLeft.setStyle(ExcelScript.BorderLineStyle.dashDot);
- edgeLeft.setWeight(ExcelScript.BorderWeight.thick);
-
- let edgeRight = format.getRangeBorder(ExcelScript.BorderIndex.edgeRight);
- edgeRight.setStyle(ExcelScript.BorderLineStyle.dashDot);
- edgeRight.setWeight(ExcelScript.BorderWeight.thick);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: continuous
- uid: 'ExcelScript!ExcelScript.BorderLineStyle.continuous:member'
- package: ExcelScript!
- summary: ''
- - name: dash
- uid: 'ExcelScript!ExcelScript.BorderLineStyle.dash:member'
- package: ExcelScript!
- summary: ''
- - name: dashDot
- uid: 'ExcelScript!ExcelScript.BorderLineStyle.dashDot:member'
- package: ExcelScript!
- summary: ''
- - name: dashDotDot
- uid: 'ExcelScript!ExcelScript.BorderLineStyle.dashDotDot:member'
- package: ExcelScript!
- summary: ''
- - name: dot
- uid: 'ExcelScript!ExcelScript.BorderLineStyle.dot:member'
- package: ExcelScript!
- summary: ''
- - name: double
- uid: 'ExcelScript!ExcelScript.BorderLineStyle.double:member'
- package: ExcelScript!
- summary: ''
- - name: none
- uid: 'ExcelScript!ExcelScript.BorderLineStyle.none:member'
- package: ExcelScript!
- summary: ''
- - name: slantDashDot
- uid: 'ExcelScript!ExcelScript.BorderLineStyle.slantDashDot:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.BorderLineStyle
+uid: 'ExcelScript!ExcelScript.BorderLineStyle:enum'
+package: ExcelScript!
+fullName: ExcelScript.BorderLineStyle
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a border around a range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the RangeFormat object for the range "B2:G10".
+ const currentSheet = workbook.getActiveWorksheet();
+ const rangeForBorder = currentSheet.getRange("B2:G10");
+ const format = rangeForBorder.getFormat();
+
+ // Get a RangeBorder object for each edge of the range and set the border properties.
+ let edgeTop = format.getRangeBorder(ExcelScript.BorderIndex.edgeTop);
+ edgeTop.setStyle(ExcelScript.BorderLineStyle.dashDot);
+ edgeTop.setWeight(ExcelScript.BorderWeight.thick);
+
+ let edgeBottom = format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom);
+ edgeBottom.setStyle(ExcelScript.BorderLineStyle.dashDot);
+ edgeBottom.setWeight(ExcelScript.BorderWeight.thick);
+
+ let edgeLeft = format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft);
+ edgeLeft.setStyle(ExcelScript.BorderLineStyle.dashDot);
+ edgeLeft.setWeight(ExcelScript.BorderWeight.thick);
+
+ let edgeRight = format.getRangeBorder(ExcelScript.BorderIndex.edgeRight);
+ edgeRight.setStyle(ExcelScript.BorderLineStyle.dashDot);
+ edgeRight.setWeight(ExcelScript.BorderWeight.thick);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: continuous
+ uid: 'ExcelScript!ExcelScript.BorderLineStyle.continuous:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dash
+ uid: 'ExcelScript!ExcelScript.BorderLineStyle.dash:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dashDot
+ uid: 'ExcelScript!ExcelScript.BorderLineStyle.dashDot:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dashDotDot
+ uid: 'ExcelScript!ExcelScript.BorderLineStyle.dashDotDot:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dot
+ uid: 'ExcelScript!ExcelScript.BorderLineStyle.dot:member'
+ package: ExcelScript!
+ summary: ''
+ - name: double
+ uid: 'ExcelScript!ExcelScript.BorderLineStyle.double:member'
+ package: ExcelScript!
+ summary: ''
+ - name: none
+ uid: 'ExcelScript!ExcelScript.BorderLineStyle.none:member'
+ package: ExcelScript!
+ summary: ''
+ - name: slantDashDot
+ uid: 'ExcelScript!ExcelScript.BorderLineStyle.slantDashDot:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.borderweight.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.borderweight.yml
index fa230d15..3b2ef1ac 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.borderweight.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.borderweight.yml
@@ -1,58 +1,58 @@
-### YamlMime:TSEnum
-name: ExcelScript.BorderWeight
-uid: 'ExcelScript!ExcelScript.BorderWeight:enum'
-package: ExcelScript!
-fullName: ExcelScript.BorderWeight
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a border around a range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the RangeFormat object for the range "B2:G10".
- const currentSheet = workbook.getActiveWorksheet();
- const rangeForBorder = currentSheet.getRange("B2:G10");
- const format = rangeForBorder.getFormat();
-
- // Get a RangeBorder object for each edge of the range and set the border properties.
- let edgeTop = format.getRangeBorder(ExcelScript.BorderIndex.edgeTop);
- edgeTop.setStyle(ExcelScript.BorderLineStyle.dashDot);
- edgeTop.setWeight(ExcelScript.BorderWeight.thick);
-
- let edgeBottom = format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom);
- edgeBottom.setStyle(ExcelScript.BorderLineStyle.dashDot);
- edgeBottom.setWeight(ExcelScript.BorderWeight.thick);
-
- let edgeLeft = format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft);
- edgeLeft.setStyle(ExcelScript.BorderLineStyle.dashDot);
- edgeLeft.setWeight(ExcelScript.BorderWeight.thick);
-
- let edgeRight = format.getRangeBorder(ExcelScript.BorderIndex.edgeRight);
- edgeRight.setStyle(ExcelScript.BorderLineStyle.dashDot);
- edgeRight.setWeight(ExcelScript.BorderWeight.thick);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: hairline
- uid: 'ExcelScript!ExcelScript.BorderWeight.hairline:member'
- package: ExcelScript!
- summary: ''
- - name: medium
- uid: 'ExcelScript!ExcelScript.BorderWeight.medium:member'
- package: ExcelScript!
- summary: ''
- - name: thick
- uid: 'ExcelScript!ExcelScript.BorderWeight.thick:member'
- package: ExcelScript!
- summary: ''
- - name: thin
- uid: 'ExcelScript!ExcelScript.BorderWeight.thin:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.BorderWeight
+uid: 'ExcelScript!ExcelScript.BorderWeight:enum'
+package: ExcelScript!
+fullName: ExcelScript.BorderWeight
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a border around a range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the RangeFormat object for the range "B2:G10".
+ const currentSheet = workbook.getActiveWorksheet();
+ const rangeForBorder = currentSheet.getRange("B2:G10");
+ const format = rangeForBorder.getFormat();
+
+ // Get a RangeBorder object for each edge of the range and set the border properties.
+ let edgeTop = format.getRangeBorder(ExcelScript.BorderIndex.edgeTop);
+ edgeTop.setStyle(ExcelScript.BorderLineStyle.dashDot);
+ edgeTop.setWeight(ExcelScript.BorderWeight.thick);
+
+ let edgeBottom = format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom);
+ edgeBottom.setStyle(ExcelScript.BorderLineStyle.dashDot);
+ edgeBottom.setWeight(ExcelScript.BorderWeight.thick);
+
+ let edgeLeft = format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft);
+ edgeLeft.setStyle(ExcelScript.BorderLineStyle.dashDot);
+ edgeLeft.setWeight(ExcelScript.BorderWeight.thick);
+
+ let edgeRight = format.getRangeBorder(ExcelScript.BorderIndex.edgeRight);
+ edgeRight.setStyle(ExcelScript.BorderLineStyle.dashDot);
+ edgeRight.setWeight(ExcelScript.BorderWeight.thick);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: hairline
+ uid: 'ExcelScript!ExcelScript.BorderWeight.hairline:member'
+ package: ExcelScript!
+ summary: ''
+ - name: medium
+ uid: 'ExcelScript!ExcelScript.BorderWeight.medium:member'
+ package: ExcelScript!
+ summary: ''
+ - name: thick
+ uid: 'ExcelScript!ExcelScript.BorderWeight.thick:member'
+ package: ExcelScript!
+ summary: ''
+ - name: thin
+ uid: 'ExcelScript!ExcelScript.BorderWeight.thin:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.builtinstyle.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.builtinstyle.yml
index 4dcea496..3daf59d4 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.builtinstyle.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.builtinstyle.yml
@@ -1,249 +1,249 @@
-### YamlMime:TSEnum
-name: ExcelScript.BuiltInStyle
-uid: 'ExcelScript!ExcelScript.BuiltInStyle:enum'
-package: ExcelScript!
-fullName: ExcelScript.BuiltInStyle
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the cell style to "warning text"
- * on every cell with a formula error.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the used range in the current worksheet.
- const sheet = workbook.getActiveWorksheet();
- const usedRange = sheet.getUsedRange();
-
- // Get any cells that are displaying errors.
- const errorCells = usedRange.getSpecialCells(
- ExcelScript.SpecialCellType.formulas,
- ExcelScript.SpecialCellValueType.errors
- );
-
- // Check if there are error cells before proceeding.
- if (errorCells) {
- // Use the built-in warning text style on the error cells.
- errorCells.setPredefinedCellStyle(
- ExcelScript.BuiltInStyle.warningText.toString()
- );
- } else {
- console.log("No formula errors in the worksheet.");
- }
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: accent1
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent1:member'
- package: ExcelScript!
- summary: ''
- - name: accent1_20
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent1_20:member'
- package: ExcelScript!
- summary: ''
- - name: accent1_40
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent1_40:member'
- package: ExcelScript!
- summary: ''
- - name: accent1_60
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent1_60:member'
- package: ExcelScript!
- summary: ''
- - name: accent2
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent2:member'
- package: ExcelScript!
- summary: ''
- - name: accent2_20
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent2_20:member'
- package: ExcelScript!
- summary: ''
- - name: accent2_40
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent2_40:member'
- package: ExcelScript!
- summary: ''
- - name: accent2_60
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent2_60:member'
- package: ExcelScript!
- summary: ''
- - name: accent3
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent3:member'
- package: ExcelScript!
- summary: ''
- - name: accent3_20
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent3_20:member'
- package: ExcelScript!
- summary: ''
- - name: accent3_40
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent3_40:member'
- package: ExcelScript!
- summary: ''
- - name: accent3_60
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent3_60:member'
- package: ExcelScript!
- summary: ''
- - name: accent4
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent4:member'
- package: ExcelScript!
- summary: ''
- - name: accent4_20
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent4_20:member'
- package: ExcelScript!
- summary: ''
- - name: accent4_40
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent4_40:member'
- package: ExcelScript!
- summary: ''
- - name: accent4_60
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent4_60:member'
- package: ExcelScript!
- summary: ''
- - name: accent5
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent5:member'
- package: ExcelScript!
- summary: ''
- - name: accent5_20
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent5_20:member'
- package: ExcelScript!
- summary: ''
- - name: accent5_40
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent5_40:member'
- package: ExcelScript!
- summary: ''
- - name: accent5_60
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent5_60:member'
- package: ExcelScript!
- summary: ''
- - name: accent6
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent6:member'
- package: ExcelScript!
- summary: ''
- - name: accent6_20
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent6_20:member'
- package: ExcelScript!
- summary: ''
- - name: accent6_40
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent6_40:member'
- package: ExcelScript!
- summary: ''
- - name: accent6_60
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent6_60:member'
- package: ExcelScript!
- summary: ''
- - name: bad
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.bad:member'
- package: ExcelScript!
- summary: ''
- - name: calculation
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.calculation:member'
- package: ExcelScript!
- summary: ''
- - name: checkCell
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.checkCell:member'
- package: ExcelScript!
- summary: ''
- - name: comma
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.comma:member'
- package: ExcelScript!
- summary: ''
- - name: currency
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.currency:member'
- package: ExcelScript!
- summary: ''
- - name: emphasis1
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.emphasis1:member'
- package: ExcelScript!
- summary: ''
- - name: emphasis2
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.emphasis2:member'
- package: ExcelScript!
- summary: ''
- - name: emphasis3
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.emphasis3:member'
- package: ExcelScript!
- summary: ''
- - name: explanatoryText
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.explanatoryText:member'
- package: ExcelScript!
- summary: ''
- - name: good
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.good:member'
- package: ExcelScript!
- summary: ''
- - name: heading1
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.heading1:member'
- package: ExcelScript!
- summary: ''
- - name: heading2
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.heading2:member'
- package: ExcelScript!
- summary: ''
- - name: heading3
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.heading3:member'
- package: ExcelScript!
- summary: ''
- - name: heading4
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.heading4:member'
- package: ExcelScript!
- summary: ''
- - name: hlink
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.hlink:member'
- package: ExcelScript!
- summary: ''
- - name: hlinkTrav
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.hlinkTrav:member'
- package: ExcelScript!
- summary: ''
- - name: input
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.input:member'
- package: ExcelScript!
- summary: ''
- - name: linkedCell
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.linkedCell:member'
- package: ExcelScript!
- summary: ''
- - name: neutral
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.neutral:member'
- package: ExcelScript!
- summary: ''
- - name: normal
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.normal:member'
- package: ExcelScript!
- summary: ''
- - name: note
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.note:member'
- package: ExcelScript!
- summary: ''
- - name: output
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.output:member'
- package: ExcelScript!
- summary: ''
- - name: percent
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.percent:member'
- package: ExcelScript!
- summary: ''
- - name: sheetTitle
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.sheetTitle:member'
- package: ExcelScript!
- summary: ''
- - name: total
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.total:member'
- package: ExcelScript!
- summary: ''
- - name: warningText
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.warningText:member'
- package: ExcelScript!
- summary: ''
- - name: wholeComma
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.wholeComma:member'
- package: ExcelScript!
- summary: ''
- - name: wholeDollar
- uid: 'ExcelScript!ExcelScript.BuiltInStyle.wholeDollar:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.BuiltInStyle
+uid: 'ExcelScript!ExcelScript.BuiltInStyle:enum'
+package: ExcelScript!
+fullName: ExcelScript.BuiltInStyle
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the cell style to "warning text"
+ * on every cell with a formula error.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the used range in the current worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const usedRange = sheet.getUsedRange();
+
+ // Get any cells that are displaying errors.
+ const errorCells = usedRange.getSpecialCells(
+ ExcelScript.SpecialCellType.formulas,
+ ExcelScript.SpecialCellValueType.errors
+ );
+
+ // Check if there are error cells before proceeding.
+ if (errorCells) {
+ // Use the built-in warning text style on the error cells.
+ errorCells.setPredefinedCellStyle(
+ ExcelScript.BuiltInStyle.warningText.toString()
+ );
+ } else {
+ console.log("No formula errors in the worksheet.");
+ }
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: accent1
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent1:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accent1_20
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent1_20:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accent1_40
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent1_40:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accent1_60
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent1_60:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accent2
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent2:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accent2_20
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent2_20:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accent2_40
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent2_40:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accent2_60
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent2_60:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accent3
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent3:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accent3_20
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent3_20:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accent3_40
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent3_40:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accent3_60
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent3_60:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accent4
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent4:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accent4_20
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent4_20:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accent4_40
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent4_40:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accent4_60
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent4_60:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accent5
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent5:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accent5_20
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent5_20:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accent5_40
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent5_40:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accent5_60
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent5_60:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accent6
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent6:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accent6_20
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent6_20:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accent6_40
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent6_40:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accent6_60
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.accent6_60:member'
+ package: ExcelScript!
+ summary: ''
+ - name: bad
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.bad:member'
+ package: ExcelScript!
+ summary: ''
+ - name: calculation
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.calculation:member'
+ package: ExcelScript!
+ summary: ''
+ - name: checkCell
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.checkCell:member'
+ package: ExcelScript!
+ summary: ''
+ - name: comma
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.comma:member'
+ package: ExcelScript!
+ summary: ''
+ - name: currency
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.currency:member'
+ package: ExcelScript!
+ summary: ''
+ - name: emphasis1
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.emphasis1:member'
+ package: ExcelScript!
+ summary: ''
+ - name: emphasis2
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.emphasis2:member'
+ package: ExcelScript!
+ summary: ''
+ - name: emphasis3
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.emphasis3:member'
+ package: ExcelScript!
+ summary: ''
+ - name: explanatoryText
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.explanatoryText:member'
+ package: ExcelScript!
+ summary: ''
+ - name: good
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.good:member'
+ package: ExcelScript!
+ summary: ''
+ - name: heading1
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.heading1:member'
+ package: ExcelScript!
+ summary: ''
+ - name: heading2
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.heading2:member'
+ package: ExcelScript!
+ summary: ''
+ - name: heading3
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.heading3:member'
+ package: ExcelScript!
+ summary: ''
+ - name: heading4
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.heading4:member'
+ package: ExcelScript!
+ summary: ''
+ - name: hlink
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.hlink:member'
+ package: ExcelScript!
+ summary: ''
+ - name: hlinkTrav
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.hlinkTrav:member'
+ package: ExcelScript!
+ summary: ''
+ - name: input
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.input:member'
+ package: ExcelScript!
+ summary: ''
+ - name: linkedCell
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.linkedCell:member'
+ package: ExcelScript!
+ summary: ''
+ - name: neutral
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.neutral:member'
+ package: ExcelScript!
+ summary: ''
+ - name: normal
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.normal:member'
+ package: ExcelScript!
+ summary: ''
+ - name: note
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.note:member'
+ package: ExcelScript!
+ summary: ''
+ - name: output
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.output:member'
+ package: ExcelScript!
+ summary: ''
+ - name: percent
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.percent:member'
+ package: ExcelScript!
+ summary: ''
+ - name: sheetTitle
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.sheetTitle:member'
+ package: ExcelScript!
+ summary: ''
+ - name: total
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.total:member'
+ package: ExcelScript!
+ summary: ''
+ - name: warningText
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.warningText:member'
+ package: ExcelScript!
+ summary: ''
+ - name: wholeComma
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.wholeComma:member'
+ package: ExcelScript!
+ summary: ''
+ - name: wholeDollar
+ uid: 'ExcelScript!ExcelScript.BuiltInStyle.wholeDollar:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.calculationmode.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.calculationmode.yml
index 13779cc7..8b0c88dd 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.calculationmode.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.calculationmode.yml
@@ -1,45 +1,45 @@
-### YamlMime:TSEnum
-name: ExcelScript.CalculationMode
-uid: 'ExcelScript!ExcelScript.CalculationMode:enum'
-package: ExcelScript!
-fullName: ExcelScript.CalculationMode
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script recalculates the used range of a specific worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Only recalculate if the calculation mode is not set to automatic.
- if (workbook.getApplication().getCalculationMode() !== ExcelScript.CalculationMode.automatic) {
- // Get the used range from a worksheet named "Monthly Report".
- const sheet = workbook.getWorksheet("Monthly Report");
- const range = sheet.getUsedRange();
- console.log(`Calculating ${range.getAddress()}`);
-
- // Force all the used cells in that worksheet to calculate.
- sheet.getUsedRange().calculate();
- }
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: automatic
- uid: 'ExcelScript!ExcelScript.CalculationMode.automatic:member'
- package: ExcelScript!
- summary: >-
- The default recalculation behavior where Excel calculates new formula results every time the relevant data is
- changed.
- - name: automaticExceptTables
- uid: 'ExcelScript!ExcelScript.CalculationMode.automaticExceptTables:member'
- package: ExcelScript!
- summary: 'Calculates new formula results every time the relevant data is changed, unless the formula is in a data table.'
- - name: manual
- uid: 'ExcelScript!ExcelScript.CalculationMode.manual:member'
- package: ExcelScript!
- summary: Calculations only occur when the user or add-in requests them.
+### YamlMime:TSEnum
+name: ExcelScript.CalculationMode
+uid: 'ExcelScript!ExcelScript.CalculationMode:enum'
+package: ExcelScript!
+fullName: ExcelScript.CalculationMode
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script recalculates the used range of a specific worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Only recalculate if the calculation mode is not set to automatic.
+ if (workbook.getApplication().getCalculationMode() !== ExcelScript.CalculationMode.automatic) {
+ // Get the used range from a worksheet named "Monthly Report".
+ const sheet = workbook.getWorksheet("Monthly Report");
+ const range = sheet.getUsedRange();
+ console.log(`Calculating ${range.getAddress()}`);
+
+ // Force all the used cells in that worksheet to calculate.
+ sheet.getUsedRange().calculate();
+ }
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: automatic
+ uid: 'ExcelScript!ExcelScript.CalculationMode.automatic:member'
+ package: ExcelScript!
+ summary: >-
+ The default recalculation behavior where Excel calculates new formula results every time the relevant data is
+ changed.
+ - name: automaticExceptTables
+ uid: 'ExcelScript!ExcelScript.CalculationMode.automaticExceptTables:member'
+ package: ExcelScript!
+ summary: 'Calculates new formula results every time the relevant data is changed, unless the formula is in a data table.'
+ - name: manual
+ uid: 'ExcelScript!ExcelScript.CalculationMode.manual:member'
+ package: ExcelScript!
+ summary: Calculations only occur when the user or add-in requests them.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.calculationstate.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.calculationstate.yml
index cdfea780..4affdec6 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.calculationstate.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.calculationstate.yml
@@ -1,53 +1,53 @@
-### YamlMime:TSEnum
-name: ExcelScript.CalculationState
-uid: 'ExcelScript!ExcelScript.CalculationState:enum'
-package: ExcelScript!
-fullName: ExcelScript.CalculationState
-summary: Represents the state of calculation across the entire Excel application.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script uses the fill color of the first cell to indicate the current
- * calculation state of the workbook.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first cell in the first worksheet.
- const cell = workbook.getWorksheets()[0].getCell(0,0);
-
- // Get that cell's fill object.
- const cellFill = cell.getFormat().getFill();
-
- // Set the cell fill based on the calculation state.
- const calcState = workbook.getApplication().getCalculationState();
- switch (calcState) {
- case ExcelScript.CalculationState.pending:
- cellFill.setColor("Red");
- break;
- case ExcelScript.CalculationState.calculating:
- cellFill.setColor("Yellow");
- break;
- case ExcelScript.CalculationState.done:
- cellFill.setColor("Green");
- break;
- }
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: calculating
- uid: 'ExcelScript!ExcelScript.CalculationState.calculating:member'
- package: ExcelScript!
- summary: Calculations in progress.
- - name: done
- uid: 'ExcelScript!ExcelScript.CalculationState.done:member'
- package: ExcelScript!
- summary: Calculations complete.
- - name: pending
- uid: 'ExcelScript!ExcelScript.CalculationState.pending:member'
- package: ExcelScript!
- summary: 'Changes that trigger calculation have been made, but a recalculation has not yet been performed.'
+### YamlMime:TSEnum
+name: ExcelScript.CalculationState
+uid: 'ExcelScript!ExcelScript.CalculationState:enum'
+package: ExcelScript!
+fullName: ExcelScript.CalculationState
+summary: Represents the state of calculation across the entire Excel application.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script uses the fill color of the first cell to indicate the current
+ * calculation state of the workbook.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first cell in the first worksheet.
+ const cell = workbook.getWorksheets()[0].getCell(0,0);
+
+ // Get that cell's fill object.
+ const cellFill = cell.getFormat().getFill();
+
+ // Set the cell fill based on the calculation state.
+ const calcState = workbook.getApplication().getCalculationState();
+ switch (calcState) {
+ case ExcelScript.CalculationState.pending:
+ cellFill.setColor("Red");
+ break;
+ case ExcelScript.CalculationState.calculating:
+ cellFill.setColor("Yellow");
+ break;
+ case ExcelScript.CalculationState.done:
+ cellFill.setColor("Green");
+ break;
+ }
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: calculating
+ uid: 'ExcelScript!ExcelScript.CalculationState.calculating:member'
+ package: ExcelScript!
+ summary: Calculations in progress.
+ - name: done
+ uid: 'ExcelScript!ExcelScript.CalculationState.done:member'
+ package: ExcelScript!
+ summary: Calculations complete.
+ - name: pending
+ uid: 'ExcelScript!ExcelScript.CalculationState.pending:member'
+ package: ExcelScript!
+ summary: 'Changes that trigger calculation have been made, but a recalculation has not yet been performed.'
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.calculationtype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.calculationtype.yml
index 7ceee7e7..8e6d2582 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.calculationtype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.calculationtype.yml
@@ -1,39 +1,39 @@
-### YamlMime:TSEnum
-name: ExcelScript.CalculationType
-uid: 'ExcelScript!ExcelScript.CalculationType:enum'
-package: ExcelScript!
-fullName: ExcelScript.CalculationType
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script fully recalculates the entire workbook.
- * This code is useful when automatic recalculation is turned off
- * but later parts of the script rely on updated values.
- */
- function main(workbook: ExcelScript.Workbook, workbookURL: string) {
- const application = workbook.getApplication();
- application.calculate(ExcelScript.CalculationType.fullRebuild);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: full
- uid: 'ExcelScript!ExcelScript.CalculationType.full:member'
- package: ExcelScript!
- summary: This will mark all cells as dirty and then recalculate them.
- - name: fullRebuild
- uid: 'ExcelScript!ExcelScript.CalculationType.fullRebuild:member'
- package: ExcelScript!
- summary: 'This will rebuild the full dependency chain, mark all cells as dirty and then recalculate them.'
- - name: recalculate
- uid: 'ExcelScript!ExcelScript.CalculationType.recalculate:member'
- package: ExcelScript!
- summary: >-
- Recalculates all cells that Excel has marked as dirty, that is, dependents of volatile or changed data, and cells
- programmatically marked as dirty.
+### YamlMime:TSEnum
+name: ExcelScript.CalculationType
+uid: 'ExcelScript!ExcelScript.CalculationType:enum'
+package: ExcelScript!
+fullName: ExcelScript.CalculationType
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script fully recalculates the entire workbook.
+ * This code is useful when automatic recalculation is turned off
+ * but later parts of the script rely on updated values.
+ */
+ function main(workbook: ExcelScript.Workbook, workbookURL: string) {
+ const application = workbook.getApplication();
+ application.calculate(ExcelScript.CalculationType.fullRebuild);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: full
+ uid: 'ExcelScript!ExcelScript.CalculationType.full:member'
+ package: ExcelScript!
+ summary: This will mark all cells as dirty and then recalculate them.
+ - name: fullRebuild
+ uid: 'ExcelScript!ExcelScript.CalculationType.fullRebuild:member'
+ package: ExcelScript!
+ summary: 'This will rebuild the full dependency chain, mark all cells as dirty and then recalculate them.'
+ - name: recalculate
+ uid: 'ExcelScript!ExcelScript.CalculationType.recalculate:member'
+ package: ExcelScript!
+ summary: >-
+ Recalculates all cells that Excel has marked as dirty, that is, dependents of volatile or changed data, and cells
+ programmatically marked as dirty.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.cellcontrol.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.cellcontrol.yml
new file mode 100644
index 00000000..ad9d996c
--- /dev/null
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.cellcontrol.yml
@@ -0,0 +1,15 @@
+### YamlMime:TSTypeAlias
+name: ExcelScript.CellControl
+uid: 'ExcelScript!ExcelScript.CellControl:type'
+package: ExcelScript!
+fullName: ExcelScript.CellControl
+summary: Represents an interactable control inside of a cell.
+remarks: ''
+isPreview: false
+isDeprecated: false
+syntax: |-
+ type CellControl =
+ | UnknownCellControl
+ | EmptyCellControl
+ | MixedCellControl
+ | CheckboxCellControl;
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.cellcontroltype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.cellcontroltype.yml
new file mode 100644
index 00000000..f37e5e08
--- /dev/null
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.cellcontroltype.yml
@@ -0,0 +1,28 @@
+### YamlMime:TSEnum
+name: ExcelScript.CellControlType
+uid: 'ExcelScript!ExcelScript.CellControlType:enum'
+package: ExcelScript!
+fullName: ExcelScript.CellControlType
+summary: Represents the type of cell control.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: checkbox
+ uid: 'ExcelScript!ExcelScript.CellControlType.checkbox:member'
+ package: ExcelScript!
+ summary: Type representing a checkbox control.
+ - name: empty
+ uid: 'ExcelScript!ExcelScript.CellControlType.empty:member'
+ package: ExcelScript!
+ summary: Type representing an empty control.
+ - name: mixed
+ uid: 'ExcelScript!ExcelScript.CellControlType.mixed:member'
+ package: ExcelScript!
+ summary: Type representing a query that results in a mix of control results.
+ - name: unknown
+ uid: 'ExcelScript!ExcelScript.CellControlType.unknown:member'
+ package: ExcelScript!
+ summary: >-
+ Type representing an unknown control. This represents a control that was added in a future version of Excel, and
+ the current version of Excel doesn't know how to display this control.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.cellvalueconditionalformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.cellvalueconditionalformat.yml
index 878ac2eb..549b6e2b 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.cellvalueconditionalformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.cellvalueconditionalformat.yml
@@ -1,87 +1,87 @@
-### YamlMime:TSType
-name: ExcelScript.CellValueConditionalFormat
-uid: 'ExcelScript!ExcelScript.CellValueConditionalFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.CellValueConditionalFormat
-summary: Represents a cell value conditional format.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies conditional formatting to a range.
- * That formatting is conditional upon the cell's numerical value.
- * Any value between 50 and 75 will have the cell fill color changed and the font made italic.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range to format.
- const sheet = workbook.getActiveWorksheet();
- const ratingColumn = sheet.getRange("D2:D20");
-
- // Add cell value conditional formatting.
- const cellValueConditionalFormatting : ExcelScript.CellValueConditionalFormat
- = ratingColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.cellValue).getCellValue();
-
- // Create the condition, in this case when the cell value is between 50 and 75.
- let rule: ExcelScript.ConditionalCellValueRule = {
- formula1: "50",
- formula2: "75",
- operator: ExcelScript.ConditionalCellValueOperator.between
- };
- cellValueConditionalFormatting.setRule(rule);
-
- // Set the format to apply when the condition is met.
- let format = cellValueConditionalFormatting.getFormat();
- format.getFill().setColor("yellow");
- format.getFont().setItalic(true);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getFormat()
- uid: 'ExcelScript!ExcelScript.CellValueConditionalFormat#getFormat:member(1)'
- package: ExcelScript!
- fullName: getFormat()
- summary: 'Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormat(): ConditionalRangeFormat;'
- return:
- type: ''
- description: ''
- - name: getRule()
- uid: 'ExcelScript!ExcelScript.CellValueConditionalFormat#getRule:member(1)'
- package: ExcelScript!
- fullName: getRule()
- summary: Specifies the rule object on this conditional format.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRule(): ConditionalCellValueRule;'
- return:
- type: ''
- description: ''
- - name: setRule(rule)
- uid: 'ExcelScript!ExcelScript.CellValueConditionalFormat#setRule:member(1)'
- package: ExcelScript!
- fullName: setRule(rule)
- summary: Specifies the rule object on this conditional format.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setRule(rule: ConditionalCellValueRule): void;'
- parameters:
- - id: rule
- description: ''
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.CellValueConditionalFormat
+uid: 'ExcelScript!ExcelScript.CellValueConditionalFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.CellValueConditionalFormat
+summary: Represents a cell value conditional format.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies conditional formatting to a range.
+ * That formatting is conditional upon the cell's numerical value.
+ * Any value between 50 and 75 will have the cell fill color changed and the font made italic.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range to format.
+ const sheet = workbook.getActiveWorksheet();
+ const ratingColumn = sheet.getRange("D2:D20");
+
+ // Add cell value conditional formatting.
+ const cellValueConditionalFormatting : ExcelScript.CellValueConditionalFormat
+ = ratingColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.cellValue).getCellValue();
+
+ // Create the condition, in this case when the cell value is between 50 and 75.
+ let rule: ExcelScript.ConditionalCellValueRule = {
+ formula1: "50",
+ formula2: "75",
+ operator: ExcelScript.ConditionalCellValueOperator.between
+ };
+ cellValueConditionalFormatting.setRule(rule);
+
+ // Set the format to apply when the condition is met.
+ let format = cellValueConditionalFormatting.getFormat();
+ format.getFill().setColor("yellow");
+ format.getFont().setItalic(true);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getFormat()
+ uid: 'ExcelScript!ExcelScript.CellValueConditionalFormat#getFormat:member(1)'
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: 'Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): ConditionalRangeFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getRule()
+ uid: 'ExcelScript!ExcelScript.CellValueConditionalFormat#getRule:member(1)'
+ package: ExcelScript!
+ fullName: getRule()
+ summary: Specifies the rule object on this conditional format.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRule(): ConditionalCellValueRule;'
+ return:
+ type: ''
+ description: ''
+ - name: setRule(rule)
+ uid: 'ExcelScript!ExcelScript.CellValueConditionalFormat#setRule:member(1)'
+ package: ExcelScript!
+ fullName: setRule(rule)
+ summary: Specifies the rule object on this conditional format.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setRule(rule: ConditionalCellValueRule): void;'
+ parameters:
+ - id: rule
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chart.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chart.yml
index 85067c8b..789ec68a 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chart.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chart.yml
@@ -1,885 +1,885 @@
-### YamlMime:TSType
-name: ExcelScript.Chart
-uid: 'ExcelScript!ExcelScript.Chart:interface'
-package: ExcelScript!
-fullName: ExcelScript.Chart
-summary: Represents a chart object in a workbook.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: activate()
- uid: 'ExcelScript!ExcelScript.Chart#activate:member(1)'
- package: ExcelScript!
- fullName: activate()
- summary: Activates the chart in the Excel UI.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'activate(): void;'
- return:
- type: void
- description: ''
- - name: 'addChartSeries(name, index)'
- uid: 'ExcelScript!ExcelScript.Chart#addChartSeries:member(1)'
- package: ExcelScript!
- fullName: 'addChartSeries(name, index)'
- summary: >-
- Add a new series to the collection. The new added series is not visible until values, x-axis values, or bubble
- sizes for it are set (depending on chart type).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addChartSeries(name?: string, index?: number): ChartSeries;'
- parameters:
- - id: name
- description: Optional. Name of the series.
- type: string
- - id: index
- description: Optional. Index value of the series to be added. Zero-indexed.
- type: number
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample produces a line chart with two series.
- * The chart assumes data in A1:E5 that looks like this:
- * Product Qtr1 Qtr2 Qtr3 Qtr4
- * Frames 5000 7000 6544 4377
- * Saddles 400 323 276 651
- */
- function main(workbook: ExcelScript.Workbook) {
- // Establish the ranges to use.
- const sheet = workbook.getActiveWorksheet();
- const headerRange = sheet.getRange("A1:E1");
- const firstSeriesRange = sheet.getRange("A2:E2");
- const secondSeriesRange = sheet.getRange("A3:E3");
-
- // Create the chart.
- const lineChart = sheet.addChart(ExcelScript.ChartType.line, headerRange);
-
- // Add the first chart series.
- const firstSeries = lineChart.addChartSeries();
- firstSeries.setXAxisValues(headerRange);
- firstSeries.setValues(firstSeriesRange);
-
- // Add the second chart series.
- const secondSeries = lineChart.addChartSeries();
- secondSeries.setXAxisValues(headerRange);
- secondSeries.setValues(secondSeriesRange);
- }
- ```
- - name: delete()
- uid: 'ExcelScript!ExcelScript.Chart#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: Deletes the chart object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: ''
- - name: getAxes()
- uid: 'ExcelScript!ExcelScript.Chart#getAxes:member(1)'
- package: ExcelScript!
- fullName: getAxes()
- summary: Represents chart axes.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAxes(): ChartAxes;'
- return:
- type: ''
- description: ''
- - name: getCategoryLabelLevel()
- uid: 'ExcelScript!ExcelScript.Chart#getCategoryLabelLevel:member(1)'
- package: ExcelScript!
- fullName: getCategoryLabelLevel()
- summary: 'Specifies a chart category label level enumeration constant, referring to the level of the source category labels.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCategoryLabelLevel(): number;'
- return:
- type: number
- description: ''
- - name: getChartType()
- uid: 'ExcelScript!ExcelScript.Chart#getChartType:member(1)'
- package: ExcelScript!
- fullName: getChartType()
- summary: Specifies the type of the chart. See `ExcelScript.ChartType` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getChartType(): ChartType;'
- return:
- type: ''
- description: ''
- - name: getDataLabels()
- uid: 'ExcelScript!ExcelScript.Chart#getDataLabels:member(1)'
- package: ExcelScript!
- fullName: getDataLabels()
- summary: Represents the data labels on the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDataLabels(): ChartDataLabels;'
- return:
- type: ''
- description: ''
- - name: getDataTable()
- uid: 'ExcelScript!ExcelScript.Chart#getDataTable:member(1)'
- package: ExcelScript!
- fullName: getDataTable()
- summary: >-
- Gets the data table on the chart. If the chart doesn't allow a data table, then this method returns
- `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDataTable(): ChartDataTable;'
- return:
- type: ''
- description: ''
- - name: getDisplayBlanksAs()
- uid: 'ExcelScript!ExcelScript.Chart#getDisplayBlanksAs:member(1)'
- package: ExcelScript!
- fullName: getDisplayBlanksAs()
- summary: Specifies the way that blank cells are plotted on a chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDisplayBlanksAs(): ChartDisplayBlanksAs;'
- return:
- type: ''
- description: ''
- - name: getFormat()
- uid: 'ExcelScript!ExcelScript.Chart#getFormat:member(1)'
- package: ExcelScript!
- fullName: getFormat()
- summary: Encapsulates the format properties for the chart area.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormat(): ChartAreaFormat;'
- return:
- type: ''
- description: ''
- - name: getHeight()
- uid: 'ExcelScript!ExcelScript.Chart#getHeight:member(1)'
- package: ExcelScript!
- fullName: getHeight()
- summary: 'Specifies the height, in points, of the chart object.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHeight(): number;'
- return:
- type: number
- description: ''
- - name: getId()
- uid: 'ExcelScript!ExcelScript.Chart#getId:member(1)'
- package: ExcelScript!
- fullName: getId()
- summary: The unique ID of chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getId(): string;'
- return:
- type: string
- description: ''
- - name: 'getImage(width, height, fittingMode)'
- uid: 'ExcelScript!ExcelScript.Chart#getImage:member(1)'
- package: ExcelScript!
- fullName: 'getImage(width, height, fittingMode)'
- summary: >-
- Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. The aspect ratio
- is preserved as part of the resizing.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- getImage(
- width?: number,
- height?: number,
- fittingMode?: ImageFittingMode
- ): string;
- parameters:
- - id: width
- description: Optional. The desired width of the resulting image.
- type: number
- - id: height
- description: Optional. The desired height of the resulting image.
- type: number
- - id: fittingMode
- description: Optional. The method used to scale the chart to the specified dimensions (if both height and width are set).
- type: ''
- return:
- type: string
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script returns an image of the first chart in the first worksheet.
- * That image is 600x400 pixels and the chart will be
- * stretched to fill those dimensions.
- * The returned image can be used in a Power Automate flow.
- */
- function main(workbook: ExcelScript.Workbook): string {
- // Get the first chart in the first worksheet.
- const firstSheet = workbook.getFirstWorksheet();
- const firstChart = firstSheet.getCharts()[0];
-
- // Get an image of the chart as a base64-encoded string.
- const base64String = firstChart.getImage(
- 600, /* Width */
- 400, /* Height */
- ExcelScript.ImageFittingMode.fill /* Fill to match the dimensions. */
- );
-
- return base64String;
- }
- ```
- - name: getLeft()
- uid: 'ExcelScript!ExcelScript.Chart#getLeft:member(1)'
- package: ExcelScript!
- fullName: getLeft()
- summary: 'The distance, in points, from the left side of the chart to the worksheet origin.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLeft(): number;'
- return:
- type: number
- description: ''
- - name: getLegend()
- uid: 'ExcelScript!ExcelScript.Chart#getLegend:member(1)'
- package: ExcelScript!
- fullName: getLegend()
- summary: Represents the legend for the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLegend(): ChartLegend;'
- return:
- type: ''
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.Chart#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: Specifies the name of a chart object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: getPivotOptions()
- uid: 'ExcelScript!ExcelScript.Chart#getPivotOptions:member(1)'
- package: ExcelScript!
- fullName: getPivotOptions()
- summary: Encapsulates the options for a pivot chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPivotOptions(): ChartPivotOptions;'
- return:
- type: ''
- description: ''
- - name: getPlotArea()
- uid: 'ExcelScript!ExcelScript.Chart#getPlotArea:member(1)'
- package: ExcelScript!
- fullName: getPlotArea()
- summary: Represents the plot area for the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPlotArea(): ChartPlotArea;'
- return:
- type: ''
- description: ''
- - name: getPlotBy()
- uid: 'ExcelScript!ExcelScript.Chart#getPlotBy:member(1)'
- package: ExcelScript!
- fullName: getPlotBy()
- summary: Specifies the way columns or rows are used as data series on the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPlotBy(): ChartPlotBy;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample performs the "Switch Row/Column" action on a chart named "ColumnClusteredChart".
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Get an existing chart named "ColumnClusteredChart".
- let columnClusteredChart = selectedSheet.getChart("ColumnClusteredChart");
-
- // Switch the row and column for the chart's data source.
- if (columnClusteredChart.getPlotBy() === ExcelScript.ChartPlotBy.columns) {
- // If the chart is grouped by columns, switch it to rows.
- columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.rows);
- } else {
- // If the chart is grouped by rows, switch it to columns.
- columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.columns);
- }
- }
- ```
- - name: getPlotVisibleOnly()
- uid: 'ExcelScript!ExcelScript.Chart#getPlotVisibleOnly:member(1)'
- package: ExcelScript!
- fullName: getPlotVisibleOnly()
- summary: True if only visible cells are plotted. False if both visible and hidden cells are plotted.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPlotVisibleOnly(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getSeries()
- uid: 'ExcelScript!ExcelScript.Chart#getSeries:member(1)'
- package: ExcelScript!
- fullName: getSeries()
- summary: Represents either a single series or collection of series in the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSeries(): ChartSeries[];'
- return:
- type: '[]'
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample sets the overlap of the columns in a chart named "ColumnClusteredChart".
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Get an existing chart named "ColumnClusteredChart".
- let chart = selectedSheet.getChart("ColumnClusteredChart");
-
- // Set the overlap of every column of each series within a category.
- let seriesList = chart.getSeries();
- seriesList.forEach((series) => {
- // An overlap of 25 means the columns have 25% of their length overlapping with the adjacent columns in the same category.
- series.setOverlap(25);
- });
- }
- ```
- - name: getSeriesNameLevel()
- uid: 'ExcelScript!ExcelScript.Chart#getSeriesNameLevel:member(1)'
- package: ExcelScript!
- fullName: getSeriesNameLevel()
- summary: 'Specifies a chart series name level enumeration constant, referring to the level of the source series names.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSeriesNameLevel(): number;'
- return:
- type: number
- description: ''
- - name: getShowAllFieldButtons()
- uid: 'ExcelScript!ExcelScript.Chart#getShowAllFieldButtons:member(1)'
- package: ExcelScript!
- fullName: getShowAllFieldButtons()
- summary: Specifies whether to display all field buttons on a PivotChart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowAllFieldButtons(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowDataLabelsOverMaximum()
- uid: 'ExcelScript!ExcelScript.Chart#getShowDataLabelsOverMaximum:member(1)'
- package: ExcelScript!
- fullName: getShowDataLabelsOverMaximum()
- summary: >-
- Specifies whether to show the data labels when the value is greater than the maximum value on the value axis. If
- the value axis becomes smaller than the size of the data points, you can use this property to set whether to show
- the data labels. This property applies to 2-D charts only.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowDataLabelsOverMaximum(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getStyle()
- uid: 'ExcelScript!ExcelScript.Chart#getStyle:member(1)'
- package: ExcelScript!
- fullName: getStyle()
- summary: Specifies the chart style for the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getStyle(): number;'
- return:
- type: number
- description: ''
- - name: getTitle()
- uid: 'ExcelScript!ExcelScript.Chart#getTitle:member(1)'
- package: ExcelScript!
- fullName: getTitle()
- summary: >-
- Represents the title of the specified chart, including the text, visibility, position, and formatting of the
- title.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTitle(): ChartTitle;'
- return:
- type: ''
- description: ''
- - name: getTop()
- uid: 'ExcelScript!ExcelScript.Chart#getTop:member(1)'
- package: ExcelScript!
- fullName: getTop()
- summary: >-
- Specifies the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top
- of the chart area (on a chart).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTop(): number;'
- return:
- type: number
- description: ''
- - name: getWidth()
- uid: 'ExcelScript!ExcelScript.Chart#getWidth:member(1)'
- package: ExcelScript!
- fullName: getWidth()
- summary: 'Specifies the width, in points, of the chart object.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWidth(): number;'
- return:
- type: number
- description: ''
- - name: getWorksheet()
- uid: 'ExcelScript!ExcelScript.Chart#getWorksheet:member(1)'
- package: ExcelScript!
- fullName: getWorksheet()
- summary: The worksheet containing the current chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWorksheet(): Worksheet;'
- return:
- type: ''
- description: ''
- - name: setCategoryLabelLevel(categoryLabelLevel)
- uid: 'ExcelScript!ExcelScript.Chart#setCategoryLabelLevel:member(1)'
- package: ExcelScript!
- fullName: setCategoryLabelLevel(categoryLabelLevel)
- summary: 'Specifies a chart category label level enumeration constant, referring to the level of the source category labels.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setCategoryLabelLevel(categoryLabelLevel: number): void;'
- parameters:
- - id: categoryLabelLevel
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setChartType(chartType)
- uid: 'ExcelScript!ExcelScript.Chart#setChartType:member(1)'
- package: ExcelScript!
- fullName: setChartType(chartType)
- summary: Specifies the type of the chart. See `ExcelScript.ChartType` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setChartType(chartType: ChartType): void;'
- parameters:
- - id: chartType
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: 'setData(sourceData, seriesBy)'
- uid: 'ExcelScript!ExcelScript.Chart#setData:member(1)'
- package: ExcelScript!
- fullName: 'setData(sourceData, seriesBy)'
- summary: Resets the source data for the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setData(sourceData: Range, seriesBy?: ChartSeriesBy): void;'
- parameters:
- - id: sourceData
- description: The range object corresponding to the source data.
- type: ''
- - id: seriesBy
- description: >-
- Specifies the way columns or rows are used as data series on the chart. Can be one of the following: Auto
- (default), Rows, and Columns. See `ExcelScript.ChartSeriesBy` for details.
- type: ''
- return:
- type: void
- description: ''
- - name: setDisplayBlanksAs(displayBlanksAs)
- uid: 'ExcelScript!ExcelScript.Chart#setDisplayBlanksAs:member(1)'
- package: ExcelScript!
- fullName: setDisplayBlanksAs(displayBlanksAs)
- summary: Specifies the way that blank cells are plotted on a chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setDisplayBlanksAs(displayBlanksAs: ChartDisplayBlanksAs): void;'
- parameters:
- - id: displayBlanksAs
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setHeight(height)
- uid: 'ExcelScript!ExcelScript.Chart#setHeight:member(1)'
- package: ExcelScript!
- fullName: setHeight(height)
- summary: 'Specifies the height, in points, of the chart object.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setHeight(height: number): void;'
- parameters:
- - id: height
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setLeft(left)
- uid: 'ExcelScript!ExcelScript.Chart#setLeft:member(1)'
- package: ExcelScript!
- fullName: setLeft(left)
- summary: 'The distance, in points, from the left side of the chart to the worksheet origin.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLeft(left: number): void;'
- parameters:
- - id: left
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setName(name)
- uid: 'ExcelScript!ExcelScript.Chart#setName:member(1)'
- package: ExcelScript!
- fullName: setName(name)
- summary: Specifies the name of a chart object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setName(name: string): void;'
- parameters:
- - id: name
- description: ''
- type: string
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample creates a column-clustered chart based on the current worksheet's data.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Get the data range.
- let range = selectedSheet.getUsedRange();
-
- // Insert a chart using the data on the current worksheet.
- let chart = selectedSheet.addChart(ExcelScript.ChartType.columnClustered, range);
-
- // Name the chart for easy access in other scripts.
- chart.setName("ColumnChart");
- }
- ```
- - name: setPlotBy(plotBy)
- uid: 'ExcelScript!ExcelScript.Chart#setPlotBy:member(1)'
- package: ExcelScript!
- fullName: setPlotBy(plotBy)
- summary: Specifies the way columns or rows are used as data series on the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPlotBy(plotBy: ChartPlotBy): void;'
- parameters:
- - id: plotBy
- description: ''
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample performs the "Switch Row/Column" action on a chart named "ColumnClusteredChart".
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Get an existing chart named "ColumnClusteredChart".
- let columnClusteredChart = selectedSheet.getChart("ColumnClusteredChart");
-
- // Switch the row and column for the chart's data source.
- if (columnClusteredChart.getPlotBy() === ExcelScript.ChartPlotBy.columns) {
- // If the chart is grouped by columns, switch it to rows.
- columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.rows);
- } else {
- // If the chart is grouped by rows, switch it to columns.
- columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.columns);
- }
- }
- ```
- - name: setPlotVisibleOnly(plotVisibleOnly)
- uid: 'ExcelScript!ExcelScript.Chart#setPlotVisibleOnly:member(1)'
- package: ExcelScript!
- fullName: setPlotVisibleOnly(plotVisibleOnly)
- summary: True if only visible cells are plotted. False if both visible and hidden cells are plotted.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPlotVisibleOnly(plotVisibleOnly: boolean): void;'
- parameters:
- - id: plotVisibleOnly
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: 'setPosition(startCell, endCell)'
- uid: 'ExcelScript!ExcelScript.Chart#setPosition:member(1)'
- package: ExcelScript!
- fullName: 'setPosition(startCell, endCell)'
- summary: Positions the chart relative to cells on the worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPosition(startCell: Range | string, endCell?: Range | string): void;'
- parameters:
- - id: startCell
- description: >-
- The start cell. This is where the chart will be moved to. The start cell is the top-left or top-right cell,
- depending on the user's right-to-left display settings.
- type: ' | string'
- - id: endCell
- description: >-
- Optional. The end cell. If specified, the chart's width and height will be set to fully cover up this
- cell/range.
- type: ' | string'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample moves an existing chart to a specific place on the worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Get an existing chart named "ColumnChart".
- let chart = selectedSheet.getChart("ColumnChart");
-
- // Place the chart over the range "F1:L13".
- chart.setPosition("F1", "L13");
- }
- ```
- - name: setSeriesNameLevel(seriesNameLevel)
- uid: 'ExcelScript!ExcelScript.Chart#setSeriesNameLevel:member(1)'
- package: ExcelScript!
- fullName: setSeriesNameLevel(seriesNameLevel)
- summary: 'Specifies a chart series name level enumeration constant, referring to the level of the source series names.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setSeriesNameLevel(seriesNameLevel: number): void;'
- parameters:
- - id: seriesNameLevel
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setShowAllFieldButtons(showAllFieldButtons)
- uid: 'ExcelScript!ExcelScript.Chart#setShowAllFieldButtons:member(1)'
- package: ExcelScript!
- fullName: setShowAllFieldButtons(showAllFieldButtons)
- summary: Specifies whether to display all field buttons on a PivotChart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowAllFieldButtons(showAllFieldButtons: boolean): void;'
- parameters:
- - id: showAllFieldButtons
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowDataLabelsOverMaximum(showDataLabelsOverMaximum)
- uid: 'ExcelScript!ExcelScript.Chart#setShowDataLabelsOverMaximum:member(1)'
- package: ExcelScript!
- fullName: setShowDataLabelsOverMaximum(showDataLabelsOverMaximum)
- summary: >-
- Specifies whether to show the data labels when the value is greater than the maximum value on the value axis. If
- the value axis becomes smaller than the size of the data points, you can use this property to set whether to show
- the data labels. This property applies to 2-D charts only.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowDataLabelsOverMaximum(showDataLabelsOverMaximum: boolean): void;'
- parameters:
- - id: showDataLabelsOverMaximum
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setStyle(style)
- uid: 'ExcelScript!ExcelScript.Chart#setStyle:member(1)'
- package: ExcelScript!
- fullName: setStyle(style)
- summary: Specifies the chart style for the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setStyle(style: number): void;'
- parameters:
- - id: style
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setTop(top)
- uid: 'ExcelScript!ExcelScript.Chart#setTop:member(1)'
- package: ExcelScript!
- fullName: setTop(top)
- summary: >-
- Specifies the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top
- of the chart area (on a chart).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTop(top: number): void;'
- parameters:
- - id: top
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setWidth(width)
- uid: 'ExcelScript!ExcelScript.Chart#setWidth:member(1)'
- package: ExcelScript!
- fullName: setWidth(width)
- summary: 'Specifies the width, in points, of the chart object.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setWidth(width: number): void;'
- parameters:
- - id: width
- description: ''
- type: number
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.Chart
+uid: 'ExcelScript!ExcelScript.Chart:interface'
+package: ExcelScript!
+fullName: ExcelScript.Chart
+summary: Represents a chart object in a workbook.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: activate()
+ uid: 'ExcelScript!ExcelScript.Chart#activate:member(1)'
+ package: ExcelScript!
+ fullName: activate()
+ summary: Activates the chart in the Excel UI.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'activate(): void;'
+ return:
+ type: void
+ description: ''
+ - name: 'addChartSeries(name, index)'
+ uid: 'ExcelScript!ExcelScript.Chart#addChartSeries:member(1)'
+ package: ExcelScript!
+ fullName: 'addChartSeries(name, index)'
+ summary: >-
+ Add a new series to the collection. The new added series is not visible until values, x-axis values, or bubble
+ sizes for it are set (depending on chart type).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addChartSeries(name?: string, index?: number): ChartSeries;'
+ parameters:
+ - id: name
+ description: Optional. Name of the series.
+ type: string
+ - id: index
+ description: Optional. Index value of the series to be added. Zero-indexed.
+ type: number
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample produces a line chart with two series.
+ * The chart assumes data in A1:E5 that looks like this:
+ * Product Qtr1 Qtr2 Qtr3 Qtr4
+ * Frames 5000 7000 6544 4377
+ * Saddles 400 323 276 651
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Establish the ranges to use.
+ const sheet = workbook.getActiveWorksheet();
+ const headerRange = sheet.getRange("A1:E1");
+ const firstSeriesRange = sheet.getRange("A2:E2");
+ const secondSeriesRange = sheet.getRange("A3:E3");
+
+ // Create the chart.
+ const lineChart = sheet.addChart(ExcelScript.ChartType.line, headerRange);
+
+ // Add the first chart series.
+ const firstSeries = lineChart.addChartSeries();
+ firstSeries.setXAxisValues(headerRange);
+ firstSeries.setValues(firstSeriesRange);
+
+ // Add the second chart series.
+ const secondSeries = lineChart.addChartSeries();
+ secondSeries.setXAxisValues(headerRange);
+ secondSeries.setValues(secondSeriesRange);
+ }
+ ```
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.Chart#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: Deletes the chart object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getAxes()
+ uid: 'ExcelScript!ExcelScript.Chart#getAxes:member(1)'
+ package: ExcelScript!
+ fullName: getAxes()
+ summary: Represents chart axes.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAxes(): ChartAxes;'
+ return:
+ type: ''
+ description: ''
+ - name: getCategoryLabelLevel()
+ uid: 'ExcelScript!ExcelScript.Chart#getCategoryLabelLevel:member(1)'
+ package: ExcelScript!
+ fullName: getCategoryLabelLevel()
+ summary: 'Specifies a chart category label level enumeration constant, referring to the level of the source category labels.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCategoryLabelLevel(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getChartType()
+ uid: 'ExcelScript!ExcelScript.Chart#getChartType:member(1)'
+ package: ExcelScript!
+ fullName: getChartType()
+ summary: Specifies the type of the chart. See `ExcelScript.ChartType` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getChartType(): ChartType;'
+ return:
+ type: ''
+ description: ''
+ - name: getDataLabels()
+ uid: 'ExcelScript!ExcelScript.Chart#getDataLabels:member(1)'
+ package: ExcelScript!
+ fullName: getDataLabels()
+ summary: Represents the data labels on the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDataLabels(): ChartDataLabels;'
+ return:
+ type: ''
+ description: ''
+ - name: getDataTable()
+ uid: 'ExcelScript!ExcelScript.Chart#getDataTable:member(1)'
+ package: ExcelScript!
+ fullName: getDataTable()
+ summary: >-
+ Gets the data table on the chart. If the chart doesn't allow a data table, then this method returns
+ `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDataTable(): ChartDataTable;'
+ return:
+ type: ''
+ description: ''
+ - name: getDisplayBlanksAs()
+ uid: 'ExcelScript!ExcelScript.Chart#getDisplayBlanksAs:member(1)'
+ package: ExcelScript!
+ fullName: getDisplayBlanksAs()
+ summary: Specifies the way that blank cells are plotted on a chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDisplayBlanksAs(): ChartDisplayBlanksAs;'
+ return:
+ type: ''
+ description: ''
+ - name: getFormat()
+ uid: 'ExcelScript!ExcelScript.Chart#getFormat:member(1)'
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: Encapsulates the format properties for the chart area.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): ChartAreaFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getHeight()
+ uid: 'ExcelScript!ExcelScript.Chart#getHeight:member(1)'
+ package: ExcelScript!
+ fullName: getHeight()
+ summary: 'Specifies the height, in points, of the chart object.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHeight(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getId()
+ uid: 'ExcelScript!ExcelScript.Chart#getId:member(1)'
+ package: ExcelScript!
+ fullName: getId()
+ summary: The unique ID of chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getId(): string;'
+ return:
+ type: string
+ description: ''
+ - name: 'getImage(width, height, fittingMode)'
+ uid: 'ExcelScript!ExcelScript.Chart#getImage:member(1)'
+ package: ExcelScript!
+ fullName: 'getImage(width, height, fittingMode)'
+ summary: >-
+ Renders the chart as a Base64-encoded image by scaling the chart to fit the specified dimensions. The aspect ratio
+ is preserved as part of the resizing.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ getImage(
+ width?: number,
+ height?: number,
+ fittingMode?: ImageFittingMode
+ ): string;
+ parameters:
+ - id: width
+ description: Optional. The desired width of the resulting image.
+ type: number
+ - id: height
+ description: Optional. The desired height of the resulting image.
+ type: number
+ - id: fittingMode
+ description: Optional. The method used to scale the chart to the specified dimensions (if both height and width are set).
+ type: ''
+ return:
+ type: string
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script returns an image of the first chart in the first worksheet.
+ * That image is 600x400 pixels and the chart will be
+ * stretched to fill those dimensions.
+ * The returned image can be used in a Power Automate flow.
+ */
+ function main(workbook: ExcelScript.Workbook): string {
+ // Get the first chart in the first worksheet.
+ const firstSheet = workbook.getFirstWorksheet();
+ const firstChart = firstSheet.getCharts()[0];
+
+ // Get an image of the chart as a base64-encoded string.
+ const base64String = firstChart.getImage(
+ 600, /* Width */
+ 400, /* Height */
+ ExcelScript.ImageFittingMode.fill /* Fill to match the dimensions. */
+ );
+
+ return base64String;
+ }
+ ```
+ - name: getLeft()
+ uid: 'ExcelScript!ExcelScript.Chart#getLeft:member(1)'
+ package: ExcelScript!
+ fullName: getLeft()
+ summary: 'The distance, in points, from the left side of the chart to the worksheet origin.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLeft(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getLegend()
+ uid: 'ExcelScript!ExcelScript.Chart#getLegend:member(1)'
+ package: ExcelScript!
+ fullName: getLegend()
+ summary: Represents the legend for the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLegend(): ChartLegend;'
+ return:
+ type: ''
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.Chart#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: Specifies the name of a chart object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getPivotOptions()
+ uid: 'ExcelScript!ExcelScript.Chart#getPivotOptions:member(1)'
+ package: ExcelScript!
+ fullName: getPivotOptions()
+ summary: Encapsulates the options for a pivot chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPivotOptions(): ChartPivotOptions;'
+ return:
+ type: ''
+ description: ''
+ - name: getPlotArea()
+ uid: 'ExcelScript!ExcelScript.Chart#getPlotArea:member(1)'
+ package: ExcelScript!
+ fullName: getPlotArea()
+ summary: Represents the plot area for the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPlotArea(): ChartPlotArea;'
+ return:
+ type: ''
+ description: ''
+ - name: getPlotBy()
+ uid: 'ExcelScript!ExcelScript.Chart#getPlotBy:member(1)'
+ package: ExcelScript!
+ fullName: getPlotBy()
+ summary: Specifies the way columns or rows are used as data series on the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPlotBy(): ChartPlotBy;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample performs the "Switch Row/Column" action on a chart named "ColumnClusteredChart".
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Get an existing chart named "ColumnClusteredChart".
+ let columnClusteredChart = selectedSheet.getChart("ColumnClusteredChart");
+
+ // Switch the row and column for the chart's data source.
+ if (columnClusteredChart.getPlotBy() === ExcelScript.ChartPlotBy.columns) {
+ // If the chart is grouped by columns, switch it to rows.
+ columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.rows);
+ } else {
+ // If the chart is grouped by rows, switch it to columns.
+ columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.columns);
+ }
+ }
+ ```
+ - name: getPlotVisibleOnly()
+ uid: 'ExcelScript!ExcelScript.Chart#getPlotVisibleOnly:member(1)'
+ package: ExcelScript!
+ fullName: getPlotVisibleOnly()
+ summary: True if only visible cells are plotted. False if both visible and hidden cells are plotted.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPlotVisibleOnly(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getSeries()
+ uid: 'ExcelScript!ExcelScript.Chart#getSeries:member(1)'
+ package: ExcelScript!
+ fullName: getSeries()
+ summary: Represents either a single series or collection of series in the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSeries(): ChartSeries[];'
+ return:
+ type: '[]'
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample sets the overlap of the columns in a chart named "ColumnClusteredChart".
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Get an existing chart named "ColumnClusteredChart".
+ let chart = selectedSheet.getChart("ColumnClusteredChart");
+
+ // Set the overlap of every column of each series within a category.
+ let seriesList = chart.getSeries();
+ seriesList.forEach((series) => {
+ // An overlap of 25 means the columns have 25% of their length overlapping with the adjacent columns in the same category.
+ series.setOverlap(25);
+ });
+ }
+ ```
+ - name: getSeriesNameLevel()
+ uid: 'ExcelScript!ExcelScript.Chart#getSeriesNameLevel:member(1)'
+ package: ExcelScript!
+ fullName: getSeriesNameLevel()
+ summary: 'Specifies a chart series name level enumeration constant, referring to the level of the source series names.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSeriesNameLevel(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getShowAllFieldButtons()
+ uid: 'ExcelScript!ExcelScript.Chart#getShowAllFieldButtons:member(1)'
+ package: ExcelScript!
+ fullName: getShowAllFieldButtons()
+ summary: Specifies whether to display all field buttons on a PivotChart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowAllFieldButtons(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowDataLabelsOverMaximum()
+ uid: 'ExcelScript!ExcelScript.Chart#getShowDataLabelsOverMaximum:member(1)'
+ package: ExcelScript!
+ fullName: getShowDataLabelsOverMaximum()
+ summary: >-
+ Specifies whether to show the data labels when the value is greater than the maximum value on the value axis. If
+ the value axis becomes smaller than the size of the data points, you can use this property to set whether to show
+ the data labels. This property applies to 2-D charts only.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowDataLabelsOverMaximum(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getStyle()
+ uid: 'ExcelScript!ExcelScript.Chart#getStyle:member(1)'
+ package: ExcelScript!
+ fullName: getStyle()
+ summary: Specifies the chart style for the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getStyle(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getTitle()
+ uid: 'ExcelScript!ExcelScript.Chart#getTitle:member(1)'
+ package: ExcelScript!
+ fullName: getTitle()
+ summary: >-
+ Represents the title of the specified chart, including the text, visibility, position, and formatting of the
+ title.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTitle(): ChartTitle;'
+ return:
+ type: ''
+ description: ''
+ - name: getTop()
+ uid: 'ExcelScript!ExcelScript.Chart#getTop:member(1)'
+ package: ExcelScript!
+ fullName: getTop()
+ summary: >-
+ Specifies the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top
+ of the chart area (on a chart).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTop(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getWidth()
+ uid: 'ExcelScript!ExcelScript.Chart#getWidth:member(1)'
+ package: ExcelScript!
+ fullName: getWidth()
+ summary: 'Specifies the width, in points, of the chart object.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWidth(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getWorksheet()
+ uid: 'ExcelScript!ExcelScript.Chart#getWorksheet:member(1)'
+ package: ExcelScript!
+ fullName: getWorksheet()
+ summary: The worksheet containing the current chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWorksheet(): Worksheet;'
+ return:
+ type: ''
+ description: ''
+ - name: setCategoryLabelLevel(categoryLabelLevel)
+ uid: 'ExcelScript!ExcelScript.Chart#setCategoryLabelLevel:member(1)'
+ package: ExcelScript!
+ fullName: setCategoryLabelLevel(categoryLabelLevel)
+ summary: 'Specifies a chart category label level enumeration constant, referring to the level of the source category labels.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setCategoryLabelLevel(categoryLabelLevel: number): void;'
+ parameters:
+ - id: categoryLabelLevel
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setChartType(chartType)
+ uid: 'ExcelScript!ExcelScript.Chart#setChartType:member(1)'
+ package: ExcelScript!
+ fullName: setChartType(chartType)
+ summary: Specifies the type of the chart. See `ExcelScript.ChartType` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setChartType(chartType: ChartType): void;'
+ parameters:
+ - id: chartType
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: 'setData(sourceData, seriesBy)'
+ uid: 'ExcelScript!ExcelScript.Chart#setData:member(1)'
+ package: ExcelScript!
+ fullName: 'setData(sourceData, seriesBy)'
+ summary: Resets the source data for the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setData(sourceData: Range, seriesBy?: ChartSeriesBy): void;'
+ parameters:
+ - id: sourceData
+ description: The range object corresponding to the source data.
+ type: ''
+ - id: seriesBy
+ description: >-
+ Specifies the way columns or rows are used as data series on the chart. Can be one of the following: Auto
+ (default), Rows, and Columns. See `ExcelScript.ChartSeriesBy` for details.
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setDisplayBlanksAs(displayBlanksAs)
+ uid: 'ExcelScript!ExcelScript.Chart#setDisplayBlanksAs:member(1)'
+ package: ExcelScript!
+ fullName: setDisplayBlanksAs(displayBlanksAs)
+ summary: Specifies the way that blank cells are plotted on a chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setDisplayBlanksAs(displayBlanksAs: ChartDisplayBlanksAs): void;'
+ parameters:
+ - id: displayBlanksAs
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setHeight(height)
+ uid: 'ExcelScript!ExcelScript.Chart#setHeight:member(1)'
+ package: ExcelScript!
+ fullName: setHeight(height)
+ summary: 'Specifies the height, in points, of the chart object.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setHeight(height: number): void;'
+ parameters:
+ - id: height
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setLeft(left)
+ uid: 'ExcelScript!ExcelScript.Chart#setLeft:member(1)'
+ package: ExcelScript!
+ fullName: setLeft(left)
+ summary: 'The distance, in points, from the left side of the chart to the worksheet origin.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLeft(left: number): void;'
+ parameters:
+ - id: left
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setName(name)
+ uid: 'ExcelScript!ExcelScript.Chart#setName:member(1)'
+ package: ExcelScript!
+ fullName: setName(name)
+ summary: Specifies the name of a chart object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setName(name: string): void;'
+ parameters:
+ - id: name
+ description: ''
+ type: string
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample creates a column-clustered chart based on the current worksheet's data.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Get the data range.
+ let range = selectedSheet.getUsedRange();
+
+ // Insert a chart using the data on the current worksheet.
+ let chart = selectedSheet.addChart(ExcelScript.ChartType.columnClustered, range);
+
+ // Name the chart for easy access in other scripts.
+ chart.setName("ColumnChart");
+ }
+ ```
+ - name: setPlotBy(plotBy)
+ uid: 'ExcelScript!ExcelScript.Chart#setPlotBy:member(1)'
+ package: ExcelScript!
+ fullName: setPlotBy(plotBy)
+ summary: Specifies the way columns or rows are used as data series on the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPlotBy(plotBy: ChartPlotBy): void;'
+ parameters:
+ - id: plotBy
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample performs the "Switch Row/Column" action on a chart named "ColumnClusteredChart".
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Get an existing chart named "ColumnClusteredChart".
+ let columnClusteredChart = selectedSheet.getChart("ColumnClusteredChart");
+
+ // Switch the row and column for the chart's data source.
+ if (columnClusteredChart.getPlotBy() === ExcelScript.ChartPlotBy.columns) {
+ // If the chart is grouped by columns, switch it to rows.
+ columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.rows);
+ } else {
+ // If the chart is grouped by rows, switch it to columns.
+ columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.columns);
+ }
+ }
+ ```
+ - name: setPlotVisibleOnly(plotVisibleOnly)
+ uid: 'ExcelScript!ExcelScript.Chart#setPlotVisibleOnly:member(1)'
+ package: ExcelScript!
+ fullName: setPlotVisibleOnly(plotVisibleOnly)
+ summary: True if only visible cells are plotted. False if both visible and hidden cells are plotted.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPlotVisibleOnly(plotVisibleOnly: boolean): void;'
+ parameters:
+ - id: plotVisibleOnly
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: 'setPosition(startCell, endCell)'
+ uid: 'ExcelScript!ExcelScript.Chart#setPosition:member(1)'
+ package: ExcelScript!
+ fullName: 'setPosition(startCell, endCell)'
+ summary: Positions the chart relative to cells on the worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPosition(startCell: Range | string, endCell?: Range | string): void;'
+ parameters:
+ - id: startCell
+ description: >-
+ The start cell. This is where the chart will be moved to. The start cell is the top-left or top-right cell,
+ depending on the user's right-to-left display settings.
+ type: ' | string'
+ - id: endCell
+ description: >-
+ Optional. The end cell. If specified, the chart's width and height will be set to fully cover up this
+ cell/range.
+ type: ' | string'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample moves an existing chart to a specific place on the worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Get an existing chart named "ColumnChart".
+ let chart = selectedSheet.getChart("ColumnChart");
+
+ // Place the chart over the range "F1:L13".
+ chart.setPosition("F1", "L13");
+ }
+ ```
+ - name: setSeriesNameLevel(seriesNameLevel)
+ uid: 'ExcelScript!ExcelScript.Chart#setSeriesNameLevel:member(1)'
+ package: ExcelScript!
+ fullName: setSeriesNameLevel(seriesNameLevel)
+ summary: 'Specifies a chart series name level enumeration constant, referring to the level of the source series names.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSeriesNameLevel(seriesNameLevel: number): void;'
+ parameters:
+ - id: seriesNameLevel
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setShowAllFieldButtons(showAllFieldButtons)
+ uid: 'ExcelScript!ExcelScript.Chart#setShowAllFieldButtons:member(1)'
+ package: ExcelScript!
+ fullName: setShowAllFieldButtons(showAllFieldButtons)
+ summary: Specifies whether to display all field buttons on a PivotChart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowAllFieldButtons(showAllFieldButtons: boolean): void;'
+ parameters:
+ - id: showAllFieldButtons
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowDataLabelsOverMaximum(showDataLabelsOverMaximum)
+ uid: 'ExcelScript!ExcelScript.Chart#setShowDataLabelsOverMaximum:member(1)'
+ package: ExcelScript!
+ fullName: setShowDataLabelsOverMaximum(showDataLabelsOverMaximum)
+ summary: >-
+ Specifies whether to show the data labels when the value is greater than the maximum value on the value axis. If
+ the value axis becomes smaller than the size of the data points, you can use this property to set whether to show
+ the data labels. This property applies to 2-D charts only.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowDataLabelsOverMaximum(showDataLabelsOverMaximum: boolean): void;'
+ parameters:
+ - id: showDataLabelsOverMaximum
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setStyle(style)
+ uid: 'ExcelScript!ExcelScript.Chart#setStyle:member(1)'
+ package: ExcelScript!
+ fullName: setStyle(style)
+ summary: Specifies the chart style for the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setStyle(style: number): void;'
+ parameters:
+ - id: style
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setTop(top)
+ uid: 'ExcelScript!ExcelScript.Chart#setTop:member(1)'
+ package: ExcelScript!
+ fullName: setTop(top)
+ summary: >-
+ Specifies the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top
+ of the chart area (on a chart).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTop(top: number): void;'
+ parameters:
+ - id: top
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setWidth(width)
+ uid: 'ExcelScript!ExcelScript.Chart#setWidth:member(1)'
+ package: ExcelScript!
+ fullName: setWidth(width)
+ summary: 'Specifies the width, in points, of the chart object.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setWidth(width: number): void;'
+ parameters:
+ - id: width
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartareaformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartareaformat.yml
index cc6c5a0b..140043e7 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartareaformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartareaformat.yml
@@ -1,110 +1,110 @@
-### YamlMime:TSType
-name: ExcelScript.ChartAreaFormat
-uid: 'ExcelScript!ExcelScript.ChartAreaFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartAreaFormat
-summary: Encapsulates the format properties for the overall chart area.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getBorder()
- uid: 'ExcelScript!ExcelScript.ChartAreaFormat#getBorder:member(1)'
- package: ExcelScript!
- fullName: getBorder()
- summary: 'Represents the border format of chart area, which includes color, linestyle, and weight.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBorder(): ChartBorder;'
- return:
- type: ''
- description: ''
- - name: getColorScheme()
- uid: 'ExcelScript!ExcelScript.ChartAreaFormat#getColorScheme:member(1)'
- package: ExcelScript!
- fullName: getColorScheme()
- summary: Specifies the color scheme of the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColorScheme(): ChartColorScheme;'
- return:
- type: ''
- description: ''
- - name: getFill()
- uid: 'ExcelScript!ExcelScript.ChartAreaFormat#getFill:member(1)'
- package: ExcelScript!
- fullName: getFill()
- summary: 'Represents the fill format of an object, which includes background formatting information.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFill(): ChartFill;'
- return:
- type: ''
- description: ''
- - name: getFont()
- uid: 'ExcelScript!ExcelScript.ChartAreaFormat#getFont:member(1)'
- package: ExcelScript!
- fullName: getFont()
- summary: 'Represents the font attributes (font name, font size, color, etc.) for the current object.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFont(): ChartFont;'
- return:
- type: ''
- description: ''
- - name: getRoundedCorners()
- uid: 'ExcelScript!ExcelScript.ChartAreaFormat#getRoundedCorners:member(1)'
- package: ExcelScript!
- fullName: getRoundedCorners()
- summary: Specifies if the chart area of the chart has rounded corners.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRoundedCorners(): boolean;'
- return:
- type: boolean
- description: ''
- - name: setColorScheme(colorScheme)
- uid: 'ExcelScript!ExcelScript.ChartAreaFormat#setColorScheme:member(1)'
- package: ExcelScript!
- fullName: setColorScheme(colorScheme)
- summary: Specifies the color scheme of the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setColorScheme(colorScheme: ChartColorScheme): void;'
- parameters:
- - id: colorScheme
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setRoundedCorners(roundedCorners)
- uid: 'ExcelScript!ExcelScript.ChartAreaFormat#setRoundedCorners:member(1)'
- package: ExcelScript!
- fullName: setRoundedCorners(roundedCorners)
- summary: Specifies if the chart area of the chart has rounded corners.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setRoundedCorners(roundedCorners: boolean): void;'
- parameters:
- - id: roundedCorners
- description: ''
- type: boolean
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartAreaFormat
+uid: 'ExcelScript!ExcelScript.ChartAreaFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartAreaFormat
+summary: Encapsulates the format properties for the overall chart area.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getBorder()
+ uid: 'ExcelScript!ExcelScript.ChartAreaFormat#getBorder:member(1)'
+ package: ExcelScript!
+ fullName: getBorder()
+ summary: 'Represents the border format of chart area, which includes color, linestyle, and weight.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBorder(): ChartBorder;'
+ return:
+ type: ''
+ description: ''
+ - name: getColorScheme()
+ uid: 'ExcelScript!ExcelScript.ChartAreaFormat#getColorScheme:member(1)'
+ package: ExcelScript!
+ fullName: getColorScheme()
+ summary: Specifies the color scheme of the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColorScheme(): ChartColorScheme;'
+ return:
+ type: ''
+ description: ''
+ - name: getFill()
+ uid: 'ExcelScript!ExcelScript.ChartAreaFormat#getFill:member(1)'
+ package: ExcelScript!
+ fullName: getFill()
+ summary: 'Represents the fill format of an object, which includes background formatting information.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFill(): ChartFill;'
+ return:
+ type: ''
+ description: ''
+ - name: getFont()
+ uid: 'ExcelScript!ExcelScript.ChartAreaFormat#getFont:member(1)'
+ package: ExcelScript!
+ fullName: getFont()
+ summary: 'Represents the font attributes (font name, font size, color, etc.) for the current object.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFont(): ChartFont;'
+ return:
+ type: ''
+ description: ''
+ - name: getRoundedCorners()
+ uid: 'ExcelScript!ExcelScript.ChartAreaFormat#getRoundedCorners:member(1)'
+ package: ExcelScript!
+ fullName: getRoundedCorners()
+ summary: Specifies if the chart area of the chart has rounded corners.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRoundedCorners(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: setColorScheme(colorScheme)
+ uid: 'ExcelScript!ExcelScript.ChartAreaFormat#setColorScheme:member(1)'
+ package: ExcelScript!
+ fullName: setColorScheme(colorScheme)
+ summary: Specifies the color scheme of the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setColorScheme(colorScheme: ChartColorScheme): void;'
+ parameters:
+ - id: colorScheme
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setRoundedCorners(roundedCorners)
+ uid: 'ExcelScript!ExcelScript.ChartAreaFormat#setRoundedCorners:member(1)'
+ package: ExcelScript!
+ fullName: setRoundedCorners(roundedCorners)
+ summary: Specifies if the chart area of the chart has rounded corners.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setRoundedCorners(roundedCorners: boolean): void;'
+ parameters:
+ - id: roundedCorners
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxes.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxes.yml
index 10f72507..83577293 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxes.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxes.yml
@@ -1,70 +1,70 @@
-### YamlMime:TSType
-name: ExcelScript.ChartAxes
-uid: 'ExcelScript!ExcelScript.ChartAxes:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartAxes
-summary: Represents the chart axes.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getCategoryAxis()
- uid: 'ExcelScript!ExcelScript.ChartAxes#getCategoryAxis:member(1)'
- package: ExcelScript!
- fullName: getCategoryAxis()
- summary: Represents the category axis in a chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCategoryAxis(): ChartAxis;'
- return:
- type: ''
- description: ''
- - name: 'getChartAxis(type, group)'
- uid: 'ExcelScript!ExcelScript.ChartAxes#getChartAxis:member(1)'
- package: ExcelScript!
- fullName: 'getChartAxis(type, group)'
- summary: Returns the specific axis identified by type and group.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getChartAxis(type: ChartAxisType, group?: ChartAxisGroup): ChartAxis;'
- parameters:
- - id: type
- description: Specifies the axis type. See `ExcelScript.ChartAxisType` for details.
- type: ''
- - id: group
- description: Optional. Specifies the axis group. See `ExcelScript.ChartAxisGroup` for details.
- type: ''
- return:
- type: ''
- description: ''
- - name: getSeriesAxis()
- uid: 'ExcelScript!ExcelScript.ChartAxes#getSeriesAxis:member(1)'
- package: ExcelScript!
- fullName: getSeriesAxis()
- summary: Represents the series axis of a 3-D chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSeriesAxis(): ChartAxis;'
- return:
- type: ''
- description: ''
- - name: getValueAxis()
- uid: 'ExcelScript!ExcelScript.ChartAxes#getValueAxis:member(1)'
- package: ExcelScript!
- fullName: getValueAxis()
- summary: Represents the value axis in an axis.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getValueAxis(): ChartAxis;'
- return:
- type: ''
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartAxes
+uid: 'ExcelScript!ExcelScript.ChartAxes:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartAxes
+summary: Represents the chart axes.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getCategoryAxis()
+ uid: 'ExcelScript!ExcelScript.ChartAxes#getCategoryAxis:member(1)'
+ package: ExcelScript!
+ fullName: getCategoryAxis()
+ summary: Represents the category axis in a chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCategoryAxis(): ChartAxis;'
+ return:
+ type: ''
+ description: ''
+ - name: 'getChartAxis(type, group)'
+ uid: 'ExcelScript!ExcelScript.ChartAxes#getChartAxis:member(1)'
+ package: ExcelScript!
+ fullName: 'getChartAxis(type, group)'
+ summary: Returns the specific axis identified by type and group.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getChartAxis(type: ChartAxisType, group?: ChartAxisGroup): ChartAxis;'
+ parameters:
+ - id: type
+ description: Specifies the axis type. See `ExcelScript.ChartAxisType` for details.
+ type: ''
+ - id: group
+ description: Optional. Specifies the axis group. See `ExcelScript.ChartAxisGroup` for details.
+ type: ''
+ return:
+ type: ''
+ description: ''
+ - name: getSeriesAxis()
+ uid: 'ExcelScript!ExcelScript.ChartAxes#getSeriesAxis:member(1)'
+ package: ExcelScript!
+ fullName: getSeriesAxis()
+ summary: Represents the series axis of a 3-D chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSeriesAxis(): ChartAxis;'
+ return:
+ type: ''
+ description: ''
+ - name: getValueAxis()
+ uid: 'ExcelScript!ExcelScript.ChartAxes#getValueAxis:member(1)'
+ package: ExcelScript!
+ fullName: getValueAxis()
+ summary: Represents the value axis in an axis.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getValueAxis(): ChartAxis;'
+ return:
+ type: ''
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxis.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxis.yml
index d069c6a5..fb8f5c8a 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxis.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxis.yml
@@ -1,1071 +1,1071 @@
-### YamlMime:TSType
-name: ExcelScript.ChartAxis
-uid: 'ExcelScript!ExcelScript.ChartAxis:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartAxis
-summary: Represents a single axis in a chart.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getAlignment()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getAlignment:member(1)'
- package: ExcelScript!
- fullName: getAlignment()
- summary: >-
- Specifies the alignment for the specified axis tick label. See `ExcelScript.ChartTextHorizontalAlignment` for
- detail.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAlignment(): ChartTickLabelAlignment;'
- return:
- type: ''
- description: ''
- - name: getAxisGroup()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getAxisGroup:member(1)'
- package: ExcelScript!
- fullName: getAxisGroup()
- summary: Specifies the group for the specified axis. See `ExcelScript.ChartAxisGroup` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAxisGroup(): ChartAxisGroup;'
- return:
- type: ''
- description: ''
- - name: getBaseTimeUnit()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getBaseTimeUnit:member(1)'
- package: ExcelScript!
- fullName: getBaseTimeUnit()
- summary: Specifies the base unit for the specified category axis.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBaseTimeUnit(): ChartAxisTimeUnit;'
- return:
- type: ''
- description: ''
- - name: getCategoryType()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getCategoryType:member(1)'
- package: ExcelScript!
- fullName: getCategoryType()
- summary: Specifies the category axis type.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCategoryType(): ChartAxisCategoryType;'
- return:
- type: ''
- description: ''
- - name: getCustomDisplayUnit()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getCustomDisplayUnit:member(1)'
- package: ExcelScript!
- fullName: getCustomDisplayUnit()
- summary: >-
- Specifies the custom axis display unit value. To set this property, please use the `SetCustomDisplayUnit(double)`
- method.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCustomDisplayUnit(): number;'
- return:
- type: number
- description: ''
- - name: getDisplayUnit()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getDisplayUnit:member(1)'
- package: ExcelScript!
- fullName: getDisplayUnit()
- summary: Represents the axis display unit. See `ExcelScript.ChartAxisDisplayUnit` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDisplayUnit(): ChartAxisDisplayUnit;'
- return:
- type: ''
- description: ''
- - name: getFormat()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getFormat:member(1)'
- package: ExcelScript!
- fullName: getFormat()
- summary: 'Represents the formatting of a chart object, which includes line and font formatting.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormat(): ChartAxisFormat;'
- return:
- type: ''
- description: ''
- - name: getHeight()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getHeight:member(1)'
- package: ExcelScript!
- fullName: getHeight()
- summary: 'Specifies the height, in points, of the chart axis. Returns `null` if the axis is not visible.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHeight(): number;'
- return:
- type: number
- description: ''
- - name: getIsBetweenCategories()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getIsBetweenCategories:member(1)'
- package: ExcelScript!
- fullName: getIsBetweenCategories()
- summary: Specifies if the value axis crosses the category axis between categories.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIsBetweenCategories(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getLeft()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getLeft:member(1)'
- package: ExcelScript!
- fullName: getLeft()
- summary: >-
- Specifies the distance, in points, from the left edge of the axis to the left of chart area. Returns `null` if the
- axis is not visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLeft(): number;'
- return:
- type: number
- description: ''
- - name: getLinkNumberFormat()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getLinkNumberFormat:member(1)'
- package: ExcelScript!
- fullName: getLinkNumberFormat()
- summary: >-
- Specifies if the number format is linked to the cells. If `true`, the number format will change in the
- labels when it changes in the cells.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLinkNumberFormat(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getLogBase()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getLogBase:member(1)'
- package: ExcelScript!
- fullName: getLogBase()
- summary: Specifies the base of the logarithm when using logarithmic scales.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLogBase(): number;'
- return:
- type: number
- description: ''
- - name: getMajorGridlines()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getMajorGridlines:member(1)'
- package: ExcelScript!
- fullName: getMajorGridlines()
- summary: Returns an object that represents the major gridlines for the specified axis.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMajorGridlines(): ChartGridlines;'
- return:
- type: ''
- description: ''
- - name: getMajorTickMark()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getMajorTickMark:member(1)'
- package: ExcelScript!
- fullName: getMajorTickMark()
- summary: Specifies the type of major tick mark for the specified axis. See `ExcelScript.ChartAxisTickMark` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMajorTickMark(): ChartAxisTickMark;'
- return:
- type: ''
- description: ''
- - name: getMajorTimeUnitScale()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getMajorTimeUnitScale:member(1)'
- package: ExcelScript!
- fullName: getMajorTimeUnitScale()
- summary: >-
- Specifies the major unit scale value for the category axis when the `categoryType` property is set to
- `dateAxis`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMajorTimeUnitScale(): ChartAxisTimeUnit;'
- return:
- type: ''
- description: ''
- - name: getMajorUnit()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getMajorUnit:member(1)'
- package: ExcelScript!
- fullName: getMajorUnit()
- summary: Specifies the interval between two major tick marks.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMajorUnit(): number;'
- return:
- type: number
- description: ''
- - name: getMaximum()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getMaximum:member(1)'
- package: ExcelScript!
- fullName: getMaximum()
- summary: Specifies the maximum value on the value axis.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMaximum(): number;'
- return:
- type: number
- description: ''
- - name: getMinimum()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getMinimum:member(1)'
- package: ExcelScript!
- fullName: getMinimum()
- summary: Specifies the minimum value on the value axis.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMinimum(): number;'
- return:
- type: number
- description: ''
- - name: getMinorGridlines()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getMinorGridlines:member(1)'
- package: ExcelScript!
- fullName: getMinorGridlines()
- summary: Returns an object that represents the minor gridlines for the specified axis.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMinorGridlines(): ChartGridlines;'
- return:
- type: ''
- description: ''
- - name: getMinorTickMark()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getMinorTickMark:member(1)'
- package: ExcelScript!
- fullName: getMinorTickMark()
- summary: Specifies the type of minor tick mark for the specified axis. See `ExcelScript.ChartAxisTickMark` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMinorTickMark(): ChartAxisTickMark;'
- return:
- type: ''
- description: ''
- - name: getMinorTimeUnitScale()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getMinorTimeUnitScale:member(1)'
- package: ExcelScript!
- fullName: getMinorTimeUnitScale()
- summary: >-
- Specifies the minor unit scale value for the category axis when the `categoryType` property is set to
- `dateAxis`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMinorTimeUnitScale(): ChartAxisTimeUnit;'
- return:
- type: ''
- description: ''
- - name: getMinorUnit()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getMinorUnit:member(1)'
- package: ExcelScript!
- fullName: getMinorUnit()
- summary: Specifies the interval between two minor tick marks.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMinorUnit(): number;'
- return:
- type: number
- description: ''
- - name: getMultiLevel()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getMultiLevel:member(1)'
- package: ExcelScript!
- fullName: getMultiLevel()
- summary: Specifies if an axis is multilevel.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMultiLevel(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getNumberFormat()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getNumberFormat:member(1)'
- package: ExcelScript!
- fullName: getNumberFormat()
- summary: Specifies the format code for the axis tick label.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNumberFormat(): string;'
- return:
- type: string
- description: ''
- - name: getOffset()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getOffset:member(1)'
- package: ExcelScript!
- fullName: getOffset()
- summary: >-
- Specifies the distance between the levels of labels, and the distance between the first level and the axis line.
- The value should be an integer from 0 to 1000.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getOffset(): number;'
- return:
- type: number
- description: ''
- - name: getPosition()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getPosition:member(1)'
- package: ExcelScript!
- fullName: getPosition()
- summary: >-
- Specifies the specified axis position where the other axis crosses. See `ExcelScript.ChartAxisPosition` for
- details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPosition(): ChartAxisPosition;'
- return:
- type: ''
- description: ''
- - name: getPositionAt()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getPositionAt:member(1)'
- package: ExcelScript!
- fullName: getPositionAt()
- summary: >-
- Specifies the axis position where the other axis crosses. You should use the `SetPositionAt(double)` method to set
- this property.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPositionAt(): number;'
- return:
- type: number
- description: ''
- - name: getReversePlotOrder()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getReversePlotOrder:member(1)'
- package: ExcelScript!
- fullName: getReversePlotOrder()
- summary: Specifies if Excel plots data points from last to first.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getReversePlotOrder(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getScaleType()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getScaleType:member(1)'
- package: ExcelScript!
- fullName: getScaleType()
- summary: Specifies the value axis scale type. See `ExcelScript.ChartAxisScaleType` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getScaleType(): ChartAxisScaleType;'
- return:
- type: ''
- description: ''
- - name: getShowDisplayUnitLabel()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getShowDisplayUnitLabel:member(1)'
- package: ExcelScript!
- fullName: getShowDisplayUnitLabel()
- summary: Specifies if the axis display unit label is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowDisplayUnitLabel(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getTextOrientation()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getTextOrientation:member(1)'
- package: ExcelScript!
- fullName: getTextOrientation()
- summary: >-
- Specifies the angle to which the text is oriented for the chart axis tick label. The value should either be an
- integer from -90 to 90 or the integer 180 for vertically-oriented text.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTextOrientation(): number;'
- return:
- type: number
- description: ''
- - name: getTickLabelPosition()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getTickLabelPosition:member(1)'
- package: ExcelScript!
- fullName: getTickLabelPosition()
- summary: >-
- Specifies the position of tick-mark labels on the specified axis. See `ExcelScript.ChartAxisTickLabelPosition` for
- details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTickLabelPosition(): ChartAxisTickLabelPosition;'
- return:
- type: ''
- description: ''
- - name: getTickLabelSpacing()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getTickLabelSpacing:member(1)'
- package: ExcelScript!
- fullName: getTickLabelSpacing()
- summary: Specifies the number of categories or series between tick-mark labels. Can be a value from 1 through 31999.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTickLabelSpacing(): number;'
- return:
- type: number
- description: ''
- - name: getTickMarkSpacing()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getTickMarkSpacing:member(1)'
- package: ExcelScript!
- fullName: getTickMarkSpacing()
- summary: Specifies the number of categories or series between tick marks.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTickMarkSpacing(): number;'
- return:
- type: number
- description: ''
- - name: getTitle()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getTitle:member(1)'
- package: ExcelScript!
- fullName: getTitle()
- summary: Represents the axis title.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTitle(): ChartAxisTitle;'
- return:
- type: ''
- description: ''
- - name: getTop()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getTop:member(1)'
- package: ExcelScript!
- fullName: getTop()
- summary: >-
- Specifies the distance, in points, from the top edge of the axis to the top of chart area. Returns `null` if the
- axis is not visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTop(): number;'
- return:
- type: number
- description: ''
- - name: getType()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getType:member(1)'
- package: ExcelScript!
- fullName: getType()
- summary: Specifies the axis type. See `ExcelScript.ChartAxisType` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getType(): ChartAxisType;'
- return:
- type: ''
- description: ''
- - name: getVisible()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getVisible:member(1)'
- package: ExcelScript!
- fullName: getVisible()
- summary: Specifies if the axis is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVisible(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getWidth()
- uid: 'ExcelScript!ExcelScript.ChartAxis#getWidth:member(1)'
- package: ExcelScript!
- fullName: getWidth()
- summary: 'Specifies the width, in points, of the chart axis. Returns `null` if the axis is not visible.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWidth(): number;'
- return:
- type: number
- description: ''
- - name: setAlignment(alignment)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setAlignment:member(1)'
- package: ExcelScript!
- fullName: setAlignment(alignment)
- summary: >-
- Specifies the alignment for the specified axis tick label. See `ExcelScript.ChartTextHorizontalAlignment` for
- detail.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setAlignment(alignment: ChartTickLabelAlignment): void;'
- parameters:
- - id: alignment
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setBaseTimeUnit(baseTimeUnit)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setBaseTimeUnit:member(1)'
- package: ExcelScript!
- fullName: setBaseTimeUnit(baseTimeUnit)
- summary: Specifies the base unit for the specified category axis.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setBaseTimeUnit(baseTimeUnit: ChartAxisTimeUnit): void;'
- parameters:
- - id: baseTimeUnit
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setCategoryNames(sourceData)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setCategoryNames:member(1)'
- package: ExcelScript!
- fullName: setCategoryNames(sourceData)
- summary: Sets all the category names for the specified axis.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setCategoryNames(sourceData: Range): void;'
- parameters:
- - id: sourceData
- description: The `Range` object corresponding to the source data.
- type: ''
- return:
- type: void
- description: ''
- - name: setCategoryType(categoryType)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setCategoryType:member(1)'
- package: ExcelScript!
- fullName: setCategoryType(categoryType)
- summary: Specifies the category axis type.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setCategoryType(categoryType: ChartAxisCategoryType): void;'
- parameters:
- - id: categoryType
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setCustomDisplayUnit(value)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setCustomDisplayUnit:member(1)'
- package: ExcelScript!
- fullName: setCustomDisplayUnit(value)
- summary: Sets the axis display unit to a custom value.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setCustomDisplayUnit(value: number): void;'
- parameters:
- - id: value
- description: Custom value of the display unit.
- type: number
- return:
- type: void
- description: ''
- - name: setDisplayUnit(displayUnit)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setDisplayUnit:member(1)'
- package: ExcelScript!
- fullName: setDisplayUnit(displayUnit)
- summary: Represents the axis display unit. See `ExcelScript.ChartAxisDisplayUnit` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setDisplayUnit(displayUnit: ChartAxisDisplayUnit): void;'
- parameters:
- - id: displayUnit
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setIsBetweenCategories(isBetweenCategories)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setIsBetweenCategories:member(1)'
- package: ExcelScript!
- fullName: setIsBetweenCategories(isBetweenCategories)
- summary: Specifies if the value axis crosses the category axis between categories.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setIsBetweenCategories(isBetweenCategories: boolean): void;'
- parameters:
- - id: isBetweenCategories
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setLinkNumberFormat(linkNumberFormat)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setLinkNumberFormat:member(1)'
- package: ExcelScript!
- fullName: setLinkNumberFormat(linkNumberFormat)
- summary: >-
- Specifies if the number format is linked to the cells. If `true`, the number format will change in the
- labels when it changes in the cells.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLinkNumberFormat(linkNumberFormat: boolean): void;'
- parameters:
- - id: linkNumberFormat
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setLogBase(logBase)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setLogBase:member(1)'
- package: ExcelScript!
- fullName: setLogBase(logBase)
- summary: Specifies the base of the logarithm when using logarithmic scales.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLogBase(logBase: number): void;'
- parameters:
- - id: logBase
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setMajorTickMark(majorTickMark)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setMajorTickMark:member(1)'
- package: ExcelScript!
- fullName: setMajorTickMark(majorTickMark)
- summary: Specifies the type of major tick mark for the specified axis. See `ExcelScript.ChartAxisTickMark` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMajorTickMark(majorTickMark: ChartAxisTickMark): void;'
- parameters:
- - id: majorTickMark
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setMajorTimeUnitScale(majorTimeUnitScale)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setMajorTimeUnitScale:member(1)'
- package: ExcelScript!
- fullName: setMajorTimeUnitScale(majorTimeUnitScale)
- summary: >-
- Specifies the major unit scale value for the category axis when the `categoryType` property is set to
- `dateAxis`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMajorTimeUnitScale(majorTimeUnitScale: ChartAxisTimeUnit): void;'
- parameters:
- - id: majorTimeUnitScale
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setMajorUnit(majorUnit)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setMajorUnit:member(1)'
- package: ExcelScript!
- fullName: setMajorUnit(majorUnit)
- summary: Specifies the interval between two major tick marks.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMajorUnit(majorUnit: number): void;'
- parameters:
- - id: majorUnit
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setMaximum(maximum)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setMaximum:member(1)'
- package: ExcelScript!
- fullName: setMaximum(maximum)
- summary: Specifies the maximum value on the value axis.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMaximum(maximum: number): void;'
- parameters:
- - id: maximum
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setMinimum(minimum)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setMinimum:member(1)'
- package: ExcelScript!
- fullName: setMinimum(minimum)
- summary: Specifies the minimum value on the value axis.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMinimum(minimum: number): void;'
- parameters:
- - id: minimum
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setMinorTickMark(minorTickMark)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setMinorTickMark:member(1)'
- package: ExcelScript!
- fullName: setMinorTickMark(minorTickMark)
- summary: Specifies the type of minor tick mark for the specified axis. See `ExcelScript.ChartAxisTickMark` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMinorTickMark(minorTickMark: ChartAxisTickMark): void;'
- parameters:
- - id: minorTickMark
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setMinorTimeUnitScale(minorTimeUnitScale)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setMinorTimeUnitScale:member(1)'
- package: ExcelScript!
- fullName: setMinorTimeUnitScale(minorTimeUnitScale)
- summary: >-
- Specifies the minor unit scale value for the category axis when the `categoryType` property is set to
- `dateAxis`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMinorTimeUnitScale(minorTimeUnitScale: ChartAxisTimeUnit): void;'
- parameters:
- - id: minorTimeUnitScale
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setMinorUnit(minorUnit)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setMinorUnit:member(1)'
- package: ExcelScript!
- fullName: setMinorUnit(minorUnit)
- summary: Specifies the interval between two minor tick marks.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMinorUnit(minorUnit: number): void;'
- parameters:
- - id: minorUnit
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setMultiLevel(multiLevel)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setMultiLevel:member(1)'
- package: ExcelScript!
- fullName: setMultiLevel(multiLevel)
- summary: Specifies if an axis is multilevel.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMultiLevel(multiLevel: boolean): void;'
- parameters:
- - id: multiLevel
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setNumberFormat(numberFormat)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setNumberFormat:member(1)'
- package: ExcelScript!
- fullName: setNumberFormat(numberFormat)
- summary: Specifies the format code for the axis tick label.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setNumberFormat(numberFormat: string): void;'
- parameters:
- - id: numberFormat
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setOffset(offset)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setOffset:member(1)'
- package: ExcelScript!
- fullName: setOffset(offset)
- summary: >-
- Specifies the distance between the levels of labels, and the distance between the first level and the axis line.
- The value should be an integer from 0 to 1000.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setOffset(offset: number): void;'
- parameters:
- - id: offset
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setPosition(position)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setPosition:member(1)'
- package: ExcelScript!
- fullName: setPosition(position)
- summary: >-
- Specifies the specified axis position where the other axis crosses. See `ExcelScript.ChartAxisPosition` for
- details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPosition(position: ChartAxisPosition): void;'
- parameters:
- - id: position
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setPositionAt(value)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setPositionAt:member(1)'
- package: ExcelScript!
- fullName: setPositionAt(value)
- summary: Sets the specified axis position where the other axis crosses.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPositionAt(value: number): void;'
- parameters:
- - id: value
- description: Custom value of the crossing point.
- type: number
- return:
- type: void
- description: ''
- - name: setReversePlotOrder(reversePlotOrder)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setReversePlotOrder:member(1)'
- package: ExcelScript!
- fullName: setReversePlotOrder(reversePlotOrder)
- summary: Specifies if Excel plots data points from last to first.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setReversePlotOrder(reversePlotOrder: boolean): void;'
- parameters:
- - id: reversePlotOrder
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setScaleType(scaleType)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setScaleType:member(1)'
- package: ExcelScript!
- fullName: setScaleType(scaleType)
- summary: Specifies the value axis scale type. See `ExcelScript.ChartAxisScaleType` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setScaleType(scaleType: ChartAxisScaleType): void;'
- parameters:
- - id: scaleType
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setShowDisplayUnitLabel(showDisplayUnitLabel)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setShowDisplayUnitLabel:member(1)'
- package: ExcelScript!
- fullName: setShowDisplayUnitLabel(showDisplayUnitLabel)
- summary: Specifies if the axis display unit label is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowDisplayUnitLabel(showDisplayUnitLabel: boolean): void;'
- parameters:
- - id: showDisplayUnitLabel
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setTextOrientation(textOrientation)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setTextOrientation:member(1)'
- package: ExcelScript!
- fullName: setTextOrientation(textOrientation)
- summary: >-
- Specifies the angle to which the text is oriented for the chart axis tick label. The value should either be an
- integer from -90 to 90 or the integer 180 for vertically-oriented text.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTextOrientation(textOrientation: number): void;'
- parameters:
- - id: textOrientation
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setTickLabelPosition(tickLabelPosition)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setTickLabelPosition:member(1)'
- package: ExcelScript!
- fullName: setTickLabelPosition(tickLabelPosition)
- summary: >-
- Specifies the position of tick-mark labels on the specified axis. See `ExcelScript.ChartAxisTickLabelPosition` for
- details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setTickLabelPosition(
- tickLabelPosition: ChartAxisTickLabelPosition
- ): void;
- parameters:
- - id: tickLabelPosition
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setTickLabelSpacing(tickLabelSpacing)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setTickLabelSpacing:member(1)'
- package: ExcelScript!
- fullName: setTickLabelSpacing(tickLabelSpacing)
- summary: Specifies the number of categories or series between tick-mark labels. Can be a value from 1 through 31999.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTickLabelSpacing(tickLabelSpacing: number): void;'
- parameters:
- - id: tickLabelSpacing
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setTickMarkSpacing(tickMarkSpacing)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setTickMarkSpacing:member(1)'
- package: ExcelScript!
- fullName: setTickMarkSpacing(tickMarkSpacing)
- summary: Specifies the number of categories or series between tick marks.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTickMarkSpacing(tickMarkSpacing: number): void;'
- parameters:
- - id: tickMarkSpacing
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setVisible(visible)
- uid: 'ExcelScript!ExcelScript.ChartAxis#setVisible:member(1)'
- package: ExcelScript!
- fullName: setVisible(visible)
- summary: Specifies if the axis is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setVisible(visible: boolean): void;'
- parameters:
- - id: visible
- description: ''
- type: boolean
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartAxis
+uid: 'ExcelScript!ExcelScript.ChartAxis:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartAxis
+summary: Represents a single axis in a chart.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getAlignment()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getAlignment:member(1)'
+ package: ExcelScript!
+ fullName: getAlignment()
+ summary: >-
+ Specifies the alignment for the specified axis tick label. See `ExcelScript.ChartTextHorizontalAlignment` for
+ detail.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAlignment(): ChartTickLabelAlignment;'
+ return:
+ type: ''
+ description: ''
+ - name: getAxisGroup()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getAxisGroup:member(1)'
+ package: ExcelScript!
+ fullName: getAxisGroup()
+ summary: Specifies the group for the specified axis. See `ExcelScript.ChartAxisGroup` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAxisGroup(): ChartAxisGroup;'
+ return:
+ type: ''
+ description: ''
+ - name: getBaseTimeUnit()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getBaseTimeUnit:member(1)'
+ package: ExcelScript!
+ fullName: getBaseTimeUnit()
+ summary: Specifies the base unit for the specified category axis.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBaseTimeUnit(): ChartAxisTimeUnit;'
+ return:
+ type: ''
+ description: ''
+ - name: getCategoryType()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getCategoryType:member(1)'
+ package: ExcelScript!
+ fullName: getCategoryType()
+ summary: Specifies the category axis type.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCategoryType(): ChartAxisCategoryType;'
+ return:
+ type: ''
+ description: ''
+ - name: getCustomDisplayUnit()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getCustomDisplayUnit:member(1)'
+ package: ExcelScript!
+ fullName: getCustomDisplayUnit()
+ summary: >-
+ Specifies the custom axis display unit value. To set this property, please use the `SetCustomDisplayUnit(double)`
+ method.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCustomDisplayUnit(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getDisplayUnit()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getDisplayUnit:member(1)'
+ package: ExcelScript!
+ fullName: getDisplayUnit()
+ summary: Represents the axis display unit. See `ExcelScript.ChartAxisDisplayUnit` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDisplayUnit(): ChartAxisDisplayUnit;'
+ return:
+ type: ''
+ description: ''
+ - name: getFormat()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getFormat:member(1)'
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: 'Represents the formatting of a chart object, which includes line and font formatting.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): ChartAxisFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getHeight()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getHeight:member(1)'
+ package: ExcelScript!
+ fullName: getHeight()
+ summary: 'Specifies the height, in points, of the chart axis. Returns `null` if the axis is not visible.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHeight(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getIsBetweenCategories()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getIsBetweenCategories:member(1)'
+ package: ExcelScript!
+ fullName: getIsBetweenCategories()
+ summary: Specifies if the value axis crosses the category axis between categories.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIsBetweenCategories(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getLeft()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getLeft:member(1)'
+ package: ExcelScript!
+ fullName: getLeft()
+ summary: >-
+ Specifies the distance, in points, from the left edge of the axis to the left of chart area. Returns `null` if the
+ axis is not visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLeft(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getLinkNumberFormat()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getLinkNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: getLinkNumberFormat()
+ summary: >-
+ Specifies if the number format is linked to the cells. If `true`, the number format will change in the
+ labels when it changes in the cells.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLinkNumberFormat(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getLogBase()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getLogBase:member(1)'
+ package: ExcelScript!
+ fullName: getLogBase()
+ summary: Specifies the base of the logarithm when using logarithmic scales.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLogBase(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getMajorGridlines()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getMajorGridlines:member(1)'
+ package: ExcelScript!
+ fullName: getMajorGridlines()
+ summary: Returns an object that represents the major gridlines for the specified axis.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMajorGridlines(): ChartGridlines;'
+ return:
+ type: ''
+ description: ''
+ - name: getMajorTickMark()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getMajorTickMark:member(1)'
+ package: ExcelScript!
+ fullName: getMajorTickMark()
+ summary: Specifies the type of major tick mark for the specified axis. See `ExcelScript.ChartAxisTickMark` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMajorTickMark(): ChartAxisTickMark;'
+ return:
+ type: ''
+ description: ''
+ - name: getMajorTimeUnitScale()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getMajorTimeUnitScale:member(1)'
+ package: ExcelScript!
+ fullName: getMajorTimeUnitScale()
+ summary: >-
+ Specifies the major unit scale value for the category axis when the `categoryType` property is set to
+ `dateAxis`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMajorTimeUnitScale(): ChartAxisTimeUnit;'
+ return:
+ type: ''
+ description: ''
+ - name: getMajorUnit()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getMajorUnit:member(1)'
+ package: ExcelScript!
+ fullName: getMajorUnit()
+ summary: Specifies the interval between two major tick marks.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMajorUnit(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getMaximum()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getMaximum:member(1)'
+ package: ExcelScript!
+ fullName: getMaximum()
+ summary: Specifies the maximum value on the value axis.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMaximum(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getMinimum()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getMinimum:member(1)'
+ package: ExcelScript!
+ fullName: getMinimum()
+ summary: Specifies the minimum value on the value axis.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMinimum(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getMinorGridlines()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getMinorGridlines:member(1)'
+ package: ExcelScript!
+ fullName: getMinorGridlines()
+ summary: Returns an object that represents the minor gridlines for the specified axis.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMinorGridlines(): ChartGridlines;'
+ return:
+ type: ''
+ description: ''
+ - name: getMinorTickMark()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getMinorTickMark:member(1)'
+ package: ExcelScript!
+ fullName: getMinorTickMark()
+ summary: Specifies the type of minor tick mark for the specified axis. See `ExcelScript.ChartAxisTickMark` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMinorTickMark(): ChartAxisTickMark;'
+ return:
+ type: ''
+ description: ''
+ - name: getMinorTimeUnitScale()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getMinorTimeUnitScale:member(1)'
+ package: ExcelScript!
+ fullName: getMinorTimeUnitScale()
+ summary: >-
+ Specifies the minor unit scale value for the category axis when the `categoryType` property is set to
+ `dateAxis`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMinorTimeUnitScale(): ChartAxisTimeUnit;'
+ return:
+ type: ''
+ description: ''
+ - name: getMinorUnit()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getMinorUnit:member(1)'
+ package: ExcelScript!
+ fullName: getMinorUnit()
+ summary: Specifies the interval between two minor tick marks.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMinorUnit(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getMultiLevel()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getMultiLevel:member(1)'
+ package: ExcelScript!
+ fullName: getMultiLevel()
+ summary: Specifies if an axis is multilevel.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMultiLevel(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getNumberFormat()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: getNumberFormat()
+ summary: Specifies the format code for the axis tick label.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNumberFormat(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getOffset()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getOffset:member(1)'
+ package: ExcelScript!
+ fullName: getOffset()
+ summary: >-
+ Specifies the distance between the levels of labels, and the distance between the first level and the axis line.
+ The value should be an integer from 0 to 1000.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getOffset(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getPosition()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getPosition:member(1)'
+ package: ExcelScript!
+ fullName: getPosition()
+ summary: >-
+ Specifies the specified axis position where the other axis crosses. See `ExcelScript.ChartAxisPosition` for
+ details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPosition(): ChartAxisPosition;'
+ return:
+ type: ''
+ description: ''
+ - name: getPositionAt()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getPositionAt:member(1)'
+ package: ExcelScript!
+ fullName: getPositionAt()
+ summary: >-
+ Specifies the axis position where the other axis crosses. You should use the `SetPositionAt(double)` method to set
+ this property.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPositionAt(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getReversePlotOrder()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getReversePlotOrder:member(1)'
+ package: ExcelScript!
+ fullName: getReversePlotOrder()
+ summary: Specifies if Excel plots data points from last to first.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getReversePlotOrder(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getScaleType()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getScaleType:member(1)'
+ package: ExcelScript!
+ fullName: getScaleType()
+ summary: Specifies the value axis scale type. See `ExcelScript.ChartAxisScaleType` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getScaleType(): ChartAxisScaleType;'
+ return:
+ type: ''
+ description: ''
+ - name: getShowDisplayUnitLabel()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getShowDisplayUnitLabel:member(1)'
+ package: ExcelScript!
+ fullName: getShowDisplayUnitLabel()
+ summary: Specifies if the axis display unit label is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowDisplayUnitLabel(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getTextOrientation()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getTextOrientation:member(1)'
+ package: ExcelScript!
+ fullName: getTextOrientation()
+ summary: >-
+ Specifies the angle to which the text is oriented for the chart axis tick label. The value should either be an
+ integer from -90 to 90 or the integer 180 for vertically-oriented text.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTextOrientation(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getTickLabelPosition()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getTickLabelPosition:member(1)'
+ package: ExcelScript!
+ fullName: getTickLabelPosition()
+ summary: >-
+ Specifies the position of tick-mark labels on the specified axis. See `ExcelScript.ChartAxisTickLabelPosition` for
+ details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTickLabelPosition(): ChartAxisTickLabelPosition;'
+ return:
+ type: ''
+ description: ''
+ - name: getTickLabelSpacing()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getTickLabelSpacing:member(1)'
+ package: ExcelScript!
+ fullName: getTickLabelSpacing()
+ summary: Specifies the number of categories or series between tick-mark labels. Can be a value from 1 through 31999.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTickLabelSpacing(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getTickMarkSpacing()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getTickMarkSpacing:member(1)'
+ package: ExcelScript!
+ fullName: getTickMarkSpacing()
+ summary: Specifies the number of categories or series between tick marks.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTickMarkSpacing(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getTitle()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getTitle:member(1)'
+ package: ExcelScript!
+ fullName: getTitle()
+ summary: Represents the axis title.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTitle(): ChartAxisTitle;'
+ return:
+ type: ''
+ description: ''
+ - name: getTop()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getTop:member(1)'
+ package: ExcelScript!
+ fullName: getTop()
+ summary: >-
+ Specifies the distance, in points, from the top edge of the axis to the top of chart area. Returns `null` if the
+ axis is not visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTop(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getType()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getType:member(1)'
+ package: ExcelScript!
+ fullName: getType()
+ summary: Specifies the axis type. See `ExcelScript.ChartAxisType` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getType(): ChartAxisType;'
+ return:
+ type: ''
+ description: ''
+ - name: getVisible()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getVisible:member(1)'
+ package: ExcelScript!
+ fullName: getVisible()
+ summary: Specifies if the axis is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVisible(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getWidth()
+ uid: 'ExcelScript!ExcelScript.ChartAxis#getWidth:member(1)'
+ package: ExcelScript!
+ fullName: getWidth()
+ summary: 'Specifies the width, in points, of the chart axis. Returns `null` if the axis is not visible.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWidth(): number;'
+ return:
+ type: number
+ description: ''
+ - name: setAlignment(alignment)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setAlignment:member(1)'
+ package: ExcelScript!
+ fullName: setAlignment(alignment)
+ summary: >-
+ Specifies the alignment for the specified axis tick label. See `ExcelScript.ChartTextHorizontalAlignment` for
+ detail.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setAlignment(alignment: ChartTickLabelAlignment): void;'
+ parameters:
+ - id: alignment
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setBaseTimeUnit(baseTimeUnit)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setBaseTimeUnit:member(1)'
+ package: ExcelScript!
+ fullName: setBaseTimeUnit(baseTimeUnit)
+ summary: Specifies the base unit for the specified category axis.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setBaseTimeUnit(baseTimeUnit: ChartAxisTimeUnit): void;'
+ parameters:
+ - id: baseTimeUnit
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setCategoryNames(sourceData)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setCategoryNames:member(1)'
+ package: ExcelScript!
+ fullName: setCategoryNames(sourceData)
+ summary: Sets all the category names for the specified axis.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setCategoryNames(sourceData: Range): void;'
+ parameters:
+ - id: sourceData
+ description: The `Range` object corresponding to the source data.
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setCategoryType(categoryType)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setCategoryType:member(1)'
+ package: ExcelScript!
+ fullName: setCategoryType(categoryType)
+ summary: Specifies the category axis type.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setCategoryType(categoryType: ChartAxisCategoryType): void;'
+ parameters:
+ - id: categoryType
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setCustomDisplayUnit(value)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setCustomDisplayUnit:member(1)'
+ package: ExcelScript!
+ fullName: setCustomDisplayUnit(value)
+ summary: Sets the axis display unit to a custom value.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setCustomDisplayUnit(value: number): void;'
+ parameters:
+ - id: value
+ description: Custom value of the display unit.
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setDisplayUnit(displayUnit)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setDisplayUnit:member(1)'
+ package: ExcelScript!
+ fullName: setDisplayUnit(displayUnit)
+ summary: Represents the axis display unit. See `ExcelScript.ChartAxisDisplayUnit` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setDisplayUnit(displayUnit: ChartAxisDisplayUnit): void;'
+ parameters:
+ - id: displayUnit
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setIsBetweenCategories(isBetweenCategories)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setIsBetweenCategories:member(1)'
+ package: ExcelScript!
+ fullName: setIsBetweenCategories(isBetweenCategories)
+ summary: Specifies if the value axis crosses the category axis between categories.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setIsBetweenCategories(isBetweenCategories: boolean): void;'
+ parameters:
+ - id: isBetweenCategories
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setLinkNumberFormat(linkNumberFormat)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setLinkNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: setLinkNumberFormat(linkNumberFormat)
+ summary: >-
+ Specifies if the number format is linked to the cells. If `true`, the number format will change in the
+ labels when it changes in the cells.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLinkNumberFormat(linkNumberFormat: boolean): void;'
+ parameters:
+ - id: linkNumberFormat
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setLogBase(logBase)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setLogBase:member(1)'
+ package: ExcelScript!
+ fullName: setLogBase(logBase)
+ summary: Specifies the base of the logarithm when using logarithmic scales.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLogBase(logBase: number): void;'
+ parameters:
+ - id: logBase
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setMajorTickMark(majorTickMark)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setMajorTickMark:member(1)'
+ package: ExcelScript!
+ fullName: setMajorTickMark(majorTickMark)
+ summary: Specifies the type of major tick mark for the specified axis. See `ExcelScript.ChartAxisTickMark` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMajorTickMark(majorTickMark: ChartAxisTickMark): void;'
+ parameters:
+ - id: majorTickMark
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setMajorTimeUnitScale(majorTimeUnitScale)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setMajorTimeUnitScale:member(1)'
+ package: ExcelScript!
+ fullName: setMajorTimeUnitScale(majorTimeUnitScale)
+ summary: >-
+ Specifies the major unit scale value for the category axis when the `categoryType` property is set to
+ `dateAxis`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMajorTimeUnitScale(majorTimeUnitScale: ChartAxisTimeUnit): void;'
+ parameters:
+ - id: majorTimeUnitScale
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setMajorUnit(majorUnit)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setMajorUnit:member(1)'
+ package: ExcelScript!
+ fullName: setMajorUnit(majorUnit)
+ summary: Specifies the interval between two major tick marks.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMajorUnit(majorUnit: number): void;'
+ parameters:
+ - id: majorUnit
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setMaximum(maximum)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setMaximum:member(1)'
+ package: ExcelScript!
+ fullName: setMaximum(maximum)
+ summary: Specifies the maximum value on the value axis.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMaximum(maximum: number): void;'
+ parameters:
+ - id: maximum
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setMinimum(minimum)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setMinimum:member(1)'
+ package: ExcelScript!
+ fullName: setMinimum(minimum)
+ summary: Specifies the minimum value on the value axis.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMinimum(minimum: number): void;'
+ parameters:
+ - id: minimum
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setMinorTickMark(minorTickMark)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setMinorTickMark:member(1)'
+ package: ExcelScript!
+ fullName: setMinorTickMark(minorTickMark)
+ summary: Specifies the type of minor tick mark for the specified axis. See `ExcelScript.ChartAxisTickMark` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMinorTickMark(minorTickMark: ChartAxisTickMark): void;'
+ parameters:
+ - id: minorTickMark
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setMinorTimeUnitScale(minorTimeUnitScale)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setMinorTimeUnitScale:member(1)'
+ package: ExcelScript!
+ fullName: setMinorTimeUnitScale(minorTimeUnitScale)
+ summary: >-
+ Specifies the minor unit scale value for the category axis when the `categoryType` property is set to
+ `dateAxis`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMinorTimeUnitScale(minorTimeUnitScale: ChartAxisTimeUnit): void;'
+ parameters:
+ - id: minorTimeUnitScale
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setMinorUnit(minorUnit)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setMinorUnit:member(1)'
+ package: ExcelScript!
+ fullName: setMinorUnit(minorUnit)
+ summary: Specifies the interval between two minor tick marks.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMinorUnit(minorUnit: number): void;'
+ parameters:
+ - id: minorUnit
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setMultiLevel(multiLevel)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setMultiLevel:member(1)'
+ package: ExcelScript!
+ fullName: setMultiLevel(multiLevel)
+ summary: Specifies if an axis is multilevel.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMultiLevel(multiLevel: boolean): void;'
+ parameters:
+ - id: multiLevel
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setNumberFormat(numberFormat)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: setNumberFormat(numberFormat)
+ summary: Specifies the format code for the axis tick label.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setNumberFormat(numberFormat: string): void;'
+ parameters:
+ - id: numberFormat
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setOffset(offset)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setOffset:member(1)'
+ package: ExcelScript!
+ fullName: setOffset(offset)
+ summary: >-
+ Specifies the distance between the levels of labels, and the distance between the first level and the axis line.
+ The value should be an integer from 0 to 1000.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setOffset(offset: number): void;'
+ parameters:
+ - id: offset
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setPosition(position)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setPosition:member(1)'
+ package: ExcelScript!
+ fullName: setPosition(position)
+ summary: >-
+ Specifies the specified axis position where the other axis crosses. See `ExcelScript.ChartAxisPosition` for
+ details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPosition(position: ChartAxisPosition): void;'
+ parameters:
+ - id: position
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setPositionAt(value)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setPositionAt:member(1)'
+ package: ExcelScript!
+ fullName: setPositionAt(value)
+ summary: Sets the specified axis position where the other axis crosses.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPositionAt(value: number): void;'
+ parameters:
+ - id: value
+ description: Custom value of the crossing point.
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setReversePlotOrder(reversePlotOrder)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setReversePlotOrder:member(1)'
+ package: ExcelScript!
+ fullName: setReversePlotOrder(reversePlotOrder)
+ summary: Specifies if Excel plots data points from last to first.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setReversePlotOrder(reversePlotOrder: boolean): void;'
+ parameters:
+ - id: reversePlotOrder
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setScaleType(scaleType)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setScaleType:member(1)'
+ package: ExcelScript!
+ fullName: setScaleType(scaleType)
+ summary: Specifies the value axis scale type. See `ExcelScript.ChartAxisScaleType` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setScaleType(scaleType: ChartAxisScaleType): void;'
+ parameters:
+ - id: scaleType
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setShowDisplayUnitLabel(showDisplayUnitLabel)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setShowDisplayUnitLabel:member(1)'
+ package: ExcelScript!
+ fullName: setShowDisplayUnitLabel(showDisplayUnitLabel)
+ summary: Specifies if the axis display unit label is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowDisplayUnitLabel(showDisplayUnitLabel: boolean): void;'
+ parameters:
+ - id: showDisplayUnitLabel
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setTextOrientation(textOrientation)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setTextOrientation:member(1)'
+ package: ExcelScript!
+ fullName: setTextOrientation(textOrientation)
+ summary: >-
+ Specifies the angle to which the text is oriented for the chart axis tick label. The value should either be an
+ integer from -90 to 90 or the integer 180 for vertically-oriented text.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTextOrientation(textOrientation: number): void;'
+ parameters:
+ - id: textOrientation
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setTickLabelPosition(tickLabelPosition)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setTickLabelPosition:member(1)'
+ package: ExcelScript!
+ fullName: setTickLabelPosition(tickLabelPosition)
+ summary: >-
+ Specifies the position of tick-mark labels on the specified axis. See `ExcelScript.ChartAxisTickLabelPosition` for
+ details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setTickLabelPosition(
+ tickLabelPosition: ChartAxisTickLabelPosition
+ ): void;
+ parameters:
+ - id: tickLabelPosition
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setTickLabelSpacing(tickLabelSpacing)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setTickLabelSpacing:member(1)'
+ package: ExcelScript!
+ fullName: setTickLabelSpacing(tickLabelSpacing)
+ summary: Specifies the number of categories or series between tick-mark labels. Can be a value from 1 through 31999.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTickLabelSpacing(tickLabelSpacing: number): void;'
+ parameters:
+ - id: tickLabelSpacing
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setTickMarkSpacing(tickMarkSpacing)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setTickMarkSpacing:member(1)'
+ package: ExcelScript!
+ fullName: setTickMarkSpacing(tickMarkSpacing)
+ summary: Specifies the number of categories or series between tick marks.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTickMarkSpacing(tickMarkSpacing: number): void;'
+ parameters:
+ - id: tickMarkSpacing
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setVisible(visible)
+ uid: 'ExcelScript!ExcelScript.ChartAxis#setVisible:member(1)'
+ package: ExcelScript!
+ fullName: setVisible(visible)
+ summary: Specifies if the axis is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setVisible(visible: boolean): void;'
+ parameters:
+ - id: visible
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxiscategorytype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxiscategorytype.yml
index b193fde3..382b0a3a 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxiscategorytype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxiscategorytype.yml
@@ -1,22 +1,22 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartAxisCategoryType
-uid: 'ExcelScript!ExcelScript.ChartAxisCategoryType:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartAxisCategoryType
-summary: Specifies the type of the category axis.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: automatic
- uid: 'ExcelScript!ExcelScript.ChartAxisCategoryType.automatic:member'
- package: ExcelScript!
- summary: Excel controls the axis type.
- - name: dateAxis
- uid: 'ExcelScript!ExcelScript.ChartAxisCategoryType.dateAxis:member'
- package: ExcelScript!
- summary: Axis groups data on a time scale.
- - name: textAxis
- uid: 'ExcelScript!ExcelScript.ChartAxisCategoryType.textAxis:member'
- package: ExcelScript!
- summary: Axis groups data by an arbitrary set of categories.
+### YamlMime:TSEnum
+name: ExcelScript.ChartAxisCategoryType
+uid: 'ExcelScript!ExcelScript.ChartAxisCategoryType:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartAxisCategoryType
+summary: Specifies the type of the category axis.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: automatic
+ uid: 'ExcelScript!ExcelScript.ChartAxisCategoryType.automatic:member'
+ package: ExcelScript!
+ summary: Excel controls the axis type.
+ - name: dateAxis
+ uid: 'ExcelScript!ExcelScript.ChartAxisCategoryType.dateAxis:member'
+ package: ExcelScript!
+ summary: Axis groups data on a time scale.
+ - name: textAxis
+ uid: 'ExcelScript!ExcelScript.ChartAxisCategoryType.textAxis:member'
+ package: ExcelScript!
+ summary: Axis groups data by an arbitrary set of categories.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisdisplayunit.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisdisplayunit.yml
index 8686cd8b..a4dcfab8 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisdisplayunit.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisdisplayunit.yml
@@ -1,54 +1,54 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartAxisDisplayUnit
-uid: 'ExcelScript!ExcelScript.ChartAxisDisplayUnit:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartAxisDisplayUnit
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: billions
- uid: 'ExcelScript!ExcelScript.ChartAxisDisplayUnit.billions:member'
- package: ExcelScript!
- summary: This will set the axis in units of billions.
- - name: custom
- uid: 'ExcelScript!ExcelScript.ChartAxisDisplayUnit.custom:member'
- package: ExcelScript!
- summary: This will set the axis in units of custom value.
- - name: hundredMillions
- uid: 'ExcelScript!ExcelScript.ChartAxisDisplayUnit.hundredMillions:member'
- package: ExcelScript!
- summary: This will set the axis in units of hundreds of millions.
- - name: hundreds
- uid: 'ExcelScript!ExcelScript.ChartAxisDisplayUnit.hundreds:member'
- package: ExcelScript!
- summary: This will set the axis in units of hundreds.
- - name: hundredThousands
- uid: 'ExcelScript!ExcelScript.ChartAxisDisplayUnit.hundredThousands:member'
- package: ExcelScript!
- summary: This will set the axis in units of hundreds of thousands.
- - name: millions
- uid: 'ExcelScript!ExcelScript.ChartAxisDisplayUnit.millions:member'
- package: ExcelScript!
- summary: This will set the axis in units of millions.
- - name: none
- uid: 'ExcelScript!ExcelScript.ChartAxisDisplayUnit.none:member'
- package: ExcelScript!
- summary: 'Default option. This will reset display unit to the axis, and set unit label invisible.'
- - name: tenMillions
- uid: 'ExcelScript!ExcelScript.ChartAxisDisplayUnit.tenMillions:member'
- package: ExcelScript!
- summary: This will set the axis in units of tens of millions.
- - name: tenThousands
- uid: 'ExcelScript!ExcelScript.ChartAxisDisplayUnit.tenThousands:member'
- package: ExcelScript!
- summary: This will set the axis in units of tens of thousands.
- - name: thousands
- uid: 'ExcelScript!ExcelScript.ChartAxisDisplayUnit.thousands:member'
- package: ExcelScript!
- summary: This will set the axis in units of thousands.
- - name: trillions
- uid: 'ExcelScript!ExcelScript.ChartAxisDisplayUnit.trillions:member'
- package: ExcelScript!
- summary: This will set the axis in units of trillions.
+### YamlMime:TSEnum
+name: ExcelScript.ChartAxisDisplayUnit
+uid: 'ExcelScript!ExcelScript.ChartAxisDisplayUnit:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartAxisDisplayUnit
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: billions
+ uid: 'ExcelScript!ExcelScript.ChartAxisDisplayUnit.billions:member'
+ package: ExcelScript!
+ summary: This will set the axis in units of billions.
+ - name: custom
+ uid: 'ExcelScript!ExcelScript.ChartAxisDisplayUnit.custom:member'
+ package: ExcelScript!
+ summary: This will set the axis in units of custom value.
+ - name: hundredMillions
+ uid: 'ExcelScript!ExcelScript.ChartAxisDisplayUnit.hundredMillions:member'
+ package: ExcelScript!
+ summary: This will set the axis in units of hundreds of millions.
+ - name: hundreds
+ uid: 'ExcelScript!ExcelScript.ChartAxisDisplayUnit.hundreds:member'
+ package: ExcelScript!
+ summary: This will set the axis in units of hundreds.
+ - name: hundredThousands
+ uid: 'ExcelScript!ExcelScript.ChartAxisDisplayUnit.hundredThousands:member'
+ package: ExcelScript!
+ summary: This will set the axis in units of hundreds of thousands.
+ - name: millions
+ uid: 'ExcelScript!ExcelScript.ChartAxisDisplayUnit.millions:member'
+ package: ExcelScript!
+ summary: This will set the axis in units of millions.
+ - name: none
+ uid: 'ExcelScript!ExcelScript.ChartAxisDisplayUnit.none:member'
+ package: ExcelScript!
+ summary: 'Default option. This will reset display unit to the axis, and set unit label invisible.'
+ - name: tenMillions
+ uid: 'ExcelScript!ExcelScript.ChartAxisDisplayUnit.tenMillions:member'
+ package: ExcelScript!
+ summary: This will set the axis in units of tens of millions.
+ - name: tenThousands
+ uid: 'ExcelScript!ExcelScript.ChartAxisDisplayUnit.tenThousands:member'
+ package: ExcelScript!
+ summary: This will set the axis in units of tens of thousands.
+ - name: thousands
+ uid: 'ExcelScript!ExcelScript.ChartAxisDisplayUnit.thousands:member'
+ package: ExcelScript!
+ summary: This will set the axis in units of thousands.
+ - name: trillions
+ uid: 'ExcelScript!ExcelScript.ChartAxisDisplayUnit.trillions:member'
+ package: ExcelScript!
+ summary: This will set the axis in units of trillions.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisformat.yml
index 288a4cfb..1130e7c0 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisformat.yml
@@ -1,50 +1,50 @@
-### YamlMime:TSType
-name: ExcelScript.ChartAxisFormat
-uid: 'ExcelScript!ExcelScript.ChartAxisFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartAxisFormat
-summary: Encapsulates the format properties for the chart axis.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getFill()
- uid: 'ExcelScript!ExcelScript.ChartAxisFormat#getFill:member(1)'
- package: ExcelScript!
- fullName: getFill()
- summary: Specifies chart fill formatting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFill(): ChartFill;'
- return:
- type: ''
- description: ''
- - name: getFont()
- uid: 'ExcelScript!ExcelScript.ChartAxisFormat#getFont:member(1)'
- package: ExcelScript!
- fullName: getFont()
- summary: 'Specifies the font attributes (font name, font size, color, etc.) for a chart axis element.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFont(): ChartFont;'
- return:
- type: ''
- description: ''
- - name: getLine()
- uid: 'ExcelScript!ExcelScript.ChartAxisFormat#getLine:member(1)'
- package: ExcelScript!
- fullName: getLine()
- summary: Specifies chart line formatting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLine(): ChartLineFormat;'
- return:
- type: ''
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartAxisFormat
+uid: 'ExcelScript!ExcelScript.ChartAxisFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartAxisFormat
+summary: Encapsulates the format properties for the chart axis.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getFill()
+ uid: 'ExcelScript!ExcelScript.ChartAxisFormat#getFill:member(1)'
+ package: ExcelScript!
+ fullName: getFill()
+ summary: Specifies chart fill formatting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFill(): ChartFill;'
+ return:
+ type: ''
+ description: ''
+ - name: getFont()
+ uid: 'ExcelScript!ExcelScript.ChartAxisFormat#getFont:member(1)'
+ package: ExcelScript!
+ fullName: getFont()
+ summary: 'Specifies the font attributes (font name, font size, color, etc.) for a chart axis element.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFont(): ChartFont;'
+ return:
+ type: ''
+ description: ''
+ - name: getLine()
+ uid: 'ExcelScript!ExcelScript.ChartAxisFormat#getLine:member(1)'
+ package: ExcelScript!
+ fullName: getLine()
+ summary: Specifies chart line formatting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLine(): ChartLineFormat;'
+ return:
+ type: ''
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisgroup.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisgroup.yml
index 9228f46b..8c2fddde 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisgroup.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisgroup.yml
@@ -1,18 +1,18 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartAxisGroup
-uid: 'ExcelScript!ExcelScript.ChartAxisGroup:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartAxisGroup
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: primary
- uid: 'ExcelScript!ExcelScript.ChartAxisGroup.primary:member'
- package: ExcelScript!
- summary: ''
- - name: secondary
- uid: 'ExcelScript!ExcelScript.ChartAxisGroup.secondary:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartAxisGroup
+uid: 'ExcelScript!ExcelScript.ChartAxisGroup:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartAxisGroup
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: primary
+ uid: 'ExcelScript!ExcelScript.ChartAxisGroup.primary:member'
+ package: ExcelScript!
+ summary: ''
+ - name: secondary
+ uid: 'ExcelScript!ExcelScript.ChartAxisGroup.secondary:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisposition.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisposition.yml
index f5614f0f..d5fb6e28 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisposition.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisposition.yml
@@ -1,26 +1,26 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartAxisPosition
-uid: 'ExcelScript!ExcelScript.ChartAxisPosition:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartAxisPosition
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: automatic
- uid: 'ExcelScript!ExcelScript.ChartAxisPosition.automatic:member'
- package: ExcelScript!
- summary: ''
- - name: custom
- uid: 'ExcelScript!ExcelScript.ChartAxisPosition.custom:member'
- package: ExcelScript!
- summary: ''
- - name: maximum
- uid: 'ExcelScript!ExcelScript.ChartAxisPosition.maximum:member'
- package: ExcelScript!
- summary: ''
- - name: minimum
- uid: 'ExcelScript!ExcelScript.ChartAxisPosition.minimum:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartAxisPosition
+uid: 'ExcelScript!ExcelScript.ChartAxisPosition:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartAxisPosition
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: automatic
+ uid: 'ExcelScript!ExcelScript.ChartAxisPosition.automatic:member'
+ package: ExcelScript!
+ summary: ''
+ - name: custom
+ uid: 'ExcelScript!ExcelScript.ChartAxisPosition.custom:member'
+ package: ExcelScript!
+ summary: ''
+ - name: maximum
+ uid: 'ExcelScript!ExcelScript.ChartAxisPosition.maximum:member'
+ package: ExcelScript!
+ summary: ''
+ - name: minimum
+ uid: 'ExcelScript!ExcelScript.ChartAxisPosition.minimum:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisscaletype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisscaletype.yml
index ebd89df7..212465ca 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisscaletype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisscaletype.yml
@@ -1,18 +1,18 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartAxisScaleType
-uid: 'ExcelScript!ExcelScript.ChartAxisScaleType:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartAxisScaleType
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: linear
- uid: 'ExcelScript!ExcelScript.ChartAxisScaleType.linear:member'
- package: ExcelScript!
- summary: ''
- - name: logarithmic
- uid: 'ExcelScript!ExcelScript.ChartAxisScaleType.logarithmic:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartAxisScaleType
+uid: 'ExcelScript!ExcelScript.ChartAxisScaleType:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartAxisScaleType
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: linear
+ uid: 'ExcelScript!ExcelScript.ChartAxisScaleType.linear:member'
+ package: ExcelScript!
+ summary: ''
+ - name: logarithmic
+ uid: 'ExcelScript!ExcelScript.ChartAxisScaleType.logarithmic:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisticklabelposition.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisticklabelposition.yml
index 43d74faa..821db1b1 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisticklabelposition.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxisticklabelposition.yml
@@ -1,26 +1,26 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartAxisTickLabelPosition
-uid: 'ExcelScript!ExcelScript.ChartAxisTickLabelPosition:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartAxisTickLabelPosition
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: high
- uid: 'ExcelScript!ExcelScript.ChartAxisTickLabelPosition.high:member'
- package: ExcelScript!
- summary: ''
- - name: low
- uid: 'ExcelScript!ExcelScript.ChartAxisTickLabelPosition.low:member'
- package: ExcelScript!
- summary: ''
- - name: nextToAxis
- uid: 'ExcelScript!ExcelScript.ChartAxisTickLabelPosition.nextToAxis:member'
- package: ExcelScript!
- summary: ''
- - name: none
- uid: 'ExcelScript!ExcelScript.ChartAxisTickLabelPosition.none:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartAxisTickLabelPosition
+uid: 'ExcelScript!ExcelScript.ChartAxisTickLabelPosition:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartAxisTickLabelPosition
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: high
+ uid: 'ExcelScript!ExcelScript.ChartAxisTickLabelPosition.high:member'
+ package: ExcelScript!
+ summary: ''
+ - name: low
+ uid: 'ExcelScript!ExcelScript.ChartAxisTickLabelPosition.low:member'
+ package: ExcelScript!
+ summary: ''
+ - name: nextToAxis
+ uid: 'ExcelScript!ExcelScript.ChartAxisTickLabelPosition.nextToAxis:member'
+ package: ExcelScript!
+ summary: ''
+ - name: none
+ uid: 'ExcelScript!ExcelScript.ChartAxisTickLabelPosition.none:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxistickmark.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxistickmark.yml
index 46936b2b..9da6f91c 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxistickmark.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxistickmark.yml
@@ -1,26 +1,26 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartAxisTickMark
-uid: 'ExcelScript!ExcelScript.ChartAxisTickMark:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartAxisTickMark
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: cross
- uid: 'ExcelScript!ExcelScript.ChartAxisTickMark.cross:member'
- package: ExcelScript!
- summary: ''
- - name: inside
- uid: 'ExcelScript!ExcelScript.ChartAxisTickMark.inside:member'
- package: ExcelScript!
- summary: ''
- - name: none
- uid: 'ExcelScript!ExcelScript.ChartAxisTickMark.none:member'
- package: ExcelScript!
- summary: ''
- - name: outside
- uid: 'ExcelScript!ExcelScript.ChartAxisTickMark.outside:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartAxisTickMark
+uid: 'ExcelScript!ExcelScript.ChartAxisTickMark:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartAxisTickMark
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: cross
+ uid: 'ExcelScript!ExcelScript.ChartAxisTickMark.cross:member'
+ package: ExcelScript!
+ summary: ''
+ - name: inside
+ uid: 'ExcelScript!ExcelScript.ChartAxisTickMark.inside:member'
+ package: ExcelScript!
+ summary: ''
+ - name: none
+ uid: 'ExcelScript!ExcelScript.ChartAxisTickMark.none:member'
+ package: ExcelScript!
+ summary: ''
+ - name: outside
+ uid: 'ExcelScript!ExcelScript.ChartAxisTickMark.outside:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxistimeunit.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxistimeunit.yml
index 5ab33754..600a1ab6 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxistimeunit.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxistimeunit.yml
@@ -1,22 +1,22 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartAxisTimeUnit
-uid: 'ExcelScript!ExcelScript.ChartAxisTimeUnit:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartAxisTimeUnit
-summary: Specifies the unit of time for chart axes and data series.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: days
- uid: 'ExcelScript!ExcelScript.ChartAxisTimeUnit.days:member'
- package: ExcelScript!
- summary: ''
- - name: months
- uid: 'ExcelScript!ExcelScript.ChartAxisTimeUnit.months:member'
- package: ExcelScript!
- summary: ''
- - name: years
- uid: 'ExcelScript!ExcelScript.ChartAxisTimeUnit.years:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartAxisTimeUnit
+uid: 'ExcelScript!ExcelScript.ChartAxisTimeUnit:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartAxisTimeUnit
+summary: Specifies the unit of time for chart axes and data series.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: days
+ uid: 'ExcelScript!ExcelScript.ChartAxisTimeUnit.days:member'
+ package: ExcelScript!
+ summary: ''
+ - name: months
+ uid: 'ExcelScript!ExcelScript.ChartAxisTimeUnit.months:member'
+ package: ExcelScript!
+ summary: ''
+ - name: years
+ uid: 'ExcelScript!ExcelScript.ChartAxisTimeUnit.years:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxistitle.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxistitle.yml
index 5f023024..a2736711 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxistitle.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxistitle.yml
@@ -1,135 +1,135 @@
-### YamlMime:TSType
-name: ExcelScript.ChartAxisTitle
-uid: 'ExcelScript!ExcelScript.ChartAxisTitle:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartAxisTitle
-summary: Represents the title of a chart axis.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getFormat()
- uid: 'ExcelScript!ExcelScript.ChartAxisTitle#getFormat:member(1)'
- package: ExcelScript!
- fullName: getFormat()
- summary: Specifies the formatting of the chart axis title.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormat(): ChartAxisTitleFormat;'
- return:
- type: ''
- description: ''
- - name: getText()
- uid: 'ExcelScript!ExcelScript.ChartAxisTitle#getText:member(1)'
- package: ExcelScript!
- fullName: getText()
- summary: Specifies the axis title.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getText(): string;'
- return:
- type: string
- description: ''
- - name: getTextOrientation()
- uid: 'ExcelScript!ExcelScript.ChartAxisTitle#getTextOrientation:member(1)'
- package: ExcelScript!
- fullName: getTextOrientation()
- summary: >-
- Specifies the angle to which the text is oriented for the chart axis title. The value should either be an integer
- from -90 to 90 or the integer 180 for vertically-oriented text.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTextOrientation(): number;'
- return:
- type: number
- description: ''
- - name: getVisible()
- uid: 'ExcelScript!ExcelScript.ChartAxisTitle#getVisible:member(1)'
- package: ExcelScript!
- fullName: getVisible()
- summary: Specifies if the axis title is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVisible(): boolean;'
- return:
- type: boolean
- description: ''
- - name: setFormula(formula)
- uid: 'ExcelScript!ExcelScript.ChartAxisTitle#setFormula:member(1)'
- package: ExcelScript!
- fullName: setFormula(formula)
- summary: A string value that represents the formula of chart axis title using A1-style notation.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFormula(formula: string): void;'
- parameters:
- - id: formula
- description: A string that represents the formula to set.
- type: string
- return:
- type: void
- description: ''
- - name: setText(text)
- uid: 'ExcelScript!ExcelScript.ChartAxisTitle#setText:member(1)'
- package: ExcelScript!
- fullName: setText(text)
- summary: Specifies the axis title.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setText(text: string): void;'
- parameters:
- - id: text
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setTextOrientation(textOrientation)
- uid: 'ExcelScript!ExcelScript.ChartAxisTitle#setTextOrientation:member(1)'
- package: ExcelScript!
- fullName: setTextOrientation(textOrientation)
- summary: >-
- Specifies the angle to which the text is oriented for the chart axis title. The value should either be an integer
- from -90 to 90 or the integer 180 for vertically-oriented text.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTextOrientation(textOrientation: number): void;'
- parameters:
- - id: textOrientation
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setVisible(visible)
- uid: 'ExcelScript!ExcelScript.ChartAxisTitle#setVisible:member(1)'
- package: ExcelScript!
- fullName: setVisible(visible)
- summary: Specifies if the axis title is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setVisible(visible: boolean): void;'
- parameters:
- - id: visible
- description: ''
- type: boolean
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartAxisTitle
+uid: 'ExcelScript!ExcelScript.ChartAxisTitle:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartAxisTitle
+summary: Represents the title of a chart axis.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getFormat()
+ uid: 'ExcelScript!ExcelScript.ChartAxisTitle#getFormat:member(1)'
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: Specifies the formatting of the chart axis title.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): ChartAxisTitleFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getText()
+ uid: 'ExcelScript!ExcelScript.ChartAxisTitle#getText:member(1)'
+ package: ExcelScript!
+ fullName: getText()
+ summary: Specifies the axis title.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getText(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getTextOrientation()
+ uid: 'ExcelScript!ExcelScript.ChartAxisTitle#getTextOrientation:member(1)'
+ package: ExcelScript!
+ fullName: getTextOrientation()
+ summary: >-
+ Specifies the angle to which the text is oriented for the chart axis title. The value should either be an integer
+ from -90 to 90 or the integer 180 for vertically-oriented text.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTextOrientation(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getVisible()
+ uid: 'ExcelScript!ExcelScript.ChartAxisTitle#getVisible:member(1)'
+ package: ExcelScript!
+ fullName: getVisible()
+ summary: Specifies if the axis title is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVisible(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: setFormula(formula)
+ uid: 'ExcelScript!ExcelScript.ChartAxisTitle#setFormula:member(1)'
+ package: ExcelScript!
+ fullName: setFormula(formula)
+ summary: A string value that represents the formula of chart axis title using A1-style notation.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFormula(formula: string): void;'
+ parameters:
+ - id: formula
+ description: A string that represents the formula to set.
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setText(text)
+ uid: 'ExcelScript!ExcelScript.ChartAxisTitle#setText:member(1)'
+ package: ExcelScript!
+ fullName: setText(text)
+ summary: Specifies the axis title.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setText(text: string): void;'
+ parameters:
+ - id: text
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setTextOrientation(textOrientation)
+ uid: 'ExcelScript!ExcelScript.ChartAxisTitle#setTextOrientation:member(1)'
+ package: ExcelScript!
+ fullName: setTextOrientation(textOrientation)
+ summary: >-
+ Specifies the angle to which the text is oriented for the chart axis title. The value should either be an integer
+ from -90 to 90 or the integer 180 for vertically-oriented text.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTextOrientation(textOrientation: number): void;'
+ parameters:
+ - id: textOrientation
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setVisible(visible)
+ uid: 'ExcelScript!ExcelScript.ChartAxisTitle#setVisible:member(1)'
+ package: ExcelScript!
+ fullName: setVisible(visible)
+ summary: Specifies if the axis title is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setVisible(visible: boolean): void;'
+ parameters:
+ - id: visible
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxistitleformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxistitleformat.yml
index 6c9bb1cf..37efc830 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxistitleformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxistitleformat.yml
@@ -1,52 +1,52 @@
-### YamlMime:TSType
-name: ExcelScript.ChartAxisTitleFormat
-uid: 'ExcelScript!ExcelScript.ChartAxisTitleFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartAxisTitleFormat
-summary: Represents the chart axis title formatting.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getBorder()
- uid: 'ExcelScript!ExcelScript.ChartAxisTitleFormat#getBorder:member(1)'
- package: ExcelScript!
- fullName: getBorder()
- summary: 'Specifies the chart axis title''s border format, which includes color, linestyle, and weight.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBorder(): ChartBorder;'
- return:
- type: ''
- description: ''
- - name: getFill()
- uid: 'ExcelScript!ExcelScript.ChartAxisTitleFormat#getFill:member(1)'
- package: ExcelScript!
- fullName: getFill()
- summary: Specifies the chart axis title's fill formatting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFill(): ChartFill;'
- return:
- type: ''
- description: ''
- - name: getFont()
- uid: 'ExcelScript!ExcelScript.ChartAxisTitleFormat#getFont:member(1)'
- package: ExcelScript!
- fullName: getFont()
- summary: >-
- Specifies the chart axis title's font attributes, such as font name, font size, or color, of the chart axis title
- object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFont(): ChartFont;'
- return:
- type: ''
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartAxisTitleFormat
+uid: 'ExcelScript!ExcelScript.ChartAxisTitleFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartAxisTitleFormat
+summary: Represents the chart axis title formatting.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getBorder()
+ uid: 'ExcelScript!ExcelScript.ChartAxisTitleFormat#getBorder:member(1)'
+ package: ExcelScript!
+ fullName: getBorder()
+ summary: 'Specifies the chart axis title''s border format, which includes color, linestyle, and weight.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBorder(): ChartBorder;'
+ return:
+ type: ''
+ description: ''
+ - name: getFill()
+ uid: 'ExcelScript!ExcelScript.ChartAxisTitleFormat#getFill:member(1)'
+ package: ExcelScript!
+ fullName: getFill()
+ summary: Specifies the chart axis title's fill formatting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFill(): ChartFill;'
+ return:
+ type: ''
+ description: ''
+ - name: getFont()
+ uid: 'ExcelScript!ExcelScript.ChartAxisTitleFormat#getFont:member(1)'
+ package: ExcelScript!
+ fullName: getFont()
+ summary: >-
+ Specifies the chart axis title's font attributes, such as font name, font size, or color, of the chart axis title
+ object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFont(): ChartFont;'
+ return:
+ type: ''
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxistype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxistype.yml
index 36877dc1..9d9bb0aa 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxistype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartaxistype.yml
@@ -1,26 +1,26 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartAxisType
-uid: 'ExcelScript!ExcelScript.ChartAxisType:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartAxisType
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: category
- uid: 'ExcelScript!ExcelScript.ChartAxisType.category:member'
- package: ExcelScript!
- summary: Axis displays categories.
- - name: invalid
- uid: 'ExcelScript!ExcelScript.ChartAxisType.invalid:member'
- package: ExcelScript!
- summary: ''
- - name: series
- uid: 'ExcelScript!ExcelScript.ChartAxisType.series:member'
- package: ExcelScript!
- summary: Axis displays data series.
- - name: value
- uid: 'ExcelScript!ExcelScript.ChartAxisType.value:member'
- package: ExcelScript!
- summary: Axis displays values.
+### YamlMime:TSEnum
+name: ExcelScript.ChartAxisType
+uid: 'ExcelScript!ExcelScript.ChartAxisType:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartAxisType
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: category
+ uid: 'ExcelScript!ExcelScript.ChartAxisType.category:member'
+ package: ExcelScript!
+ summary: Axis displays categories.
+ - name: invalid
+ uid: 'ExcelScript!ExcelScript.ChartAxisType.invalid:member'
+ package: ExcelScript!
+ summary: ''
+ - name: series
+ uid: 'ExcelScript!ExcelScript.ChartAxisType.series:member'
+ package: ExcelScript!
+ summary: Axis displays data series.
+ - name: value
+ uid: 'ExcelScript!ExcelScript.ChartAxisType.value:member'
+ package: ExcelScript!
+ summary: Axis displays values.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartbinoptions.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartbinoptions.yml
index 89ba673d..cd673aa6 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartbinoptions.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartbinoptions.yml
@@ -1,221 +1,221 @@
-### YamlMime:TSType
-name: ExcelScript.ChartBinOptions
-uid: 'ExcelScript!ExcelScript.ChartBinOptions:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartBinOptions
-summary: Encapsulates the bin options for histogram charts and pareto charts.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getAllowOverflow()
- uid: 'ExcelScript!ExcelScript.ChartBinOptions#getAllowOverflow:member(1)'
- package: ExcelScript!
- fullName: getAllowOverflow()
- summary: Specifies if bin overflow is enabled in a histogram chart or pareto chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAllowOverflow(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getAllowUnderflow()
- uid: 'ExcelScript!ExcelScript.ChartBinOptions#getAllowUnderflow:member(1)'
- package: ExcelScript!
- fullName: getAllowUnderflow()
- summary: Specifies if bin underflow is enabled in a histogram chart or pareto chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAllowUnderflow(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getCount()
- uid: 'ExcelScript!ExcelScript.ChartBinOptions#getCount:member(1)'
- package: ExcelScript!
- fullName: getCount()
- summary: Specifies the bin count of a histogram chart or pareto chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCount(): number;'
- return:
- type: number
- description: ''
- - name: getOverflowValue()
- uid: 'ExcelScript!ExcelScript.ChartBinOptions#getOverflowValue:member(1)'
- package: ExcelScript!
- fullName: getOverflowValue()
- summary: Specifies the bin overflow value of a histogram chart or pareto chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getOverflowValue(): number;'
- return:
- type: number
- description: ''
- - name: getType()
- uid: 'ExcelScript!ExcelScript.ChartBinOptions#getType:member(1)'
- package: ExcelScript!
- fullName: getType()
- summary: Specifies the bin's type for a histogram chart or pareto chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getType(): ChartBinType;'
- return:
- type: ''
- description: ''
- - name: getUnderflowValue()
- uid: 'ExcelScript!ExcelScript.ChartBinOptions#getUnderflowValue:member(1)'
- package: ExcelScript!
- fullName: getUnderflowValue()
- summary: Specifies the bin underflow value of a histogram chart or pareto chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getUnderflowValue(): number;'
- return:
- type: number
- description: ''
- - name: getWidth()
- uid: 'ExcelScript!ExcelScript.ChartBinOptions#getWidth:member(1)'
- package: ExcelScript!
- fullName: getWidth()
- summary: Specifies the bin width value of a histogram chart or pareto chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWidth(): number;'
- return:
- type: number
- description: ''
- - name: setAllowOverflow(allowOverflow)
- uid: 'ExcelScript!ExcelScript.ChartBinOptions#setAllowOverflow:member(1)'
- package: ExcelScript!
- fullName: setAllowOverflow(allowOverflow)
- summary: Specifies if bin overflow is enabled in a histogram chart or pareto chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setAllowOverflow(allowOverflow: boolean): void;'
- parameters:
- - id: allowOverflow
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setAllowUnderflow(allowUnderflow)
- uid: 'ExcelScript!ExcelScript.ChartBinOptions#setAllowUnderflow:member(1)'
- package: ExcelScript!
- fullName: setAllowUnderflow(allowUnderflow)
- summary: Specifies if bin underflow is enabled in a histogram chart or pareto chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setAllowUnderflow(allowUnderflow: boolean): void;'
- parameters:
- - id: allowUnderflow
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setCount(count)
- uid: 'ExcelScript!ExcelScript.ChartBinOptions#setCount:member(1)'
- package: ExcelScript!
- fullName: setCount(count)
- summary: Specifies the bin count of a histogram chart or pareto chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setCount(count: number): void;'
- parameters:
- - id: count
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setOverflowValue(overflowValue)
- uid: 'ExcelScript!ExcelScript.ChartBinOptions#setOverflowValue:member(1)'
- package: ExcelScript!
- fullName: setOverflowValue(overflowValue)
- summary: Specifies the bin overflow value of a histogram chart or pareto chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setOverflowValue(overflowValue: number): void;'
- parameters:
- - id: overflowValue
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setType(type)
- uid: 'ExcelScript!ExcelScript.ChartBinOptions#setType:member(1)'
- package: ExcelScript!
- fullName: setType(type)
- summary: Specifies the bin's type for a histogram chart or pareto chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setType(type: ChartBinType): void;'
- parameters:
- - id: type
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setUnderflowValue(underflowValue)
- uid: 'ExcelScript!ExcelScript.ChartBinOptions#setUnderflowValue:member(1)'
- package: ExcelScript!
- fullName: setUnderflowValue(underflowValue)
- summary: Specifies the bin underflow value of a histogram chart or pareto chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setUnderflowValue(underflowValue: number): void;'
- parameters:
- - id: underflowValue
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setWidth(width)
- uid: 'ExcelScript!ExcelScript.ChartBinOptions#setWidth:member(1)'
- package: ExcelScript!
- fullName: setWidth(width)
- summary: Specifies the bin width value of a histogram chart or pareto chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setWidth(width: number): void;'
- parameters:
- - id: width
- description: ''
- type: number
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartBinOptions
+uid: 'ExcelScript!ExcelScript.ChartBinOptions:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartBinOptions
+summary: Encapsulates the bin options for histogram charts and pareto charts.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getAllowOverflow()
+ uid: 'ExcelScript!ExcelScript.ChartBinOptions#getAllowOverflow:member(1)'
+ package: ExcelScript!
+ fullName: getAllowOverflow()
+ summary: Specifies if bin overflow is enabled in a histogram chart or pareto chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAllowOverflow(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getAllowUnderflow()
+ uid: 'ExcelScript!ExcelScript.ChartBinOptions#getAllowUnderflow:member(1)'
+ package: ExcelScript!
+ fullName: getAllowUnderflow()
+ summary: Specifies if bin underflow is enabled in a histogram chart or pareto chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAllowUnderflow(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getCount()
+ uid: 'ExcelScript!ExcelScript.ChartBinOptions#getCount:member(1)'
+ package: ExcelScript!
+ fullName: getCount()
+ summary: Specifies the bin count of a histogram chart or pareto chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCount(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getOverflowValue()
+ uid: 'ExcelScript!ExcelScript.ChartBinOptions#getOverflowValue:member(1)'
+ package: ExcelScript!
+ fullName: getOverflowValue()
+ summary: Specifies the bin overflow value of a histogram chart or pareto chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getOverflowValue(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getType()
+ uid: 'ExcelScript!ExcelScript.ChartBinOptions#getType:member(1)'
+ package: ExcelScript!
+ fullName: getType()
+ summary: Specifies the bin's type for a histogram chart or pareto chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getType(): ChartBinType;'
+ return:
+ type: ''
+ description: ''
+ - name: getUnderflowValue()
+ uid: 'ExcelScript!ExcelScript.ChartBinOptions#getUnderflowValue:member(1)'
+ package: ExcelScript!
+ fullName: getUnderflowValue()
+ summary: Specifies the bin underflow value of a histogram chart or pareto chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getUnderflowValue(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getWidth()
+ uid: 'ExcelScript!ExcelScript.ChartBinOptions#getWidth:member(1)'
+ package: ExcelScript!
+ fullName: getWidth()
+ summary: Specifies the bin width value of a histogram chart or pareto chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWidth(): number;'
+ return:
+ type: number
+ description: ''
+ - name: setAllowOverflow(allowOverflow)
+ uid: 'ExcelScript!ExcelScript.ChartBinOptions#setAllowOverflow:member(1)'
+ package: ExcelScript!
+ fullName: setAllowOverflow(allowOverflow)
+ summary: Specifies if bin overflow is enabled in a histogram chart or pareto chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setAllowOverflow(allowOverflow: boolean): void;'
+ parameters:
+ - id: allowOverflow
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setAllowUnderflow(allowUnderflow)
+ uid: 'ExcelScript!ExcelScript.ChartBinOptions#setAllowUnderflow:member(1)'
+ package: ExcelScript!
+ fullName: setAllowUnderflow(allowUnderflow)
+ summary: Specifies if bin underflow is enabled in a histogram chart or pareto chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setAllowUnderflow(allowUnderflow: boolean): void;'
+ parameters:
+ - id: allowUnderflow
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setCount(count)
+ uid: 'ExcelScript!ExcelScript.ChartBinOptions#setCount:member(1)'
+ package: ExcelScript!
+ fullName: setCount(count)
+ summary: Specifies the bin count of a histogram chart or pareto chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setCount(count: number): void;'
+ parameters:
+ - id: count
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setOverflowValue(overflowValue)
+ uid: 'ExcelScript!ExcelScript.ChartBinOptions#setOverflowValue:member(1)'
+ package: ExcelScript!
+ fullName: setOverflowValue(overflowValue)
+ summary: Specifies the bin overflow value of a histogram chart or pareto chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setOverflowValue(overflowValue: number): void;'
+ parameters:
+ - id: overflowValue
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setType(type)
+ uid: 'ExcelScript!ExcelScript.ChartBinOptions#setType:member(1)'
+ package: ExcelScript!
+ fullName: setType(type)
+ summary: Specifies the bin's type for a histogram chart or pareto chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setType(type: ChartBinType): void;'
+ parameters:
+ - id: type
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setUnderflowValue(underflowValue)
+ uid: 'ExcelScript!ExcelScript.ChartBinOptions#setUnderflowValue:member(1)'
+ package: ExcelScript!
+ fullName: setUnderflowValue(underflowValue)
+ summary: Specifies the bin underflow value of a histogram chart or pareto chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setUnderflowValue(underflowValue: number): void;'
+ parameters:
+ - id: underflowValue
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setWidth(width)
+ uid: 'ExcelScript!ExcelScript.ChartBinOptions#setWidth:member(1)'
+ package: ExcelScript!
+ fullName: setWidth(width)
+ summary: Specifies the bin width value of a histogram chart or pareto chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setWidth(width: number): void;'
+ parameters:
+ - id: width
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartbintype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartbintype.yml
index 817c4e3e..db382358 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartbintype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartbintype.yml
@@ -1,26 +1,26 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartBinType
-uid: 'ExcelScript!ExcelScript.ChartBinType:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartBinType
-summary: Specifies the bin type of a histogram chart or pareto chart series.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: auto
- uid: 'ExcelScript!ExcelScript.ChartBinType.auto:member'
- package: ExcelScript!
- summary: ''
- - name: binCount
- uid: 'ExcelScript!ExcelScript.ChartBinType.binCount:member'
- package: ExcelScript!
- summary: ''
- - name: binWidth
- uid: 'ExcelScript!ExcelScript.ChartBinType.binWidth:member'
- package: ExcelScript!
- summary: ''
- - name: category
- uid: 'ExcelScript!ExcelScript.ChartBinType.category:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartBinType
+uid: 'ExcelScript!ExcelScript.ChartBinType:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartBinType
+summary: Specifies the bin type of a histogram chart or pareto chart series.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: auto
+ uid: 'ExcelScript!ExcelScript.ChartBinType.auto:member'
+ package: ExcelScript!
+ summary: ''
+ - name: binCount
+ uid: 'ExcelScript!ExcelScript.ChartBinType.binCount:member'
+ package: ExcelScript!
+ summary: ''
+ - name: binWidth
+ uid: 'ExcelScript!ExcelScript.ChartBinType.binWidth:member'
+ package: ExcelScript!
+ summary: ''
+ - name: category
+ uid: 'ExcelScript!ExcelScript.ChartBinType.category:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartborder.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartborder.yml
index dd5e6ee8..60535397 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartborder.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartborder.yml
@@ -1,114 +1,114 @@
-### YamlMime:TSType
-name: ExcelScript.ChartBorder
-uid: 'ExcelScript!ExcelScript.ChartBorder:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartBorder
-summary: Represents the border formatting of a chart element.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: clear()
- uid: 'ExcelScript!ExcelScript.ChartBorder#clear:member(1)'
- package: ExcelScript!
- fullName: clear()
- summary: Clear the border format of a chart element.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'clear(): void;'
- return:
- type: void
- description: ''
- - name: getColor()
- uid: 'ExcelScript!ExcelScript.ChartBorder#getColor:member(1)'
- package: ExcelScript!
- fullName: getColor()
- summary: HTML color code representing the color of borders in the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColor(): string;'
- return:
- type: string
- description: ''
- - name: getLineStyle()
- uid: 'ExcelScript!ExcelScript.ChartBorder#getLineStyle:member(1)'
- package: ExcelScript!
- fullName: getLineStyle()
- summary: Represents the line style of the border. See `ExcelScript.ChartLineStyle` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLineStyle(): ChartLineStyle;'
- return:
- type: ''
- description: ''
- - name: getWeight()
- uid: 'ExcelScript!ExcelScript.ChartBorder#getWeight:member(1)'
- package: ExcelScript!
- fullName: getWeight()
- summary: 'Represents weight of the border, in points.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWeight(): number;'
- return:
- type: number
- description: ''
- - name: setColor(color)
- uid: 'ExcelScript!ExcelScript.ChartBorder#setColor:member(1)'
- package: ExcelScript!
- fullName: setColor(color)
- summary: HTML color code representing the color of borders in the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setColor(color: string): void;'
- parameters:
- - id: color
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setLineStyle(lineStyle)
- uid: 'ExcelScript!ExcelScript.ChartBorder#setLineStyle:member(1)'
- package: ExcelScript!
- fullName: setLineStyle(lineStyle)
- summary: Represents the line style of the border. See `ExcelScript.ChartLineStyle` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLineStyle(lineStyle: ChartLineStyle): void;'
- parameters:
- - id: lineStyle
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setWeight(weight)
- uid: 'ExcelScript!ExcelScript.ChartBorder#setWeight:member(1)'
- package: ExcelScript!
- fullName: setWeight(weight)
- summary: 'Represents weight of the border, in points.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setWeight(weight: number): void;'
- parameters:
- - id: weight
- description: ''
- type: number
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartBorder
+uid: 'ExcelScript!ExcelScript.ChartBorder:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartBorder
+summary: Represents the border formatting of a chart element.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: clear()
+ uid: 'ExcelScript!ExcelScript.ChartBorder#clear:member(1)'
+ package: ExcelScript!
+ fullName: clear()
+ summary: Clear the border format of a chart element.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clear(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getColor()
+ uid: 'ExcelScript!ExcelScript.ChartBorder#getColor:member(1)'
+ package: ExcelScript!
+ fullName: getColor()
+ summary: HTML color code representing the color of borders in the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getLineStyle()
+ uid: 'ExcelScript!ExcelScript.ChartBorder#getLineStyle:member(1)'
+ package: ExcelScript!
+ fullName: getLineStyle()
+ summary: Represents the line style of the border. See `ExcelScript.ChartLineStyle` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLineStyle(): ChartLineStyle;'
+ return:
+ type: ''
+ description: ''
+ - name: getWeight()
+ uid: 'ExcelScript!ExcelScript.ChartBorder#getWeight:member(1)'
+ package: ExcelScript!
+ fullName: getWeight()
+ summary: 'Represents weight of the border, in points.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWeight(): number;'
+ return:
+ type: number
+ description: ''
+ - name: setColor(color)
+ uid: 'ExcelScript!ExcelScript.ChartBorder#setColor:member(1)'
+ package: ExcelScript!
+ fullName: setColor(color)
+ summary: HTML color code representing the color of borders in the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setColor(color: string): void;'
+ parameters:
+ - id: color
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setLineStyle(lineStyle)
+ uid: 'ExcelScript!ExcelScript.ChartBorder#setLineStyle:member(1)'
+ package: ExcelScript!
+ fullName: setLineStyle(lineStyle)
+ summary: Represents the line style of the border. See `ExcelScript.ChartLineStyle` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLineStyle(lineStyle: ChartLineStyle): void;'
+ parameters:
+ - id: lineStyle
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setWeight(weight)
+ uid: 'ExcelScript!ExcelScript.ChartBorder#setWeight:member(1)'
+ package: ExcelScript!
+ fullName: setWeight(weight)
+ summary: 'Represents weight of the border, in points.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setWeight(weight: number): void;'
+ parameters:
+ - id: weight
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartboxquartilecalculation.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartboxquartilecalculation.yml
index 60e8abfd..424b1007 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartboxquartilecalculation.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartboxquartilecalculation.yml
@@ -1,18 +1,18 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartBoxQuartileCalculation
-uid: 'ExcelScript!ExcelScript.ChartBoxQuartileCalculation:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartBoxQuartileCalculation
-summary: Represents the quartile calculation type of chart series layout. Only applies to a box and whisker chart.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: exclusive
- uid: 'ExcelScript!ExcelScript.ChartBoxQuartileCalculation.exclusive:member'
- package: ExcelScript!
- summary: ''
- - name: inclusive
- uid: 'ExcelScript!ExcelScript.ChartBoxQuartileCalculation.inclusive:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartBoxQuartileCalculation
+uid: 'ExcelScript!ExcelScript.ChartBoxQuartileCalculation:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartBoxQuartileCalculation
+summary: Represents the quartile calculation type of chart series layout. Only applies to a box and whisker chart.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: exclusive
+ uid: 'ExcelScript!ExcelScript.ChartBoxQuartileCalculation.exclusive:member'
+ package: ExcelScript!
+ summary: ''
+ - name: inclusive
+ uid: 'ExcelScript!ExcelScript.ChartBoxQuartileCalculation.inclusive:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartboxwhiskeroptions.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartboxwhiskeroptions.yml
index 0d70e8c2..7ed04347 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartboxwhiskeroptions.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartboxwhiskeroptions.yml
@@ -1,164 +1,164 @@
-### YamlMime:TSType
-name: ExcelScript.ChartBoxwhiskerOptions
-uid: 'ExcelScript!ExcelScript.ChartBoxwhiskerOptions:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartBoxwhiskerOptions
-summary: Represents the properties of a box and whisker chart.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getQuartileCalculation()
- uid: 'ExcelScript!ExcelScript.ChartBoxwhiskerOptions#getQuartileCalculation:member(1)'
- package: ExcelScript!
- fullName: getQuartileCalculation()
- summary: Specifies if the quartile calculation type of a box and whisker chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getQuartileCalculation(): ChartBoxQuartileCalculation;'
- return:
- type: ''
- description: ''
- - name: getShowInnerPoints()
- uid: 'ExcelScript!ExcelScript.ChartBoxwhiskerOptions#getShowInnerPoints:member(1)'
- package: ExcelScript!
- fullName: getShowInnerPoints()
- summary: Specifies if inner points are shown in a box and whisker chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowInnerPoints(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowMeanLine()
- uid: 'ExcelScript!ExcelScript.ChartBoxwhiskerOptions#getShowMeanLine:member(1)'
- package: ExcelScript!
- fullName: getShowMeanLine()
- summary: Specifies if the mean line is shown in a box and whisker chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowMeanLine(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowMeanMarker()
- uid: 'ExcelScript!ExcelScript.ChartBoxwhiskerOptions#getShowMeanMarker:member(1)'
- package: ExcelScript!
- fullName: getShowMeanMarker()
- summary: Specifies if the mean marker is shown in a box and whisker chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowMeanMarker(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowOutlierPoints()
- uid: 'ExcelScript!ExcelScript.ChartBoxwhiskerOptions#getShowOutlierPoints:member(1)'
- package: ExcelScript!
- fullName: getShowOutlierPoints()
- summary: Specifies if outlier points are shown in a box and whisker chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowOutlierPoints(): boolean;'
- return:
- type: boolean
- description: ''
- - name: setQuartileCalculation(quartileCalculation)
- uid: 'ExcelScript!ExcelScript.ChartBoxwhiskerOptions#setQuartileCalculation:member(1)'
- package: ExcelScript!
- fullName: setQuartileCalculation(quartileCalculation)
- summary: Specifies if the quartile calculation type of a box and whisker chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setQuartileCalculation(
- quartileCalculation: ChartBoxQuartileCalculation
- ): void;
- parameters:
- - id: quartileCalculation
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setShowInnerPoints(showInnerPoints)
- uid: 'ExcelScript!ExcelScript.ChartBoxwhiskerOptions#setShowInnerPoints:member(1)'
- package: ExcelScript!
- fullName: setShowInnerPoints(showInnerPoints)
- summary: Specifies if inner points are shown in a box and whisker chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowInnerPoints(showInnerPoints: boolean): void;'
- parameters:
- - id: showInnerPoints
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowMeanLine(showMeanLine)
- uid: 'ExcelScript!ExcelScript.ChartBoxwhiskerOptions#setShowMeanLine:member(1)'
- package: ExcelScript!
- fullName: setShowMeanLine(showMeanLine)
- summary: Specifies if the mean line is shown in a box and whisker chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowMeanLine(showMeanLine: boolean): void;'
- parameters:
- - id: showMeanLine
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowMeanMarker(showMeanMarker)
- uid: 'ExcelScript!ExcelScript.ChartBoxwhiskerOptions#setShowMeanMarker:member(1)'
- package: ExcelScript!
- fullName: setShowMeanMarker(showMeanMarker)
- summary: Specifies if the mean marker is shown in a box and whisker chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowMeanMarker(showMeanMarker: boolean): void;'
- parameters:
- - id: showMeanMarker
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowOutlierPoints(showOutlierPoints)
- uid: 'ExcelScript!ExcelScript.ChartBoxwhiskerOptions#setShowOutlierPoints:member(1)'
- package: ExcelScript!
- fullName: setShowOutlierPoints(showOutlierPoints)
- summary: Specifies if outlier points are shown in a box and whisker chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowOutlierPoints(showOutlierPoints: boolean): void;'
- parameters:
- - id: showOutlierPoints
- description: ''
- type: boolean
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartBoxwhiskerOptions
+uid: 'ExcelScript!ExcelScript.ChartBoxwhiskerOptions:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartBoxwhiskerOptions
+summary: Represents the properties of a box and whisker chart.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getQuartileCalculation()
+ uid: 'ExcelScript!ExcelScript.ChartBoxwhiskerOptions#getQuartileCalculation:member(1)'
+ package: ExcelScript!
+ fullName: getQuartileCalculation()
+ summary: Specifies if the quartile calculation type of a box and whisker chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getQuartileCalculation(): ChartBoxQuartileCalculation;'
+ return:
+ type: ''
+ description: ''
+ - name: getShowInnerPoints()
+ uid: 'ExcelScript!ExcelScript.ChartBoxwhiskerOptions#getShowInnerPoints:member(1)'
+ package: ExcelScript!
+ fullName: getShowInnerPoints()
+ summary: Specifies if inner points are shown in a box and whisker chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowInnerPoints(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowMeanLine()
+ uid: 'ExcelScript!ExcelScript.ChartBoxwhiskerOptions#getShowMeanLine:member(1)'
+ package: ExcelScript!
+ fullName: getShowMeanLine()
+ summary: Specifies if the mean line is shown in a box and whisker chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowMeanLine(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowMeanMarker()
+ uid: 'ExcelScript!ExcelScript.ChartBoxwhiskerOptions#getShowMeanMarker:member(1)'
+ package: ExcelScript!
+ fullName: getShowMeanMarker()
+ summary: Specifies if the mean marker is shown in a box and whisker chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowMeanMarker(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowOutlierPoints()
+ uid: 'ExcelScript!ExcelScript.ChartBoxwhiskerOptions#getShowOutlierPoints:member(1)'
+ package: ExcelScript!
+ fullName: getShowOutlierPoints()
+ summary: Specifies if outlier points are shown in a box and whisker chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowOutlierPoints(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: setQuartileCalculation(quartileCalculation)
+ uid: 'ExcelScript!ExcelScript.ChartBoxwhiskerOptions#setQuartileCalculation:member(1)'
+ package: ExcelScript!
+ fullName: setQuartileCalculation(quartileCalculation)
+ summary: Specifies if the quartile calculation type of a box and whisker chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setQuartileCalculation(
+ quartileCalculation: ChartBoxQuartileCalculation
+ ): void;
+ parameters:
+ - id: quartileCalculation
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setShowInnerPoints(showInnerPoints)
+ uid: 'ExcelScript!ExcelScript.ChartBoxwhiskerOptions#setShowInnerPoints:member(1)'
+ package: ExcelScript!
+ fullName: setShowInnerPoints(showInnerPoints)
+ summary: Specifies if inner points are shown in a box and whisker chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowInnerPoints(showInnerPoints: boolean): void;'
+ parameters:
+ - id: showInnerPoints
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowMeanLine(showMeanLine)
+ uid: 'ExcelScript!ExcelScript.ChartBoxwhiskerOptions#setShowMeanLine:member(1)'
+ package: ExcelScript!
+ fullName: setShowMeanLine(showMeanLine)
+ summary: Specifies if the mean line is shown in a box and whisker chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowMeanLine(showMeanLine: boolean): void;'
+ parameters:
+ - id: showMeanLine
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowMeanMarker(showMeanMarker)
+ uid: 'ExcelScript!ExcelScript.ChartBoxwhiskerOptions#setShowMeanMarker:member(1)'
+ package: ExcelScript!
+ fullName: setShowMeanMarker(showMeanMarker)
+ summary: Specifies if the mean marker is shown in a box and whisker chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowMeanMarker(showMeanMarker: boolean): void;'
+ parameters:
+ - id: showMeanMarker
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowOutlierPoints(showOutlierPoints)
+ uid: 'ExcelScript!ExcelScript.ChartBoxwhiskerOptions#setShowOutlierPoints:member(1)'
+ package: ExcelScript!
+ fullName: setShowOutlierPoints(showOutlierPoints)
+ summary: Specifies if outlier points are shown in a box and whisker chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowOutlierPoints(showOutlierPoints: boolean): void;'
+ parameters:
+ - id: showOutlierPoints
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartcolorscheme.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartcolorscheme.yml
index d86d5751..9d5be929 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartcolorscheme.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartcolorscheme.yml
@@ -1,78 +1,78 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartColorScheme
-uid: 'ExcelScript!ExcelScript.ChartColorScheme:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartColorScheme
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: colorfulPalette1
- uid: 'ExcelScript!ExcelScript.ChartColorScheme.colorfulPalette1:member'
- package: ExcelScript!
- summary: ''
- - name: colorfulPalette2
- uid: 'ExcelScript!ExcelScript.ChartColorScheme.colorfulPalette2:member'
- package: ExcelScript!
- summary: ''
- - name: colorfulPalette3
- uid: 'ExcelScript!ExcelScript.ChartColorScheme.colorfulPalette3:member'
- package: ExcelScript!
- summary: ''
- - name: colorfulPalette4
- uid: 'ExcelScript!ExcelScript.ChartColorScheme.colorfulPalette4:member'
- package: ExcelScript!
- summary: ''
- - name: monochromaticPalette1
- uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette1:member'
- package: ExcelScript!
- summary: ''
- - name: monochromaticPalette10
- uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette10:member'
- package: ExcelScript!
- summary: ''
- - name: monochromaticPalette11
- uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette11:member'
- package: ExcelScript!
- summary: ''
- - name: monochromaticPalette12
- uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette12:member'
- package: ExcelScript!
- summary: ''
- - name: monochromaticPalette13
- uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette13:member'
- package: ExcelScript!
- summary: ''
- - name: monochromaticPalette2
- uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette2:member'
- package: ExcelScript!
- summary: ''
- - name: monochromaticPalette3
- uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette3:member'
- package: ExcelScript!
- summary: ''
- - name: monochromaticPalette4
- uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette4:member'
- package: ExcelScript!
- summary: ''
- - name: monochromaticPalette5
- uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette5:member'
- package: ExcelScript!
- summary: ''
- - name: monochromaticPalette6
- uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette6:member'
- package: ExcelScript!
- summary: ''
- - name: monochromaticPalette7
- uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette7:member'
- package: ExcelScript!
- summary: ''
- - name: monochromaticPalette8
- uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette8:member'
- package: ExcelScript!
- summary: ''
- - name: monochromaticPalette9
- uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette9:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartColorScheme
+uid: 'ExcelScript!ExcelScript.ChartColorScheme:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartColorScheme
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: colorfulPalette1
+ uid: 'ExcelScript!ExcelScript.ChartColorScheme.colorfulPalette1:member'
+ package: ExcelScript!
+ summary: ''
+ - name: colorfulPalette2
+ uid: 'ExcelScript!ExcelScript.ChartColorScheme.colorfulPalette2:member'
+ package: ExcelScript!
+ summary: ''
+ - name: colorfulPalette3
+ uid: 'ExcelScript!ExcelScript.ChartColorScheme.colorfulPalette3:member'
+ package: ExcelScript!
+ summary: ''
+ - name: colorfulPalette4
+ uid: 'ExcelScript!ExcelScript.ChartColorScheme.colorfulPalette4:member'
+ package: ExcelScript!
+ summary: ''
+ - name: monochromaticPalette1
+ uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette1:member'
+ package: ExcelScript!
+ summary: ''
+ - name: monochromaticPalette10
+ uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette10:member'
+ package: ExcelScript!
+ summary: ''
+ - name: monochromaticPalette11
+ uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette11:member'
+ package: ExcelScript!
+ summary: ''
+ - name: monochromaticPalette12
+ uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette12:member'
+ package: ExcelScript!
+ summary: ''
+ - name: monochromaticPalette13
+ uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette13:member'
+ package: ExcelScript!
+ summary: ''
+ - name: monochromaticPalette2
+ uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette2:member'
+ package: ExcelScript!
+ summary: ''
+ - name: monochromaticPalette3
+ uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette3:member'
+ package: ExcelScript!
+ summary: ''
+ - name: monochromaticPalette4
+ uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette4:member'
+ package: ExcelScript!
+ summary: ''
+ - name: monochromaticPalette5
+ uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette5:member'
+ package: ExcelScript!
+ summary: ''
+ - name: monochromaticPalette6
+ uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette6:member'
+ package: ExcelScript!
+ summary: ''
+ - name: monochromaticPalette7
+ uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette7:member'
+ package: ExcelScript!
+ summary: ''
+ - name: monochromaticPalette8
+ uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette8:member'
+ package: ExcelScript!
+ summary: ''
+ - name: monochromaticPalette9
+ uid: 'ExcelScript!ExcelScript.ChartColorScheme.monochromaticPalette9:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatalabel.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatalabel.yml
index 3fc2be06..91d94cde 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatalabel.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatalabel.yml
@@ -1,620 +1,740 @@
-### YamlMime:TSType
-name: ExcelScript.ChartDataLabel
-uid: 'ExcelScript!ExcelScript.ChartDataLabel:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartDataLabel
-summary: Represents the data label of a chart point.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getAutoText()
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#getAutoText:member(1)'
- package: ExcelScript!
- fullName: getAutoText()
- summary: Specifies if the data label automatically generates appropriate text based on context.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAutoText(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getFormat()
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#getFormat:member(1)'
- package: ExcelScript!
- fullName: getFormat()
- summary: Represents the format of chart data label.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormat(): ChartDataLabelFormat;'
- return:
- type: ''
- description: ''
- - name: getFormula()
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#getFormula:member(1)'
- package: ExcelScript!
- fullName: getFormula()
- summary: String value that represents the formula of chart data label using A1-style notation.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormula(): string;'
- return:
- type: string
- description: ''
- - name: getHeight()
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#getHeight:member(1)'
- package: ExcelScript!
- fullName: getHeight()
- summary: 'Returns the height, in points, of the chart data label. Value is `null` if the chart data label is not visible.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHeight(): number;'
- return:
- type: number
- description: ''
- - name: getHorizontalAlignment()
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#getHorizontalAlignment:member(1)'
- package: ExcelScript!
- fullName: getHorizontalAlignment()
- summary: >-
- Represents the horizontal alignment for chart data label. See `ExcelScript.ChartTextHorizontalAlignment` for
- details. This property is valid only when `TextOrientation` of data label is -90, 90, or 180.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHorizontalAlignment(): ChartTextHorizontalAlignment;'
- return:
- type: ''
- description: ''
- - name: getLeft()
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#getLeft:member(1)'
- package: ExcelScript!
- fullName: getLeft()
- summary: >-
- Represents the distance, in points, from the left edge of chart data label to the left edge of chart area. Value
- is `null` if the chart data label is not visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLeft(): number;'
- return:
- type: number
- description: ''
- - name: getLinkNumberFormat()
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#getLinkNumberFormat:member(1)'
- package: ExcelScript!
- fullName: getLinkNumberFormat()
- summary: >-
- Specifies if the number format is linked to the cells (so that the number format changes in the labels when it
- changes in the cells).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLinkNumberFormat(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getNumberFormat()
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#getNumberFormat:member(1)'
- package: ExcelScript!
- fullName: getNumberFormat()
- summary: String value that represents the format code for data label.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNumberFormat(): string;'
- return:
- type: string
- description: ''
- - name: getPosition()
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#getPosition:member(1)'
- package: ExcelScript!
- fullName: getPosition()
- summary: Value that represents the position of the data label. See `ExcelScript.ChartDataLabelPosition` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPosition(): ChartDataLabelPosition;'
- return:
- type: ''
- description: ''
- - name: getSeparator()
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#getSeparator:member(1)'
- package: ExcelScript!
- fullName: getSeparator()
- summary: String representing the separator used for the data label on a chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSeparator(): string;'
- return:
- type: string
- description: ''
- - name: getShowBubbleSize()
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#getShowBubbleSize:member(1)'
- package: ExcelScript!
- fullName: getShowBubbleSize()
- summary: Specifies if the data label bubble size is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowBubbleSize(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowCategoryName()
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#getShowCategoryName:member(1)'
- package: ExcelScript!
- fullName: getShowCategoryName()
- summary: Specifies if the data label category name is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowCategoryName(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowLegendKey()
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#getShowLegendKey:member(1)'
- package: ExcelScript!
- fullName: getShowLegendKey()
- summary: Specifies if the data label legend key is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowLegendKey(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowPercentage()
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#getShowPercentage:member(1)'
- package: ExcelScript!
- fullName: getShowPercentage()
- summary: Specifies if the data label percentage is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowPercentage(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowSeriesName()
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#getShowSeriesName:member(1)'
- package: ExcelScript!
- fullName: getShowSeriesName()
- summary: Specifies if the data label series name is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowSeriesName(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowValue()
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#getShowValue:member(1)'
- package: ExcelScript!
- fullName: getShowValue()
- summary: Specifies if the data label value is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowValue(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getText()
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#getText:member(1)'
- package: ExcelScript!
- fullName: getText()
- summary: String representing the text of the data label on a chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getText(): string;'
- return:
- type: string
- description: ''
- - name: getTextOrientation()
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#getTextOrientation:member(1)'
- package: ExcelScript!
- fullName: getTextOrientation()
- summary: >-
- Represents the angle to which the text is oriented for the chart data label. The value should either be an integer
- from -90 to 90 or the integer 180 for vertically-oriented text.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTextOrientation(): number;'
- return:
- type: number
- description: ''
- - name: getTop()
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#getTop:member(1)'
- package: ExcelScript!
- fullName: getTop()
- summary: >-
- Represents the distance, in points, from the top edge of chart data label to the top of chart area. Value is
- `null` if the chart data label is not visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTop(): number;'
- return:
- type: number
- description: ''
- - name: getVerticalAlignment()
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#getVerticalAlignment:member(1)'
- package: ExcelScript!
- fullName: getVerticalAlignment()
- summary: >-
- Represents the vertical alignment of chart data label. See `ExcelScript.ChartTextVerticalAlignment` for details.
- This property is valid only when `TextOrientation` of data label is 0.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVerticalAlignment(): ChartTextVerticalAlignment;'
- return:
- type: ''
- description: ''
- - name: getWidth()
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#getWidth:member(1)'
- package: ExcelScript!
- fullName: getWidth()
- summary: 'Returns the width, in points, of the chart data label. Value is `null` if the chart data label is not visible.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWidth(): number;'
- return:
- type: number
- description: ''
- - name: setAutoText(autoText)
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#setAutoText:member(1)'
- package: ExcelScript!
- fullName: setAutoText(autoText)
- summary: Specifies if the data label automatically generates appropriate text based on context.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setAutoText(autoText: boolean): void;'
- parameters:
- - id: autoText
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setFormula(formula)
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#setFormula:member(1)'
- package: ExcelScript!
- fullName: setFormula(formula)
- summary: String value that represents the formula of chart data label using A1-style notation.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFormula(formula: string): void;'
- parameters:
- - id: formula
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setHorizontalAlignment(horizontalAlignment)
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#setHorizontalAlignment:member(1)'
- package: ExcelScript!
- fullName: setHorizontalAlignment(horizontalAlignment)
- summary: >-
- Represents the horizontal alignment for chart data label. See `ExcelScript.ChartTextHorizontalAlignment` for
- details. This property is valid only when `TextOrientation` of data label is -90, 90, or 180.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setHorizontalAlignment(
- horizontalAlignment: ChartTextHorizontalAlignment
- ): void;
- parameters:
- - id: horizontalAlignment
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setLeft(left)
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#setLeft:member(1)'
- package: ExcelScript!
- fullName: setLeft(left)
- summary: >-
- Represents the distance, in points, from the left edge of chart data label to the left edge of chart area. Value
- is `null` if the chart data label is not visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLeft(left: number): void;'
- parameters:
- - id: left
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setLinkNumberFormat(linkNumberFormat)
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#setLinkNumberFormat:member(1)'
- package: ExcelScript!
- fullName: setLinkNumberFormat(linkNumberFormat)
- summary: >-
- Specifies if the number format is linked to the cells (so that the number format changes in the labels when it
- changes in the cells).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLinkNumberFormat(linkNumberFormat: boolean): void;'
- parameters:
- - id: linkNumberFormat
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setNumberFormat(numberFormat)
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#setNumberFormat:member(1)'
- package: ExcelScript!
- fullName: setNumberFormat(numberFormat)
- summary: String value that represents the format code for data label.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setNumberFormat(numberFormat: string): void;'
- parameters:
- - id: numberFormat
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setPosition(position)
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#setPosition:member(1)'
- package: ExcelScript!
- fullName: setPosition(position)
- summary: Value that represents the position of the data label. See `ExcelScript.ChartDataLabelPosition` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPosition(position: ChartDataLabelPosition): void;'
- parameters:
- - id: position
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setSeparator(separator)
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#setSeparator:member(1)'
- package: ExcelScript!
- fullName: setSeparator(separator)
- summary: String representing the separator used for the data label on a chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setSeparator(separator: string): void;'
- parameters:
- - id: separator
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setShowBubbleSize(showBubbleSize)
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#setShowBubbleSize:member(1)'
- package: ExcelScript!
- fullName: setShowBubbleSize(showBubbleSize)
- summary: Specifies if the data label bubble size is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowBubbleSize(showBubbleSize: boolean): void;'
- parameters:
- - id: showBubbleSize
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowCategoryName(showCategoryName)
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#setShowCategoryName:member(1)'
- package: ExcelScript!
- fullName: setShowCategoryName(showCategoryName)
- summary: Specifies if the data label category name is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowCategoryName(showCategoryName: boolean): void;'
- parameters:
- - id: showCategoryName
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowLegendKey(showLegendKey)
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#setShowLegendKey:member(1)'
- package: ExcelScript!
- fullName: setShowLegendKey(showLegendKey)
- summary: Specifies if the data label legend key is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowLegendKey(showLegendKey: boolean): void;'
- parameters:
- - id: showLegendKey
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowPercentage(showPercentage)
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#setShowPercentage:member(1)'
- package: ExcelScript!
- fullName: setShowPercentage(showPercentage)
- summary: Specifies if the data label percentage is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowPercentage(showPercentage: boolean): void;'
- parameters:
- - id: showPercentage
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowSeriesName(showSeriesName)
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#setShowSeriesName:member(1)'
- package: ExcelScript!
- fullName: setShowSeriesName(showSeriesName)
- summary: Specifies if the data label series name is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowSeriesName(showSeriesName: boolean): void;'
- parameters:
- - id: showSeriesName
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowValue(showValue)
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#setShowValue:member(1)'
- package: ExcelScript!
- fullName: setShowValue(showValue)
- summary: Specifies if the data label value is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowValue(showValue: boolean): void;'
- parameters:
- - id: showValue
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setText(text)
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#setText:member(1)'
- package: ExcelScript!
- fullName: setText(text)
- summary: String representing the text of the data label on a chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setText(text: string): void;'
- parameters:
- - id: text
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setTextOrientation(textOrientation)
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#setTextOrientation:member(1)'
- package: ExcelScript!
- fullName: setTextOrientation(textOrientation)
- summary: >-
- Represents the angle to which the text is oriented for the chart data label. The value should either be an integer
- from -90 to 90 or the integer 180 for vertically-oriented text.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTextOrientation(textOrientation: number): void;'
- parameters:
- - id: textOrientation
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setTop(top)
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#setTop:member(1)'
- package: ExcelScript!
- fullName: setTop(top)
- summary: >-
- Represents the distance, in points, from the top edge of chart data label to the top of chart area. Value is
- `null` if the chart data label is not visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTop(top: number): void;'
- parameters:
- - id: top
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setVerticalAlignment(verticalAlignment)
- uid: 'ExcelScript!ExcelScript.ChartDataLabel#setVerticalAlignment:member(1)'
- package: ExcelScript!
- fullName: setVerticalAlignment(verticalAlignment)
- summary: >-
- Represents the vertical alignment of chart data label. See `ExcelScript.ChartTextVerticalAlignment` for details.
- This property is valid only when `TextOrientation` of data label is 0.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setVerticalAlignment(
- verticalAlignment: ChartTextVerticalAlignment
- ): void;
- parameters:
- - id: verticalAlignment
- description: ''
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartDataLabel
+uid: 'ExcelScript!ExcelScript.ChartDataLabel:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartDataLabel
+summary: Represents the data label of a chart point.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getAutoText()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getAutoText:member(1)'
+ package: ExcelScript!
+ fullName: getAutoText()
+ summary: Specifies if the data label automatically generates appropriate text based on context.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAutoText(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getFormat()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getFormat:member(1)'
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: Represents the format of chart data label.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): ChartDataLabelFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getFormula()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getFormula:member(1)'
+ package: ExcelScript!
+ fullName: getFormula()
+ summary: String value that represents the formula of chart data label using A1-style notation.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormula(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getGeometricShapeType()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getGeometricShapeType:member(1)'
+ package: ExcelScript!
+ fullName: getGeometricShapeType()
+ summary: >-
+ Specifies the geometric shape type of the data label. See `ExcelScript.GeometricShapeType` for more details. Value
+ is `null` if the data label is not a geometric shape.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGeometricShapeType(): GeometricShapeType;'
+ return:
+ type: ''
+ description: ''
+ - name: getHeight()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getHeight:member(1)'
+ package: ExcelScript!
+ fullName: getHeight()
+ summary: 'Returns the height, in points, of the chart data label. Value is `null` if the chart data label is not visible.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHeight(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getHorizontalAlignment()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getHorizontalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: getHorizontalAlignment()
+ summary: >-
+ Represents the horizontal alignment for chart data label. See `ExcelScript.ChartTextHorizontalAlignment` for
+ details. This property is valid only when `TextOrientation` of data label is -90, 90, or 180.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHorizontalAlignment(): ChartTextHorizontalAlignment;'
+ return:
+ type: ''
+ description: ''
+ - name: getLeft()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getLeft:member(1)'
+ package: ExcelScript!
+ fullName: getLeft()
+ summary: >-
+ Represents the distance, in points, from the left edge of chart data label to the left edge of chart area. Value
+ is `null` if the chart data label is not visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLeft(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getLinkNumberFormat()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getLinkNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: getLinkNumberFormat()
+ summary: >-
+ Specifies if the number format is linked to the cells (so that the number format changes in the labels when it
+ changes in the cells).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLinkNumberFormat(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getNumberFormat()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: getNumberFormat()
+ summary: String value that represents the format code for data label.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNumberFormat(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getPosition()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getPosition:member(1)'
+ package: ExcelScript!
+ fullName: getPosition()
+ summary: Value that represents the position of the data label. See `ExcelScript.ChartDataLabelPosition` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPosition(): ChartDataLabelPosition;'
+ return:
+ type: ''
+ description: ''
+ - name: getSeparator()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getSeparator:member(1)'
+ package: ExcelScript!
+ fullName: getSeparator()
+ summary: String representing the separator used for the data label on a chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSeparator(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getShowAsStickyCallout()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getShowAsStickyCallout:member(1)'
+ package: ExcelScript!
+ fullName: getShowAsStickyCallout()
+ summary: >-
+ Gets a value that indicates whether the data labels are shown as a callout with the tail anchor attached to the
+ data point. If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2",
+ "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See
+ Excel.GeometricShapeType for more details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowAsStickyCallout(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowBubbleSize()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getShowBubbleSize:member(1)'
+ package: ExcelScript!
+ fullName: getShowBubbleSize()
+ summary: Specifies if the data label bubble size is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowBubbleSize(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowCategoryName()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getShowCategoryName:member(1)'
+ package: ExcelScript!
+ fullName: getShowCategoryName()
+ summary: Specifies if the data label category name is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowCategoryName(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowLegendKey()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getShowLegendKey:member(1)'
+ package: ExcelScript!
+ fullName: getShowLegendKey()
+ summary: Specifies if the data label legend key is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowLegendKey(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowPercentage()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getShowPercentage:member(1)'
+ package: ExcelScript!
+ fullName: getShowPercentage()
+ summary: Specifies if the data label percentage is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowPercentage(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowSeriesName()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getShowSeriesName:member(1)'
+ package: ExcelScript!
+ fullName: getShowSeriesName()
+ summary: Specifies if the data label series name is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowSeriesName(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowValue()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getShowValue:member(1)'
+ package: ExcelScript!
+ fullName: getShowValue()
+ summary: Specifies if the data label value is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowValue(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: 'getSubstring(start, length)'
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getSubstring:member(1)'
+ package: ExcelScript!
+ fullName: 'getSubstring(start, length)'
+ summary: Returns a substring of the data label. The line break character '\\n' counts as one character.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSubstring(start: number, length?: number): ChartFormatString;'
+ parameters:
+ - id: start
+ description: The zero-based starting character position of a substring in the data label.
+ type: number
+ - id: length
+ description: >-
+ Optional. The number of characters in the substring. If length is omitted, all the characters from start to
+ the end of the data label are retrieved.
+ type: number
+ return:
+ type: ''
+ description: ''
+ - name: getTailAnchor()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getTailAnchor:member(1)'
+ package: ExcelScript!
+ fullName: getTailAnchor()
+ summary: Returns the tail anchor of the data label which is shown as a sticky callout.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTailAnchor(): ChartDataLabelAnchor;'
+ return:
+ type: ''
+ description: ''
+ - name: getText()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getText:member(1)'
+ package: ExcelScript!
+ fullName: getText()
+ summary: String representing the text of the data label on a chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getText(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getTextOrientation()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getTextOrientation:member(1)'
+ package: ExcelScript!
+ fullName: getTextOrientation()
+ summary: >-
+ Represents the angle to which the text is oriented for the chart data label. The value should either be an integer
+ from -90 to 90 or the integer 180 for vertically-oriented text.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTextOrientation(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getTop()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getTop:member(1)'
+ package: ExcelScript!
+ fullName: getTop()
+ summary: >-
+ Represents the distance, in points, from the top edge of chart data label to the top of chart area. Value is
+ `null` if the chart data label is not visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTop(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getVerticalAlignment()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getVerticalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: getVerticalAlignment()
+ summary: >-
+ Represents the vertical alignment of chart data label. See `ExcelScript.ChartTextVerticalAlignment` for details.
+ This property is valid only when `TextOrientation` of data label is 0.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVerticalAlignment(): ChartTextVerticalAlignment;'
+ return:
+ type: ''
+ description: ''
+ - name: getWidth()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#getWidth:member(1)'
+ package: ExcelScript!
+ fullName: getWidth()
+ summary: 'Returns the width, in points, of the chart data label. Value is `null` if the chart data label is not visible.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWidth(): number;'
+ return:
+ type: number
+ description: ''
+ - name: setAutoText(autoText)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#setAutoText:member(1)'
+ package: ExcelScript!
+ fullName: setAutoText(autoText)
+ summary: Specifies if the data label automatically generates appropriate text based on context.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setAutoText(autoText: boolean): void;'
+ parameters:
+ - id: autoText
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setFormula(formula)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#setFormula:member(1)'
+ package: ExcelScript!
+ fullName: setFormula(formula)
+ summary: String value that represents the formula of chart data label using A1-style notation.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFormula(formula: string): void;'
+ parameters:
+ - id: formula
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setGeometricShapeType(geometricShapeType)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#setGeometricShapeType:member(1)'
+ package: ExcelScript!
+ fullName: setGeometricShapeType(geometricShapeType)
+ summary: >-
+ Specifies the geometric shape type of the data label. See `ExcelScript.GeometricShapeType` for more details. Value
+ is `null` if the data label is not a geometric shape.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setGeometricShapeType(geometricShapeType: GeometricShapeType): void;'
+ parameters:
+ - id: geometricShapeType
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setHeight(height)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#setHeight:member(1)'
+ package: ExcelScript!
+ fullName: setHeight(height)
+ summary: Sets the height of the data label in points.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setHeight(height: number): void;'
+ parameters:
+ - id: height
+ description: The height of the data label in points.
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setHorizontalAlignment(horizontalAlignment)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#setHorizontalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: setHorizontalAlignment(horizontalAlignment)
+ summary: >-
+ Represents the horizontal alignment for chart data label. See `ExcelScript.ChartTextHorizontalAlignment` for
+ details. This property is valid only when `TextOrientation` of data label is -90, 90, or 180.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setHorizontalAlignment(
+ horizontalAlignment: ChartTextHorizontalAlignment
+ ): void;
+ parameters:
+ - id: horizontalAlignment
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setLeft(left)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#setLeft:member(1)'
+ package: ExcelScript!
+ fullName: setLeft(left)
+ summary: >-
+ Represents the distance, in points, from the left edge of chart data label to the left edge of chart area. Value
+ is `null` if the chart data label is not visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLeft(left: number): void;'
+ parameters:
+ - id: left
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setLinkNumberFormat(linkNumberFormat)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#setLinkNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: setLinkNumberFormat(linkNumberFormat)
+ summary: >-
+ Specifies if the number format is linked to the cells (so that the number format changes in the labels when it
+ changes in the cells).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLinkNumberFormat(linkNumberFormat: boolean): void;'
+ parameters:
+ - id: linkNumberFormat
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setNumberFormat(numberFormat)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#setNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: setNumberFormat(numberFormat)
+ summary: String value that represents the format code for data label.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setNumberFormat(numberFormat: string): void;'
+ parameters:
+ - id: numberFormat
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setPosition(position)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#setPosition:member(1)'
+ package: ExcelScript!
+ fullName: setPosition(position)
+ summary: Value that represents the position of the data label. See `ExcelScript.ChartDataLabelPosition` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPosition(position: ChartDataLabelPosition): void;'
+ parameters:
+ - id: position
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setSeparator(separator)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#setSeparator:member(1)'
+ package: ExcelScript!
+ fullName: setSeparator(separator)
+ summary: String representing the separator used for the data label on a chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSeparator(separator: string): void;'
+ parameters:
+ - id: separator
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setShowBubbleSize(showBubbleSize)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#setShowBubbleSize:member(1)'
+ package: ExcelScript!
+ fullName: setShowBubbleSize(showBubbleSize)
+ summary: Specifies if the data label bubble size is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowBubbleSize(showBubbleSize: boolean): void;'
+ parameters:
+ - id: showBubbleSize
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowCategoryName(showCategoryName)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#setShowCategoryName:member(1)'
+ package: ExcelScript!
+ fullName: setShowCategoryName(showCategoryName)
+ summary: Specifies if the data label category name is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowCategoryName(showCategoryName: boolean): void;'
+ parameters:
+ - id: showCategoryName
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowLegendKey(showLegendKey)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#setShowLegendKey:member(1)'
+ package: ExcelScript!
+ fullName: setShowLegendKey(showLegendKey)
+ summary: Specifies if the data label legend key is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowLegendKey(showLegendKey: boolean): void;'
+ parameters:
+ - id: showLegendKey
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowPercentage(showPercentage)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#setShowPercentage:member(1)'
+ package: ExcelScript!
+ fullName: setShowPercentage(showPercentage)
+ summary: Specifies if the data label percentage is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowPercentage(showPercentage: boolean): void;'
+ parameters:
+ - id: showPercentage
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowSeriesName(showSeriesName)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#setShowSeriesName:member(1)'
+ package: ExcelScript!
+ fullName: setShowSeriesName(showSeriesName)
+ summary: Specifies if the data label series name is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowSeriesName(showSeriesName: boolean): void;'
+ parameters:
+ - id: showSeriesName
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowValue(showValue)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#setShowValue:member(1)'
+ package: ExcelScript!
+ fullName: setShowValue(showValue)
+ summary: Specifies if the data label value is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowValue(showValue: boolean): void;'
+ parameters:
+ - id: showValue
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setText(text)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#setText:member(1)'
+ package: ExcelScript!
+ fullName: setText(text)
+ summary: String representing the text of the data label on a chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setText(text: string): void;'
+ parameters:
+ - id: text
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setTextOrientation(textOrientation)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#setTextOrientation:member(1)'
+ package: ExcelScript!
+ fullName: setTextOrientation(textOrientation)
+ summary: >-
+ Represents the angle to which the text is oriented for the chart data label. The value should either be an integer
+ from -90 to 90 or the integer 180 for vertically-oriented text.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTextOrientation(textOrientation: number): void;'
+ parameters:
+ - id: textOrientation
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setTop(top)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#setTop:member(1)'
+ package: ExcelScript!
+ fullName: setTop(top)
+ summary: >-
+ Represents the distance, in points, from the top edge of chart data label to the top of chart area. Value is
+ `null` if the chart data label is not visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTop(top: number): void;'
+ parameters:
+ - id: top
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setVerticalAlignment(verticalAlignment)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#setVerticalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: setVerticalAlignment(verticalAlignment)
+ summary: >-
+ Represents the vertical alignment of chart data label. See `ExcelScript.ChartTextVerticalAlignment` for details.
+ This property is valid only when `TextOrientation` of data label is 0.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setVerticalAlignment(
+ verticalAlignment: ChartTextVerticalAlignment
+ ): void;
+ parameters:
+ - id: verticalAlignment
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setWidth(width)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabel#setWidth:member(1)'
+ package: ExcelScript!
+ fullName: setWidth(width)
+ summary: Sets the width of the data label in points.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setWidth(width: number): void;'
+ parameters:
+ - id: width
+ description: The width of the data label in points.
+ type: number
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatalabelanchor.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatalabelanchor.yml
new file mode 100644
index 00000000..1edbfd8e
--- /dev/null
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatalabelanchor.yml
@@ -0,0 +1,79 @@
+### YamlMime:TSType
+name: ExcelScript.ChartDataLabelAnchor
+uid: 'ExcelScript!ExcelScript.ChartDataLabelAnchor:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartDataLabelAnchor
+summary: Represents the chart data label anchor.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getLeft()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabelAnchor#getLeft:member(1)'
+ package: ExcelScript!
+ fullName: getLeft()
+ summary: >-
+ Represents the distance, in points, from the anchor to the left edge of the chart data label. Note that when
+ getting the value, it may differ slightly from the set value.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLeft(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getTop()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabelAnchor#getTop:member(1)'
+ package: ExcelScript!
+ fullName: getTop()
+ summary: >-
+ Represents the distance, in points, from the anchor to the top edge of the chart data label. Note that when
+ getting the value, it may differ slightly from the set value.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTop(): number;'
+ return:
+ type: number
+ description: ''
+ - name: setLeft(left)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabelAnchor#setLeft:member(1)'
+ package: ExcelScript!
+ fullName: setLeft(left)
+ summary: >-
+ Represents the distance, in points, from the anchor to the left edge of the chart data label. Note that when
+ getting the value, it may differ slightly from the set value.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLeft(left: number): void;'
+ parameters:
+ - id: left
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setTop(top)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabelAnchor#setTop:member(1)'
+ package: ExcelScript!
+ fullName: setTop(top)
+ summary: >-
+ Represents the distance, in points, from the anchor to the top edge of the chart data label. Note that when
+ getting the value, it may differ slightly from the set value.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTop(top: number): void;'
+ parameters:
+ - id: top
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatalabelformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatalabelformat.yml
index dd4657f9..3de047d9 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatalabelformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatalabelformat.yml
@@ -1,50 +1,50 @@
-### YamlMime:TSType
-name: ExcelScript.ChartDataLabelFormat
-uid: 'ExcelScript!ExcelScript.ChartDataLabelFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartDataLabelFormat
-summary: Encapsulates the format properties for the chart data labels.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getBorder()
- uid: 'ExcelScript!ExcelScript.ChartDataLabelFormat#getBorder:member(1)'
- package: ExcelScript!
- fullName: getBorder()
- summary: 'Represents the border format, which includes color, linestyle, and weight.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBorder(): ChartBorder;'
- return:
- type: ''
- description: ''
- - name: getFill()
- uid: 'ExcelScript!ExcelScript.ChartDataLabelFormat#getFill:member(1)'
- package: ExcelScript!
- fullName: getFill()
- summary: Represents the fill format of the current chart data label.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFill(): ChartFill;'
- return:
- type: ''
- description: ''
- - name: getFont()
- uid: 'ExcelScript!ExcelScript.ChartDataLabelFormat#getFont:member(1)'
- package: ExcelScript!
- fullName: getFont()
- summary: 'Represents the font attributes (such as font name, font size, and color) for a chart data label.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFont(): ChartFont;'
- return:
- type: ''
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartDataLabelFormat
+uid: 'ExcelScript!ExcelScript.ChartDataLabelFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartDataLabelFormat
+summary: Encapsulates the format properties for the chart data labels.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getBorder()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabelFormat#getBorder:member(1)'
+ package: ExcelScript!
+ fullName: getBorder()
+ summary: 'Represents the border format, which includes color, linestyle, and weight.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBorder(): ChartBorder;'
+ return:
+ type: ''
+ description: ''
+ - name: getFill()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabelFormat#getFill:member(1)'
+ package: ExcelScript!
+ fullName: getFill()
+ summary: Represents the fill format of the current chart data label.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFill(): ChartFill;'
+ return:
+ type: ''
+ description: ''
+ - name: getFont()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabelFormat#getFont:member(1)'
+ package: ExcelScript!
+ fullName: getFont()
+ summary: 'Represents the font attributes (such as font name, font size, and color) for a chart data label.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFont(): ChartFont;'
+ return:
+ type: ''
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatalabelposition.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatalabelposition.yml
index 8e4cbb0f..88b6379a 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatalabelposition.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatalabelposition.yml
@@ -1,58 +1,58 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartDataLabelPosition
-uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartDataLabelPosition
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: bestFit
- uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.bestFit:member'
- package: ExcelScript!
- summary: ''
- - name: bottom
- uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.bottom:member'
- package: ExcelScript!
- summary: ''
- - name: callout
- uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.callout:member'
- package: ExcelScript!
- summary: ''
- - name: center
- uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.center:member'
- package: ExcelScript!
- summary: ''
- - name: insideBase
- uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.insideBase:member'
- package: ExcelScript!
- summary: ''
- - name: insideEnd
- uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.insideEnd:member'
- package: ExcelScript!
- summary: ''
- - name: invalid
- uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.invalid:member'
- package: ExcelScript!
- summary: ''
- - name: left
- uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.left:member'
- package: ExcelScript!
- summary: ''
- - name: none
- uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.none:member'
- package: ExcelScript!
- summary: ''
- - name: outsideEnd
- uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.outsideEnd:member'
- package: ExcelScript!
- summary: ''
- - name: right
- uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.right:member'
- package: ExcelScript!
- summary: ''
- - name: top
- uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.top:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartDataLabelPosition
+uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartDataLabelPosition
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: bestFit
+ uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.bestFit:member'
+ package: ExcelScript!
+ summary: ''
+ - name: bottom
+ uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.bottom:member'
+ package: ExcelScript!
+ summary: ''
+ - name: callout
+ uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.callout:member'
+ package: ExcelScript!
+ summary: ''
+ - name: center
+ uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.center:member'
+ package: ExcelScript!
+ summary: ''
+ - name: insideBase
+ uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.insideBase:member'
+ package: ExcelScript!
+ summary: ''
+ - name: insideEnd
+ uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.insideEnd:member'
+ package: ExcelScript!
+ summary: ''
+ - name: invalid
+ uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.invalid:member'
+ package: ExcelScript!
+ summary: ''
+ - name: left
+ uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.left:member'
+ package: ExcelScript!
+ summary: ''
+ - name: none
+ uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.none:member'
+ package: ExcelScript!
+ summary: ''
+ - name: outsideEnd
+ uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.outsideEnd:member'
+ package: ExcelScript!
+ summary: ''
+ - name: right
+ uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.right:member'
+ package: ExcelScript!
+ summary: ''
+ - name: top
+ uid: 'ExcelScript!ExcelScript.ChartDataLabelPosition.top:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatalabels.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatalabels.yml
index c6535248..4feb61e5 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatalabels.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatalabels.yml
@@ -1,466 +1,564 @@
-### YamlMime:TSType
-name: ExcelScript.ChartDataLabels
-uid: 'ExcelScript!ExcelScript.ChartDataLabels:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartDataLabels
-summary: Represents a collection of all the data labels on a chart point.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getAutoText()
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#getAutoText:member(1)'
- package: ExcelScript!
- fullName: getAutoText()
- summary: Specifies if data labels automatically generate appropriate text based on context.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAutoText(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getFormat()
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#getFormat:member(1)'
- package: ExcelScript!
- fullName: getFormat()
- summary: 'Specifies the format of chart data labels, which includes fill and font formatting.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormat(): ChartDataLabelFormat;'
- return:
- type: ''
- description: ''
- - name: getHorizontalAlignment()
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#getHorizontalAlignment:member(1)'
- package: ExcelScript!
- fullName: getHorizontalAlignment()
- summary: >-
- Specifies the horizontal alignment for chart data label. See `ExcelScript.ChartTextHorizontalAlignment` for
- details. This property is valid only when the `TextOrientation` of data label is 0.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHorizontalAlignment(): ChartTextHorizontalAlignment;'
- return:
- type: ''
- description: ''
- - name: getLinkNumberFormat()
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#getLinkNumberFormat:member(1)'
- package: ExcelScript!
- fullName: getLinkNumberFormat()
- summary: >-
- Specifies if the number format is linked to the cells. If `true`, the number format will change in the
- labels when it changes in the cells.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLinkNumberFormat(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getNumberFormat()
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#getNumberFormat:member(1)'
- package: ExcelScript!
- fullName: getNumberFormat()
- summary: Specifies the format code for data labels.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNumberFormat(): string;'
- return:
- type: string
- description: ''
- - name: getPosition()
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#getPosition:member(1)'
- package: ExcelScript!
- fullName: getPosition()
- summary: Value that represents the position of the data label. See `ExcelScript.ChartDataLabelPosition` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPosition(): ChartDataLabelPosition;'
- return:
- type: ''
- description: ''
- - name: getSeparator()
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#getSeparator:member(1)'
- package: ExcelScript!
- fullName: getSeparator()
- summary: String representing the separator used for the data labels on a chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSeparator(): string;'
- return:
- type: string
- description: ''
- - name: getShowBubbleSize()
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#getShowBubbleSize:member(1)'
- package: ExcelScript!
- fullName: getShowBubbleSize()
- summary: Specifies if the data label bubble size is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowBubbleSize(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowCategoryName()
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#getShowCategoryName:member(1)'
- package: ExcelScript!
- fullName: getShowCategoryName()
- summary: Specifies if the data label category name is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowCategoryName(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowLegendKey()
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#getShowLegendKey:member(1)'
- package: ExcelScript!
- fullName: getShowLegendKey()
- summary: Specifies if the data label legend key is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowLegendKey(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowPercentage()
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#getShowPercentage:member(1)'
- package: ExcelScript!
- fullName: getShowPercentage()
- summary: Specifies if the data label percentage is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowPercentage(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowSeriesName()
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#getShowSeriesName:member(1)'
- package: ExcelScript!
- fullName: getShowSeriesName()
- summary: Specifies if the data label series name is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowSeriesName(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowValue()
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#getShowValue:member(1)'
- package: ExcelScript!
- fullName: getShowValue()
- summary: Specifies if the data label value is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowValue(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getTextOrientation()
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#getTextOrientation:member(1)'
- package: ExcelScript!
- fullName: getTextOrientation()
- summary: >-
- Represents the angle to which the text is oriented for data labels. The value should either be an integer from -90
- to 90 or the integer 180 for vertically-oriented text.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTextOrientation(): number;'
- return:
- type: number
- description: ''
- - name: getVerticalAlignment()
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#getVerticalAlignment:member(1)'
- package: ExcelScript!
- fullName: getVerticalAlignment()
- summary: >-
- Represents the vertical alignment of chart data label. See `ExcelScript.ChartTextVerticalAlignment` for details.
- This property is valid only when `TextOrientation` of the data label is -90, 90, or 180.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVerticalAlignment(): ChartTextVerticalAlignment;'
- return:
- type: ''
- description: ''
- - name: setAutoText(autoText)
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#setAutoText:member(1)'
- package: ExcelScript!
- fullName: setAutoText(autoText)
- summary: Specifies if data labels automatically generate appropriate text based on context.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setAutoText(autoText: boolean): void;'
- parameters:
- - id: autoText
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setHorizontalAlignment(horizontalAlignment)
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#setHorizontalAlignment:member(1)'
- package: ExcelScript!
- fullName: setHorizontalAlignment(horizontalAlignment)
- summary: >-
- Specifies the horizontal alignment for chart data label. See `ExcelScript.ChartTextHorizontalAlignment` for
- details. This property is valid only when the `TextOrientation` of data label is 0.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setHorizontalAlignment(
- horizontalAlignment: ChartTextHorizontalAlignment
- ): void;
- parameters:
- - id: horizontalAlignment
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setLinkNumberFormat(linkNumberFormat)
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#setLinkNumberFormat:member(1)'
- package: ExcelScript!
- fullName: setLinkNumberFormat(linkNumberFormat)
- summary: >-
- Specifies if the number format is linked to the cells. If `true`, the number format will change in the
- labels when it changes in the cells.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLinkNumberFormat(linkNumberFormat: boolean): void;'
- parameters:
- - id: linkNumberFormat
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setNumberFormat(numberFormat)
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#setNumberFormat:member(1)'
- package: ExcelScript!
- fullName: setNumberFormat(numberFormat)
- summary: Specifies the format code for data labels.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setNumberFormat(numberFormat: string): void;'
- parameters:
- - id: numberFormat
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setPosition(position)
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#setPosition:member(1)'
- package: ExcelScript!
- fullName: setPosition(position)
- summary: Value that represents the position of the data label. See `ExcelScript.ChartDataLabelPosition` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPosition(position: ChartDataLabelPosition): void;'
- parameters:
- - id: position
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setSeparator(separator)
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#setSeparator:member(1)'
- package: ExcelScript!
- fullName: setSeparator(separator)
- summary: String representing the separator used for the data labels on a chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setSeparator(separator: string): void;'
- parameters:
- - id: separator
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setShowBubbleSize(showBubbleSize)
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#setShowBubbleSize:member(1)'
- package: ExcelScript!
- fullName: setShowBubbleSize(showBubbleSize)
- summary: Specifies if the data label bubble size is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowBubbleSize(showBubbleSize: boolean): void;'
- parameters:
- - id: showBubbleSize
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowCategoryName(showCategoryName)
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#setShowCategoryName:member(1)'
- package: ExcelScript!
- fullName: setShowCategoryName(showCategoryName)
- summary: Specifies if the data label category name is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowCategoryName(showCategoryName: boolean): void;'
- parameters:
- - id: showCategoryName
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowLegendKey(showLegendKey)
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#setShowLegendKey:member(1)'
- package: ExcelScript!
- fullName: setShowLegendKey(showLegendKey)
- summary: Specifies if the data label legend key is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowLegendKey(showLegendKey: boolean): void;'
- parameters:
- - id: showLegendKey
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowPercentage(showPercentage)
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#setShowPercentage:member(1)'
- package: ExcelScript!
- fullName: setShowPercentage(showPercentage)
- summary: Specifies if the data label percentage is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowPercentage(showPercentage: boolean): void;'
- parameters:
- - id: showPercentage
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowSeriesName(showSeriesName)
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#setShowSeriesName:member(1)'
- package: ExcelScript!
- fullName: setShowSeriesName(showSeriesName)
- summary: Specifies if the data label series name is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowSeriesName(showSeriesName: boolean): void;'
- parameters:
- - id: showSeriesName
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowValue(showValue)
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#setShowValue:member(1)'
- package: ExcelScript!
- fullName: setShowValue(showValue)
- summary: Specifies if the data label value is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowValue(showValue: boolean): void;'
- parameters:
- - id: showValue
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setTextOrientation(textOrientation)
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#setTextOrientation:member(1)'
- package: ExcelScript!
- fullName: setTextOrientation(textOrientation)
- summary: >-
- Represents the angle to which the text is oriented for data labels. The value should either be an integer from -90
- to 90 or the integer 180 for vertically-oriented text.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTextOrientation(textOrientation: number): void;'
- parameters:
- - id: textOrientation
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setVerticalAlignment(verticalAlignment)
- uid: 'ExcelScript!ExcelScript.ChartDataLabels#setVerticalAlignment:member(1)'
- package: ExcelScript!
- fullName: setVerticalAlignment(verticalAlignment)
- summary: >-
- Represents the vertical alignment of chart data label. See `ExcelScript.ChartTextVerticalAlignment` for details.
- This property is valid only when `TextOrientation` of the data label is -90, 90, or 180.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setVerticalAlignment(
- verticalAlignment: ChartTextVerticalAlignment
- ): void;
- parameters:
- - id: verticalAlignment
- description: ''
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartDataLabels
+uid: 'ExcelScript!ExcelScript.ChartDataLabels:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartDataLabels
+summary: Represents a collection of all the data labels on a chart point.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getAutoText()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#getAutoText:member(1)'
+ package: ExcelScript!
+ fullName: getAutoText()
+ summary: Specifies if data labels automatically generate appropriate text based on context.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAutoText(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getFormat()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#getFormat:member(1)'
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: 'Specifies the format of chart data labels, which includes fill and font formatting.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): ChartDataLabelFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getGeometricShapeType()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#getGeometricShapeType:member(1)'
+ package: ExcelScript!
+ fullName: getGeometricShapeType()
+ summary: >-
+ Specifies the geometric shape type of the data labels. See `ExcelScript.GeometricShapeType` for more details.
+ Value is `null` if the data labels are not geometric shapes.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGeometricShapeType(): GeometricShapeType;'
+ return:
+ type: ''
+ description: ''
+ - name: getHorizontalAlignment()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#getHorizontalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: getHorizontalAlignment()
+ summary: >-
+ Specifies the horizontal alignment for chart data label. See `ExcelScript.ChartTextHorizontalAlignment` for
+ details. This property is valid only when the `TextOrientation` of data label is 0.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHorizontalAlignment(): ChartTextHorizontalAlignment;'
+ return:
+ type: ''
+ description: ''
+ - name: getLeaderLines()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#getLeaderLines:member(1)'
+ package: ExcelScript!
+ fullName: getLeaderLines()
+ summary: Gets an object that represents the leader lines of the data labels.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLeaderLines(): ChartLeaderLines;'
+ return:
+ type: ''
+ description: ''
+ - name: getLinkNumberFormat()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#getLinkNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: getLinkNumberFormat()
+ summary: >-
+ Specifies if the number format is linked to the cells. If `true`, the number format will change in the
+ labels when it changes in the cells.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLinkNumberFormat(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getNumberFormat()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#getNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: getNumberFormat()
+ summary: Specifies the format code for data labels.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNumberFormat(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getPosition()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#getPosition:member(1)'
+ package: ExcelScript!
+ fullName: getPosition()
+ summary: Value that represents the position of the data label. See `ExcelScript.ChartDataLabelPosition` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPosition(): ChartDataLabelPosition;'
+ return:
+ type: ''
+ description: ''
+ - name: getSeparator()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#getSeparator:member(1)'
+ package: ExcelScript!
+ fullName: getSeparator()
+ summary: String representing the separator used for the data labels on a chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSeparator(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getShowAsStickyCallout()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#getShowAsStickyCallout:member(1)'
+ package: ExcelScript!
+ fullName: getShowAsStickyCallout()
+ summary: >-
+ Gets a value that indicates whether the data labels are shown as a callout with the tail anchor attached to the
+ data point. If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2",
+ "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See
+ Excel.GeometricShapeType for more details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowAsStickyCallout(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowBubbleSize()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#getShowBubbleSize:member(1)'
+ package: ExcelScript!
+ fullName: getShowBubbleSize()
+ summary: Specifies if the data label bubble size is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowBubbleSize(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowCategoryName()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#getShowCategoryName:member(1)'
+ package: ExcelScript!
+ fullName: getShowCategoryName()
+ summary: Specifies if the data label category name is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowCategoryName(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowLeaderLines()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#getShowLeaderLines:member(1)'
+ package: ExcelScript!
+ fullName: getShowLeaderLines()
+ summary: >-
+ Specifies a value that indicates whether leader lines are displayed for the data labels. `true` if leader lines
+ are shown; otherwise, `false`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowLeaderLines(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowLegendKey()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#getShowLegendKey:member(1)'
+ package: ExcelScript!
+ fullName: getShowLegendKey()
+ summary: Specifies if the data label legend key is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowLegendKey(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowPercentage()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#getShowPercentage:member(1)'
+ package: ExcelScript!
+ fullName: getShowPercentage()
+ summary: Specifies if the data label percentage is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowPercentage(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowSeriesName()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#getShowSeriesName:member(1)'
+ package: ExcelScript!
+ fullName: getShowSeriesName()
+ summary: Specifies if the data label series name is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowSeriesName(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowValue()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#getShowValue:member(1)'
+ package: ExcelScript!
+ fullName: getShowValue()
+ summary: Specifies if the data label value is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowValue(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getTextOrientation()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#getTextOrientation:member(1)'
+ package: ExcelScript!
+ fullName: getTextOrientation()
+ summary: >-
+ Represents the angle to which the text is oriented for data labels. The value should either be an integer from -90
+ to 90 or the integer 180 for vertically-oriented text.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTextOrientation(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getVerticalAlignment()
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#getVerticalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: getVerticalAlignment()
+ summary: >-
+ Represents the vertical alignment of chart data label. See `ExcelScript.ChartTextVerticalAlignment` for details.
+ This property is valid only when `TextOrientation` of the data label is -90, 90, or 180.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVerticalAlignment(): ChartTextVerticalAlignment;'
+ return:
+ type: ''
+ description: ''
+ - name: setAutoText(autoText)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#setAutoText:member(1)'
+ package: ExcelScript!
+ fullName: setAutoText(autoText)
+ summary: Specifies if data labels automatically generate appropriate text based on context.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setAutoText(autoText: boolean): void;'
+ parameters:
+ - id: autoText
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setGeometricShapeType(geometricShapeType)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#setGeometricShapeType:member(1)'
+ package: ExcelScript!
+ fullName: setGeometricShapeType(geometricShapeType)
+ summary: >-
+ Specifies the geometric shape type of the data labels. See `ExcelScript.GeometricShapeType` for more details.
+ Value is `null` if the data labels are not geometric shapes.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setGeometricShapeType(geometricShapeType: GeometricShapeType): void;'
+ parameters:
+ - id: geometricShapeType
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setHorizontalAlignment(horizontalAlignment)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#setHorizontalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: setHorizontalAlignment(horizontalAlignment)
+ summary: >-
+ Specifies the horizontal alignment for chart data label. See `ExcelScript.ChartTextHorizontalAlignment` for
+ details. This property is valid only when the `TextOrientation` of data label is 0.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setHorizontalAlignment(
+ horizontalAlignment: ChartTextHorizontalAlignment
+ ): void;
+ parameters:
+ - id: horizontalAlignment
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setLinkNumberFormat(linkNumberFormat)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#setLinkNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: setLinkNumberFormat(linkNumberFormat)
+ summary: >-
+ Specifies if the number format is linked to the cells. If `true`, the number format will change in the
+ labels when it changes in the cells.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLinkNumberFormat(linkNumberFormat: boolean): void;'
+ parameters:
+ - id: linkNumberFormat
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setNumberFormat(numberFormat)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#setNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: setNumberFormat(numberFormat)
+ summary: Specifies the format code for data labels.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setNumberFormat(numberFormat: string): void;'
+ parameters:
+ - id: numberFormat
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setPosition(position)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#setPosition:member(1)'
+ package: ExcelScript!
+ fullName: setPosition(position)
+ summary: Value that represents the position of the data label. See `ExcelScript.ChartDataLabelPosition` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPosition(position: ChartDataLabelPosition): void;'
+ parameters:
+ - id: position
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setSeparator(separator)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#setSeparator:member(1)'
+ package: ExcelScript!
+ fullName: setSeparator(separator)
+ summary: String representing the separator used for the data labels on a chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSeparator(separator: string): void;'
+ parameters:
+ - id: separator
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setShowBubbleSize(showBubbleSize)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#setShowBubbleSize:member(1)'
+ package: ExcelScript!
+ fullName: setShowBubbleSize(showBubbleSize)
+ summary: Specifies if the data label bubble size is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowBubbleSize(showBubbleSize: boolean): void;'
+ parameters:
+ - id: showBubbleSize
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowCategoryName(showCategoryName)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#setShowCategoryName:member(1)'
+ package: ExcelScript!
+ fullName: setShowCategoryName(showCategoryName)
+ summary: Specifies if the data label category name is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowCategoryName(showCategoryName: boolean): void;'
+ parameters:
+ - id: showCategoryName
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowLeaderLines(showLeaderLines)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#setShowLeaderLines:member(1)'
+ package: ExcelScript!
+ fullName: setShowLeaderLines(showLeaderLines)
+ summary: >-
+ Specifies a value that indicates whether leader lines are displayed for the data labels. `true` if leader lines
+ are shown; otherwise, `false`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowLeaderLines(showLeaderLines: boolean): void;'
+ parameters:
+ - id: showLeaderLines
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowLegendKey(showLegendKey)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#setShowLegendKey:member(1)'
+ package: ExcelScript!
+ fullName: setShowLegendKey(showLegendKey)
+ summary: Specifies if the data label legend key is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowLegendKey(showLegendKey: boolean): void;'
+ parameters:
+ - id: showLegendKey
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowPercentage(showPercentage)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#setShowPercentage:member(1)'
+ package: ExcelScript!
+ fullName: setShowPercentage(showPercentage)
+ summary: Specifies if the data label percentage is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowPercentage(showPercentage: boolean): void;'
+ parameters:
+ - id: showPercentage
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowSeriesName(showSeriesName)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#setShowSeriesName:member(1)'
+ package: ExcelScript!
+ fullName: setShowSeriesName(showSeriesName)
+ summary: Specifies if the data label series name is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowSeriesName(showSeriesName: boolean): void;'
+ parameters:
+ - id: showSeriesName
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowValue(showValue)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#setShowValue:member(1)'
+ package: ExcelScript!
+ fullName: setShowValue(showValue)
+ summary: Specifies if the data label value is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowValue(showValue: boolean): void;'
+ parameters:
+ - id: showValue
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setTextOrientation(textOrientation)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#setTextOrientation:member(1)'
+ package: ExcelScript!
+ fullName: setTextOrientation(textOrientation)
+ summary: >-
+ Represents the angle to which the text is oriented for data labels. The value should either be an integer from -90
+ to 90 or the integer 180 for vertically-oriented text.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTextOrientation(textOrientation: number): void;'
+ parameters:
+ - id: textOrientation
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setVerticalAlignment(verticalAlignment)
+ uid: 'ExcelScript!ExcelScript.ChartDataLabels#setVerticalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: setVerticalAlignment(verticalAlignment)
+ summary: >-
+ Represents the vertical alignment of chart data label. See `ExcelScript.ChartTextVerticalAlignment` for details.
+ This property is valid only when `TextOrientation` of the data label is -90, 90, or 180.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setVerticalAlignment(
+ verticalAlignment: ChartTextVerticalAlignment
+ ): void;
+ parameters:
+ - id: verticalAlignment
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatasourcetype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatasourcetype.yml
index c38d11e9..6eedfe68 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatasourcetype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatasourcetype.yml
@@ -1,26 +1,26 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartDataSourceType
-uid: 'ExcelScript!ExcelScript.ChartDataSourceType:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartDataSourceType
-summary: Specifies the data source type of the chart series.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: externalRange
- uid: 'ExcelScript!ExcelScript.ChartDataSourceType.externalRange:member'
- package: ExcelScript!
- summary: The data source type of the chart series is an external range.
- - name: list
- uid: 'ExcelScript!ExcelScript.ChartDataSourceType.list:member'
- package: ExcelScript!
- summary: The data source type of the chart series is a list.
- - name: localRange
- uid: 'ExcelScript!ExcelScript.ChartDataSourceType.localRange:member'
- package: ExcelScript!
- summary: The data source type of the chart series is a local range.
- - name: unknown
- uid: 'ExcelScript!ExcelScript.ChartDataSourceType.unknown:member'
- package: ExcelScript!
- summary: The data source type of the chart series is unknown or unsupported.
+### YamlMime:TSEnum
+name: ExcelScript.ChartDataSourceType
+uid: 'ExcelScript!ExcelScript.ChartDataSourceType:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartDataSourceType
+summary: Specifies the data source type of the chart series.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: externalRange
+ uid: 'ExcelScript!ExcelScript.ChartDataSourceType.externalRange:member'
+ package: ExcelScript!
+ summary: The data source type of the chart series is an external range.
+ - name: list
+ uid: 'ExcelScript!ExcelScript.ChartDataSourceType.list:member'
+ package: ExcelScript!
+ summary: The data source type of the chart series is a list.
+ - name: localRange
+ uid: 'ExcelScript!ExcelScript.ChartDataSourceType.localRange:member'
+ package: ExcelScript!
+ summary: The data source type of the chart series is a local range.
+ - name: unknown
+ uid: 'ExcelScript!ExcelScript.ChartDataSourceType.unknown:member'
+ package: ExcelScript!
+ summary: The data source type of the chart series is unknown or unsupported.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatatable.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatatable.yml
index ac9fe775..7abbe110 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatatable.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatatable.yml
@@ -1,174 +1,174 @@
-### YamlMime:TSType
-name: ExcelScript.ChartDataTable
-uid: 'ExcelScript!ExcelScript.ChartDataTable:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartDataTable
-summary: Represents the data table object of a chart.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getFormat()
- uid: 'ExcelScript!ExcelScript.ChartDataTable#getFormat:member(1)'
- package: ExcelScript!
- fullName: getFormat()
- summary: 'Represents the format of a chart data table, which includes fill, font, and border format.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormat(): ChartDataTableFormat;'
- return:
- type: ''
- description: ''
- - name: getShowHorizontalBorder()
- uid: 'ExcelScript!ExcelScript.ChartDataTable#getShowHorizontalBorder:member(1)'
- package: ExcelScript!
- fullName: getShowHorizontalBorder()
- summary: Specifies whether to display the horizontal border of the data table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowHorizontalBorder(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowLegendKey()
- uid: 'ExcelScript!ExcelScript.ChartDataTable#getShowLegendKey:member(1)'
- package: ExcelScript!
- fullName: getShowLegendKey()
- summary: Specifies whether to show the legend key of the data table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowLegendKey(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowOutlineBorder()
- uid: 'ExcelScript!ExcelScript.ChartDataTable#getShowOutlineBorder:member(1)'
- package: ExcelScript!
- fullName: getShowOutlineBorder()
- summary: Specifies whether to display the outline border of the data table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowOutlineBorder(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowVerticalBorder()
- uid: 'ExcelScript!ExcelScript.ChartDataTable#getShowVerticalBorder:member(1)'
- package: ExcelScript!
- fullName: getShowVerticalBorder()
- summary: Specifies whether to display the vertical border of the data table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowVerticalBorder(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getVisible()
- uid: 'ExcelScript!ExcelScript.ChartDataTable#getVisible:member(1)'
- package: ExcelScript!
- fullName: getVisible()
- summary: Specifies whether to show the data table of the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVisible(): boolean;'
- return:
- type: boolean
- description: ''
- - name: setShowHorizontalBorder(showHorizontalBorder)
- uid: 'ExcelScript!ExcelScript.ChartDataTable#setShowHorizontalBorder:member(1)'
- package: ExcelScript!
- fullName: setShowHorizontalBorder(showHorizontalBorder)
- summary: Specifies whether to display the horizontal border of the data table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowHorizontalBorder(showHorizontalBorder: boolean): void;'
- parameters:
- - id: showHorizontalBorder
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowLegendKey(showLegendKey)
- uid: 'ExcelScript!ExcelScript.ChartDataTable#setShowLegendKey:member(1)'
- package: ExcelScript!
- fullName: setShowLegendKey(showLegendKey)
- summary: Specifies whether to show the legend key of the data table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowLegendKey(showLegendKey: boolean): void;'
- parameters:
- - id: showLegendKey
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowOutlineBorder(showOutlineBorder)
- uid: 'ExcelScript!ExcelScript.ChartDataTable#setShowOutlineBorder:member(1)'
- package: ExcelScript!
- fullName: setShowOutlineBorder(showOutlineBorder)
- summary: Specifies whether to display the outline border of the data table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowOutlineBorder(showOutlineBorder: boolean): void;'
- parameters:
- - id: showOutlineBorder
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowVerticalBorder(showVerticalBorder)
- uid: 'ExcelScript!ExcelScript.ChartDataTable#setShowVerticalBorder:member(1)'
- package: ExcelScript!
- fullName: setShowVerticalBorder(showVerticalBorder)
- summary: Specifies whether to display the vertical border of the data table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowVerticalBorder(showVerticalBorder: boolean): void;'
- parameters:
- - id: showVerticalBorder
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setVisible(visible)
- uid: 'ExcelScript!ExcelScript.ChartDataTable#setVisible:member(1)'
- package: ExcelScript!
- fullName: setVisible(visible)
- summary: Specifies whether to show the data table of the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setVisible(visible: boolean): void;'
- parameters:
- - id: visible
- description: ''
- type: boolean
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartDataTable
+uid: 'ExcelScript!ExcelScript.ChartDataTable:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartDataTable
+summary: Represents the data table object of a chart.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getFormat()
+ uid: 'ExcelScript!ExcelScript.ChartDataTable#getFormat:member(1)'
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: 'Represents the format of a chart data table, which includes fill, font, and border format.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): ChartDataTableFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getShowHorizontalBorder()
+ uid: 'ExcelScript!ExcelScript.ChartDataTable#getShowHorizontalBorder:member(1)'
+ package: ExcelScript!
+ fullName: getShowHorizontalBorder()
+ summary: Specifies whether to display the horizontal border of the data table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowHorizontalBorder(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowLegendKey()
+ uid: 'ExcelScript!ExcelScript.ChartDataTable#getShowLegendKey:member(1)'
+ package: ExcelScript!
+ fullName: getShowLegendKey()
+ summary: Specifies whether to show the legend key of the data table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowLegendKey(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowOutlineBorder()
+ uid: 'ExcelScript!ExcelScript.ChartDataTable#getShowOutlineBorder:member(1)'
+ package: ExcelScript!
+ fullName: getShowOutlineBorder()
+ summary: Specifies whether to display the outline border of the data table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowOutlineBorder(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowVerticalBorder()
+ uid: 'ExcelScript!ExcelScript.ChartDataTable#getShowVerticalBorder:member(1)'
+ package: ExcelScript!
+ fullName: getShowVerticalBorder()
+ summary: Specifies whether to display the vertical border of the data table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowVerticalBorder(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getVisible()
+ uid: 'ExcelScript!ExcelScript.ChartDataTable#getVisible:member(1)'
+ package: ExcelScript!
+ fullName: getVisible()
+ summary: Specifies whether to show the data table of the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVisible(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: setShowHorizontalBorder(showHorizontalBorder)
+ uid: 'ExcelScript!ExcelScript.ChartDataTable#setShowHorizontalBorder:member(1)'
+ package: ExcelScript!
+ fullName: setShowHorizontalBorder(showHorizontalBorder)
+ summary: Specifies whether to display the horizontal border of the data table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowHorizontalBorder(showHorizontalBorder: boolean): void;'
+ parameters:
+ - id: showHorizontalBorder
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowLegendKey(showLegendKey)
+ uid: 'ExcelScript!ExcelScript.ChartDataTable#setShowLegendKey:member(1)'
+ package: ExcelScript!
+ fullName: setShowLegendKey(showLegendKey)
+ summary: Specifies whether to show the legend key of the data table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowLegendKey(showLegendKey: boolean): void;'
+ parameters:
+ - id: showLegendKey
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowOutlineBorder(showOutlineBorder)
+ uid: 'ExcelScript!ExcelScript.ChartDataTable#setShowOutlineBorder:member(1)'
+ package: ExcelScript!
+ fullName: setShowOutlineBorder(showOutlineBorder)
+ summary: Specifies whether to display the outline border of the data table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowOutlineBorder(showOutlineBorder: boolean): void;'
+ parameters:
+ - id: showOutlineBorder
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowVerticalBorder(showVerticalBorder)
+ uid: 'ExcelScript!ExcelScript.ChartDataTable#setShowVerticalBorder:member(1)'
+ package: ExcelScript!
+ fullName: setShowVerticalBorder(showVerticalBorder)
+ summary: Specifies whether to display the vertical border of the data table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowVerticalBorder(showVerticalBorder: boolean): void;'
+ parameters:
+ - id: showVerticalBorder
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setVisible(visible)
+ uid: 'ExcelScript!ExcelScript.ChartDataTable#setVisible:member(1)'
+ package: ExcelScript!
+ fullName: setVisible(visible)
+ summary: Specifies whether to show the data table of the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setVisible(visible: boolean): void;'
+ parameters:
+ - id: visible
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatatableformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatatableformat.yml
index 3378467f..507db2ba 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatatableformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdatatableformat.yml
@@ -1,50 +1,50 @@
-### YamlMime:TSType
-name: ExcelScript.ChartDataTableFormat
-uid: 'ExcelScript!ExcelScript.ChartDataTableFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartDataTableFormat
-summary: Represents the format of a chart data table.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getBorder()
- uid: 'ExcelScript!ExcelScript.ChartDataTableFormat#getBorder:member(1)'
- package: ExcelScript!
- fullName: getBorder()
- summary: 'Represents the border format of chart data table, which includes color, line style, and weight.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBorder(): ChartBorder;'
- return:
- type: ''
- description: ''
- - name: getFill()
- uid: 'ExcelScript!ExcelScript.ChartDataTableFormat#getFill:member(1)'
- package: ExcelScript!
- fullName: getFill()
- summary: 'Represents the fill format of an object, which includes background formatting information.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFill(): ChartFill;'
- return:
- type: ''
- description: ''
- - name: getFont()
- uid: 'ExcelScript!ExcelScript.ChartDataTableFormat#getFont:member(1)'
- package: ExcelScript!
- fullName: getFont()
- summary: 'Represents the font attributes (such as font name, font size, and color) for the current object.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFont(): ChartFont;'
- return:
- type: ''
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartDataTableFormat
+uid: 'ExcelScript!ExcelScript.ChartDataTableFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartDataTableFormat
+summary: Represents the format of a chart data table.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getBorder()
+ uid: 'ExcelScript!ExcelScript.ChartDataTableFormat#getBorder:member(1)'
+ package: ExcelScript!
+ fullName: getBorder()
+ summary: 'Represents the border format of chart data table, which includes color, line style, and weight.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBorder(): ChartBorder;'
+ return:
+ type: ''
+ description: ''
+ - name: getFill()
+ uid: 'ExcelScript!ExcelScript.ChartDataTableFormat#getFill:member(1)'
+ package: ExcelScript!
+ fullName: getFill()
+ summary: 'Represents the fill format of an object, which includes background formatting information.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFill(): ChartFill;'
+ return:
+ type: ''
+ description: ''
+ - name: getFont()
+ uid: 'ExcelScript!ExcelScript.ChartDataTableFormat#getFont:member(1)'
+ package: ExcelScript!
+ fullName: getFont()
+ summary: 'Represents the font attributes (such as font name, font size, and color) for the current object.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFont(): ChartFont;'
+ return:
+ type: ''
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdisplayblanksas.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdisplayblanksas.yml
index 3a5fde96..556a339d 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdisplayblanksas.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartdisplayblanksas.yml
@@ -1,22 +1,22 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartDisplayBlanksAs
-uid: 'ExcelScript!ExcelScript.ChartDisplayBlanksAs:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartDisplayBlanksAs
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: interplotted
- uid: 'ExcelScript!ExcelScript.ChartDisplayBlanksAs.interplotted:member'
- package: ExcelScript!
- summary: ''
- - name: notPlotted
- uid: 'ExcelScript!ExcelScript.ChartDisplayBlanksAs.notPlotted:member'
- package: ExcelScript!
- summary: ''
- - name: zero
- uid: 'ExcelScript!ExcelScript.ChartDisplayBlanksAs.zero:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartDisplayBlanksAs
+uid: 'ExcelScript!ExcelScript.ChartDisplayBlanksAs:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartDisplayBlanksAs
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: interplotted
+ uid: 'ExcelScript!ExcelScript.ChartDisplayBlanksAs.interplotted:member'
+ package: ExcelScript!
+ summary: ''
+ - name: notPlotted
+ uid: 'ExcelScript!ExcelScript.ChartDisplayBlanksAs.notPlotted:member'
+ package: ExcelScript!
+ summary: ''
+ - name: zero
+ uid: 'ExcelScript!ExcelScript.ChartDisplayBlanksAs.zero:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.charterrorbars.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.charterrorbars.yml
index cd68ef73..c22ddfa5 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.charterrorbars.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.charterrorbars.yml
@@ -1,144 +1,144 @@
-### YamlMime:TSType
-name: ExcelScript.ChartErrorBars
-uid: 'ExcelScript!ExcelScript.ChartErrorBars:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartErrorBars
-summary: This object represents the attributes for a chart's error bars.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getEndStyleCap()
- uid: 'ExcelScript!ExcelScript.ChartErrorBars#getEndStyleCap:member(1)'
- package: ExcelScript!
- fullName: getEndStyleCap()
- summary: Specifies if error bars have an end style cap.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getEndStyleCap(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getFormat()
- uid: 'ExcelScript!ExcelScript.ChartErrorBars#getFormat:member(1)'
- package: ExcelScript!
- fullName: getFormat()
- summary: Specifies the formatting type of the error bars.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormat(): ChartErrorBarsFormat;'
- return:
- type: ''
- description: ''
- - name: getInclude()
- uid: 'ExcelScript!ExcelScript.ChartErrorBars#getInclude:member(1)'
- package: ExcelScript!
- fullName: getInclude()
- summary: Specifies which parts of the error bars to include.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getInclude(): ChartErrorBarsInclude;'
- return:
- type: ''
- description: ''
- - name: getType()
- uid: 'ExcelScript!ExcelScript.ChartErrorBars#getType:member(1)'
- package: ExcelScript!
- fullName: getType()
- summary: The type of range marked by the error bars.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getType(): ChartErrorBarsType;'
- return:
- type: ''
- description: ''
- - name: getVisible()
- uid: 'ExcelScript!ExcelScript.ChartErrorBars#getVisible:member(1)'
- package: ExcelScript!
- fullName: getVisible()
- summary: Specifies whether the error bars are displayed.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVisible(): boolean;'
- return:
- type: boolean
- description: ''
- - name: setEndStyleCap(endStyleCap)
- uid: 'ExcelScript!ExcelScript.ChartErrorBars#setEndStyleCap:member(1)'
- package: ExcelScript!
- fullName: setEndStyleCap(endStyleCap)
- summary: Specifies if error bars have an end style cap.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setEndStyleCap(endStyleCap: boolean): void;'
- parameters:
- - id: endStyleCap
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setInclude(include)
- uid: 'ExcelScript!ExcelScript.ChartErrorBars#setInclude:member(1)'
- package: ExcelScript!
- fullName: setInclude(include)
- summary: Specifies which parts of the error bars to include.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setInclude(include: ChartErrorBarsInclude): void;'
- parameters:
- - id: include
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setType(type)
- uid: 'ExcelScript!ExcelScript.ChartErrorBars#setType:member(1)'
- package: ExcelScript!
- fullName: setType(type)
- summary: The type of range marked by the error bars.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setType(type: ChartErrorBarsType): void;'
- parameters:
- - id: type
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setVisible(visible)
- uid: 'ExcelScript!ExcelScript.ChartErrorBars#setVisible:member(1)'
- package: ExcelScript!
- fullName: setVisible(visible)
- summary: Specifies whether the error bars are displayed.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setVisible(visible: boolean): void;'
- parameters:
- - id: visible
- description: ''
- type: boolean
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartErrorBars
+uid: 'ExcelScript!ExcelScript.ChartErrorBars:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartErrorBars
+summary: This object represents the attributes for a chart's error bars.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getEndStyleCap()
+ uid: 'ExcelScript!ExcelScript.ChartErrorBars#getEndStyleCap:member(1)'
+ package: ExcelScript!
+ fullName: getEndStyleCap()
+ summary: Specifies if error bars have an end style cap.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getEndStyleCap(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getFormat()
+ uid: 'ExcelScript!ExcelScript.ChartErrorBars#getFormat:member(1)'
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: Specifies the formatting type of the error bars.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): ChartErrorBarsFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getInclude()
+ uid: 'ExcelScript!ExcelScript.ChartErrorBars#getInclude:member(1)'
+ package: ExcelScript!
+ fullName: getInclude()
+ summary: Specifies which parts of the error bars to include.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getInclude(): ChartErrorBarsInclude;'
+ return:
+ type: ''
+ description: ''
+ - name: getType()
+ uid: 'ExcelScript!ExcelScript.ChartErrorBars#getType:member(1)'
+ package: ExcelScript!
+ fullName: getType()
+ summary: The type of range marked by the error bars.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getType(): ChartErrorBarsType;'
+ return:
+ type: ''
+ description: ''
+ - name: getVisible()
+ uid: 'ExcelScript!ExcelScript.ChartErrorBars#getVisible:member(1)'
+ package: ExcelScript!
+ fullName: getVisible()
+ summary: Specifies whether the error bars are displayed.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVisible(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: setEndStyleCap(endStyleCap)
+ uid: 'ExcelScript!ExcelScript.ChartErrorBars#setEndStyleCap:member(1)'
+ package: ExcelScript!
+ fullName: setEndStyleCap(endStyleCap)
+ summary: Specifies if error bars have an end style cap.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setEndStyleCap(endStyleCap: boolean): void;'
+ parameters:
+ - id: endStyleCap
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setInclude(include)
+ uid: 'ExcelScript!ExcelScript.ChartErrorBars#setInclude:member(1)'
+ package: ExcelScript!
+ fullName: setInclude(include)
+ summary: Specifies which parts of the error bars to include.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setInclude(include: ChartErrorBarsInclude): void;'
+ parameters:
+ - id: include
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setType(type)
+ uid: 'ExcelScript!ExcelScript.ChartErrorBars#setType:member(1)'
+ package: ExcelScript!
+ fullName: setType(type)
+ summary: The type of range marked by the error bars.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setType(type: ChartErrorBarsType): void;'
+ parameters:
+ - id: type
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setVisible(visible)
+ uid: 'ExcelScript!ExcelScript.ChartErrorBars#setVisible:member(1)'
+ package: ExcelScript!
+ fullName: setVisible(visible)
+ summary: Specifies whether the error bars are displayed.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setVisible(visible: boolean): void;'
+ parameters:
+ - id: visible
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.charterrorbarsformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.charterrorbarsformat.yml
index 7fd95f2e..3103cf56 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.charterrorbarsformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.charterrorbarsformat.yml
@@ -1,24 +1,24 @@
-### YamlMime:TSType
-name: ExcelScript.ChartErrorBarsFormat
-uid: 'ExcelScript!ExcelScript.ChartErrorBarsFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartErrorBarsFormat
-summary: Encapsulates the format properties for chart error bars.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getLine()
- uid: 'ExcelScript!ExcelScript.ChartErrorBarsFormat#getLine:member(1)'
- package: ExcelScript!
- fullName: getLine()
- summary: Represents the chart line formatting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLine(): ChartLineFormat;'
- return:
- type: ''
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartErrorBarsFormat
+uid: 'ExcelScript!ExcelScript.ChartErrorBarsFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartErrorBarsFormat
+summary: Encapsulates the format properties for chart error bars.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getLine()
+ uid: 'ExcelScript!ExcelScript.ChartErrorBarsFormat#getLine:member(1)'
+ package: ExcelScript!
+ fullName: getLine()
+ summary: Represents the chart line formatting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLine(): ChartLineFormat;'
+ return:
+ type: ''
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.charterrorbarsinclude.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.charterrorbarsinclude.yml
index 482a2634..53d02e42 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.charterrorbarsinclude.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.charterrorbarsinclude.yml
@@ -1,22 +1,22 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartErrorBarsInclude
-uid: 'ExcelScript!ExcelScript.ChartErrorBarsInclude:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartErrorBarsInclude
-summary: Represents which parts of the error bar to include.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: both
- uid: 'ExcelScript!ExcelScript.ChartErrorBarsInclude.both:member'
- package: ExcelScript!
- summary: ''
- - name: minusValues
- uid: 'ExcelScript!ExcelScript.ChartErrorBarsInclude.minusValues:member'
- package: ExcelScript!
- summary: ''
- - name: plusValues
- uid: 'ExcelScript!ExcelScript.ChartErrorBarsInclude.plusValues:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartErrorBarsInclude
+uid: 'ExcelScript!ExcelScript.ChartErrorBarsInclude:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartErrorBarsInclude
+summary: Represents which parts of the error bar to include.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: both
+ uid: 'ExcelScript!ExcelScript.ChartErrorBarsInclude.both:member'
+ package: ExcelScript!
+ summary: ''
+ - name: minusValues
+ uid: 'ExcelScript!ExcelScript.ChartErrorBarsInclude.minusValues:member'
+ package: ExcelScript!
+ summary: ''
+ - name: plusValues
+ uid: 'ExcelScript!ExcelScript.ChartErrorBarsInclude.plusValues:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.charterrorbarstype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.charterrorbarstype.yml
index 0b8fc502..703f3614 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.charterrorbarstype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.charterrorbarstype.yml
@@ -1,54 +1,54 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartErrorBarsType
-uid: 'ExcelScript!ExcelScript.ChartErrorBarsType:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartErrorBarsType
-summary: Represents the range type for error bars.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds error bars for the standard error of each chart series point.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range for the chart.
- const worksheet = workbook.getWorksheet("Sample");
- const dataRange = worksheet.getRange("A1:B15");
-
- // Create a line chart.
- const chart = worksheet.addChart(ExcelScript.ChartType.line, dataRange);
-
- // For each series, add error bars for the standard error on each point.
- const allSeries = chart.getSeries();
- allSeries.forEach((series) => {
- series.getYErrorBars().setType(ExcelScript.ChartErrorBarsType.stError);
- series.getYErrorBars().setVisible(true);
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: custom
- uid: 'ExcelScript!ExcelScript.ChartErrorBarsType.custom:member'
- package: ExcelScript!
- summary: ''
- - name: fixedValue
- uid: 'ExcelScript!ExcelScript.ChartErrorBarsType.fixedValue:member'
- package: ExcelScript!
- summary: ''
- - name: percent
- uid: 'ExcelScript!ExcelScript.ChartErrorBarsType.percent:member'
- package: ExcelScript!
- summary: ''
- - name: stDev
- uid: 'ExcelScript!ExcelScript.ChartErrorBarsType.stDev:member'
- package: ExcelScript!
- summary: ''
- - name: stError
- uid: 'ExcelScript!ExcelScript.ChartErrorBarsType.stError:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartErrorBarsType
+uid: 'ExcelScript!ExcelScript.ChartErrorBarsType:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartErrorBarsType
+summary: Represents the range type for error bars.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds error bars for the standard error of each chart series point.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range for the chart.
+ const worksheet = workbook.getWorksheet("Sample");
+ const dataRange = worksheet.getRange("A1:B15");
+
+ // Create a line chart.
+ const chart = worksheet.addChart(ExcelScript.ChartType.line, dataRange);
+
+ // For each series, add error bars for the standard error on each point.
+ const allSeries = chart.getSeries();
+ allSeries.forEach((series) => {
+ series.getYErrorBars().setType(ExcelScript.ChartErrorBarsType.stError);
+ series.getYErrorBars().setVisible(true);
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: custom
+ uid: 'ExcelScript!ExcelScript.ChartErrorBarsType.custom:member'
+ package: ExcelScript!
+ summary: ''
+ - name: fixedValue
+ uid: 'ExcelScript!ExcelScript.ChartErrorBarsType.fixedValue:member'
+ package: ExcelScript!
+ summary: ''
+ - name: percent
+ uid: 'ExcelScript!ExcelScript.ChartErrorBarsType.percent:member'
+ package: ExcelScript!
+ summary: ''
+ - name: stDev
+ uid: 'ExcelScript!ExcelScript.ChartErrorBarsType.stDev:member'
+ package: ExcelScript!
+ summary: ''
+ - name: stError
+ uid: 'ExcelScript!ExcelScript.ChartErrorBarsType.stError:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartfill.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartfill.yml
index b3dc5f1e..8e5d63d6 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartfill.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartfill.yml
@@ -1,56 +1,56 @@
-### YamlMime:TSType
-name: ExcelScript.ChartFill
-uid: 'ExcelScript!ExcelScript.ChartFill:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartFill
-summary: Represents the fill formatting for a chart element.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: clear()
- uid: 'ExcelScript!ExcelScript.ChartFill#clear:member(1)'
- package: ExcelScript!
- fullName: clear()
- summary: Clears the fill color of a chart element.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'clear(): void;'
- return:
- type: void
- description: ''
- - name: getSolidColor()
- uid: 'ExcelScript!ExcelScript.ChartFill#getSolidColor:member(1)'
- package: ExcelScript!
- fullName: getSolidColor()
- summary: Gets the uniform color fill formatting of a chart element.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSolidColor(): string;'
- return:
- type: string
- description: ''
- - name: setSolidColor(color)
- uid: 'ExcelScript!ExcelScript.ChartFill#setSolidColor:member(1)'
- package: ExcelScript!
- fullName: setSolidColor(color)
- summary: Sets the fill formatting of a chart element to a uniform color.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setSolidColor(color: string): void;'
- parameters:
- - id: color
- description: >-
- HTML color code representing the color of the background, in the form \#RRGGBB (e.g., "FFA500") or as a
- named HTML color (e.g., "orange").
- type: string
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartFill
+uid: 'ExcelScript!ExcelScript.ChartFill:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartFill
+summary: Represents the fill formatting for a chart element.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: clear()
+ uid: 'ExcelScript!ExcelScript.ChartFill#clear:member(1)'
+ package: ExcelScript!
+ fullName: clear()
+ summary: Clears the fill color of a chart element.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clear(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getSolidColor()
+ uid: 'ExcelScript!ExcelScript.ChartFill#getSolidColor:member(1)'
+ package: ExcelScript!
+ fullName: getSolidColor()
+ summary: Gets the uniform color fill formatting of a chart element.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSolidColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: setSolidColor(color)
+ uid: 'ExcelScript!ExcelScript.ChartFill#setSolidColor:member(1)'
+ package: ExcelScript!
+ fullName: setSolidColor(color)
+ summary: Sets the fill formatting of a chart element to a uniform color.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSolidColor(color: string): void;'
+ parameters:
+ - id: color
+ description: >-
+ HTML color code representing the color of the background, in the form \#RRGGBB (e.g., "FFA500") or as a
+ named HTML color (e.g., "orange").
+ type: string
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartfont.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartfont.yml
index 6849907e..4f9bfcfe 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartfont.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartfont.yml
@@ -1,191 +1,191 @@
-### YamlMime:TSType
-name: ExcelScript.ChartFont
-uid: 'ExcelScript!ExcelScript.ChartFont:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartFont
-summary: 'This object represents the font attributes (such as font name, font size, and color) for a chart object.'
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getBold()
- uid: 'ExcelScript!ExcelScript.ChartFont#getBold:member(1)'
- package: ExcelScript!
- fullName: getBold()
- summary: Represents the bold status of font.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBold(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getColor()
- uid: 'ExcelScript!ExcelScript.ChartFont#getColor:member(1)'
- package: ExcelScript!
- fullName: getColor()
- summary: 'HTML color code representation of the text color (e.g., \#FF0000 represents Red).'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColor(): string;'
- return:
- type: string
- description: ''
- - name: getItalic()
- uid: 'ExcelScript!ExcelScript.ChartFont#getItalic:member(1)'
- package: ExcelScript!
- fullName: getItalic()
- summary: Represents the italic status of the font.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getItalic(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.ChartFont#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: 'Font name (e.g., "Calibri")'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: getSize()
- uid: 'ExcelScript!ExcelScript.ChartFont#getSize:member(1)'
- package: ExcelScript!
- fullName: getSize()
- summary: 'Size of the font (e.g., 11)'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSize(): number;'
- return:
- type: number
- description: ''
- - name: getUnderline()
- uid: 'ExcelScript!ExcelScript.ChartFont#getUnderline:member(1)'
- package: ExcelScript!
- fullName: getUnderline()
- summary: Type of underline applied to the font. See `ExcelScript.ChartUnderlineStyle` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getUnderline(): ChartUnderlineStyle;'
- return:
- type: ''
- description: ''
- - name: setBold(bold)
- uid: 'ExcelScript!ExcelScript.ChartFont#setBold:member(1)'
- package: ExcelScript!
- fullName: setBold(bold)
- summary: Represents the bold status of font.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setBold(bold: boolean): void;'
- parameters:
- - id: bold
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setColor(color)
- uid: 'ExcelScript!ExcelScript.ChartFont#setColor:member(1)'
- package: ExcelScript!
- fullName: setColor(color)
- summary: 'HTML color code representation of the text color (e.g., \#FF0000 represents Red).'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setColor(color: string): void;'
- parameters:
- - id: color
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setItalic(italic)
- uid: 'ExcelScript!ExcelScript.ChartFont#setItalic:member(1)'
- package: ExcelScript!
- fullName: setItalic(italic)
- summary: Represents the italic status of the font.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setItalic(italic: boolean): void;'
- parameters:
- - id: italic
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setName(name)
- uid: 'ExcelScript!ExcelScript.ChartFont#setName:member(1)'
- package: ExcelScript!
- fullName: setName(name)
- summary: 'Font name (e.g., "Calibri")'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setName(name: string): void;'
- parameters:
- - id: name
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setSize(size)
- uid: 'ExcelScript!ExcelScript.ChartFont#setSize:member(1)'
- package: ExcelScript!
- fullName: setSize(size)
- summary: 'Size of the font (e.g., 11)'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setSize(size: number): void;'
- parameters:
- - id: size
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setUnderline(underline)
- uid: 'ExcelScript!ExcelScript.ChartFont#setUnderline:member(1)'
- package: ExcelScript!
- fullName: setUnderline(underline)
- summary: Type of underline applied to the font. See `ExcelScript.ChartUnderlineStyle` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setUnderline(underline: ChartUnderlineStyle): void;'
- parameters:
- - id: underline
- description: ''
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartFont
+uid: 'ExcelScript!ExcelScript.ChartFont:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartFont
+summary: 'This object represents the font attributes (such as font name, font size, and color) for a chart object.'
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getBold()
+ uid: 'ExcelScript!ExcelScript.ChartFont#getBold:member(1)'
+ package: ExcelScript!
+ fullName: getBold()
+ summary: Represents the bold status of font.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBold(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getColor()
+ uid: 'ExcelScript!ExcelScript.ChartFont#getColor:member(1)'
+ package: ExcelScript!
+ fullName: getColor()
+ summary: 'HTML color code representation of the text color (e.g., \#FF0000 represents Red).'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getItalic()
+ uid: 'ExcelScript!ExcelScript.ChartFont#getItalic:member(1)'
+ package: ExcelScript!
+ fullName: getItalic()
+ summary: Represents the italic status of the font.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItalic(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.ChartFont#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: 'Font name (e.g., "Calibri")'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getSize()
+ uid: 'ExcelScript!ExcelScript.ChartFont#getSize:member(1)'
+ package: ExcelScript!
+ fullName: getSize()
+ summary: 'Size of the font (e.g., 11)'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSize(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getUnderline()
+ uid: 'ExcelScript!ExcelScript.ChartFont#getUnderline:member(1)'
+ package: ExcelScript!
+ fullName: getUnderline()
+ summary: Type of underline applied to the font. See `ExcelScript.ChartUnderlineStyle` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getUnderline(): ChartUnderlineStyle;'
+ return:
+ type: ''
+ description: ''
+ - name: setBold(bold)
+ uid: 'ExcelScript!ExcelScript.ChartFont#setBold:member(1)'
+ package: ExcelScript!
+ fullName: setBold(bold)
+ summary: Represents the bold status of font.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setBold(bold: boolean): void;'
+ parameters:
+ - id: bold
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setColor(color)
+ uid: 'ExcelScript!ExcelScript.ChartFont#setColor:member(1)'
+ package: ExcelScript!
+ fullName: setColor(color)
+ summary: 'HTML color code representation of the text color (e.g., \#FF0000 represents Red).'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setColor(color: string): void;'
+ parameters:
+ - id: color
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setItalic(italic)
+ uid: 'ExcelScript!ExcelScript.ChartFont#setItalic:member(1)'
+ package: ExcelScript!
+ fullName: setItalic(italic)
+ summary: Represents the italic status of the font.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setItalic(italic: boolean): void;'
+ parameters:
+ - id: italic
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setName(name)
+ uid: 'ExcelScript!ExcelScript.ChartFont#setName:member(1)'
+ package: ExcelScript!
+ fullName: setName(name)
+ summary: 'Font name (e.g., "Calibri")'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setName(name: string): void;'
+ parameters:
+ - id: name
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setSize(size)
+ uid: 'ExcelScript!ExcelScript.ChartFont#setSize:member(1)'
+ package: ExcelScript!
+ fullName: setSize(size)
+ summary: 'Size of the font (e.g., 11)'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSize(size: number): void;'
+ parameters:
+ - id: size
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setUnderline(underline)
+ uid: 'ExcelScript!ExcelScript.ChartFont#setUnderline:member(1)'
+ package: ExcelScript!
+ fullName: setUnderline(underline)
+ summary: Type of underline applied to the font. See `ExcelScript.ChartUnderlineStyle` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setUnderline(underline: ChartUnderlineStyle): void;'
+ parameters:
+ - id: underline
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartformatstring.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartformatstring.yml
index 812bd34e..149a5e20 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartformatstring.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartformatstring.yml
@@ -1,26 +1,26 @@
-### YamlMime:TSType
-name: ExcelScript.ChartFormatString
-uid: 'ExcelScript!ExcelScript.ChartFormatString:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartFormatString
-summary: >-
- Represents the substring in chart related objects that contain text, like a `ChartTitle` object or `ChartAxisTitle`
- object.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getFont()
- uid: 'ExcelScript!ExcelScript.ChartFormatString#getFont:member(1)'
- package: ExcelScript!
- fullName: getFont()
- summary: 'Represents the font attributes, such as font name, font size, and color of a chart characters object.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFont(): ChartFont;'
- return:
- type: ''
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartFormatString
+uid: 'ExcelScript!ExcelScript.ChartFormatString:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartFormatString
+summary: >-
+ Represents the substring in chart related objects that contain text, like a `ChartTitle` object or `ChartAxisTitle`
+ object.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getFont()
+ uid: 'ExcelScript!ExcelScript.ChartFormatString#getFont:member(1)'
+ package: ExcelScript!
+ fullName: getFont()
+ summary: 'Represents the font attributes, such as font name, font size, and color of a chart characters object.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFont(): ChartFont;'
+ return:
+ type: ''
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartgradientstyle.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartgradientstyle.yml
index 95512406..12ca7fc3 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartgradientstyle.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartgradientstyle.yml
@@ -1,18 +1,18 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartGradientStyle
-uid: 'ExcelScript!ExcelScript.ChartGradientStyle:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartGradientStyle
-summary: Represents the gradient style of a chart series. This is only applicable for region map charts.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: threePhaseColor
- uid: 'ExcelScript!ExcelScript.ChartGradientStyle.threePhaseColor:member'
- package: ExcelScript!
- summary: ''
- - name: twoPhaseColor
- uid: 'ExcelScript!ExcelScript.ChartGradientStyle.twoPhaseColor:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartGradientStyle
+uid: 'ExcelScript!ExcelScript.ChartGradientStyle:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartGradientStyle
+summary: Represents the gradient style of a chart series. This is only applicable for region map charts.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: threePhaseColor
+ uid: 'ExcelScript!ExcelScript.ChartGradientStyle.threePhaseColor:member'
+ package: ExcelScript!
+ summary: ''
+ - name: twoPhaseColor
+ uid: 'ExcelScript!ExcelScript.ChartGradientStyle.twoPhaseColor:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartgradientstyletype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartgradientstyletype.yml
index 898d93ae..75bf6360 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartgradientstyletype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartgradientstyletype.yml
@@ -1,22 +1,22 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartGradientStyleType
-uid: 'ExcelScript!ExcelScript.ChartGradientStyleType:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartGradientStyleType
-summary: Represents the gradient style type of a chart series. This is only applicable for region map charts.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: extremeValue
- uid: 'ExcelScript!ExcelScript.ChartGradientStyleType.extremeValue:member'
- package: ExcelScript!
- summary: ''
- - name: number
- uid: 'ExcelScript!ExcelScript.ChartGradientStyleType.number:member'
- package: ExcelScript!
- summary: ''
- - name: percent
- uid: 'ExcelScript!ExcelScript.ChartGradientStyleType.percent:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartGradientStyleType
+uid: 'ExcelScript!ExcelScript.ChartGradientStyleType:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartGradientStyleType
+summary: Represents the gradient style type of a chart series. This is only applicable for region map charts.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: extremeValue
+ uid: 'ExcelScript!ExcelScript.ChartGradientStyleType.extremeValue:member'
+ package: ExcelScript!
+ summary: ''
+ - name: number
+ uid: 'ExcelScript!ExcelScript.ChartGradientStyleType.number:member'
+ package: ExcelScript!
+ summary: ''
+ - name: percent
+ uid: 'ExcelScript!ExcelScript.ChartGradientStyleType.percent:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartgridlines.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartgridlines.yml
index 23653d59..5793421e 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartgridlines.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartgridlines.yml
@@ -1,54 +1,54 @@
-### YamlMime:TSType
-name: ExcelScript.ChartGridlines
-uid: 'ExcelScript!ExcelScript.ChartGridlines:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartGridlines
-summary: Represents major or minor gridlines on a chart axis.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getFormat()
- uid: 'ExcelScript!ExcelScript.ChartGridlines#getFormat:member(1)'
- package: ExcelScript!
- fullName: getFormat()
- summary: Represents the formatting of chart gridlines.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormat(): ChartGridlinesFormat;'
- return:
- type: ''
- description: ''
- - name: getVisible()
- uid: 'ExcelScript!ExcelScript.ChartGridlines#getVisible:member(1)'
- package: ExcelScript!
- fullName: getVisible()
- summary: Specifies if the axis gridlines are visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVisible(): boolean;'
- return:
- type: boolean
- description: ''
- - name: setVisible(visible)
- uid: 'ExcelScript!ExcelScript.ChartGridlines#setVisible:member(1)'
- package: ExcelScript!
- fullName: setVisible(visible)
- summary: Specifies if the axis gridlines are visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setVisible(visible: boolean): void;'
- parameters:
- - id: visible
- description: ''
- type: boolean
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartGridlines
+uid: 'ExcelScript!ExcelScript.ChartGridlines:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartGridlines
+summary: Represents major or minor gridlines on a chart axis.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getFormat()
+ uid: 'ExcelScript!ExcelScript.ChartGridlines#getFormat:member(1)'
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: Represents the formatting of chart gridlines.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): ChartGridlinesFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getVisible()
+ uid: 'ExcelScript!ExcelScript.ChartGridlines#getVisible:member(1)'
+ package: ExcelScript!
+ fullName: getVisible()
+ summary: Specifies if the axis gridlines are visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVisible(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: setVisible(visible)
+ uid: 'ExcelScript!ExcelScript.ChartGridlines#setVisible:member(1)'
+ package: ExcelScript!
+ fullName: setVisible(visible)
+ summary: Specifies if the axis gridlines are visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setVisible(visible: boolean): void;'
+ parameters:
+ - id: visible
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartgridlinesformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartgridlinesformat.yml
index b896dd5f..3ae584d5 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartgridlinesformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartgridlinesformat.yml
@@ -1,24 +1,24 @@
-### YamlMime:TSType
-name: ExcelScript.ChartGridlinesFormat
-uid: 'ExcelScript!ExcelScript.ChartGridlinesFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartGridlinesFormat
-summary: Encapsulates the format properties for chart gridlines.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getLine()
- uid: 'ExcelScript!ExcelScript.ChartGridlinesFormat#getLine:member(1)'
- package: ExcelScript!
- fullName: getLine()
- summary: Represents chart line formatting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLine(): ChartLineFormat;'
- return:
- type: ''
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartGridlinesFormat
+uid: 'ExcelScript!ExcelScript.ChartGridlinesFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartGridlinesFormat
+summary: Encapsulates the format properties for chart gridlines.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getLine()
+ uid: 'ExcelScript!ExcelScript.ChartGridlinesFormat#getLine:member(1)'
+ package: ExcelScript!
+ fullName: getLine()
+ summary: Represents chart line formatting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLine(): ChartLineFormat;'
+ return:
+ type: ''
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartleaderlines.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartleaderlines.yml
new file mode 100644
index 00000000..d6cd95b7
--- /dev/null
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartleaderlines.yml
@@ -0,0 +1,24 @@
+### YamlMime:TSType
+name: ExcelScript.ChartLeaderLines
+uid: 'ExcelScript!ExcelScript.ChartLeaderLines:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartLeaderLines
+summary: Gets an object that represents the formatting of chart leader lines.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getFormat()
+ uid: 'ExcelScript!ExcelScript.ChartLeaderLines#getFormat:member(1)'
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: Represents the formatting of leader lines of data labels in a series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): ChartLeaderLinesFormat;'
+ return:
+ type: ''
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartleaderlinesformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartleaderlinesformat.yml
new file mode 100644
index 00000000..e2269571
--- /dev/null
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartleaderlinesformat.yml
@@ -0,0 +1,24 @@
+### YamlMime:TSType
+name: ExcelScript.ChartLeaderLinesFormat
+uid: 'ExcelScript!ExcelScript.ChartLeaderLinesFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartLeaderLinesFormat
+summary: Encapsulates the format properties for leader lines.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getLine()
+ uid: 'ExcelScript!ExcelScript.ChartLeaderLinesFormat#getLine:member(1)'
+ package: ExcelScript!
+ fullName: getLine()
+ summary: Gets an object that represents the line formatting of chart leader lines.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLine(): ChartLineFormat;'
+ return:
+ type: ''
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartlegend.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartlegend.yml
index 02e383c6..163c7886 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartlegend.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartlegend.yml
@@ -1,277 +1,277 @@
-### YamlMime:TSType
-name: ExcelScript.ChartLegend
-uid: 'ExcelScript!ExcelScript.ChartLegend:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartLegend
-summary: Represents the legend in a chart.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getFormat()
- uid: 'ExcelScript!ExcelScript.ChartLegend#getFormat:member(1)'
- package: ExcelScript!
- fullName: getFormat()
- summary: 'Represents the formatting of a chart legend, which includes fill and font formatting.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormat(): ChartLegendFormat;'
- return:
- type: ''
- description: ''
- - name: getHeight()
- uid: 'ExcelScript!ExcelScript.ChartLegend#getHeight:member(1)'
- package: ExcelScript!
- fullName: getHeight()
- summary: 'Specifies the height, in points, of the legend on the chart. Value is `null` if the legend is not visible.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHeight(): number;'
- return:
- type: number
- description: ''
- - name: getLeft()
- uid: 'ExcelScript!ExcelScript.ChartLegend#getLeft:member(1)'
- package: ExcelScript!
- fullName: getLeft()
- summary: 'Specifies the left value, in points, of the legend on the chart. Value is `null` if the legend is not visible.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLeft(): number;'
- return:
- type: number
- description: ''
- - name: getLegendEntries()
- uid: 'ExcelScript!ExcelScript.ChartLegend#getLegendEntries:member(1)'
- package: ExcelScript!
- fullName: getLegendEntries()
- summary: Represents a collection of legendEntries in the legend.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLegendEntries(): ChartLegendEntry[];'
- return:
- type: '[]'
- description: ''
- - name: getOverlay()
- uid: 'ExcelScript!ExcelScript.ChartLegend#getOverlay:member(1)'
- package: ExcelScript!
- fullName: getOverlay()
- summary: Specifies if the chart legend should overlap with the main body of the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getOverlay(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getPosition()
- uid: 'ExcelScript!ExcelScript.ChartLegend#getPosition:member(1)'
- package: ExcelScript!
- fullName: getPosition()
- summary: Specifies the position of the legend on the chart. See `ExcelScript.ChartLegendPosition` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPosition(): ChartLegendPosition;'
- return:
- type: ''
- description: ''
- - name: getShowShadow()
- uid: 'ExcelScript!ExcelScript.ChartLegend#getShowShadow:member(1)'
- package: ExcelScript!
- fullName: getShowShadow()
- summary: Specifies if the legend has a shadow on the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowShadow(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getTop()
- uid: 'ExcelScript!ExcelScript.ChartLegend#getTop:member(1)'
- package: ExcelScript!
- fullName: getTop()
- summary: Specifies the top of a chart legend.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTop(): number;'
- return:
- type: number
- description: ''
- - name: getVisible()
- uid: 'ExcelScript!ExcelScript.ChartLegend#getVisible:member(1)'
- package: ExcelScript!
- fullName: getVisible()
- summary: Specifies if the chart legend is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVisible(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getWidth()
- uid: 'ExcelScript!ExcelScript.ChartLegend#getWidth:member(1)'
- package: ExcelScript!
- fullName: getWidth()
- summary: 'Specifies the width, in points, of the legend on the chart. Value is `null` if the legend is not visible.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWidth(): number;'
- return:
- type: number
- description: ''
- - name: setHeight(height)
- uid: 'ExcelScript!ExcelScript.ChartLegend#setHeight:member(1)'
- package: ExcelScript!
- fullName: setHeight(height)
- summary: 'Specifies the height, in points, of the legend on the chart. Value is `null` if the legend is not visible.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setHeight(height: number): void;'
- parameters:
- - id: height
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setLeft(left)
- uid: 'ExcelScript!ExcelScript.ChartLegend#setLeft:member(1)'
- package: ExcelScript!
- fullName: setLeft(left)
- summary: 'Specifies the left value, in points, of the legend on the chart. Value is `null` if the legend is not visible.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLeft(left: number): void;'
- parameters:
- - id: left
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setOverlay(overlay)
- uid: 'ExcelScript!ExcelScript.ChartLegend#setOverlay:member(1)'
- package: ExcelScript!
- fullName: setOverlay(overlay)
- summary: Specifies if the chart legend should overlap with the main body of the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setOverlay(overlay: boolean): void;'
- parameters:
- - id: overlay
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setPosition(position)
- uid: 'ExcelScript!ExcelScript.ChartLegend#setPosition:member(1)'
- package: ExcelScript!
- fullName: setPosition(position)
- summary: Specifies the position of the legend on the chart. See `ExcelScript.ChartLegendPosition` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPosition(position: ChartLegendPosition): void;'
- parameters:
- - id: position
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setShowShadow(showShadow)
- uid: 'ExcelScript!ExcelScript.ChartLegend#setShowShadow:member(1)'
- package: ExcelScript!
- fullName: setShowShadow(showShadow)
- summary: Specifies if the legend has a shadow on the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowShadow(showShadow: boolean): void;'
- parameters:
- - id: showShadow
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setTop(top)
- uid: 'ExcelScript!ExcelScript.ChartLegend#setTop:member(1)'
- package: ExcelScript!
- fullName: setTop(top)
- summary: Specifies the top of a chart legend.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTop(top: number): void;'
- parameters:
- - id: top
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setVisible(visible)
- uid: 'ExcelScript!ExcelScript.ChartLegend#setVisible:member(1)'
- package: ExcelScript!
- fullName: setVisible(visible)
- summary: Specifies if the chart legend is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setVisible(visible: boolean): void;'
- parameters:
- - id: visible
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setWidth(width)
- uid: 'ExcelScript!ExcelScript.ChartLegend#setWidth:member(1)'
- package: ExcelScript!
- fullName: setWidth(width)
- summary: 'Specifies the width, in points, of the legend on the chart. Value is `null` if the legend is not visible.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setWidth(width: number): void;'
- parameters:
- - id: width
- description: ''
- type: number
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartLegend
+uid: 'ExcelScript!ExcelScript.ChartLegend:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartLegend
+summary: Represents the legend in a chart.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getFormat()
+ uid: 'ExcelScript!ExcelScript.ChartLegend#getFormat:member(1)'
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: 'Represents the formatting of a chart legend, which includes fill and font formatting.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): ChartLegendFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getHeight()
+ uid: 'ExcelScript!ExcelScript.ChartLegend#getHeight:member(1)'
+ package: ExcelScript!
+ fullName: getHeight()
+ summary: 'Specifies the height, in points, of the legend on the chart. Value is `null` if the legend is not visible.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHeight(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getLeft()
+ uid: 'ExcelScript!ExcelScript.ChartLegend#getLeft:member(1)'
+ package: ExcelScript!
+ fullName: getLeft()
+ summary: 'Specifies the left value, in points, of the legend on the chart. Value is `null` if the legend is not visible.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLeft(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getLegendEntries()
+ uid: 'ExcelScript!ExcelScript.ChartLegend#getLegendEntries:member(1)'
+ package: ExcelScript!
+ fullName: getLegendEntries()
+ summary: Represents a collection of legendEntries in the legend.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLegendEntries(): ChartLegendEntry[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getOverlay()
+ uid: 'ExcelScript!ExcelScript.ChartLegend#getOverlay:member(1)'
+ package: ExcelScript!
+ fullName: getOverlay()
+ summary: Specifies if the chart legend should overlap with the main body of the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getOverlay(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getPosition()
+ uid: 'ExcelScript!ExcelScript.ChartLegend#getPosition:member(1)'
+ package: ExcelScript!
+ fullName: getPosition()
+ summary: Specifies the position of the legend on the chart. See `ExcelScript.ChartLegendPosition` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPosition(): ChartLegendPosition;'
+ return:
+ type: ''
+ description: ''
+ - name: getShowShadow()
+ uid: 'ExcelScript!ExcelScript.ChartLegend#getShowShadow:member(1)'
+ package: ExcelScript!
+ fullName: getShowShadow()
+ summary: Specifies if the legend has a shadow on the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowShadow(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getTop()
+ uid: 'ExcelScript!ExcelScript.ChartLegend#getTop:member(1)'
+ package: ExcelScript!
+ fullName: getTop()
+ summary: Specifies the top of a chart legend.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTop(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getVisible()
+ uid: 'ExcelScript!ExcelScript.ChartLegend#getVisible:member(1)'
+ package: ExcelScript!
+ fullName: getVisible()
+ summary: Specifies if the chart legend is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVisible(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getWidth()
+ uid: 'ExcelScript!ExcelScript.ChartLegend#getWidth:member(1)'
+ package: ExcelScript!
+ fullName: getWidth()
+ summary: 'Specifies the width, in points, of the legend on the chart. Value is `null` if the legend is not visible.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWidth(): number;'
+ return:
+ type: number
+ description: ''
+ - name: setHeight(height)
+ uid: 'ExcelScript!ExcelScript.ChartLegend#setHeight:member(1)'
+ package: ExcelScript!
+ fullName: setHeight(height)
+ summary: 'Specifies the height, in points, of the legend on the chart. Value is `null` if the legend is not visible.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setHeight(height: number): void;'
+ parameters:
+ - id: height
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setLeft(left)
+ uid: 'ExcelScript!ExcelScript.ChartLegend#setLeft:member(1)'
+ package: ExcelScript!
+ fullName: setLeft(left)
+ summary: 'Specifies the left value, in points, of the legend on the chart. Value is `null` if the legend is not visible.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLeft(left: number): void;'
+ parameters:
+ - id: left
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setOverlay(overlay)
+ uid: 'ExcelScript!ExcelScript.ChartLegend#setOverlay:member(1)'
+ package: ExcelScript!
+ fullName: setOverlay(overlay)
+ summary: Specifies if the chart legend should overlap with the main body of the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setOverlay(overlay: boolean): void;'
+ parameters:
+ - id: overlay
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setPosition(position)
+ uid: 'ExcelScript!ExcelScript.ChartLegend#setPosition:member(1)'
+ package: ExcelScript!
+ fullName: setPosition(position)
+ summary: Specifies the position of the legend on the chart. See `ExcelScript.ChartLegendPosition` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPosition(position: ChartLegendPosition): void;'
+ parameters:
+ - id: position
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setShowShadow(showShadow)
+ uid: 'ExcelScript!ExcelScript.ChartLegend#setShowShadow:member(1)'
+ package: ExcelScript!
+ fullName: setShowShadow(showShadow)
+ summary: Specifies if the legend has a shadow on the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowShadow(showShadow: boolean): void;'
+ parameters:
+ - id: showShadow
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setTop(top)
+ uid: 'ExcelScript!ExcelScript.ChartLegend#setTop:member(1)'
+ package: ExcelScript!
+ fullName: setTop(top)
+ summary: Specifies the top of a chart legend.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTop(top: number): void;'
+ parameters:
+ - id: top
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setVisible(visible)
+ uid: 'ExcelScript!ExcelScript.ChartLegend#setVisible:member(1)'
+ package: ExcelScript!
+ fullName: setVisible(visible)
+ summary: Specifies if the chart legend is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setVisible(visible: boolean): void;'
+ parameters:
+ - id: visible
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setWidth(width)
+ uid: 'ExcelScript!ExcelScript.ChartLegend#setWidth:member(1)'
+ package: ExcelScript!
+ fullName: setWidth(width)
+ summary: 'Specifies the width, in points, of the legend on the chart. Value is `null` if the legend is not visible.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setWidth(width: number): void;'
+ parameters:
+ - id: width
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartlegendentry.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartlegendentry.yml
index cd2a8076..82fb73c8 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartlegendentry.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartlegendentry.yml
@@ -1,106 +1,106 @@
-### YamlMime:TSType
-name: ExcelScript.ChartLegendEntry
-uid: 'ExcelScript!ExcelScript.ChartLegendEntry:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartLegendEntry
-summary: Represents the legend entry in `legendEntryCollection`.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getHeight()
- uid: 'ExcelScript!ExcelScript.ChartLegendEntry#getHeight:member(1)'
- package: ExcelScript!
- fullName: getHeight()
- summary: Specifies the height of the legend entry on the chart legend.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHeight(): number;'
- return:
- type: number
- description: ''
- - name: getIndex()
- uid: 'ExcelScript!ExcelScript.ChartLegendEntry#getIndex:member(1)'
- package: ExcelScript!
- fullName: getIndex()
- summary: Specifies the index of the legend entry in the chart legend.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIndex(): number;'
- return:
- type: number
- description: ''
- - name: getLeft()
- uid: 'ExcelScript!ExcelScript.ChartLegendEntry#getLeft:member(1)'
- package: ExcelScript!
- fullName: getLeft()
- summary: Specifies the left value of a chart legend entry.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLeft(): number;'
- return:
- type: number
- description: ''
- - name: getTop()
- uid: 'ExcelScript!ExcelScript.ChartLegendEntry#getTop:member(1)'
- package: ExcelScript!
- fullName: getTop()
- summary: Specifies the top of a chart legend entry.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTop(): number;'
- return:
- type: number
- description: ''
- - name: getVisible()
- uid: 'ExcelScript!ExcelScript.ChartLegendEntry#getVisible:member(1)'
- package: ExcelScript!
- fullName: getVisible()
- summary: Represents the visibility of a chart legend entry.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVisible(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getWidth()
- uid: 'ExcelScript!ExcelScript.ChartLegendEntry#getWidth:member(1)'
- package: ExcelScript!
- fullName: getWidth()
- summary: Represents the width of the legend entry on the chart Legend.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWidth(): number;'
- return:
- type: number
- description: ''
- - name: setVisible(visible)
- uid: 'ExcelScript!ExcelScript.ChartLegendEntry#setVisible:member(1)'
- package: ExcelScript!
- fullName: setVisible(visible)
- summary: Represents the visibility of a chart legend entry.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setVisible(visible: boolean): void;'
- parameters:
- - id: visible
- description: ''
- type: boolean
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartLegendEntry
+uid: 'ExcelScript!ExcelScript.ChartLegendEntry:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartLegendEntry
+summary: Represents the legend entry in `legendEntryCollection`.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getHeight()
+ uid: 'ExcelScript!ExcelScript.ChartLegendEntry#getHeight:member(1)'
+ package: ExcelScript!
+ fullName: getHeight()
+ summary: Specifies the height of the legend entry on the chart legend.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHeight(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getIndex()
+ uid: 'ExcelScript!ExcelScript.ChartLegendEntry#getIndex:member(1)'
+ package: ExcelScript!
+ fullName: getIndex()
+ summary: Specifies the index of the legend entry in the chart legend.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIndex(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getLeft()
+ uid: 'ExcelScript!ExcelScript.ChartLegendEntry#getLeft:member(1)'
+ package: ExcelScript!
+ fullName: getLeft()
+ summary: Specifies the left value of a chart legend entry.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLeft(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getTop()
+ uid: 'ExcelScript!ExcelScript.ChartLegendEntry#getTop:member(1)'
+ package: ExcelScript!
+ fullName: getTop()
+ summary: Specifies the top of a chart legend entry.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTop(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getVisible()
+ uid: 'ExcelScript!ExcelScript.ChartLegendEntry#getVisible:member(1)'
+ package: ExcelScript!
+ fullName: getVisible()
+ summary: Represents the visibility of a chart legend entry.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVisible(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getWidth()
+ uid: 'ExcelScript!ExcelScript.ChartLegendEntry#getWidth:member(1)'
+ package: ExcelScript!
+ fullName: getWidth()
+ summary: Represents the width of the legend entry on the chart Legend.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWidth(): number;'
+ return:
+ type: number
+ description: ''
+ - name: setVisible(visible)
+ uid: 'ExcelScript!ExcelScript.ChartLegendEntry#setVisible:member(1)'
+ package: ExcelScript!
+ fullName: setVisible(visible)
+ summary: Represents the visibility of a chart legend entry.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setVisible(visible: boolean): void;'
+ parameters:
+ - id: visible
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartlegendformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartlegendformat.yml
index f2165c19..171af8bb 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartlegendformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartlegendformat.yml
@@ -1,50 +1,50 @@
-### YamlMime:TSType
-name: ExcelScript.ChartLegendFormat
-uid: 'ExcelScript!ExcelScript.ChartLegendFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartLegendFormat
-summary: Encapsulates the format properties of a chart legend.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getBorder()
- uid: 'ExcelScript!ExcelScript.ChartLegendFormat#getBorder:member(1)'
- package: ExcelScript!
- fullName: getBorder()
- summary: 'Represents the border format, which includes color, linestyle, and weight.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBorder(): ChartBorder;'
- return:
- type: ''
- description: ''
- - name: getFill()
- uid: 'ExcelScript!ExcelScript.ChartLegendFormat#getFill:member(1)'
- package: ExcelScript!
- fullName: getFill()
- summary: 'Represents the fill format of an object, which includes background formatting information.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFill(): ChartFill;'
- return:
- type: ''
- description: ''
- - name: getFont()
- uid: 'ExcelScript!ExcelScript.ChartLegendFormat#getFont:member(1)'
- package: ExcelScript!
- fullName: getFont()
- summary: 'Represents the font attributes such as font name, font size, and color of a chart legend.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFont(): ChartFont;'
- return:
- type: ''
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartLegendFormat
+uid: 'ExcelScript!ExcelScript.ChartLegendFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartLegendFormat
+summary: Encapsulates the format properties of a chart legend.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getBorder()
+ uid: 'ExcelScript!ExcelScript.ChartLegendFormat#getBorder:member(1)'
+ package: ExcelScript!
+ fullName: getBorder()
+ summary: 'Represents the border format, which includes color, linestyle, and weight.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBorder(): ChartBorder;'
+ return:
+ type: ''
+ description: ''
+ - name: getFill()
+ uid: 'ExcelScript!ExcelScript.ChartLegendFormat#getFill:member(1)'
+ package: ExcelScript!
+ fullName: getFill()
+ summary: 'Represents the fill format of an object, which includes background formatting information.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFill(): ChartFill;'
+ return:
+ type: ''
+ description: ''
+ - name: getFont()
+ uid: 'ExcelScript!ExcelScript.ChartLegendFormat#getFont:member(1)'
+ package: ExcelScript!
+ fullName: getFont()
+ summary: 'Represents the font attributes such as font name, font size, and color of a chart legend.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFont(): ChartFont;'
+ return:
+ type: ''
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartlegendposition.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartlegendposition.yml
index 0ba79d25..c974934f 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartlegendposition.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartlegendposition.yml
@@ -1,38 +1,38 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartLegendPosition
-uid: 'ExcelScript!ExcelScript.ChartLegendPosition:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartLegendPosition
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: bottom
- uid: 'ExcelScript!ExcelScript.ChartLegendPosition.bottom:member'
- package: ExcelScript!
- summary: ''
- - name: corner
- uid: 'ExcelScript!ExcelScript.ChartLegendPosition.corner:member'
- package: ExcelScript!
- summary: ''
- - name: custom
- uid: 'ExcelScript!ExcelScript.ChartLegendPosition.custom:member'
- package: ExcelScript!
- summary: ''
- - name: invalid
- uid: 'ExcelScript!ExcelScript.ChartLegendPosition.invalid:member'
- package: ExcelScript!
- summary: ''
- - name: left
- uid: 'ExcelScript!ExcelScript.ChartLegendPosition.left:member'
- package: ExcelScript!
- summary: ''
- - name: right
- uid: 'ExcelScript!ExcelScript.ChartLegendPosition.right:member'
- package: ExcelScript!
- summary: ''
- - name: top
- uid: 'ExcelScript!ExcelScript.ChartLegendPosition.top:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartLegendPosition
+uid: 'ExcelScript!ExcelScript.ChartLegendPosition:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartLegendPosition
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: bottom
+ uid: 'ExcelScript!ExcelScript.ChartLegendPosition.bottom:member'
+ package: ExcelScript!
+ summary: ''
+ - name: corner
+ uid: 'ExcelScript!ExcelScript.ChartLegendPosition.corner:member'
+ package: ExcelScript!
+ summary: ''
+ - name: custom
+ uid: 'ExcelScript!ExcelScript.ChartLegendPosition.custom:member'
+ package: ExcelScript!
+ summary: ''
+ - name: invalid
+ uid: 'ExcelScript!ExcelScript.ChartLegendPosition.invalid:member'
+ package: ExcelScript!
+ summary: ''
+ - name: left
+ uid: 'ExcelScript!ExcelScript.ChartLegendPosition.left:member'
+ package: ExcelScript!
+ summary: ''
+ - name: right
+ uid: 'ExcelScript!ExcelScript.ChartLegendPosition.right:member'
+ package: ExcelScript!
+ summary: ''
+ - name: top
+ uid: 'ExcelScript!ExcelScript.ChartLegendPosition.top:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartlineformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartlineformat.yml
index fc3d22e1..3680da68 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartlineformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartlineformat.yml
@@ -1,114 +1,114 @@
-### YamlMime:TSType
-name: ExcelScript.ChartLineFormat
-uid: 'ExcelScript!ExcelScript.ChartLineFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartLineFormat
-summary: Encapsulates the formatting options for line elements.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: clear()
- uid: 'ExcelScript!ExcelScript.ChartLineFormat#clear:member(1)'
- package: ExcelScript!
- fullName: clear()
- summary: Clears the line format of a chart element.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'clear(): void;'
- return:
- type: void
- description: ''
- - name: getColor()
- uid: 'ExcelScript!ExcelScript.ChartLineFormat#getColor:member(1)'
- package: ExcelScript!
- fullName: getColor()
- summary: HTML color code representing the color of lines in the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColor(): string;'
- return:
- type: string
- description: ''
- - name: getLineStyle()
- uid: 'ExcelScript!ExcelScript.ChartLineFormat#getLineStyle:member(1)'
- package: ExcelScript!
- fullName: getLineStyle()
- summary: Represents the line style. See `ExcelScript.ChartLineStyle` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLineStyle(): ChartLineStyle;'
- return:
- type: ''
- description: ''
- - name: getWeight()
- uid: 'ExcelScript!ExcelScript.ChartLineFormat#getWeight:member(1)'
- package: ExcelScript!
- fullName: getWeight()
- summary: 'Represents weight of the line, in points.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWeight(): number;'
- return:
- type: number
- description: ''
- - name: setColor(color)
- uid: 'ExcelScript!ExcelScript.ChartLineFormat#setColor:member(1)'
- package: ExcelScript!
- fullName: setColor(color)
- summary: HTML color code representing the color of lines in the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setColor(color: string): void;'
- parameters:
- - id: color
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setLineStyle(lineStyle)
- uid: 'ExcelScript!ExcelScript.ChartLineFormat#setLineStyle:member(1)'
- package: ExcelScript!
- fullName: setLineStyle(lineStyle)
- summary: Represents the line style. See `ExcelScript.ChartLineStyle` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLineStyle(lineStyle: ChartLineStyle): void;'
- parameters:
- - id: lineStyle
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setWeight(weight)
- uid: 'ExcelScript!ExcelScript.ChartLineFormat#setWeight:member(1)'
- package: ExcelScript!
- fullName: setWeight(weight)
- summary: 'Represents weight of the line, in points.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setWeight(weight: number): void;'
- parameters:
- - id: weight
- description: ''
- type: number
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartLineFormat
+uid: 'ExcelScript!ExcelScript.ChartLineFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartLineFormat
+summary: Encapsulates the formatting options for line elements.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: clear()
+ uid: 'ExcelScript!ExcelScript.ChartLineFormat#clear:member(1)'
+ package: ExcelScript!
+ fullName: clear()
+ summary: Clears the line format of a chart element.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clear(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getColor()
+ uid: 'ExcelScript!ExcelScript.ChartLineFormat#getColor:member(1)'
+ package: ExcelScript!
+ fullName: getColor()
+ summary: HTML color code representing the color of lines in the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getLineStyle()
+ uid: 'ExcelScript!ExcelScript.ChartLineFormat#getLineStyle:member(1)'
+ package: ExcelScript!
+ fullName: getLineStyle()
+ summary: Represents the line style. See `ExcelScript.ChartLineStyle` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLineStyle(): ChartLineStyle;'
+ return:
+ type: ''
+ description: ''
+ - name: getWeight()
+ uid: 'ExcelScript!ExcelScript.ChartLineFormat#getWeight:member(1)'
+ package: ExcelScript!
+ fullName: getWeight()
+ summary: 'Represents weight of the line, in points.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWeight(): number;'
+ return:
+ type: number
+ description: ''
+ - name: setColor(color)
+ uid: 'ExcelScript!ExcelScript.ChartLineFormat#setColor:member(1)'
+ package: ExcelScript!
+ fullName: setColor(color)
+ summary: HTML color code representing the color of lines in the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setColor(color: string): void;'
+ parameters:
+ - id: color
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setLineStyle(lineStyle)
+ uid: 'ExcelScript!ExcelScript.ChartLineFormat#setLineStyle:member(1)'
+ package: ExcelScript!
+ fullName: setLineStyle(lineStyle)
+ summary: Represents the line style. See `ExcelScript.ChartLineStyle` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLineStyle(lineStyle: ChartLineStyle): void;'
+ parameters:
+ - id: lineStyle
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setWeight(weight)
+ uid: 'ExcelScript!ExcelScript.ChartLineFormat#setWeight:member(1)'
+ package: ExcelScript!
+ fullName: setWeight(weight)
+ summary: 'Represents weight of the line, in points.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setWeight(weight: number): void;'
+ parameters:
+ - id: weight
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartlinestyle.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartlinestyle.yml
index af2e8307..37483507 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartlinestyle.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartlinestyle.yml
@@ -1,54 +1,54 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartLineStyle
-uid: 'ExcelScript!ExcelScript.ChartLineStyle:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartLineStyle
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: automatic
- uid: 'ExcelScript!ExcelScript.ChartLineStyle.automatic:member'
- package: ExcelScript!
- summary: ''
- - name: continuous
- uid: 'ExcelScript!ExcelScript.ChartLineStyle.continuous:member'
- package: ExcelScript!
- summary: ''
- - name: dash
- uid: 'ExcelScript!ExcelScript.ChartLineStyle.dash:member'
- package: ExcelScript!
- summary: ''
- - name: dashDot
- uid: 'ExcelScript!ExcelScript.ChartLineStyle.dashDot:member'
- package: ExcelScript!
- summary: ''
- - name: dashDotDot
- uid: 'ExcelScript!ExcelScript.ChartLineStyle.dashDotDot:member'
- package: ExcelScript!
- summary: ''
- - name: dot
- uid: 'ExcelScript!ExcelScript.ChartLineStyle.dot:member'
- package: ExcelScript!
- summary: ''
- - name: grey25
- uid: 'ExcelScript!ExcelScript.ChartLineStyle.grey25:member'
- package: ExcelScript!
- summary: ''
- - name: grey50
- uid: 'ExcelScript!ExcelScript.ChartLineStyle.grey50:member'
- package: ExcelScript!
- summary: ''
- - name: grey75
- uid: 'ExcelScript!ExcelScript.ChartLineStyle.grey75:member'
- package: ExcelScript!
- summary: ''
- - name: none
- uid: 'ExcelScript!ExcelScript.ChartLineStyle.none:member'
- package: ExcelScript!
- summary: ''
- - name: roundDot
- uid: 'ExcelScript!ExcelScript.ChartLineStyle.roundDot:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartLineStyle
+uid: 'ExcelScript!ExcelScript.ChartLineStyle:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartLineStyle
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: automatic
+ uid: 'ExcelScript!ExcelScript.ChartLineStyle.automatic:member'
+ package: ExcelScript!
+ summary: ''
+ - name: continuous
+ uid: 'ExcelScript!ExcelScript.ChartLineStyle.continuous:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dash
+ uid: 'ExcelScript!ExcelScript.ChartLineStyle.dash:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dashDot
+ uid: 'ExcelScript!ExcelScript.ChartLineStyle.dashDot:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dashDotDot
+ uid: 'ExcelScript!ExcelScript.ChartLineStyle.dashDotDot:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dot
+ uid: 'ExcelScript!ExcelScript.ChartLineStyle.dot:member'
+ package: ExcelScript!
+ summary: ''
+ - name: grey25
+ uid: 'ExcelScript!ExcelScript.ChartLineStyle.grey25:member'
+ package: ExcelScript!
+ summary: ''
+ - name: grey50
+ uid: 'ExcelScript!ExcelScript.ChartLineStyle.grey50:member'
+ package: ExcelScript!
+ summary: ''
+ - name: grey75
+ uid: 'ExcelScript!ExcelScript.ChartLineStyle.grey75:member'
+ package: ExcelScript!
+ summary: ''
+ - name: none
+ uid: 'ExcelScript!ExcelScript.ChartLineStyle.none:member'
+ package: ExcelScript!
+ summary: ''
+ - name: roundDot
+ uid: 'ExcelScript!ExcelScript.ChartLineStyle.roundDot:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartmaparealevel.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartmaparealevel.yml
index 86dd1309..d059e801 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartmaparealevel.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartmaparealevel.yml
@@ -1,42 +1,42 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartMapAreaLevel
-uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartMapAreaLevel
-summary: Represents the mapping level of a chart series. This only applies to region map charts.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: automatic
- uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel.automatic:member'
- package: ExcelScript!
- summary: ''
- - name: city
- uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel.city:member'
- package: ExcelScript!
- summary: ''
- - name: continent
- uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel.continent:member'
- package: ExcelScript!
- summary: ''
- - name: country
- uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel.country:member'
- package: ExcelScript!
- summary: ''
- - name: county
- uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel.county:member'
- package: ExcelScript!
- summary: ''
- - name: dataOnly
- uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel.dataOnly:member'
- package: ExcelScript!
- summary: ''
- - name: state
- uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel.state:member'
- package: ExcelScript!
- summary: ''
- - name: world
- uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel.world:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartMapAreaLevel
+uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartMapAreaLevel
+summary: Represents the mapping level of a chart series. This only applies to region map charts.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: automatic
+ uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel.automatic:member'
+ package: ExcelScript!
+ summary: ''
+ - name: city
+ uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel.city:member'
+ package: ExcelScript!
+ summary: ''
+ - name: continent
+ uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel.continent:member'
+ package: ExcelScript!
+ summary: ''
+ - name: country
+ uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel.country:member'
+ package: ExcelScript!
+ summary: ''
+ - name: county
+ uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel.county:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dataOnly
+ uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel.dataOnly:member'
+ package: ExcelScript!
+ summary: ''
+ - name: state
+ uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel.state:member'
+ package: ExcelScript!
+ summary: ''
+ - name: world
+ uid: 'ExcelScript!ExcelScript.ChartMapAreaLevel.world:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartmaplabelstrategy.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartmaplabelstrategy.yml
index bf78f117..63f04e19 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartmaplabelstrategy.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartmaplabelstrategy.yml
@@ -1,22 +1,22 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartMapLabelStrategy
-uid: 'ExcelScript!ExcelScript.ChartMapLabelStrategy:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartMapLabelStrategy
-summary: Represents the region level of a chart series layout. This only applies to region map charts.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: bestFit
- uid: 'ExcelScript!ExcelScript.ChartMapLabelStrategy.bestFit:member'
- package: ExcelScript!
- summary: ''
- - name: none
- uid: 'ExcelScript!ExcelScript.ChartMapLabelStrategy.none:member'
- package: ExcelScript!
- summary: ''
- - name: showAll
- uid: 'ExcelScript!ExcelScript.ChartMapLabelStrategy.showAll:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartMapLabelStrategy
+uid: 'ExcelScript!ExcelScript.ChartMapLabelStrategy:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartMapLabelStrategy
+summary: Represents the region level of a chart series layout. This only applies to region map charts.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: bestFit
+ uid: 'ExcelScript!ExcelScript.ChartMapLabelStrategy.bestFit:member'
+ package: ExcelScript!
+ summary: ''
+ - name: none
+ uid: 'ExcelScript!ExcelScript.ChartMapLabelStrategy.none:member'
+ package: ExcelScript!
+ summary: ''
+ - name: showAll
+ uid: 'ExcelScript!ExcelScript.ChartMapLabelStrategy.showAll:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartmapoptions.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartmapoptions.yml
index c3dd9363..55c1f80d 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartmapoptions.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartmapoptions.yml
@@ -1,101 +1,101 @@
-### YamlMime:TSType
-name: ExcelScript.ChartMapOptions
-uid: 'ExcelScript!ExcelScript.ChartMapOptions:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartMapOptions
-summary: Encapsulates the properties for a region map chart.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getLabelStrategy()
- uid: 'ExcelScript!ExcelScript.ChartMapOptions#getLabelStrategy:member(1)'
- package: ExcelScript!
- fullName: getLabelStrategy()
- summary: Specifies the series map labels strategy of a region map chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLabelStrategy(): ChartMapLabelStrategy;'
- return:
- type: ''
- description: ''
- - name: getLevel()
- uid: 'ExcelScript!ExcelScript.ChartMapOptions#getLevel:member(1)'
- package: ExcelScript!
- fullName: getLevel()
- summary: Specifies the series mapping level of a region map chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLevel(): ChartMapAreaLevel;'
- return:
- type: ''
- description: ''
- - name: getProjectionType()
- uid: 'ExcelScript!ExcelScript.ChartMapOptions#getProjectionType:member(1)'
- package: ExcelScript!
- fullName: getProjectionType()
- summary: Specifies the series projection type of a region map chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getProjectionType(): ChartMapProjectionType;'
- return:
- type: ''
- description: ''
- - name: setLabelStrategy(labelStrategy)
- uid: 'ExcelScript!ExcelScript.ChartMapOptions#setLabelStrategy:member(1)'
- package: ExcelScript!
- fullName: setLabelStrategy(labelStrategy)
- summary: Specifies the series map labels strategy of a region map chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLabelStrategy(labelStrategy: ChartMapLabelStrategy): void;'
- parameters:
- - id: labelStrategy
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setLevel(level)
- uid: 'ExcelScript!ExcelScript.ChartMapOptions#setLevel:member(1)'
- package: ExcelScript!
- fullName: setLevel(level)
- summary: Specifies the series mapping level of a region map chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLevel(level: ChartMapAreaLevel): void;'
- parameters:
- - id: level
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setProjectionType(projectionType)
- uid: 'ExcelScript!ExcelScript.ChartMapOptions#setProjectionType:member(1)'
- package: ExcelScript!
- fullName: setProjectionType(projectionType)
- summary: Specifies the series projection type of a region map chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setProjectionType(projectionType: ChartMapProjectionType): void;'
- parameters:
- - id: projectionType
- description: ''
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartMapOptions
+uid: 'ExcelScript!ExcelScript.ChartMapOptions:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartMapOptions
+summary: Encapsulates the properties for a region map chart.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getLabelStrategy()
+ uid: 'ExcelScript!ExcelScript.ChartMapOptions#getLabelStrategy:member(1)'
+ package: ExcelScript!
+ fullName: getLabelStrategy()
+ summary: Specifies the series map labels strategy of a region map chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLabelStrategy(): ChartMapLabelStrategy;'
+ return:
+ type: ''
+ description: ''
+ - name: getLevel()
+ uid: 'ExcelScript!ExcelScript.ChartMapOptions#getLevel:member(1)'
+ package: ExcelScript!
+ fullName: getLevel()
+ summary: Specifies the series mapping level of a region map chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLevel(): ChartMapAreaLevel;'
+ return:
+ type: ''
+ description: ''
+ - name: getProjectionType()
+ uid: 'ExcelScript!ExcelScript.ChartMapOptions#getProjectionType:member(1)'
+ package: ExcelScript!
+ fullName: getProjectionType()
+ summary: Specifies the series projection type of a region map chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getProjectionType(): ChartMapProjectionType;'
+ return:
+ type: ''
+ description: ''
+ - name: setLabelStrategy(labelStrategy)
+ uid: 'ExcelScript!ExcelScript.ChartMapOptions#setLabelStrategy:member(1)'
+ package: ExcelScript!
+ fullName: setLabelStrategy(labelStrategy)
+ summary: Specifies the series map labels strategy of a region map chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLabelStrategy(labelStrategy: ChartMapLabelStrategy): void;'
+ parameters:
+ - id: labelStrategy
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setLevel(level)
+ uid: 'ExcelScript!ExcelScript.ChartMapOptions#setLevel:member(1)'
+ package: ExcelScript!
+ fullName: setLevel(level)
+ summary: Specifies the series mapping level of a region map chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLevel(level: ChartMapAreaLevel): void;'
+ parameters:
+ - id: level
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setProjectionType(projectionType)
+ uid: 'ExcelScript!ExcelScript.ChartMapOptions#setProjectionType:member(1)'
+ package: ExcelScript!
+ fullName: setProjectionType(projectionType)
+ summary: Specifies the series projection type of a region map chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setProjectionType(projectionType: ChartMapProjectionType): void;'
+ parameters:
+ - id: projectionType
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartmapprojectiontype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartmapprojectiontype.yml
index cd5b04ad..94a66fd5 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartmapprojectiontype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartmapprojectiontype.yml
@@ -1,30 +1,30 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartMapProjectionType
-uid: 'ExcelScript!ExcelScript.ChartMapProjectionType:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartMapProjectionType
-summary: Represents the region projection type of a chart series layout. This only applies to region map charts.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: albers
- uid: 'ExcelScript!ExcelScript.ChartMapProjectionType.albers:member'
- package: ExcelScript!
- summary: ''
- - name: automatic
- uid: 'ExcelScript!ExcelScript.ChartMapProjectionType.automatic:member'
- package: ExcelScript!
- summary: ''
- - name: mercator
- uid: 'ExcelScript!ExcelScript.ChartMapProjectionType.mercator:member'
- package: ExcelScript!
- summary: ''
- - name: miller
- uid: 'ExcelScript!ExcelScript.ChartMapProjectionType.miller:member'
- package: ExcelScript!
- summary: ''
- - name: robinson
- uid: 'ExcelScript!ExcelScript.ChartMapProjectionType.robinson:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartMapProjectionType
+uid: 'ExcelScript!ExcelScript.ChartMapProjectionType:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartMapProjectionType
+summary: Represents the region projection type of a chart series layout. This only applies to region map charts.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: albers
+ uid: 'ExcelScript!ExcelScript.ChartMapProjectionType.albers:member'
+ package: ExcelScript!
+ summary: ''
+ - name: automatic
+ uid: 'ExcelScript!ExcelScript.ChartMapProjectionType.automatic:member'
+ package: ExcelScript!
+ summary: ''
+ - name: mercator
+ uid: 'ExcelScript!ExcelScript.ChartMapProjectionType.mercator:member'
+ package: ExcelScript!
+ summary: ''
+ - name: miller
+ uid: 'ExcelScript!ExcelScript.ChartMapProjectionType.miller:member'
+ package: ExcelScript!
+ summary: ''
+ - name: robinson
+ uid: 'ExcelScript!ExcelScript.ChartMapProjectionType.robinson:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartmarkerstyle.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartmarkerstyle.yml
index c8323c10..a1b1b59a 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartmarkerstyle.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartmarkerstyle.yml
@@ -1,62 +1,62 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartMarkerStyle
-uid: 'ExcelScript!ExcelScript.ChartMarkerStyle:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartMarkerStyle
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: automatic
- uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.automatic:member'
- package: ExcelScript!
- summary: ''
- - name: circle
- uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.circle:member'
- package: ExcelScript!
- summary: ''
- - name: dash
- uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.dash:member'
- package: ExcelScript!
- summary: ''
- - name: diamond
- uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.diamond:member'
- package: ExcelScript!
- summary: ''
- - name: dot
- uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.dot:member'
- package: ExcelScript!
- summary: ''
- - name: invalid
- uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.invalid:member'
- package: ExcelScript!
- summary: ''
- - name: none
- uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.none:member'
- package: ExcelScript!
- summary: ''
- - name: picture
- uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.picture:member'
- package: ExcelScript!
- summary: ''
- - name: plus
- uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.plus:member'
- package: ExcelScript!
- summary: ''
- - name: square
- uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.square:member'
- package: ExcelScript!
- summary: ''
- - name: star
- uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.star:member'
- package: ExcelScript!
- summary: ''
- - name: triangle
- uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.triangle:member'
- package: ExcelScript!
- summary: ''
- - name: x
- uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.x:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartMarkerStyle
+uid: 'ExcelScript!ExcelScript.ChartMarkerStyle:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartMarkerStyle
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: automatic
+ uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.automatic:member'
+ package: ExcelScript!
+ summary: ''
+ - name: circle
+ uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.circle:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dash
+ uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.dash:member'
+ package: ExcelScript!
+ summary: ''
+ - name: diamond
+ uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.diamond:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dot
+ uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.dot:member'
+ package: ExcelScript!
+ summary: ''
+ - name: invalid
+ uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.invalid:member'
+ package: ExcelScript!
+ summary: ''
+ - name: none
+ uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.none:member'
+ package: ExcelScript!
+ summary: ''
+ - name: picture
+ uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.picture:member'
+ package: ExcelScript!
+ summary: ''
+ - name: plus
+ uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.plus:member'
+ package: ExcelScript!
+ summary: ''
+ - name: square
+ uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.square:member'
+ package: ExcelScript!
+ summary: ''
+ - name: star
+ uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.star:member'
+ package: ExcelScript!
+ summary: ''
+ - name: triangle
+ uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.triangle:member'
+ package: ExcelScript!
+ summary: ''
+ - name: x
+ uid: 'ExcelScript!ExcelScript.ChartMarkerStyle.x:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartparentlabelstrategy.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartparentlabelstrategy.yml
index 6543addf..724a3e44 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartparentlabelstrategy.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartparentlabelstrategy.yml
@@ -1,22 +1,22 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartParentLabelStrategy
-uid: 'ExcelScript!ExcelScript.ChartParentLabelStrategy:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartParentLabelStrategy
-summary: Represents the parent label strategy of the chart series layout. This only applies to treemap charts
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: banner
- uid: 'ExcelScript!ExcelScript.ChartParentLabelStrategy.banner:member'
- package: ExcelScript!
- summary: ''
- - name: none
- uid: 'ExcelScript!ExcelScript.ChartParentLabelStrategy.none:member'
- package: ExcelScript!
- summary: ''
- - name: overlapping
- uid: 'ExcelScript!ExcelScript.ChartParentLabelStrategy.overlapping:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartParentLabelStrategy
+uid: 'ExcelScript!ExcelScript.ChartParentLabelStrategy:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartParentLabelStrategy
+summary: Represents the parent label strategy of the chart series layout. This only applies to treemap charts
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: banner
+ uid: 'ExcelScript!ExcelScript.ChartParentLabelStrategy.banner:member'
+ package: ExcelScript!
+ summary: ''
+ - name: none
+ uid: 'ExcelScript!ExcelScript.ChartParentLabelStrategy.none:member'
+ package: ExcelScript!
+ summary: ''
+ - name: overlapping
+ uid: 'ExcelScript!ExcelScript.ChartParentLabelStrategy.overlapping:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartpivotoptions.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartpivotoptions.yml
index b9a613a6..dc2e0177 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartpivotoptions.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartpivotoptions.yml
@@ -1,140 +1,140 @@
-### YamlMime:TSType
-name: ExcelScript.ChartPivotOptions
-uid: 'ExcelScript!ExcelScript.ChartPivotOptions:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartPivotOptions
-summary: Encapsulates the options for the pivot chart.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getShowAxisFieldButtons()
- uid: 'ExcelScript!ExcelScript.ChartPivotOptions#getShowAxisFieldButtons:member(1)'
- package: ExcelScript!
- fullName: getShowAxisFieldButtons()
- summary: >-
- Specifies whether to display the axis field buttons on a PivotChart. The `showAxisFieldButtons` property
- corresponds to the "Show Axis Field Buttons" command on the "Field Buttons" drop-down list of the "Analyze" tab,
- which is available when a PivotChart is selected.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowAxisFieldButtons(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowLegendFieldButtons()
- uid: 'ExcelScript!ExcelScript.ChartPivotOptions#getShowLegendFieldButtons:member(1)'
- package: ExcelScript!
- fullName: getShowLegendFieldButtons()
- summary: Specifies whether to display the legend field buttons on a PivotChart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowLegendFieldButtons(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowReportFilterFieldButtons()
- uid: 'ExcelScript!ExcelScript.ChartPivotOptions#getShowReportFilterFieldButtons:member(1)'
- package: ExcelScript!
- fullName: getShowReportFilterFieldButtons()
- summary: Specifies whether to display the report filter field buttons on a PivotChart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowReportFilterFieldButtons(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowValueFieldButtons()
- uid: 'ExcelScript!ExcelScript.ChartPivotOptions#getShowValueFieldButtons:member(1)'
- package: ExcelScript!
- fullName: getShowValueFieldButtons()
- summary: Specifies whether to display the show value field buttons on a PivotChart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowValueFieldButtons(): boolean;'
- return:
- type: boolean
- description: ''
- - name: setShowAxisFieldButtons(showAxisFieldButtons)
- uid: 'ExcelScript!ExcelScript.ChartPivotOptions#setShowAxisFieldButtons:member(1)'
- package: ExcelScript!
- fullName: setShowAxisFieldButtons(showAxisFieldButtons)
- summary: >-
- Specifies whether to display the axis field buttons on a PivotChart. The `showAxisFieldButtons` property
- corresponds to the "Show Axis Field Buttons" command on the "Field Buttons" drop-down list of the "Analyze" tab,
- which is available when a PivotChart is selected.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowAxisFieldButtons(showAxisFieldButtons: boolean): void;'
- parameters:
- - id: showAxisFieldButtons
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowLegendFieldButtons(showLegendFieldButtons)
- uid: 'ExcelScript!ExcelScript.ChartPivotOptions#setShowLegendFieldButtons:member(1)'
- package: ExcelScript!
- fullName: setShowLegendFieldButtons(showLegendFieldButtons)
- summary: Specifies whether to display the legend field buttons on a PivotChart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowLegendFieldButtons(showLegendFieldButtons: boolean): void;'
- parameters:
- - id: showLegendFieldButtons
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowReportFilterFieldButtons(showReportFilterFieldButtons)
- uid: 'ExcelScript!ExcelScript.ChartPivotOptions#setShowReportFilterFieldButtons:member(1)'
- package: ExcelScript!
- fullName: setShowReportFilterFieldButtons(showReportFilterFieldButtons)
- summary: Specifies whether to display the report filter field buttons on a PivotChart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setShowReportFilterFieldButtons(
- showReportFilterFieldButtons: boolean
- ): void;
- parameters:
- - id: showReportFilterFieldButtons
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowValueFieldButtons(showValueFieldButtons)
- uid: 'ExcelScript!ExcelScript.ChartPivotOptions#setShowValueFieldButtons:member(1)'
- package: ExcelScript!
- fullName: setShowValueFieldButtons(showValueFieldButtons)
- summary: Specifies whether to display the show value field buttons on a PivotChart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowValueFieldButtons(showValueFieldButtons: boolean): void;'
- parameters:
- - id: showValueFieldButtons
- description: ''
- type: boolean
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartPivotOptions
+uid: 'ExcelScript!ExcelScript.ChartPivotOptions:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartPivotOptions
+summary: Encapsulates the options for the pivot chart.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getShowAxisFieldButtons()
+ uid: 'ExcelScript!ExcelScript.ChartPivotOptions#getShowAxisFieldButtons:member(1)'
+ package: ExcelScript!
+ fullName: getShowAxisFieldButtons()
+ summary: >-
+ Specifies whether to display the axis field buttons on a PivotChart. The `showAxisFieldButtons` property
+ corresponds to the "Show Axis Field Buttons" command on the "Field Buttons" drop-down list of the "Analyze" tab,
+ which is available when a PivotChart is selected.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowAxisFieldButtons(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowLegendFieldButtons()
+ uid: 'ExcelScript!ExcelScript.ChartPivotOptions#getShowLegendFieldButtons:member(1)'
+ package: ExcelScript!
+ fullName: getShowLegendFieldButtons()
+ summary: Specifies whether to display the legend field buttons on a PivotChart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowLegendFieldButtons(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowReportFilterFieldButtons()
+ uid: 'ExcelScript!ExcelScript.ChartPivotOptions#getShowReportFilterFieldButtons:member(1)'
+ package: ExcelScript!
+ fullName: getShowReportFilterFieldButtons()
+ summary: Specifies whether to display the report filter field buttons on a PivotChart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowReportFilterFieldButtons(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowValueFieldButtons()
+ uid: 'ExcelScript!ExcelScript.ChartPivotOptions#getShowValueFieldButtons:member(1)'
+ package: ExcelScript!
+ fullName: getShowValueFieldButtons()
+ summary: Specifies whether to display the show value field buttons on a PivotChart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowValueFieldButtons(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: setShowAxisFieldButtons(showAxisFieldButtons)
+ uid: 'ExcelScript!ExcelScript.ChartPivotOptions#setShowAxisFieldButtons:member(1)'
+ package: ExcelScript!
+ fullName: setShowAxisFieldButtons(showAxisFieldButtons)
+ summary: >-
+ Specifies whether to display the axis field buttons on a PivotChart. The `showAxisFieldButtons` property
+ corresponds to the "Show Axis Field Buttons" command on the "Field Buttons" drop-down list of the "Analyze" tab,
+ which is available when a PivotChart is selected.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowAxisFieldButtons(showAxisFieldButtons: boolean): void;'
+ parameters:
+ - id: showAxisFieldButtons
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowLegendFieldButtons(showLegendFieldButtons)
+ uid: 'ExcelScript!ExcelScript.ChartPivotOptions#setShowLegendFieldButtons:member(1)'
+ package: ExcelScript!
+ fullName: setShowLegendFieldButtons(showLegendFieldButtons)
+ summary: Specifies whether to display the legend field buttons on a PivotChart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowLegendFieldButtons(showLegendFieldButtons: boolean): void;'
+ parameters:
+ - id: showLegendFieldButtons
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowReportFilterFieldButtons(showReportFilterFieldButtons)
+ uid: 'ExcelScript!ExcelScript.ChartPivotOptions#setShowReportFilterFieldButtons:member(1)'
+ package: ExcelScript!
+ fullName: setShowReportFilterFieldButtons(showReportFilterFieldButtons)
+ summary: Specifies whether to display the report filter field buttons on a PivotChart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setShowReportFilterFieldButtons(
+ showReportFilterFieldButtons: boolean
+ ): void;
+ parameters:
+ - id: showReportFilterFieldButtons
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowValueFieldButtons(showValueFieldButtons)
+ uid: 'ExcelScript!ExcelScript.ChartPivotOptions#setShowValueFieldButtons:member(1)'
+ package: ExcelScript!
+ fullName: setShowValueFieldButtons(showValueFieldButtons)
+ summary: Specifies whether to display the show value field buttons on a PivotChart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowValueFieldButtons(showValueFieldButtons: boolean): void;'
+ parameters:
+ - id: showValueFieldButtons
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartplotarea.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartplotarea.yml
index f9826bea..440ac5e4 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartplotarea.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartplotarea.yml
@@ -1,294 +1,294 @@
-### YamlMime:TSType
-name: ExcelScript.ChartPlotArea
-uid: 'ExcelScript!ExcelScript.ChartPlotArea:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartPlotArea
-summary: This object represents the attributes for a chart plot area.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getFormat()
- uid: 'ExcelScript!ExcelScript.ChartPlotArea#getFormat:member(1)'
- package: ExcelScript!
- fullName: getFormat()
- summary: Specifies the formatting of a chart plot area.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormat(): ChartPlotAreaFormat;'
- return:
- type: ''
- description: ''
- - name: getHeight()
- uid: 'ExcelScript!ExcelScript.ChartPlotArea#getHeight:member(1)'
- package: ExcelScript!
- fullName: getHeight()
- summary: Specifies the height value of a plot area.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHeight(): number;'
- return:
- type: number
- description: ''
- - name: getInsideHeight()
- uid: 'ExcelScript!ExcelScript.ChartPlotArea#getInsideHeight:member(1)'
- package: ExcelScript!
- fullName: getInsideHeight()
- summary: Specifies the inside height value of a plot area.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getInsideHeight(): number;'
- return:
- type: number
- description: ''
- - name: getInsideLeft()
- uid: 'ExcelScript!ExcelScript.ChartPlotArea#getInsideLeft:member(1)'
- package: ExcelScript!
- fullName: getInsideLeft()
- summary: Specifies the inside left value of a plot area.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getInsideLeft(): number;'
- return:
- type: number
- description: ''
- - name: getInsideTop()
- uid: 'ExcelScript!ExcelScript.ChartPlotArea#getInsideTop:member(1)'
- package: ExcelScript!
- fullName: getInsideTop()
- summary: Specifies the inside top value of a plot area.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getInsideTop(): number;'
- return:
- type: number
- description: ''
- - name: getInsideWidth()
- uid: 'ExcelScript!ExcelScript.ChartPlotArea#getInsideWidth:member(1)'
- package: ExcelScript!
- fullName: getInsideWidth()
- summary: Specifies the inside width value of a plot area.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getInsideWidth(): number;'
- return:
- type: number
- description: ''
- - name: getLeft()
- uid: 'ExcelScript!ExcelScript.ChartPlotArea#getLeft:member(1)'
- package: ExcelScript!
- fullName: getLeft()
- summary: Specifies the left value of a plot area.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLeft(): number;'
- return:
- type: number
- description: ''
- - name: getPosition()
- uid: 'ExcelScript!ExcelScript.ChartPlotArea#getPosition:member(1)'
- package: ExcelScript!
- fullName: getPosition()
- summary: Specifies the position of a plot area.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPosition(): ChartPlotAreaPosition;'
- return:
- type: ''
- description: ''
- - name: getTop()
- uid: 'ExcelScript!ExcelScript.ChartPlotArea#getTop:member(1)'
- package: ExcelScript!
- fullName: getTop()
- summary: Specifies the top value of a plot area.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTop(): number;'
- return:
- type: number
- description: ''
- - name: getWidth()
- uid: 'ExcelScript!ExcelScript.ChartPlotArea#getWidth:member(1)'
- package: ExcelScript!
- fullName: getWidth()
- summary: Specifies the width value of a plot area.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWidth(): number;'
- return:
- type: number
- description: ''
- - name: setHeight(height)
- uid: 'ExcelScript!ExcelScript.ChartPlotArea#setHeight:member(1)'
- package: ExcelScript!
- fullName: setHeight(height)
- summary: Specifies the height value of a plot area.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setHeight(height: number): void;'
- parameters:
- - id: height
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setInsideHeight(insideHeight)
- uid: 'ExcelScript!ExcelScript.ChartPlotArea#setInsideHeight:member(1)'
- package: ExcelScript!
- fullName: setInsideHeight(insideHeight)
- summary: Specifies the inside height value of a plot area.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setInsideHeight(insideHeight: number): void;'
- parameters:
- - id: insideHeight
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setInsideLeft(insideLeft)
- uid: 'ExcelScript!ExcelScript.ChartPlotArea#setInsideLeft:member(1)'
- package: ExcelScript!
- fullName: setInsideLeft(insideLeft)
- summary: Specifies the inside left value of a plot area.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setInsideLeft(insideLeft: number): void;'
- parameters:
- - id: insideLeft
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setInsideTop(insideTop)
- uid: 'ExcelScript!ExcelScript.ChartPlotArea#setInsideTop:member(1)'
- package: ExcelScript!
- fullName: setInsideTop(insideTop)
- summary: Specifies the inside top value of a plot area.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setInsideTop(insideTop: number): void;'
- parameters:
- - id: insideTop
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setInsideWidth(insideWidth)
- uid: 'ExcelScript!ExcelScript.ChartPlotArea#setInsideWidth:member(1)'
- package: ExcelScript!
- fullName: setInsideWidth(insideWidth)
- summary: Specifies the inside width value of a plot area.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setInsideWidth(insideWidth: number): void;'
- parameters:
- - id: insideWidth
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setLeft(left)
- uid: 'ExcelScript!ExcelScript.ChartPlotArea#setLeft:member(1)'
- package: ExcelScript!
- fullName: setLeft(left)
- summary: Specifies the left value of a plot area.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLeft(left: number): void;'
- parameters:
- - id: left
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setPosition(position)
- uid: 'ExcelScript!ExcelScript.ChartPlotArea#setPosition:member(1)'
- package: ExcelScript!
- fullName: setPosition(position)
- summary: Specifies the position of a plot area.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPosition(position: ChartPlotAreaPosition): void;'
- parameters:
- - id: position
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setTop(top)
- uid: 'ExcelScript!ExcelScript.ChartPlotArea#setTop:member(1)'
- package: ExcelScript!
- fullName: setTop(top)
- summary: Specifies the top value of a plot area.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTop(top: number): void;'
- parameters:
- - id: top
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setWidth(width)
- uid: 'ExcelScript!ExcelScript.ChartPlotArea#setWidth:member(1)'
- package: ExcelScript!
- fullName: setWidth(width)
- summary: Specifies the width value of a plot area.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setWidth(width: number): void;'
- parameters:
- - id: width
- description: ''
- type: number
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartPlotArea
+uid: 'ExcelScript!ExcelScript.ChartPlotArea:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartPlotArea
+summary: This object represents the attributes for a chart plot area.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getFormat()
+ uid: 'ExcelScript!ExcelScript.ChartPlotArea#getFormat:member(1)'
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: Specifies the formatting of a chart plot area.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): ChartPlotAreaFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getHeight()
+ uid: 'ExcelScript!ExcelScript.ChartPlotArea#getHeight:member(1)'
+ package: ExcelScript!
+ fullName: getHeight()
+ summary: Specifies the height value of a plot area.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHeight(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getInsideHeight()
+ uid: 'ExcelScript!ExcelScript.ChartPlotArea#getInsideHeight:member(1)'
+ package: ExcelScript!
+ fullName: getInsideHeight()
+ summary: Specifies the inside height value of a plot area.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getInsideHeight(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getInsideLeft()
+ uid: 'ExcelScript!ExcelScript.ChartPlotArea#getInsideLeft:member(1)'
+ package: ExcelScript!
+ fullName: getInsideLeft()
+ summary: Specifies the inside left value of a plot area.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getInsideLeft(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getInsideTop()
+ uid: 'ExcelScript!ExcelScript.ChartPlotArea#getInsideTop:member(1)'
+ package: ExcelScript!
+ fullName: getInsideTop()
+ summary: Specifies the inside top value of a plot area.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getInsideTop(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getInsideWidth()
+ uid: 'ExcelScript!ExcelScript.ChartPlotArea#getInsideWidth:member(1)'
+ package: ExcelScript!
+ fullName: getInsideWidth()
+ summary: Specifies the inside width value of a plot area.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getInsideWidth(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getLeft()
+ uid: 'ExcelScript!ExcelScript.ChartPlotArea#getLeft:member(1)'
+ package: ExcelScript!
+ fullName: getLeft()
+ summary: Specifies the left value of a plot area.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLeft(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getPosition()
+ uid: 'ExcelScript!ExcelScript.ChartPlotArea#getPosition:member(1)'
+ package: ExcelScript!
+ fullName: getPosition()
+ summary: Specifies the position of a plot area.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPosition(): ChartPlotAreaPosition;'
+ return:
+ type: ''
+ description: ''
+ - name: getTop()
+ uid: 'ExcelScript!ExcelScript.ChartPlotArea#getTop:member(1)'
+ package: ExcelScript!
+ fullName: getTop()
+ summary: Specifies the top value of a plot area.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTop(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getWidth()
+ uid: 'ExcelScript!ExcelScript.ChartPlotArea#getWidth:member(1)'
+ package: ExcelScript!
+ fullName: getWidth()
+ summary: Specifies the width value of a plot area.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWidth(): number;'
+ return:
+ type: number
+ description: ''
+ - name: setHeight(height)
+ uid: 'ExcelScript!ExcelScript.ChartPlotArea#setHeight:member(1)'
+ package: ExcelScript!
+ fullName: setHeight(height)
+ summary: Specifies the height value of a plot area.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setHeight(height: number): void;'
+ parameters:
+ - id: height
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setInsideHeight(insideHeight)
+ uid: 'ExcelScript!ExcelScript.ChartPlotArea#setInsideHeight:member(1)'
+ package: ExcelScript!
+ fullName: setInsideHeight(insideHeight)
+ summary: Specifies the inside height value of a plot area.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setInsideHeight(insideHeight: number): void;'
+ parameters:
+ - id: insideHeight
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setInsideLeft(insideLeft)
+ uid: 'ExcelScript!ExcelScript.ChartPlotArea#setInsideLeft:member(1)'
+ package: ExcelScript!
+ fullName: setInsideLeft(insideLeft)
+ summary: Specifies the inside left value of a plot area.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setInsideLeft(insideLeft: number): void;'
+ parameters:
+ - id: insideLeft
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setInsideTop(insideTop)
+ uid: 'ExcelScript!ExcelScript.ChartPlotArea#setInsideTop:member(1)'
+ package: ExcelScript!
+ fullName: setInsideTop(insideTop)
+ summary: Specifies the inside top value of a plot area.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setInsideTop(insideTop: number): void;'
+ parameters:
+ - id: insideTop
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setInsideWidth(insideWidth)
+ uid: 'ExcelScript!ExcelScript.ChartPlotArea#setInsideWidth:member(1)'
+ package: ExcelScript!
+ fullName: setInsideWidth(insideWidth)
+ summary: Specifies the inside width value of a plot area.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setInsideWidth(insideWidth: number): void;'
+ parameters:
+ - id: insideWidth
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setLeft(left)
+ uid: 'ExcelScript!ExcelScript.ChartPlotArea#setLeft:member(1)'
+ package: ExcelScript!
+ fullName: setLeft(left)
+ summary: Specifies the left value of a plot area.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLeft(left: number): void;'
+ parameters:
+ - id: left
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setPosition(position)
+ uid: 'ExcelScript!ExcelScript.ChartPlotArea#setPosition:member(1)'
+ package: ExcelScript!
+ fullName: setPosition(position)
+ summary: Specifies the position of a plot area.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPosition(position: ChartPlotAreaPosition): void;'
+ parameters:
+ - id: position
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setTop(top)
+ uid: 'ExcelScript!ExcelScript.ChartPlotArea#setTop:member(1)'
+ package: ExcelScript!
+ fullName: setTop(top)
+ summary: Specifies the top value of a plot area.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTop(top: number): void;'
+ parameters:
+ - id: top
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setWidth(width)
+ uid: 'ExcelScript!ExcelScript.ChartPlotArea#setWidth:member(1)'
+ package: ExcelScript!
+ fullName: setWidth(width)
+ summary: Specifies the width value of a plot area.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setWidth(width: number): void;'
+ parameters:
+ - id: width
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartplotareaformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartplotareaformat.yml
index de2ff7f5..9e88c468 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartplotareaformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartplotareaformat.yml
@@ -1,37 +1,37 @@
-### YamlMime:TSType
-name: ExcelScript.ChartPlotAreaFormat
-uid: 'ExcelScript!ExcelScript.ChartPlotAreaFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartPlotAreaFormat
-summary: Represents the format properties for a chart plot area.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getBorder()
- uid: 'ExcelScript!ExcelScript.ChartPlotAreaFormat#getBorder:member(1)'
- package: ExcelScript!
- fullName: getBorder()
- summary: Specifies the border attributes of a chart plot area.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBorder(): ChartBorder;'
- return:
- type: ''
- description: ''
- - name: getFill()
- uid: 'ExcelScript!ExcelScript.ChartPlotAreaFormat#getFill:member(1)'
- package: ExcelScript!
- fullName: getFill()
- summary: 'Specifies the fill format of an object, which includes background formatting information.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFill(): ChartFill;'
- return:
- type: ''
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartPlotAreaFormat
+uid: 'ExcelScript!ExcelScript.ChartPlotAreaFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartPlotAreaFormat
+summary: Represents the format properties for a chart plot area.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getBorder()
+ uid: 'ExcelScript!ExcelScript.ChartPlotAreaFormat#getBorder:member(1)'
+ package: ExcelScript!
+ fullName: getBorder()
+ summary: Specifies the border attributes of a chart plot area.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBorder(): ChartBorder;'
+ return:
+ type: ''
+ description: ''
+ - name: getFill()
+ uid: 'ExcelScript!ExcelScript.ChartPlotAreaFormat#getFill:member(1)'
+ package: ExcelScript!
+ fullName: getFill()
+ summary: 'Specifies the fill format of an object, which includes background formatting information.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFill(): ChartFill;'
+ return:
+ type: ''
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartplotareaposition.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartplotareaposition.yml
index 9bc4e288..930b93e0 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartplotareaposition.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartplotareaposition.yml
@@ -1,18 +1,18 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartPlotAreaPosition
-uid: 'ExcelScript!ExcelScript.ChartPlotAreaPosition:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartPlotAreaPosition
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: automatic
- uid: 'ExcelScript!ExcelScript.ChartPlotAreaPosition.automatic:member'
- package: ExcelScript!
- summary: ''
- - name: custom
- uid: 'ExcelScript!ExcelScript.ChartPlotAreaPosition.custom:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartPlotAreaPosition
+uid: 'ExcelScript!ExcelScript.ChartPlotAreaPosition:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartPlotAreaPosition
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: automatic
+ uid: 'ExcelScript!ExcelScript.ChartPlotAreaPosition.automatic:member'
+ package: ExcelScript!
+ summary: ''
+ - name: custom
+ uid: 'ExcelScript!ExcelScript.ChartPlotAreaPosition.custom:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartplotby.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartplotby.yml
index 1ae45ded..59f5de17 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartplotby.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartplotby.yml
@@ -1,43 +1,43 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartPlotBy
-uid: 'ExcelScript!ExcelScript.ChartPlotBy:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartPlotBy
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample performs the "Switch Row/Column" action on a chart named "ColumnClusteredChart".
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Get an existing chart named "ColumnClusteredChart".
- let columnClusteredChart = selectedSheet.getChart("ColumnClusteredChart");
-
- // Switch the row and column for the chart's data source.
- if (columnClusteredChart.getPlotBy() === ExcelScript.ChartPlotBy.columns) {
- // If the chart is grouped by columns, switch it to rows.
- columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.rows);
- } else {
- // If the chart is grouped by rows, switch it to columns.
- columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.columns);
- }
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: columns
- uid: 'ExcelScript!ExcelScript.ChartPlotBy.columns:member'
- package: ExcelScript!
- summary: ''
- - name: rows
- uid: 'ExcelScript!ExcelScript.ChartPlotBy.rows:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartPlotBy
+uid: 'ExcelScript!ExcelScript.ChartPlotBy:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartPlotBy
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample performs the "Switch Row/Column" action on a chart named "ColumnClusteredChart".
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Get an existing chart named "ColumnClusteredChart".
+ let columnClusteredChart = selectedSheet.getChart("ColumnClusteredChart");
+
+ // Switch the row and column for the chart's data source.
+ if (columnClusteredChart.getPlotBy() === ExcelScript.ChartPlotBy.columns) {
+ // If the chart is grouped by columns, switch it to rows.
+ columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.rows);
+ } else {
+ // If the chart is grouped by rows, switch it to columns.
+ columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.columns);
+ }
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: columns
+ uid: 'ExcelScript!ExcelScript.ChartPlotBy.columns:member'
+ package: ExcelScript!
+ summary: ''
+ - name: rows
+ uid: 'ExcelScript!ExcelScript.ChartPlotBy.rows:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartpoint.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartpoint.yml
index a2848618..a3c144e6 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartpoint.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartpoint.yml
@@ -1,204 +1,204 @@
-### YamlMime:TSType
-name: ExcelScript.ChartPoint
-uid: 'ExcelScript!ExcelScript.ChartPoint:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartPoint
-summary: Represents a point of a series in a chart.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getDataLabel()
- uid: 'ExcelScript!ExcelScript.ChartPoint#getDataLabel:member(1)'
- package: ExcelScript!
- fullName: getDataLabel()
- summary: Returns the data label of a chart point.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDataLabel(): ChartDataLabel;'
- return:
- type: ''
- description: ''
- - name: getFormat()
- uid: 'ExcelScript!ExcelScript.ChartPoint#getFormat:member(1)'
- package: ExcelScript!
- fullName: getFormat()
- summary: Encapsulates the format properties chart point.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormat(): ChartPointFormat;'
- return:
- type: ''
- description: ''
- - name: getHasDataLabel()
- uid: 'ExcelScript!ExcelScript.ChartPoint#getHasDataLabel:member(1)'
- package: ExcelScript!
- fullName: getHasDataLabel()
- summary: Represents whether a data point has a data label. Not applicable for surface charts.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHasDataLabel(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getMarkerBackgroundColor()
- uid: 'ExcelScript!ExcelScript.ChartPoint#getMarkerBackgroundColor:member(1)'
- package: ExcelScript!
- fullName: getMarkerBackgroundColor()
- summary: 'HTML color code representation of the marker background color of a data point (e.g., \#FF0000 represents Red).'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMarkerBackgroundColor(): string;'
- return:
- type: string
- description: ''
- - name: getMarkerForegroundColor()
- uid: 'ExcelScript!ExcelScript.ChartPoint#getMarkerForegroundColor:member(1)'
- package: ExcelScript!
- fullName: getMarkerForegroundColor()
- summary: 'HTML color code representation of the marker foreground color of a data point (e.g., \#FF0000 represents Red).'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMarkerForegroundColor(): string;'
- return:
- type: string
- description: ''
- - name: getMarkerSize()
- uid: 'ExcelScript!ExcelScript.ChartPoint#getMarkerSize:member(1)'
- package: ExcelScript!
- fullName: getMarkerSize()
- summary: >-
- Represents marker size of a data point. The supported size range is 2 to 72. This method returns an
- InvalidArgument error if it's set with a size outside of the supported range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMarkerSize(): number;'
- return:
- type: number
- description: ''
- - name: getMarkerStyle()
- uid: 'ExcelScript!ExcelScript.ChartPoint#getMarkerStyle:member(1)'
- package: ExcelScript!
- fullName: getMarkerStyle()
- summary: Represents marker style of a chart data point. See `ExcelScript.ChartMarkerStyle` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMarkerStyle(): ChartMarkerStyle;'
- return:
- type: ''
- description: ''
- - name: getValue()
- uid: 'ExcelScript!ExcelScript.ChartPoint#getValue:member(1)'
- package: ExcelScript!
- fullName: getValue()
- summary: Returns the value of a chart point.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getValue(): number;'
- return:
- type: number
- description: ''
- - name: setHasDataLabel(hasDataLabel)
- uid: 'ExcelScript!ExcelScript.ChartPoint#setHasDataLabel:member(1)'
- package: ExcelScript!
- fullName: setHasDataLabel(hasDataLabel)
- summary: Represents whether a data point has a data label. Not applicable for surface charts.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setHasDataLabel(hasDataLabel: boolean): void;'
- parameters:
- - id: hasDataLabel
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setMarkerBackgroundColor(markerBackgroundColor)
- uid: 'ExcelScript!ExcelScript.ChartPoint#setMarkerBackgroundColor:member(1)'
- package: ExcelScript!
- fullName: setMarkerBackgroundColor(markerBackgroundColor)
- summary: 'HTML color code representation of the marker background color of a data point (e.g., \#FF0000 represents Red).'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMarkerBackgroundColor(markerBackgroundColor: string): void;'
- parameters:
- - id: markerBackgroundColor
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setMarkerForegroundColor(markerForegroundColor)
- uid: 'ExcelScript!ExcelScript.ChartPoint#setMarkerForegroundColor:member(1)'
- package: ExcelScript!
- fullName: setMarkerForegroundColor(markerForegroundColor)
- summary: 'HTML color code representation of the marker foreground color of a data point (e.g., \#FF0000 represents Red).'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMarkerForegroundColor(markerForegroundColor: string): void;'
- parameters:
- - id: markerForegroundColor
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setMarkerSize(markerSize)
- uid: 'ExcelScript!ExcelScript.ChartPoint#setMarkerSize:member(1)'
- package: ExcelScript!
- fullName: setMarkerSize(markerSize)
- summary: >-
- Represents marker size of a data point. The supported size range is 2 to 72. This method returns an
- InvalidArgument error if it's set with a size outside of the supported range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMarkerSize(markerSize: number): void;'
- parameters:
- - id: markerSize
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setMarkerStyle(markerStyle)
- uid: 'ExcelScript!ExcelScript.ChartPoint#setMarkerStyle:member(1)'
- package: ExcelScript!
- fullName: setMarkerStyle(markerStyle)
- summary: Represents marker style of a chart data point. See `ExcelScript.ChartMarkerStyle` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMarkerStyle(markerStyle: ChartMarkerStyle): void;'
- parameters:
- - id: markerStyle
- description: ''
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartPoint
+uid: 'ExcelScript!ExcelScript.ChartPoint:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartPoint
+summary: Represents a point of a series in a chart.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getDataLabel()
+ uid: 'ExcelScript!ExcelScript.ChartPoint#getDataLabel:member(1)'
+ package: ExcelScript!
+ fullName: getDataLabel()
+ summary: Returns the data label of a chart point.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDataLabel(): ChartDataLabel;'
+ return:
+ type: ''
+ description: ''
+ - name: getFormat()
+ uid: 'ExcelScript!ExcelScript.ChartPoint#getFormat:member(1)'
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: Encapsulates the format properties chart point.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): ChartPointFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getHasDataLabel()
+ uid: 'ExcelScript!ExcelScript.ChartPoint#getHasDataLabel:member(1)'
+ package: ExcelScript!
+ fullName: getHasDataLabel()
+ summary: Represents whether a data point has a data label. Not applicable for surface charts.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHasDataLabel(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getMarkerBackgroundColor()
+ uid: 'ExcelScript!ExcelScript.ChartPoint#getMarkerBackgroundColor:member(1)'
+ package: ExcelScript!
+ fullName: getMarkerBackgroundColor()
+ summary: 'HTML color code representation of the marker background color of a data point (e.g., \#FF0000 represents Red).'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMarkerBackgroundColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getMarkerForegroundColor()
+ uid: 'ExcelScript!ExcelScript.ChartPoint#getMarkerForegroundColor:member(1)'
+ package: ExcelScript!
+ fullName: getMarkerForegroundColor()
+ summary: 'HTML color code representation of the marker foreground color of a data point (e.g., \#FF0000 represents Red).'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMarkerForegroundColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getMarkerSize()
+ uid: 'ExcelScript!ExcelScript.ChartPoint#getMarkerSize:member(1)'
+ package: ExcelScript!
+ fullName: getMarkerSize()
+ summary: >-
+ Represents marker size of a data point. The supported size range is 2 to 72. This method returns an
+ InvalidArgument error if it's set with a size outside of the supported range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMarkerSize(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getMarkerStyle()
+ uid: 'ExcelScript!ExcelScript.ChartPoint#getMarkerStyle:member(1)'
+ package: ExcelScript!
+ fullName: getMarkerStyle()
+ summary: Represents marker style of a chart data point. See `ExcelScript.ChartMarkerStyle` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMarkerStyle(): ChartMarkerStyle;'
+ return:
+ type: ''
+ description: ''
+ - name: getValue()
+ uid: 'ExcelScript!ExcelScript.ChartPoint#getValue:member(1)'
+ package: ExcelScript!
+ fullName: getValue()
+ summary: Returns the value of a chart point.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getValue(): number;'
+ return:
+ type: number
+ description: ''
+ - name: setHasDataLabel(hasDataLabel)
+ uid: 'ExcelScript!ExcelScript.ChartPoint#setHasDataLabel:member(1)'
+ package: ExcelScript!
+ fullName: setHasDataLabel(hasDataLabel)
+ summary: Represents whether a data point has a data label. Not applicable for surface charts.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setHasDataLabel(hasDataLabel: boolean): void;'
+ parameters:
+ - id: hasDataLabel
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setMarkerBackgroundColor(markerBackgroundColor)
+ uid: 'ExcelScript!ExcelScript.ChartPoint#setMarkerBackgroundColor:member(1)'
+ package: ExcelScript!
+ fullName: setMarkerBackgroundColor(markerBackgroundColor)
+ summary: 'HTML color code representation of the marker background color of a data point (e.g., \#FF0000 represents Red).'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMarkerBackgroundColor(markerBackgroundColor: string): void;'
+ parameters:
+ - id: markerBackgroundColor
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setMarkerForegroundColor(markerForegroundColor)
+ uid: 'ExcelScript!ExcelScript.ChartPoint#setMarkerForegroundColor:member(1)'
+ package: ExcelScript!
+ fullName: setMarkerForegroundColor(markerForegroundColor)
+ summary: 'HTML color code representation of the marker foreground color of a data point (e.g., \#FF0000 represents Red).'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMarkerForegroundColor(markerForegroundColor: string): void;'
+ parameters:
+ - id: markerForegroundColor
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setMarkerSize(markerSize)
+ uid: 'ExcelScript!ExcelScript.ChartPoint#setMarkerSize:member(1)'
+ package: ExcelScript!
+ fullName: setMarkerSize(markerSize)
+ summary: >-
+ Represents marker size of a data point. The supported size range is 2 to 72. This method returns an
+ InvalidArgument error if it's set with a size outside of the supported range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMarkerSize(markerSize: number): void;'
+ parameters:
+ - id: markerSize
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setMarkerStyle(markerStyle)
+ uid: 'ExcelScript!ExcelScript.ChartPoint#setMarkerStyle:member(1)'
+ package: ExcelScript!
+ fullName: setMarkerStyle(markerStyle)
+ summary: Represents marker style of a chart data point. See `ExcelScript.ChartMarkerStyle` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMarkerStyle(markerStyle: ChartMarkerStyle): void;'
+ parameters:
+ - id: markerStyle
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartpointformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartpointformat.yml
index a75d9134..7713b48a 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartpointformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartpointformat.yml
@@ -1,37 +1,37 @@
-### YamlMime:TSType
-name: ExcelScript.ChartPointFormat
-uid: 'ExcelScript!ExcelScript.ChartPointFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartPointFormat
-summary: Represents the formatting object for chart points.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getBorder()
- uid: 'ExcelScript!ExcelScript.ChartPointFormat#getBorder:member(1)'
- package: ExcelScript!
- fullName: getBorder()
- summary: 'Represents the border format of a chart data point, which includes color, style, and weight information.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBorder(): ChartBorder;'
- return:
- type: ''
- description: ''
- - name: getFill()
- uid: 'ExcelScript!ExcelScript.ChartPointFormat#getFill:member(1)'
- package: ExcelScript!
- fullName: getFill()
- summary: 'Represents the fill format of a chart, which includes background formatting information.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFill(): ChartFill;'
- return:
- type: ''
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartPointFormat
+uid: 'ExcelScript!ExcelScript.ChartPointFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartPointFormat
+summary: Represents the formatting object for chart points.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getBorder()
+ uid: 'ExcelScript!ExcelScript.ChartPointFormat#getBorder:member(1)'
+ package: ExcelScript!
+ fullName: getBorder()
+ summary: 'Represents the border format of a chart data point, which includes color, style, and weight information.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBorder(): ChartBorder;'
+ return:
+ type: ''
+ description: ''
+ - name: getFill()
+ uid: 'ExcelScript!ExcelScript.ChartPointFormat#getFill:member(1)'
+ package: ExcelScript!
+ fullName: getFill()
+ summary: 'Represents the fill format of a chart, which includes background formatting information.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFill(): ChartFill;'
+ return:
+ type: ''
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartseries.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartseries.yml
index b07882d2..b9f682ea 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartseries.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartseries.yml
@@ -1,1540 +1,1540 @@
-### YamlMime:TSType
-name: ExcelScript.ChartSeries
-uid: 'ExcelScript!ExcelScript.ChartSeries:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartSeries
-summary: Represents a series in a chart.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample produces a line chart with two series.
- * The chart assumes data in A1:E5 that looks like this:
- * Product Qtr1 Qtr2 Qtr3 Qtr4
- * Frames 5000 7000 6544 4377
- * Saddles 400 323 276 651
- */
- function main(workbook: ExcelScript.Workbook) {
- // Establish the ranges to use.
- const sheet = workbook.getActiveWorksheet();
- const headerRange = sheet.getRange("A1:E1");
- const firstSeriesRange = sheet.getRange("A2:E2");
- const secondSeriesRange = sheet.getRange("A3:E3");
-
- // Create the chart.
- const lineChart = sheet.addChart(ExcelScript.ChartType.line, headerRange);
-
- // Add the first chart series.
- const firstSeries = lineChart.addChartSeries();
- firstSeries.setXAxisValues(headerRange);
- firstSeries.setValues(firstSeriesRange);
-
- // Add the second chart series.
- const secondSeries = lineChart.addChartSeries();
- secondSeries.setXAxisValues(headerRange);
- secondSeries.setValues(secondSeriesRange);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: addChartTrendline(type)
- uid: 'ExcelScript!ExcelScript.ChartSeries#addChartTrendline:member(1)'
- package: ExcelScript!
- fullName: addChartTrendline(type)
- summary: Adds a new trendline to trendline collection.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addChartTrendline(type?: ChartTrendlineType): ChartTrendline;'
- parameters:
- - id: type
- description: Specifies the trendline type. The default value is "Linear". See `ExcelScript.ChartTrendline` for details.
- type: ''
- return:
- type: ''
- description: ''
- - name: delete()
- uid: 'ExcelScript!ExcelScript.ChartSeries#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: Deletes the chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: ''
- - name: getAxisGroup()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getAxisGroup:member(1)'
- package: ExcelScript!
- fullName: getAxisGroup()
- summary: Specifies the group for the specified series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAxisGroup(): ChartAxisGroup;'
- return:
- type: ''
- description: ''
- - name: getBinOptions()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getBinOptions:member(1)'
- package: ExcelScript!
- fullName: getBinOptions()
- summary: Encapsulates the bin options for histogram charts and pareto charts.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBinOptions(): ChartBinOptions;'
- return:
- type: ''
- description: ''
- - name: getBoxwhiskerOptions()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getBoxwhiskerOptions:member(1)'
- package: ExcelScript!
- fullName: getBoxwhiskerOptions()
- summary: Encapsulates the options for the box and whisker charts.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBoxwhiskerOptions(): ChartBoxwhiskerOptions;'
- return:
- type: ''
- description: ''
- - name: getBubbleScale()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getBubbleScale:member(1)'
- package: ExcelScript!
- fullName: getBubbleScale()
- summary: >-
- This can be an integer value from 0 (zero) to 300, representing the percentage of the default size. This property
- only applies to bubble charts.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBubbleScale(): number;'
- return:
- type: number
- description: ''
- - name: getChartTrendline(index)
- uid: 'ExcelScript!ExcelScript.ChartSeries#getChartTrendline:member(1)'
- package: ExcelScript!
- fullName: getChartTrendline(index)
- summary: 'Gets a trendline object by index, which is the insertion order in the items array.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getChartTrendline(index: number): ChartTrendline;'
- parameters:
- - id: index
- description: Represents the insertion order in the items array.
- type: number
- return:
- type: ''
- description: ''
- - name: getChartType()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getChartType:member(1)'
- package: ExcelScript!
- fullName: getChartType()
- summary: Represents the chart type of a series. See `ExcelScript.ChartType` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getChartType(): ChartType;'
- return:
- type: ''
- description: ''
- - name: getDataLabels()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getDataLabels:member(1)'
- package: ExcelScript!
- fullName: getDataLabels()
- summary: Represents a collection of all data labels in the series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDataLabels(): ChartDataLabels;'
- return:
- type: ''
- description: ''
- - name: getDimensionDataSourceString(dimension)
- uid: 'ExcelScript!ExcelScript.ChartSeries#getDimensionDataSourceString:member(1)'
- package: ExcelScript!
- fullName: getDimensionDataSourceString(dimension)
- summary: >-
- Gets the string representation of the data source of the chart series. The string representation could be
- information such as a cell address.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDimensionDataSourceString(dimension: ChartSeriesDimension): string;'
- parameters:
- - id: dimension
- description: The dimension of the axis where the data is from.
- type: ''
- return:
- type: string
- description: ''
- - name: getDimensionDataSourceType(dimension)
- uid: 'ExcelScript!ExcelScript.ChartSeries#getDimensionDataSourceType:member(1)'
- package: ExcelScript!
- fullName: getDimensionDataSourceType(dimension)
- summary: Gets the data source type of the chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- getDimensionDataSourceType(
- dimension: ChartSeriesDimension
- ): ChartDataSourceType;
- parameters:
- - id: dimension
- description: The dimension of the axis where the data is from.
- type: ''
- return:
- type: ''
- description: ''
- - name: getDimensionValues(dimension)
- uid: 'ExcelScript!ExcelScript.ChartSeries#getDimensionValues:member(1)'
- package: ExcelScript!
- fullName: getDimensionValues(dimension)
- summary: >-
- Gets the values from a single dimension of the chart series. These could be either category values or data values,
- depending on the dimension specified and how the data is mapped for the chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDimensionValues(dimension: ChartSeriesDimension): string[];'
- parameters:
- - id: dimension
- description: The dimension of the axis where the data is from.
- type: ''
- return:
- type: 'string[]'
- description: ''
- - name: getDoughnutHoleSize()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getDoughnutHoleSize:member(1)'
- package: ExcelScript!
- fullName: getDoughnutHoleSize()
- summary: >-
- Represents the doughnut hole size of a chart series. Only valid on doughnut and doughnut exploded charts. Throws
- an `InvalidArgument` error on invalid charts.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDoughnutHoleSize(): number;'
- return:
- type: number
- description: ''
- - name: getExplosion()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getExplosion:member(1)'
- package: ExcelScript!
- fullName: getExplosion()
- summary: >-
- Specifies the explosion value for a pie-chart or doughnut-chart slice. Returns 0 (zero) if there's no explosion
- (the tip of the slice is in the center of the pie).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getExplosion(): number;'
- return:
- type: number
- description: ''
- - name: getFiltered()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getFiltered:member(1)'
- package: ExcelScript!
- fullName: getFiltered()
- summary: Specifies if the series is filtered. Not applicable for surface charts.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFiltered(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getFirstSliceAngle()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getFirstSliceAngle:member(1)'
- package: ExcelScript!
- fullName: getFirstSliceAngle()
- summary: >-
- Specifies the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). Applies
- only to pie, 3-D pie, and doughnut charts. Can be a value from 0 through 360.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFirstSliceAngle(): number;'
- return:
- type: number
- description: ''
- - name: getFormat()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getFormat:member(1)'
- package: ExcelScript!
- fullName: getFormat()
- summary: 'Represents the formatting of a chart series, which includes fill and line formatting.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormat(): ChartSeriesFormat;'
- return:
- type: ''
- description: ''
- - name: getGapWidth()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getGapWidth:member(1)'
- package: ExcelScript!
- fullName: getGapWidth()
- summary: >-
- Represents the gap width of a chart series. Only valid on bar and column charts, as well as specific classes of
- line and pie charts. Throws an invalid argument exception on invalid charts.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGapWidth(): number;'
- return:
- type: number
- description: ''
- - name: getGradientMaximumColor()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getGradientMaximumColor:member(1)'
- package: ExcelScript!
- fullName: getGradientMaximumColor()
- summary: Specifies the color for maximum value of a region map chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGradientMaximumColor(): string;'
- return:
- type: string
- description: ''
- - name: getGradientMaximumType()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getGradientMaximumType:member(1)'
- package: ExcelScript!
- fullName: getGradientMaximumType()
- summary: Specifies the type for maximum value of a region map chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGradientMaximumType(): ChartGradientStyleType;'
- return:
- type: ''
- description: ''
- - name: getGradientMaximumValue()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getGradientMaximumValue:member(1)'
- package: ExcelScript!
- fullName: getGradientMaximumValue()
- summary: Specifies the maximum value of a region map chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGradientMaximumValue(): number;'
- return:
- type: number
- description: ''
- - name: getGradientMidpointColor()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getGradientMidpointColor:member(1)'
- package: ExcelScript!
- fullName: getGradientMidpointColor()
- summary: Specifies the color for the midpoint value of a region map chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGradientMidpointColor(): string;'
- return:
- type: string
- description: ''
- - name: getGradientMidpointType()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getGradientMidpointType:member(1)'
- package: ExcelScript!
- fullName: getGradientMidpointType()
- summary: Specifies the type for the midpoint value of a region map chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGradientMidpointType(): ChartGradientStyleType;'
- return:
- type: ''
- description: ''
- - name: getGradientMidpointValue()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getGradientMidpointValue:member(1)'
- package: ExcelScript!
- fullName: getGradientMidpointValue()
- summary: Specifies the midpoint value of a region map chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGradientMidpointValue(): number;'
- return:
- type: number
- description: ''
- - name: getGradientMinimumColor()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getGradientMinimumColor:member(1)'
- package: ExcelScript!
- fullName: getGradientMinimumColor()
- summary: Specifies the color for the minimum value of a region map chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGradientMinimumColor(): string;'
- return:
- type: string
- description: ''
- - name: getGradientMinimumType()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getGradientMinimumType:member(1)'
- package: ExcelScript!
- fullName: getGradientMinimumType()
- summary: Specifies the type for the minimum value of a region map chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGradientMinimumType(): ChartGradientStyleType;'
- return:
- type: ''
- description: ''
- - name: getGradientMinimumValue()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getGradientMinimumValue:member(1)'
- package: ExcelScript!
- fullName: getGradientMinimumValue()
- summary: Specifies the minimum value of a region map chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGradientMinimumValue(): number;'
- return:
- type: number
- description: ''
- - name: getGradientStyle()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getGradientStyle:member(1)'
- package: ExcelScript!
- fullName: getGradientStyle()
- summary: Specifies the series gradient style of a region map chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGradientStyle(): ChartGradientStyle;'
- return:
- type: ''
- description: ''
- - name: getHasDataLabels()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getHasDataLabels:member(1)'
- package: ExcelScript!
- fullName: getHasDataLabels()
- summary: Specifies if the series has data labels.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHasDataLabels(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getInvertColor()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getInvertColor:member(1)'
- package: ExcelScript!
- fullName: getInvertColor()
- summary: Specifies the fill color for negative data points in a series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getInvertColor(): string;'
- return:
- type: string
- description: ''
- - name: getInvertIfNegative()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getInvertIfNegative:member(1)'
- package: ExcelScript!
- fullName: getInvertIfNegative()
- summary: True if Excel inverts the pattern in the item when it corresponds to a negative number.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getInvertIfNegative(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getMapOptions()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getMapOptions:member(1)'
- package: ExcelScript!
- fullName: getMapOptions()
- summary: Encapsulates the options for a region map chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMapOptions(): ChartMapOptions;'
- return:
- type: ''
- description: ''
- - name: getMarkerBackgroundColor()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getMarkerBackgroundColor:member(1)'
- package: ExcelScript!
- fullName: getMarkerBackgroundColor()
- summary: Specifies the marker background color of a chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMarkerBackgroundColor(): string;'
- return:
- type: string
- description: ''
- - name: getMarkerForegroundColor()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getMarkerForegroundColor:member(1)'
- package: ExcelScript!
- fullName: getMarkerForegroundColor()
- summary: Specifies the marker foreground color of a chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMarkerForegroundColor(): string;'
- return:
- type: string
- description: ''
- - name: getMarkerSize()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getMarkerSize:member(1)'
- package: ExcelScript!
- fullName: getMarkerSize()
- summary: >-
- Specifies the marker size of a chart series. The supported size range is 2 to 72. This method returns an
- InvalidArgument error if it's set with a size outside of the supported range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMarkerSize(): number;'
- return:
- type: number
- description: ''
- - name: getMarkerStyle()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getMarkerStyle:member(1)'
- package: ExcelScript!
- fullName: getMarkerStyle()
- summary: Specifies the marker style of a chart series. See `ExcelScript.ChartMarkerStyle` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMarkerStyle(): ChartMarkerStyle;'
- return:
- type: ''
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: Specifies the name of a series in a chart. The name's length should not be greater than 255 characters.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample logs the names of each of the chart series in a chart named "ColumnClusteredChart".
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Get an existing chart named "ColumnClusteredChart".
- let chart = selectedSheet.getChart("ColumnClusteredChart");
-
- // Log the name of each chart series in the chart.
- let seriesList = chart.getSeries();
- seriesList.forEach((series) => {
- console.log(series.getName());
- });
- }
- ```
- - name: getOverlap()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getOverlap:member(1)'
- package: ExcelScript!
- fullName: getOverlap()
- summary: >-
- Specifies how bars and columns are positioned. Can be a value between -100 and 100. Applies only to 2-D bar and
- 2-D column charts.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getOverlap(): number;'
- return:
- type: number
- description: ''
- - name: getParentLabelStrategy()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getParentLabelStrategy:member(1)'
- package: ExcelScript!
- fullName: getParentLabelStrategy()
- summary: Specifies the series parent label strategy area for a treemap chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getParentLabelStrategy(): ChartParentLabelStrategy;'
- return:
- type: ''
- description: ''
- - name: getPlotOrder()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getPlotOrder:member(1)'
- package: ExcelScript!
- fullName: getPlotOrder()
- summary: Specifies the plot order of a chart series within the chart group.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPlotOrder(): number;'
- return:
- type: number
- description: ''
- - name: getPoints()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getPoints:member(1)'
- package: ExcelScript!
- fullName: getPoints()
- summary: Returns a collection of all points in the series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPoints(): ChartPoint[];'
- return:
- type: '[]'
- description: ''
- - name: getSecondPlotSize()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getSecondPlotSize:member(1)'
- package: ExcelScript!
- fullName: getSecondPlotSize()
- summary: >-
- Specifies the size of the secondary section of either a pie-of-pie chart or a bar-of-pie chart, as a percentage of
- the size of the primary pie. Can be a value from 5 to 200.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSecondPlotSize(): number;'
- return:
- type: number
- description: ''
- - name: getShowConnectorLines()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getShowConnectorLines:member(1)'
- package: ExcelScript!
- fullName: getShowConnectorLines()
- summary: Specifies whether connector lines are shown in waterfall charts.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowConnectorLines(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowLeaderLines()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getShowLeaderLines:member(1)'
- package: ExcelScript!
- fullName: getShowLeaderLines()
- summary: Specifies whether leader lines are displayed for each data label in the series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowLeaderLines(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowShadow()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getShowShadow:member(1)'
- package: ExcelScript!
- fullName: getShowShadow()
- summary: Specifies if the series has a shadow.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowShadow(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getSmooth()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getSmooth:member(1)'
- package: ExcelScript!
- fullName: getSmooth()
- summary: Specifies if the series is smooth. Only applicable to line and scatter charts.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSmooth(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getSplitType()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getSplitType:member(1)'
- package: ExcelScript!
- fullName: getSplitType()
- summary: Specifies the way the two sections of either a pie-of-pie chart or a bar-of-pie chart are split.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSplitType(): ChartSplitType;'
- return:
- type: ''
- description: ''
- - name: getSplitValue()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getSplitValue:member(1)'
- package: ExcelScript!
- fullName: getSplitValue()
- summary: Specifies the threshold value that separates two sections of either a pie-of-pie chart or a bar-of-pie chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSplitValue(): number;'
- return:
- type: number
- description: ''
- - name: getTrendlines()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getTrendlines:member(1)'
- package: ExcelScript!
- fullName: getTrendlines()
- summary: The collection of trendlines in the series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTrendlines(): ChartTrendline[];'
- return:
- type: '[]'
- description: ''
- - name: getVaryByCategories()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getVaryByCategories:member(1)'
- package: ExcelScript!
- fullName: getVaryByCategories()
- summary: True if Excel assigns a different color or pattern to each data marker. The chart must contain only one series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVaryByCategories(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getXErrorBars()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getXErrorBars:member(1)'
- package: ExcelScript!
- fullName: getXErrorBars()
- summary: Represents the error bar object of a chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getXErrorBars(): ChartErrorBars;'
- return:
- type: ''
- description: ''
- - name: getYErrorBars()
- uid: 'ExcelScript!ExcelScript.ChartSeries#getYErrorBars:member(1)'
- package: ExcelScript!
- fullName: getYErrorBars()
- summary: Represents the error bar object of a chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getYErrorBars(): ChartErrorBars;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds error bars for the standard error of each chart series point.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range for the chart.
- const worksheet = workbook.getWorksheet("Sample");
- const dataRange = worksheet.getRange("A1:B15");
-
- // Create a line chart.
- const chart = worksheet.addChart(ExcelScript.ChartType.line, dataRange);
-
- // For each series, add error bars for the standard error on each point
- const allSeries = chart.getSeries();
- allSeries.forEach((series) => {
- series.getYErrorBars().setType(ExcelScript.ChartErrorBarsType.stError);
- series.getYErrorBars().setVisible(true);
- });
- }
- ```
- - name: setAxisGroup(axisGroup)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setAxisGroup:member(1)'
- package: ExcelScript!
- fullName: setAxisGroup(axisGroup)
- summary: Specifies the group for the specified series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setAxisGroup(axisGroup: ChartAxisGroup): void;'
- parameters:
- - id: axisGroup
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setBubbleScale(bubbleScale)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setBubbleScale:member(1)'
- package: ExcelScript!
- fullName: setBubbleScale(bubbleScale)
- summary: >-
- This can be an integer value from 0 (zero) to 300, representing the percentage of the default size. This property
- only applies to bubble charts.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setBubbleScale(bubbleScale: number): void;'
- parameters:
- - id: bubbleScale
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setBubbleSizes(sourceData)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setBubbleSizes:member(1)'
- package: ExcelScript!
- fullName: setBubbleSizes(sourceData)
- summary: Sets the bubble sizes for a chart series. Only works for bubble charts.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setBubbleSizes(sourceData: Range): void;'
- parameters:
- - id: sourceData
- description: The `Range` object corresponding to the source data.
- type: ''
- return:
- type: void
- description: ''
- - name: setChartType(chartType)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setChartType:member(1)'
- package: ExcelScript!
- fullName: setChartType(chartType)
- summary: Represents the chart type of a series. See `ExcelScript.ChartType` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setChartType(chartType: ChartType): void;'
- parameters:
- - id: chartType
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setDoughnutHoleSize(doughnutHoleSize)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setDoughnutHoleSize:member(1)'
- package: ExcelScript!
- fullName: setDoughnutHoleSize(doughnutHoleSize)
- summary: >-
- Represents the doughnut hole size of a chart series. Only valid on doughnut and doughnut exploded charts. Throws
- an `InvalidArgument` error on invalid charts.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setDoughnutHoleSize(doughnutHoleSize: number): void;'
- parameters:
- - id: doughnutHoleSize
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setExplosion(explosion)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setExplosion:member(1)'
- package: ExcelScript!
- fullName: setExplosion(explosion)
- summary: >-
- Specifies the explosion value for a pie-chart or doughnut-chart slice. Returns 0 (zero) if there's no explosion
- (the tip of the slice is in the center of the pie).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setExplosion(explosion: number): void;'
- parameters:
- - id: explosion
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setFiltered(filtered)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setFiltered:member(1)'
- package: ExcelScript!
- fullName: setFiltered(filtered)
- summary: Specifies if the series is filtered. Not applicable for surface charts.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFiltered(filtered: boolean): void;'
- parameters:
- - id: filtered
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setFirstSliceAngle(firstSliceAngle)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setFirstSliceAngle:member(1)'
- package: ExcelScript!
- fullName: setFirstSliceAngle(firstSliceAngle)
- summary: >-
- Specifies the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). Applies
- only to pie, 3-D pie, and doughnut charts. Can be a value from 0 through 360.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFirstSliceAngle(firstSliceAngle: number): void;'
- parameters:
- - id: firstSliceAngle
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setGapWidth(gapWidth)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setGapWidth:member(1)'
- package: ExcelScript!
- fullName: setGapWidth(gapWidth)
- summary: >-
- Represents the gap width of a chart series. Only valid on bar and column charts, as well as specific classes of
- line and pie charts. Throws an invalid argument exception on invalid charts.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setGapWidth(gapWidth: number): void;'
- parameters:
- - id: gapWidth
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setGradientMaximumColor(gradientMaximumColor)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setGradientMaximumColor:member(1)'
- package: ExcelScript!
- fullName: setGradientMaximumColor(gradientMaximumColor)
- summary: Specifies the color for maximum value of a region map chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setGradientMaximumColor(gradientMaximumColor: string): void;'
- parameters:
- - id: gradientMaximumColor
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setGradientMaximumType(gradientMaximumType)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setGradientMaximumType:member(1)'
- package: ExcelScript!
- fullName: setGradientMaximumType(gradientMaximumType)
- summary: Specifies the type for maximum value of a region map chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setGradientMaximumType(
- gradientMaximumType: ChartGradientStyleType
- ): void;
- parameters:
- - id: gradientMaximumType
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setGradientMaximumValue(gradientMaximumValue)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setGradientMaximumValue:member(1)'
- package: ExcelScript!
- fullName: setGradientMaximumValue(gradientMaximumValue)
- summary: Specifies the maximum value of a region map chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setGradientMaximumValue(gradientMaximumValue: number): void;'
- parameters:
- - id: gradientMaximumValue
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setGradientMidpointColor(gradientMidpointColor)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setGradientMidpointColor:member(1)'
- package: ExcelScript!
- fullName: setGradientMidpointColor(gradientMidpointColor)
- summary: Specifies the color for the midpoint value of a region map chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setGradientMidpointColor(gradientMidpointColor: string): void;'
- parameters:
- - id: gradientMidpointColor
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setGradientMidpointType(gradientMidpointType)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setGradientMidpointType:member(1)'
- package: ExcelScript!
- fullName: setGradientMidpointType(gradientMidpointType)
- summary: Specifies the type for the midpoint value of a region map chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setGradientMidpointType(
- gradientMidpointType: ChartGradientStyleType
- ): void;
- parameters:
- - id: gradientMidpointType
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setGradientMidpointValue(gradientMidpointValue)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setGradientMidpointValue:member(1)'
- package: ExcelScript!
- fullName: setGradientMidpointValue(gradientMidpointValue)
- summary: Specifies the midpoint value of a region map chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setGradientMidpointValue(gradientMidpointValue: number): void;'
- parameters:
- - id: gradientMidpointValue
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setGradientMinimumColor(gradientMinimumColor)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setGradientMinimumColor:member(1)'
- package: ExcelScript!
- fullName: setGradientMinimumColor(gradientMinimumColor)
- summary: Specifies the color for the minimum value of a region map chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setGradientMinimumColor(gradientMinimumColor: string): void;'
- parameters:
- - id: gradientMinimumColor
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setGradientMinimumType(gradientMinimumType)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setGradientMinimumType:member(1)'
- package: ExcelScript!
- fullName: setGradientMinimumType(gradientMinimumType)
- summary: Specifies the type for the minimum value of a region map chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setGradientMinimumType(
- gradientMinimumType: ChartGradientStyleType
- ): void;
- parameters:
- - id: gradientMinimumType
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setGradientMinimumValue(gradientMinimumValue)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setGradientMinimumValue:member(1)'
- package: ExcelScript!
- fullName: setGradientMinimumValue(gradientMinimumValue)
- summary: Specifies the minimum value of a region map chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setGradientMinimumValue(gradientMinimumValue: number): void;'
- parameters:
- - id: gradientMinimumValue
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setGradientStyle(gradientStyle)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setGradientStyle:member(1)'
- package: ExcelScript!
- fullName: setGradientStyle(gradientStyle)
- summary: Specifies the series gradient style of a region map chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setGradientStyle(gradientStyle: ChartGradientStyle): void;'
- parameters:
- - id: gradientStyle
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setHasDataLabels(hasDataLabels)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setHasDataLabels:member(1)'
- package: ExcelScript!
- fullName: setHasDataLabels(hasDataLabels)
- summary: Specifies if the series has data labels.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setHasDataLabels(hasDataLabels: boolean): void;'
- parameters:
- - id: hasDataLabels
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setInvertColor(invertColor)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setInvertColor:member(1)'
- package: ExcelScript!
- fullName: setInvertColor(invertColor)
- summary: Specifies the fill color for negative data points in a series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setInvertColor(invertColor: string): void;'
- parameters:
- - id: invertColor
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setInvertIfNegative(invertIfNegative)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setInvertIfNegative:member(1)'
- package: ExcelScript!
- fullName: setInvertIfNegative(invertIfNegative)
- summary: True if Excel inverts the pattern in the item when it corresponds to a negative number.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setInvertIfNegative(invertIfNegative: boolean): void;'
- parameters:
- - id: invertIfNegative
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setMarkerBackgroundColor(markerBackgroundColor)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setMarkerBackgroundColor:member(1)'
- package: ExcelScript!
- fullName: setMarkerBackgroundColor(markerBackgroundColor)
- summary: Specifies the marker background color of a chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMarkerBackgroundColor(markerBackgroundColor: string): void;'
- parameters:
- - id: markerBackgroundColor
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setMarkerForegroundColor(markerForegroundColor)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setMarkerForegroundColor:member(1)'
- package: ExcelScript!
- fullName: setMarkerForegroundColor(markerForegroundColor)
- summary: Specifies the marker foreground color of a chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMarkerForegroundColor(markerForegroundColor: string): void;'
- parameters:
- - id: markerForegroundColor
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setMarkerSize(markerSize)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setMarkerSize:member(1)'
- package: ExcelScript!
- fullName: setMarkerSize(markerSize)
- summary: >-
- Specifies the marker size of a chart series. The supported size range is 2 to 72. This method returns an
- InvalidArgument error if it's set with a size outside of the supported range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMarkerSize(markerSize: number): void;'
- parameters:
- - id: markerSize
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setMarkerStyle(markerStyle)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setMarkerStyle:member(1)'
- package: ExcelScript!
- fullName: setMarkerStyle(markerStyle)
- summary: Specifies the marker style of a chart series. See `ExcelScript.ChartMarkerStyle` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMarkerStyle(markerStyle: ChartMarkerStyle): void;'
- parameters:
- - id: markerStyle
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setName(name)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setName:member(1)'
- package: ExcelScript!
- fullName: setName(name)
- summary: Specifies the name of a series in a chart. The name's length should not be greater than 255 characters.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setName(name: string): void;'
- parameters:
- - id: name
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setOverlap(overlap)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setOverlap:member(1)'
- package: ExcelScript!
- fullName: setOverlap(overlap)
- summary: >-
- Specifies how bars and columns are positioned. Can be a value between -100 and 100. Applies only to 2-D bar and
- 2-D column charts.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setOverlap(overlap: number): void;'
- parameters:
- - id: overlap
- description: ''
- type: number
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample sets the overlap of the columns in a chart named "ColumnClusteredChart".
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Get an existing chart named "ColumnClusteredChart".
- let chart = selectedSheet.getChart("ColumnClusteredChart");
-
- // Set the overlap of every column of each series within a category.
- let seriesList = chart.getSeries();
- seriesList.forEach((series) => {
- // An overlap of 25 means the columns have 25% of their length overlapping with the adjacent columns in the same category.
- series.setOverlap(25);
- });
- }
- ```
- - name: setParentLabelStrategy(parentLabelStrategy)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setParentLabelStrategy:member(1)'
- package: ExcelScript!
- fullName: setParentLabelStrategy(parentLabelStrategy)
- summary: Specifies the series parent label strategy area for a treemap chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setParentLabelStrategy(
- parentLabelStrategy: ChartParentLabelStrategy
- ): void;
- parameters:
- - id: parentLabelStrategy
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setPlotOrder(plotOrder)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setPlotOrder:member(1)'
- package: ExcelScript!
- fullName: setPlotOrder(plotOrder)
- summary: Specifies the plot order of a chart series within the chart group.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPlotOrder(plotOrder: number): void;'
- parameters:
- - id: plotOrder
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setSecondPlotSize(secondPlotSize)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setSecondPlotSize:member(1)'
- package: ExcelScript!
- fullName: setSecondPlotSize(secondPlotSize)
- summary: >-
- Specifies the size of the secondary section of either a pie-of-pie chart or a bar-of-pie chart, as a percentage of
- the size of the primary pie. Can be a value from 5 to 200.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setSecondPlotSize(secondPlotSize: number): void;'
- parameters:
- - id: secondPlotSize
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setShowConnectorLines(showConnectorLines)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setShowConnectorLines:member(1)'
- package: ExcelScript!
- fullName: setShowConnectorLines(showConnectorLines)
- summary: Specifies whether connector lines are shown in waterfall charts.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowConnectorLines(showConnectorLines: boolean): void;'
- parameters:
- - id: showConnectorLines
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowLeaderLines(showLeaderLines)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setShowLeaderLines:member(1)'
- package: ExcelScript!
- fullName: setShowLeaderLines(showLeaderLines)
- summary: Specifies whether leader lines are displayed for each data label in the series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowLeaderLines(showLeaderLines: boolean): void;'
- parameters:
- - id: showLeaderLines
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowShadow(showShadow)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setShowShadow:member(1)'
- package: ExcelScript!
- fullName: setShowShadow(showShadow)
- summary: Specifies if the series has a shadow.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowShadow(showShadow: boolean): void;'
- parameters:
- - id: showShadow
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setSmooth(smooth)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setSmooth:member(1)'
- package: ExcelScript!
- fullName: setSmooth(smooth)
- summary: Specifies if the series is smooth. Only applicable to line and scatter charts.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setSmooth(smooth: boolean): void;'
- parameters:
- - id: smooth
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setSplitType(splitType)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setSplitType:member(1)'
- package: ExcelScript!
- fullName: setSplitType(splitType)
- summary: Specifies the way the two sections of either a pie-of-pie chart or a bar-of-pie chart are split.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setSplitType(splitType: ChartSplitType): void;'
- parameters:
- - id: splitType
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setSplitValue(splitValue)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setSplitValue:member(1)'
- package: ExcelScript!
- fullName: setSplitValue(splitValue)
- summary: Specifies the threshold value that separates two sections of either a pie-of-pie chart or a bar-of-pie chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setSplitValue(splitValue: number): void;'
- parameters:
- - id: splitValue
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setValues(sourceData)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setValues:member(1)'
- package: ExcelScript!
- fullName: setValues(sourceData)
- summary: 'Sets the values for a chart series. For scatter charts, it refers to y-axis values.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setValues(sourceData: Range): void;'
- parameters:
- - id: sourceData
- description: The `Range` object corresponding to the source data.
- type: ''
- return:
- type: void
- description: ''
- - name: setVaryByCategories(varyByCategories)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setVaryByCategories:member(1)'
- package: ExcelScript!
- fullName: setVaryByCategories(varyByCategories)
- summary: True if Excel assigns a different color or pattern to each data marker. The chart must contain only one series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setVaryByCategories(varyByCategories: boolean): void;'
- parameters:
- - id: varyByCategories
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setXAxisValues(sourceData)
- uid: 'ExcelScript!ExcelScript.ChartSeries#setXAxisValues:member(1)'
- package: ExcelScript!
- fullName: setXAxisValues(sourceData)
- summary: Sets the values of the x-axis for a chart series.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setXAxisValues(sourceData: Range): void;'
- parameters:
- - id: sourceData
- description: The `Range` object corresponding to the source data.
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartSeries
+uid: 'ExcelScript!ExcelScript.ChartSeries:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartSeries
+summary: Represents a series in a chart.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample produces a line chart with two series.
+ * The chart assumes data in A1:E5 that looks like this:
+ * Product Qtr1 Qtr2 Qtr3 Qtr4
+ * Frames 5000 7000 6544 4377
+ * Saddles 400 323 276 651
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Establish the ranges to use.
+ const sheet = workbook.getActiveWorksheet();
+ const headerRange = sheet.getRange("A1:E1");
+ const firstSeriesRange = sheet.getRange("A2:E2");
+ const secondSeriesRange = sheet.getRange("A3:E3");
+
+ // Create the chart.
+ const lineChart = sheet.addChart(ExcelScript.ChartType.line, headerRange);
+
+ // Add the first chart series.
+ const firstSeries = lineChart.addChartSeries();
+ firstSeries.setXAxisValues(headerRange);
+ firstSeries.setValues(firstSeriesRange);
+
+ // Add the second chart series.
+ const secondSeries = lineChart.addChartSeries();
+ secondSeries.setXAxisValues(headerRange);
+ secondSeries.setValues(secondSeriesRange);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: addChartTrendline(type)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#addChartTrendline:member(1)'
+ package: ExcelScript!
+ fullName: addChartTrendline(type)
+ summary: Adds a new trendline to trendline collection.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addChartTrendline(type?: ChartTrendlineType): ChartTrendline;'
+ parameters:
+ - id: type
+ description: Specifies the trendline type. The default value is "Linear". See `ExcelScript.ChartTrendline` for details.
+ type: ''
+ return:
+ type: ''
+ description: ''
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: Deletes the chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getAxisGroup()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getAxisGroup:member(1)'
+ package: ExcelScript!
+ fullName: getAxisGroup()
+ summary: Specifies the group for the specified series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAxisGroup(): ChartAxisGroup;'
+ return:
+ type: ''
+ description: ''
+ - name: getBinOptions()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getBinOptions:member(1)'
+ package: ExcelScript!
+ fullName: getBinOptions()
+ summary: Encapsulates the bin options for histogram charts and pareto charts.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBinOptions(): ChartBinOptions;'
+ return:
+ type: ''
+ description: ''
+ - name: getBoxwhiskerOptions()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getBoxwhiskerOptions:member(1)'
+ package: ExcelScript!
+ fullName: getBoxwhiskerOptions()
+ summary: Encapsulates the options for the box and whisker charts.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBoxwhiskerOptions(): ChartBoxwhiskerOptions;'
+ return:
+ type: ''
+ description: ''
+ - name: getBubbleScale()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getBubbleScale:member(1)'
+ package: ExcelScript!
+ fullName: getBubbleScale()
+ summary: >-
+ This can be an integer value from 0 (zero) to 300, representing the percentage of the default size. This property
+ only applies to bubble charts.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBubbleScale(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getChartTrendline(index)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getChartTrendline:member(1)'
+ package: ExcelScript!
+ fullName: getChartTrendline(index)
+ summary: 'Gets a trendline object by index, which is the insertion order in the items array.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getChartTrendline(index: number): ChartTrendline;'
+ parameters:
+ - id: index
+ description: Represents the insertion order in the items array.
+ type: number
+ return:
+ type: ''
+ description: ''
+ - name: getChartType()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getChartType:member(1)'
+ package: ExcelScript!
+ fullName: getChartType()
+ summary: Represents the chart type of a series. See `ExcelScript.ChartType` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getChartType(): ChartType;'
+ return:
+ type: ''
+ description: ''
+ - name: getDataLabels()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getDataLabels:member(1)'
+ package: ExcelScript!
+ fullName: getDataLabels()
+ summary: Represents a collection of all data labels in the series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDataLabels(): ChartDataLabels;'
+ return:
+ type: ''
+ description: ''
+ - name: getDimensionDataSourceString(dimension)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getDimensionDataSourceString:member(1)'
+ package: ExcelScript!
+ fullName: getDimensionDataSourceString(dimension)
+ summary: >-
+ Gets the string representation of the data source of the chart series. The string representation could be
+ information such as a cell address.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDimensionDataSourceString(dimension: ChartSeriesDimension): string;'
+ parameters:
+ - id: dimension
+ description: The dimension of the axis where the data is from.
+ type: ''
+ return:
+ type: string
+ description: ''
+ - name: getDimensionDataSourceType(dimension)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getDimensionDataSourceType:member(1)'
+ package: ExcelScript!
+ fullName: getDimensionDataSourceType(dimension)
+ summary: Gets the data source type of the chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ getDimensionDataSourceType(
+ dimension: ChartSeriesDimension
+ ): ChartDataSourceType;
+ parameters:
+ - id: dimension
+ description: The dimension of the axis where the data is from.
+ type: ''
+ return:
+ type: ''
+ description: ''
+ - name: getDimensionValues(dimension)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getDimensionValues:member(1)'
+ package: ExcelScript!
+ fullName: getDimensionValues(dimension)
+ summary: >-
+ Gets the values from a single dimension of the chart series. These could be either category values or data values,
+ depending on the dimension specified and how the data is mapped for the chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDimensionValues(dimension: ChartSeriesDimension): string[];'
+ parameters:
+ - id: dimension
+ description: The dimension of the axis where the data is from.
+ type: ''
+ return:
+ type: 'string[]'
+ description: ''
+ - name: getDoughnutHoleSize()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getDoughnutHoleSize:member(1)'
+ package: ExcelScript!
+ fullName: getDoughnutHoleSize()
+ summary: >-
+ Represents the doughnut hole size of a chart series. Only valid on doughnut and doughnut exploded charts. Throws
+ an `InvalidArgument` error on invalid charts.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDoughnutHoleSize(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getExplosion()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getExplosion:member(1)'
+ package: ExcelScript!
+ fullName: getExplosion()
+ summary: >-
+ Specifies the explosion value for a pie-chart or doughnut-chart slice. Returns 0 (zero) if there's no explosion
+ (the tip of the slice is in the center of the pie).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getExplosion(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getFiltered()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getFiltered:member(1)'
+ package: ExcelScript!
+ fullName: getFiltered()
+ summary: Specifies if the series is filtered. Not applicable for surface charts.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFiltered(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getFirstSliceAngle()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getFirstSliceAngle:member(1)'
+ package: ExcelScript!
+ fullName: getFirstSliceAngle()
+ summary: >-
+ Specifies the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). Applies
+ only to pie, 3-D pie, and doughnut charts. Can be a value from 0 through 360.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFirstSliceAngle(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getFormat()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getFormat:member(1)'
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: 'Represents the formatting of a chart series, which includes fill and line formatting.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): ChartSeriesFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getGapWidth()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getGapWidth:member(1)'
+ package: ExcelScript!
+ fullName: getGapWidth()
+ summary: >-
+ Represents the gap width of a chart series. Only valid on bar and column charts, as well as specific classes of
+ line and pie charts. Throws an invalid argument exception on invalid charts.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGapWidth(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getGradientMaximumColor()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getGradientMaximumColor:member(1)'
+ package: ExcelScript!
+ fullName: getGradientMaximumColor()
+ summary: Specifies the color for maximum value of a region map chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGradientMaximumColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getGradientMaximumType()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getGradientMaximumType:member(1)'
+ package: ExcelScript!
+ fullName: getGradientMaximumType()
+ summary: Specifies the type for maximum value of a region map chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGradientMaximumType(): ChartGradientStyleType;'
+ return:
+ type: ''
+ description: ''
+ - name: getGradientMaximumValue()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getGradientMaximumValue:member(1)'
+ package: ExcelScript!
+ fullName: getGradientMaximumValue()
+ summary: Specifies the maximum value of a region map chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGradientMaximumValue(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getGradientMidpointColor()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getGradientMidpointColor:member(1)'
+ package: ExcelScript!
+ fullName: getGradientMidpointColor()
+ summary: Specifies the color for the midpoint value of a region map chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGradientMidpointColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getGradientMidpointType()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getGradientMidpointType:member(1)'
+ package: ExcelScript!
+ fullName: getGradientMidpointType()
+ summary: Specifies the type for the midpoint value of a region map chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGradientMidpointType(): ChartGradientStyleType;'
+ return:
+ type: ''
+ description: ''
+ - name: getGradientMidpointValue()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getGradientMidpointValue:member(1)'
+ package: ExcelScript!
+ fullName: getGradientMidpointValue()
+ summary: Specifies the midpoint value of a region map chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGradientMidpointValue(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getGradientMinimumColor()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getGradientMinimumColor:member(1)'
+ package: ExcelScript!
+ fullName: getGradientMinimumColor()
+ summary: Specifies the color for the minimum value of a region map chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGradientMinimumColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getGradientMinimumType()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getGradientMinimumType:member(1)'
+ package: ExcelScript!
+ fullName: getGradientMinimumType()
+ summary: Specifies the type for the minimum value of a region map chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGradientMinimumType(): ChartGradientStyleType;'
+ return:
+ type: ''
+ description: ''
+ - name: getGradientMinimumValue()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getGradientMinimumValue:member(1)'
+ package: ExcelScript!
+ fullName: getGradientMinimumValue()
+ summary: Specifies the minimum value of a region map chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGradientMinimumValue(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getGradientStyle()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getGradientStyle:member(1)'
+ package: ExcelScript!
+ fullName: getGradientStyle()
+ summary: Specifies the series gradient style of a region map chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGradientStyle(): ChartGradientStyle;'
+ return:
+ type: ''
+ description: ''
+ - name: getHasDataLabels()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getHasDataLabels:member(1)'
+ package: ExcelScript!
+ fullName: getHasDataLabels()
+ summary: Specifies if the series has data labels.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHasDataLabels(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getInvertColor()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getInvertColor:member(1)'
+ package: ExcelScript!
+ fullName: getInvertColor()
+ summary: Specifies the fill color for negative data points in a series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getInvertColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getInvertIfNegative()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getInvertIfNegative:member(1)'
+ package: ExcelScript!
+ fullName: getInvertIfNegative()
+ summary: True if Excel inverts the pattern in the item when it corresponds to a negative number.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getInvertIfNegative(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getMapOptions()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getMapOptions:member(1)'
+ package: ExcelScript!
+ fullName: getMapOptions()
+ summary: Encapsulates the options for a region map chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMapOptions(): ChartMapOptions;'
+ return:
+ type: ''
+ description: ''
+ - name: getMarkerBackgroundColor()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getMarkerBackgroundColor:member(1)'
+ package: ExcelScript!
+ fullName: getMarkerBackgroundColor()
+ summary: Specifies the marker background color of a chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMarkerBackgroundColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getMarkerForegroundColor()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getMarkerForegroundColor:member(1)'
+ package: ExcelScript!
+ fullName: getMarkerForegroundColor()
+ summary: Specifies the marker foreground color of a chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMarkerForegroundColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getMarkerSize()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getMarkerSize:member(1)'
+ package: ExcelScript!
+ fullName: getMarkerSize()
+ summary: >-
+ Specifies the marker size of a chart series. The supported size range is 2 to 72. This method returns an
+ InvalidArgument error if it's set with a size outside of the supported range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMarkerSize(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getMarkerStyle()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getMarkerStyle:member(1)'
+ package: ExcelScript!
+ fullName: getMarkerStyle()
+ summary: Specifies the marker style of a chart series. See `ExcelScript.ChartMarkerStyle` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMarkerStyle(): ChartMarkerStyle;'
+ return:
+ type: ''
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: Specifies the name of a series in a chart. The name's length should not be greater than 255 characters.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample logs the names of each of the chart series in a chart named "ColumnClusteredChart".
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Get an existing chart named "ColumnClusteredChart".
+ let chart = selectedSheet.getChart("ColumnClusteredChart");
+
+ // Log the name of each chart series in the chart.
+ let seriesList = chart.getSeries();
+ seriesList.forEach((series) => {
+ console.log(series.getName());
+ });
+ }
+ ```
+ - name: getOverlap()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getOverlap:member(1)'
+ package: ExcelScript!
+ fullName: getOverlap()
+ summary: >-
+ Specifies how bars and columns are positioned. Can be a value between -100 and 100. Applies only to 2-D bar and
+ 2-D column charts.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getOverlap(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getParentLabelStrategy()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getParentLabelStrategy:member(1)'
+ package: ExcelScript!
+ fullName: getParentLabelStrategy()
+ summary: Specifies the series parent label strategy area for a treemap chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getParentLabelStrategy(): ChartParentLabelStrategy;'
+ return:
+ type: ''
+ description: ''
+ - name: getPlotOrder()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getPlotOrder:member(1)'
+ package: ExcelScript!
+ fullName: getPlotOrder()
+ summary: Specifies the plot order of a chart series within the chart group.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPlotOrder(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getPoints()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getPoints:member(1)'
+ package: ExcelScript!
+ fullName: getPoints()
+ summary: Returns a collection of all points in the series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPoints(): ChartPoint[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getSecondPlotSize()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getSecondPlotSize:member(1)'
+ package: ExcelScript!
+ fullName: getSecondPlotSize()
+ summary: >-
+ Specifies the size of the secondary section of either a pie-of-pie chart or a bar-of-pie chart, as a percentage of
+ the size of the primary pie. Can be a value from 5 to 200.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSecondPlotSize(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getShowConnectorLines()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getShowConnectorLines:member(1)'
+ package: ExcelScript!
+ fullName: getShowConnectorLines()
+ summary: Specifies whether connector lines are shown in waterfall charts.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowConnectorLines(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowLeaderLines()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getShowLeaderLines:member(1)'
+ package: ExcelScript!
+ fullName: getShowLeaderLines()
+ summary: Specifies whether leader lines are displayed for each data label in the series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowLeaderLines(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowShadow()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getShowShadow:member(1)'
+ package: ExcelScript!
+ fullName: getShowShadow()
+ summary: Specifies if the series has a shadow.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowShadow(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getSmooth()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getSmooth:member(1)'
+ package: ExcelScript!
+ fullName: getSmooth()
+ summary: Specifies if the series is smooth. Only applicable to line and scatter charts.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSmooth(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getSplitType()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getSplitType:member(1)'
+ package: ExcelScript!
+ fullName: getSplitType()
+ summary: Specifies the way the two sections of either a pie-of-pie chart or a bar-of-pie chart are split.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSplitType(): ChartSplitType;'
+ return:
+ type: ''
+ description: ''
+ - name: getSplitValue()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getSplitValue:member(1)'
+ package: ExcelScript!
+ fullName: getSplitValue()
+ summary: Specifies the threshold value that separates two sections of either a pie-of-pie chart or a bar-of-pie chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSplitValue(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getTrendlines()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getTrendlines:member(1)'
+ package: ExcelScript!
+ fullName: getTrendlines()
+ summary: The collection of trendlines in the series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTrendlines(): ChartTrendline[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getVaryByCategories()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getVaryByCategories:member(1)'
+ package: ExcelScript!
+ fullName: getVaryByCategories()
+ summary: True if Excel assigns a different color or pattern to each data marker. The chart must contain only one series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVaryByCategories(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getXErrorBars()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getXErrorBars:member(1)'
+ package: ExcelScript!
+ fullName: getXErrorBars()
+ summary: Represents the error bar object of a chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getXErrorBars(): ChartErrorBars;'
+ return:
+ type: ''
+ description: ''
+ - name: getYErrorBars()
+ uid: 'ExcelScript!ExcelScript.ChartSeries#getYErrorBars:member(1)'
+ package: ExcelScript!
+ fullName: getYErrorBars()
+ summary: Represents the error bar object of a chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getYErrorBars(): ChartErrorBars;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds error bars for the standard error of each chart series point.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range for the chart.
+ const worksheet = workbook.getWorksheet("Sample");
+ const dataRange = worksheet.getRange("A1:B15");
+
+ // Create a line chart.
+ const chart = worksheet.addChart(ExcelScript.ChartType.line, dataRange);
+
+ // For each series, add error bars for the standard error on each point
+ const allSeries = chart.getSeries();
+ allSeries.forEach((series) => {
+ series.getYErrorBars().setType(ExcelScript.ChartErrorBarsType.stError);
+ series.getYErrorBars().setVisible(true);
+ });
+ }
+ ```
+ - name: setAxisGroup(axisGroup)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setAxisGroup:member(1)'
+ package: ExcelScript!
+ fullName: setAxisGroup(axisGroup)
+ summary: Specifies the group for the specified series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setAxisGroup(axisGroup: ChartAxisGroup): void;'
+ parameters:
+ - id: axisGroup
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setBubbleScale(bubbleScale)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setBubbleScale:member(1)'
+ package: ExcelScript!
+ fullName: setBubbleScale(bubbleScale)
+ summary: >-
+ This can be an integer value from 0 (zero) to 300, representing the percentage of the default size. This property
+ only applies to bubble charts.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setBubbleScale(bubbleScale: number): void;'
+ parameters:
+ - id: bubbleScale
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setBubbleSizes(sourceData)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setBubbleSizes:member(1)'
+ package: ExcelScript!
+ fullName: setBubbleSizes(sourceData)
+ summary: Sets the bubble sizes for a chart series. Only works for bubble charts.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setBubbleSizes(sourceData: Range): void;'
+ parameters:
+ - id: sourceData
+ description: The `Range` object corresponding to the source data.
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setChartType(chartType)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setChartType:member(1)'
+ package: ExcelScript!
+ fullName: setChartType(chartType)
+ summary: Represents the chart type of a series. See `ExcelScript.ChartType` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setChartType(chartType: ChartType): void;'
+ parameters:
+ - id: chartType
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setDoughnutHoleSize(doughnutHoleSize)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setDoughnutHoleSize:member(1)'
+ package: ExcelScript!
+ fullName: setDoughnutHoleSize(doughnutHoleSize)
+ summary: >-
+ Represents the doughnut hole size of a chart series. Only valid on doughnut and doughnut exploded charts. Throws
+ an `InvalidArgument` error on invalid charts.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setDoughnutHoleSize(doughnutHoleSize: number): void;'
+ parameters:
+ - id: doughnutHoleSize
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setExplosion(explosion)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setExplosion:member(1)'
+ package: ExcelScript!
+ fullName: setExplosion(explosion)
+ summary: >-
+ Specifies the explosion value for a pie-chart or doughnut-chart slice. Returns 0 (zero) if there's no explosion
+ (the tip of the slice is in the center of the pie).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setExplosion(explosion: number): void;'
+ parameters:
+ - id: explosion
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setFiltered(filtered)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setFiltered:member(1)'
+ package: ExcelScript!
+ fullName: setFiltered(filtered)
+ summary: Specifies if the series is filtered. Not applicable for surface charts.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFiltered(filtered: boolean): void;'
+ parameters:
+ - id: filtered
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setFirstSliceAngle(firstSliceAngle)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setFirstSliceAngle:member(1)'
+ package: ExcelScript!
+ fullName: setFirstSliceAngle(firstSliceAngle)
+ summary: >-
+ Specifies the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). Applies
+ only to pie, 3-D pie, and doughnut charts. Can be a value from 0 through 360.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFirstSliceAngle(firstSliceAngle: number): void;'
+ parameters:
+ - id: firstSliceAngle
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setGapWidth(gapWidth)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setGapWidth:member(1)'
+ package: ExcelScript!
+ fullName: setGapWidth(gapWidth)
+ summary: >-
+ Represents the gap width of a chart series. Only valid on bar and column charts, as well as specific classes of
+ line and pie charts. Throws an invalid argument exception on invalid charts.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setGapWidth(gapWidth: number): void;'
+ parameters:
+ - id: gapWidth
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setGradientMaximumColor(gradientMaximumColor)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setGradientMaximumColor:member(1)'
+ package: ExcelScript!
+ fullName: setGradientMaximumColor(gradientMaximumColor)
+ summary: Specifies the color for maximum value of a region map chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setGradientMaximumColor(gradientMaximumColor: string): void;'
+ parameters:
+ - id: gradientMaximumColor
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setGradientMaximumType(gradientMaximumType)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setGradientMaximumType:member(1)'
+ package: ExcelScript!
+ fullName: setGradientMaximumType(gradientMaximumType)
+ summary: Specifies the type for maximum value of a region map chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setGradientMaximumType(
+ gradientMaximumType: ChartGradientStyleType
+ ): void;
+ parameters:
+ - id: gradientMaximumType
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setGradientMaximumValue(gradientMaximumValue)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setGradientMaximumValue:member(1)'
+ package: ExcelScript!
+ fullName: setGradientMaximumValue(gradientMaximumValue)
+ summary: Specifies the maximum value of a region map chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setGradientMaximumValue(gradientMaximumValue: number): void;'
+ parameters:
+ - id: gradientMaximumValue
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setGradientMidpointColor(gradientMidpointColor)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setGradientMidpointColor:member(1)'
+ package: ExcelScript!
+ fullName: setGradientMidpointColor(gradientMidpointColor)
+ summary: Specifies the color for the midpoint value of a region map chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setGradientMidpointColor(gradientMidpointColor: string): void;'
+ parameters:
+ - id: gradientMidpointColor
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setGradientMidpointType(gradientMidpointType)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setGradientMidpointType:member(1)'
+ package: ExcelScript!
+ fullName: setGradientMidpointType(gradientMidpointType)
+ summary: Specifies the type for the midpoint value of a region map chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setGradientMidpointType(
+ gradientMidpointType: ChartGradientStyleType
+ ): void;
+ parameters:
+ - id: gradientMidpointType
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setGradientMidpointValue(gradientMidpointValue)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setGradientMidpointValue:member(1)'
+ package: ExcelScript!
+ fullName: setGradientMidpointValue(gradientMidpointValue)
+ summary: Specifies the midpoint value of a region map chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setGradientMidpointValue(gradientMidpointValue: number): void;'
+ parameters:
+ - id: gradientMidpointValue
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setGradientMinimumColor(gradientMinimumColor)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setGradientMinimumColor:member(1)'
+ package: ExcelScript!
+ fullName: setGradientMinimumColor(gradientMinimumColor)
+ summary: Specifies the color for the minimum value of a region map chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setGradientMinimumColor(gradientMinimumColor: string): void;'
+ parameters:
+ - id: gradientMinimumColor
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setGradientMinimumType(gradientMinimumType)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setGradientMinimumType:member(1)'
+ package: ExcelScript!
+ fullName: setGradientMinimumType(gradientMinimumType)
+ summary: Specifies the type for the minimum value of a region map chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setGradientMinimumType(
+ gradientMinimumType: ChartGradientStyleType
+ ): void;
+ parameters:
+ - id: gradientMinimumType
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setGradientMinimumValue(gradientMinimumValue)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setGradientMinimumValue:member(1)'
+ package: ExcelScript!
+ fullName: setGradientMinimumValue(gradientMinimumValue)
+ summary: Specifies the minimum value of a region map chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setGradientMinimumValue(gradientMinimumValue: number): void;'
+ parameters:
+ - id: gradientMinimumValue
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setGradientStyle(gradientStyle)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setGradientStyle:member(1)'
+ package: ExcelScript!
+ fullName: setGradientStyle(gradientStyle)
+ summary: Specifies the series gradient style of a region map chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setGradientStyle(gradientStyle: ChartGradientStyle): void;'
+ parameters:
+ - id: gradientStyle
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setHasDataLabels(hasDataLabels)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setHasDataLabels:member(1)'
+ package: ExcelScript!
+ fullName: setHasDataLabels(hasDataLabels)
+ summary: Specifies if the series has data labels.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setHasDataLabels(hasDataLabels: boolean): void;'
+ parameters:
+ - id: hasDataLabels
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setInvertColor(invertColor)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setInvertColor:member(1)'
+ package: ExcelScript!
+ fullName: setInvertColor(invertColor)
+ summary: Specifies the fill color for negative data points in a series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setInvertColor(invertColor: string): void;'
+ parameters:
+ - id: invertColor
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setInvertIfNegative(invertIfNegative)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setInvertIfNegative:member(1)'
+ package: ExcelScript!
+ fullName: setInvertIfNegative(invertIfNegative)
+ summary: True if Excel inverts the pattern in the item when it corresponds to a negative number.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setInvertIfNegative(invertIfNegative: boolean): void;'
+ parameters:
+ - id: invertIfNegative
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setMarkerBackgroundColor(markerBackgroundColor)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setMarkerBackgroundColor:member(1)'
+ package: ExcelScript!
+ fullName: setMarkerBackgroundColor(markerBackgroundColor)
+ summary: Specifies the marker background color of a chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMarkerBackgroundColor(markerBackgroundColor: string): void;'
+ parameters:
+ - id: markerBackgroundColor
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setMarkerForegroundColor(markerForegroundColor)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setMarkerForegroundColor:member(1)'
+ package: ExcelScript!
+ fullName: setMarkerForegroundColor(markerForegroundColor)
+ summary: Specifies the marker foreground color of a chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMarkerForegroundColor(markerForegroundColor: string): void;'
+ parameters:
+ - id: markerForegroundColor
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setMarkerSize(markerSize)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setMarkerSize:member(1)'
+ package: ExcelScript!
+ fullName: setMarkerSize(markerSize)
+ summary: >-
+ Specifies the marker size of a chart series. The supported size range is 2 to 72. This method returns an
+ InvalidArgument error if it's set with a size outside of the supported range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMarkerSize(markerSize: number): void;'
+ parameters:
+ - id: markerSize
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setMarkerStyle(markerStyle)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setMarkerStyle:member(1)'
+ package: ExcelScript!
+ fullName: setMarkerStyle(markerStyle)
+ summary: Specifies the marker style of a chart series. See `ExcelScript.ChartMarkerStyle` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMarkerStyle(markerStyle: ChartMarkerStyle): void;'
+ parameters:
+ - id: markerStyle
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setName(name)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setName:member(1)'
+ package: ExcelScript!
+ fullName: setName(name)
+ summary: Specifies the name of a series in a chart. The name's length should not be greater than 255 characters.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setName(name: string): void;'
+ parameters:
+ - id: name
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setOverlap(overlap)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setOverlap:member(1)'
+ package: ExcelScript!
+ fullName: setOverlap(overlap)
+ summary: >-
+ Specifies how bars and columns are positioned. Can be a value between -100 and 100. Applies only to 2-D bar and
+ 2-D column charts.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setOverlap(overlap: number): void;'
+ parameters:
+ - id: overlap
+ description: ''
+ type: number
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample sets the overlap of the columns in a chart named "ColumnClusteredChart".
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Get an existing chart named "ColumnClusteredChart".
+ let chart = selectedSheet.getChart("ColumnClusteredChart");
+
+ // Set the overlap of every column of each series within a category.
+ let seriesList = chart.getSeries();
+ seriesList.forEach((series) => {
+ // An overlap of 25 means the columns have 25% of their length overlapping with the adjacent columns in the same category.
+ series.setOverlap(25);
+ });
+ }
+ ```
+ - name: setParentLabelStrategy(parentLabelStrategy)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setParentLabelStrategy:member(1)'
+ package: ExcelScript!
+ fullName: setParentLabelStrategy(parentLabelStrategy)
+ summary: Specifies the series parent label strategy area for a treemap chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setParentLabelStrategy(
+ parentLabelStrategy: ChartParentLabelStrategy
+ ): void;
+ parameters:
+ - id: parentLabelStrategy
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setPlotOrder(plotOrder)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setPlotOrder:member(1)'
+ package: ExcelScript!
+ fullName: setPlotOrder(plotOrder)
+ summary: Specifies the plot order of a chart series within the chart group.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPlotOrder(plotOrder: number): void;'
+ parameters:
+ - id: plotOrder
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setSecondPlotSize(secondPlotSize)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setSecondPlotSize:member(1)'
+ package: ExcelScript!
+ fullName: setSecondPlotSize(secondPlotSize)
+ summary: >-
+ Specifies the size of the secondary section of either a pie-of-pie chart or a bar-of-pie chart, as a percentage of
+ the size of the primary pie. Can be a value from 5 to 200.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSecondPlotSize(secondPlotSize: number): void;'
+ parameters:
+ - id: secondPlotSize
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setShowConnectorLines(showConnectorLines)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setShowConnectorLines:member(1)'
+ package: ExcelScript!
+ fullName: setShowConnectorLines(showConnectorLines)
+ summary: Specifies whether connector lines are shown in waterfall charts.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowConnectorLines(showConnectorLines: boolean): void;'
+ parameters:
+ - id: showConnectorLines
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowLeaderLines(showLeaderLines)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setShowLeaderLines:member(1)'
+ package: ExcelScript!
+ fullName: setShowLeaderLines(showLeaderLines)
+ summary: Specifies whether leader lines are displayed for each data label in the series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowLeaderLines(showLeaderLines: boolean): void;'
+ parameters:
+ - id: showLeaderLines
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowShadow(showShadow)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setShowShadow:member(1)'
+ package: ExcelScript!
+ fullName: setShowShadow(showShadow)
+ summary: Specifies if the series has a shadow.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowShadow(showShadow: boolean): void;'
+ parameters:
+ - id: showShadow
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setSmooth(smooth)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setSmooth:member(1)'
+ package: ExcelScript!
+ fullName: setSmooth(smooth)
+ summary: Specifies if the series is smooth. Only applicable to line and scatter charts.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSmooth(smooth: boolean): void;'
+ parameters:
+ - id: smooth
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setSplitType(splitType)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setSplitType:member(1)'
+ package: ExcelScript!
+ fullName: setSplitType(splitType)
+ summary: Specifies the way the two sections of either a pie-of-pie chart or a bar-of-pie chart are split.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSplitType(splitType: ChartSplitType): void;'
+ parameters:
+ - id: splitType
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setSplitValue(splitValue)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setSplitValue:member(1)'
+ package: ExcelScript!
+ fullName: setSplitValue(splitValue)
+ summary: Specifies the threshold value that separates two sections of either a pie-of-pie chart or a bar-of-pie chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSplitValue(splitValue: number): void;'
+ parameters:
+ - id: splitValue
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setValues(sourceData)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setValues:member(1)'
+ package: ExcelScript!
+ fullName: setValues(sourceData)
+ summary: 'Sets the values for a chart series. For scatter charts, it refers to y-axis values.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setValues(sourceData: Range): void;'
+ parameters:
+ - id: sourceData
+ description: The `Range` object corresponding to the source data.
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setVaryByCategories(varyByCategories)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setVaryByCategories:member(1)'
+ package: ExcelScript!
+ fullName: setVaryByCategories(varyByCategories)
+ summary: True if Excel assigns a different color or pattern to each data marker. The chart must contain only one series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setVaryByCategories(varyByCategories: boolean): void;'
+ parameters:
+ - id: varyByCategories
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setXAxisValues(sourceData)
+ uid: 'ExcelScript!ExcelScript.ChartSeries#setXAxisValues:member(1)'
+ package: ExcelScript!
+ fullName: setXAxisValues(sourceData)
+ summary: Sets the values of the x-axis for a chart series.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setXAxisValues(sourceData: Range): void;'
+ parameters:
+ - id: sourceData
+ description: The `Range` object corresponding to the source data.
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartseriesby.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartseriesby.yml
index d6d5dce7..70de74b9 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartseriesby.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartseriesby.yml
@@ -1,48 +1,48 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartSeriesBy
-uid: 'ExcelScript!ExcelScript.ChartSeriesBy:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartSeriesBy
-summary: >-
- 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".
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a clustered-column chart using an existing table.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table on the current worksheet.
- const sheet = workbook.getActiveWorksheet();
- const table = sheet.getTables()[0];
-
- // Add a clustered-column chart that clusters the data based on the columns in the table.
- const chart = sheet.addChart(
- ExcelScript.ChartType.columnClustered,
- table.getRange(),
- ExcelScript.ChartSeriesBy.columns
- );
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: auto
- uid: 'ExcelScript!ExcelScript.ChartSeriesBy.auto:member'
- package: ExcelScript!
- summary: >-
- 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".
- - name: columns
- uid: 'ExcelScript!ExcelScript.ChartSeriesBy.columns:member'
- package: ExcelScript!
- summary: ''
- - name: rows
- uid: 'ExcelScript!ExcelScript.ChartSeriesBy.rows:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartSeriesBy
+uid: 'ExcelScript!ExcelScript.ChartSeriesBy:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartSeriesBy
+summary: >-
+ 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".
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a clustered-column chart using an existing table.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table on the current worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const table = sheet.getTables()[0];
+
+ // Add a clustered-column chart that clusters the data based on the columns in the table.
+ const chart = sheet.addChart(
+ ExcelScript.ChartType.columnClustered,
+ table.getRange(),
+ ExcelScript.ChartSeriesBy.columns
+ );
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: auto
+ uid: 'ExcelScript!ExcelScript.ChartSeriesBy.auto:member'
+ package: ExcelScript!
+ summary: >-
+ 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".
+ - name: columns
+ uid: 'ExcelScript!ExcelScript.ChartSeriesBy.columns:member'
+ package: ExcelScript!
+ summary: ''
+ - name: rows
+ uid: 'ExcelScript!ExcelScript.ChartSeriesBy.rows:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartseriesdimension.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartseriesdimension.yml
index adce13fc..78c75391 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartseriesdimension.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartseriesdimension.yml
@@ -1,30 +1,30 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartSeriesDimension
-uid: 'ExcelScript!ExcelScript.ChartSeriesDimension:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartSeriesDimension
-summary: Represents the dimensions when getting values from chart series.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: bubbleSizes
- uid: 'ExcelScript!ExcelScript.ChartSeriesDimension.bubbleSizes:member'
- package: ExcelScript!
- summary: The chart series axis for the bubble sizes in bubble charts.
- - name: categories
- uid: 'ExcelScript!ExcelScript.ChartSeriesDimension.categories:member'
- package: ExcelScript!
- summary: The chart series axis for the categories.
- - name: values
- uid: 'ExcelScript!ExcelScript.ChartSeriesDimension.values:member'
- package: ExcelScript!
- summary: The chart series axis for the values.
- - name: xvalues
- uid: 'ExcelScript!ExcelScript.ChartSeriesDimension.xvalues:member'
- package: ExcelScript!
- summary: The chart series axis for the x-axis values in scatter and bubble charts.
- - name: yvalues
- uid: 'ExcelScript!ExcelScript.ChartSeriesDimension.yvalues:member'
- package: ExcelScript!
- summary: The chart series axis for the y-axis values in scatter and bubble charts.
+### YamlMime:TSEnum
+name: ExcelScript.ChartSeriesDimension
+uid: 'ExcelScript!ExcelScript.ChartSeriesDimension:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartSeriesDimension
+summary: Represents the dimensions when getting values from chart series.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: bubbleSizes
+ uid: 'ExcelScript!ExcelScript.ChartSeriesDimension.bubbleSizes:member'
+ package: ExcelScript!
+ summary: The chart series axis for the bubble sizes in bubble charts.
+ - name: categories
+ uid: 'ExcelScript!ExcelScript.ChartSeriesDimension.categories:member'
+ package: ExcelScript!
+ summary: The chart series axis for the categories.
+ - name: values
+ uid: 'ExcelScript!ExcelScript.ChartSeriesDimension.values:member'
+ package: ExcelScript!
+ summary: The chart series axis for the values.
+ - name: xvalues
+ uid: 'ExcelScript!ExcelScript.ChartSeriesDimension.xvalues:member'
+ package: ExcelScript!
+ summary: The chart series axis for the x-axis values in scatter and bubble charts.
+ - name: yvalues
+ uid: 'ExcelScript!ExcelScript.ChartSeriesDimension.yvalues:member'
+ package: ExcelScript!
+ summary: The chart series axis for the y-axis values in scatter and bubble charts.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartseriesformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartseriesformat.yml
index 0597f70b..3cab32b7 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartseriesformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartseriesformat.yml
@@ -1,37 +1,37 @@
-### YamlMime:TSType
-name: ExcelScript.ChartSeriesFormat
-uid: 'ExcelScript!ExcelScript.ChartSeriesFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartSeriesFormat
-summary: Encapsulates the format properties for the chart series
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getFill()
- uid: 'ExcelScript!ExcelScript.ChartSeriesFormat#getFill:member(1)'
- package: ExcelScript!
- fullName: getFill()
- summary: 'Represents the fill format of a chart series, which includes background formatting information.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFill(): ChartFill;'
- return:
- type: ''
- description: ''
- - name: getLine()
- uid: 'ExcelScript!ExcelScript.ChartSeriesFormat#getLine:member(1)'
- package: ExcelScript!
- fullName: getLine()
- summary: Represents line formatting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLine(): ChartLineFormat;'
- return:
- type: ''
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartSeriesFormat
+uid: 'ExcelScript!ExcelScript.ChartSeriesFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartSeriesFormat
+summary: Encapsulates the format properties for the chart series
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getFill()
+ uid: 'ExcelScript!ExcelScript.ChartSeriesFormat#getFill:member(1)'
+ package: ExcelScript!
+ fullName: getFill()
+ summary: 'Represents the fill format of a chart series, which includes background formatting information.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFill(): ChartFill;'
+ return:
+ type: ''
+ description: ''
+ - name: getLine()
+ uid: 'ExcelScript!ExcelScript.ChartSeriesFormat#getLine:member(1)'
+ package: ExcelScript!
+ fullName: getLine()
+ summary: Represents line formatting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLine(): ChartLineFormat;'
+ return:
+ type: ''
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartsplittype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartsplittype.yml
index 74a04356..b728c87f 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartsplittype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartsplittype.yml
@@ -1,26 +1,26 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartSplitType
-uid: 'ExcelScript!ExcelScript.ChartSplitType:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartSplitType
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: splitByCustomSplit
- uid: 'ExcelScript!ExcelScript.ChartSplitType.splitByCustomSplit:member'
- package: ExcelScript!
- summary: ''
- - name: splitByPercentValue
- uid: 'ExcelScript!ExcelScript.ChartSplitType.splitByPercentValue:member'
- package: ExcelScript!
- summary: ''
- - name: splitByPosition
- uid: 'ExcelScript!ExcelScript.ChartSplitType.splitByPosition:member'
- package: ExcelScript!
- summary: ''
- - name: splitByValue
- uid: 'ExcelScript!ExcelScript.ChartSplitType.splitByValue:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartSplitType
+uid: 'ExcelScript!ExcelScript.ChartSplitType:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartSplitType
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: splitByCustomSplit
+ uid: 'ExcelScript!ExcelScript.ChartSplitType.splitByCustomSplit:member'
+ package: ExcelScript!
+ summary: ''
+ - name: splitByPercentValue
+ uid: 'ExcelScript!ExcelScript.ChartSplitType.splitByPercentValue:member'
+ package: ExcelScript!
+ summary: ''
+ - name: splitByPosition
+ uid: 'ExcelScript!ExcelScript.ChartSplitType.splitByPosition:member'
+ package: ExcelScript!
+ summary: ''
+ - name: splitByValue
+ uid: 'ExcelScript!ExcelScript.ChartSplitType.splitByValue:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.charttexthorizontalalignment.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.charttexthorizontalalignment.yml
index 1963f4c4..7975270f 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.charttexthorizontalalignment.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.charttexthorizontalalignment.yml
@@ -1,30 +1,30 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartTextHorizontalAlignment
-uid: 'ExcelScript!ExcelScript.ChartTextHorizontalAlignment:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartTextHorizontalAlignment
-summary: Represents the horizontal alignment for the specified object.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: center
- uid: 'ExcelScript!ExcelScript.ChartTextHorizontalAlignment.center:member'
- package: ExcelScript!
- summary: ''
- - name: distributed
- uid: 'ExcelScript!ExcelScript.ChartTextHorizontalAlignment.distributed:member'
- package: ExcelScript!
- summary: ''
- - name: justify
- uid: 'ExcelScript!ExcelScript.ChartTextHorizontalAlignment.justify:member'
- package: ExcelScript!
- summary: ''
- - name: left
- uid: 'ExcelScript!ExcelScript.ChartTextHorizontalAlignment.left:member'
- package: ExcelScript!
- summary: ''
- - name: right
- uid: 'ExcelScript!ExcelScript.ChartTextHorizontalAlignment.right:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartTextHorizontalAlignment
+uid: 'ExcelScript!ExcelScript.ChartTextHorizontalAlignment:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartTextHorizontalAlignment
+summary: Represents the horizontal alignment for the specified object.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: center
+ uid: 'ExcelScript!ExcelScript.ChartTextHorizontalAlignment.center:member'
+ package: ExcelScript!
+ summary: ''
+ - name: distributed
+ uid: 'ExcelScript!ExcelScript.ChartTextHorizontalAlignment.distributed:member'
+ package: ExcelScript!
+ summary: ''
+ - name: justify
+ uid: 'ExcelScript!ExcelScript.ChartTextHorizontalAlignment.justify:member'
+ package: ExcelScript!
+ summary: ''
+ - name: left
+ uid: 'ExcelScript!ExcelScript.ChartTextHorizontalAlignment.left:member'
+ package: ExcelScript!
+ summary: ''
+ - name: right
+ uid: 'ExcelScript!ExcelScript.ChartTextHorizontalAlignment.right:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.charttextverticalalignment.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.charttextverticalalignment.yml
index 328537b4..22f2e9c6 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.charttextverticalalignment.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.charttextverticalalignment.yml
@@ -1,30 +1,30 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartTextVerticalAlignment
-uid: 'ExcelScript!ExcelScript.ChartTextVerticalAlignment:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartTextVerticalAlignment
-summary: Represents the vertical alignment for the specified object.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: bottom
- uid: 'ExcelScript!ExcelScript.ChartTextVerticalAlignment.bottom:member'
- package: ExcelScript!
- summary: ''
- - name: center
- uid: 'ExcelScript!ExcelScript.ChartTextVerticalAlignment.center:member'
- package: ExcelScript!
- summary: ''
- - name: distributed
- uid: 'ExcelScript!ExcelScript.ChartTextVerticalAlignment.distributed:member'
- package: ExcelScript!
- summary: ''
- - name: justify
- uid: 'ExcelScript!ExcelScript.ChartTextVerticalAlignment.justify:member'
- package: ExcelScript!
- summary: ''
- - name: top
- uid: 'ExcelScript!ExcelScript.ChartTextVerticalAlignment.top:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartTextVerticalAlignment
+uid: 'ExcelScript!ExcelScript.ChartTextVerticalAlignment:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartTextVerticalAlignment
+summary: Represents the vertical alignment for the specified object.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: bottom
+ uid: 'ExcelScript!ExcelScript.ChartTextVerticalAlignment.bottom:member'
+ package: ExcelScript!
+ summary: ''
+ - name: center
+ uid: 'ExcelScript!ExcelScript.ChartTextVerticalAlignment.center:member'
+ package: ExcelScript!
+ summary: ''
+ - name: distributed
+ uid: 'ExcelScript!ExcelScript.ChartTextVerticalAlignment.distributed:member'
+ package: ExcelScript!
+ summary: ''
+ - name: justify
+ uid: 'ExcelScript!ExcelScript.ChartTextVerticalAlignment.justify:member'
+ package: ExcelScript!
+ summary: ''
+ - name: top
+ uid: 'ExcelScript!ExcelScript.ChartTextVerticalAlignment.top:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartticklabelalignment.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartticklabelalignment.yml
index fe76c273..6d177010 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartticklabelalignment.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartticklabelalignment.yml
@@ -1,22 +1,22 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartTickLabelAlignment
-uid: 'ExcelScript!ExcelScript.ChartTickLabelAlignment:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartTickLabelAlignment
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: center
- uid: 'ExcelScript!ExcelScript.ChartTickLabelAlignment.center:member'
- package: ExcelScript!
- summary: ''
- - name: left
- uid: 'ExcelScript!ExcelScript.ChartTickLabelAlignment.left:member'
- package: ExcelScript!
- summary: ''
- - name: right
- uid: 'ExcelScript!ExcelScript.ChartTickLabelAlignment.right:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartTickLabelAlignment
+uid: 'ExcelScript!ExcelScript.ChartTickLabelAlignment:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartTickLabelAlignment
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: center
+ uid: 'ExcelScript!ExcelScript.ChartTickLabelAlignment.center:member'
+ package: ExcelScript!
+ summary: ''
+ - name: left
+ uid: 'ExcelScript!ExcelScript.ChartTickLabelAlignment.left:member'
+ package: ExcelScript!
+ summary: ''
+ - name: right
+ uid: 'ExcelScript!ExcelScript.ChartTickLabelAlignment.right:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.charttitle.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.charttitle.yml
index e6ff2c86..231c059d 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.charttitle.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.charttitle.yml
@@ -1,405 +1,405 @@
-### YamlMime:TSType
-name: ExcelScript.ChartTitle
-uid: 'ExcelScript!ExcelScript.ChartTitle:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartTitle
-summary: Represents a chart title object of a chart.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getFormat()
- uid: 'ExcelScript!ExcelScript.ChartTitle#getFormat:member(1)'
- package: ExcelScript!
- fullName: getFormat()
- summary: 'Represents the formatting of a chart title, which includes fill and font formatting.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormat(): ChartTitleFormat;'
- return:
- type: ''
- description: ''
- - name: getHeight()
- uid: 'ExcelScript!ExcelScript.ChartTitle#getHeight:member(1)'
- package: ExcelScript!
- fullName: getHeight()
- summary: 'Returns the height, in points, of the chart title. Value is `null` if the chart title is not visible.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHeight(): number;'
- return:
- type: number
- description: ''
- - name: getHorizontalAlignment()
- uid: 'ExcelScript!ExcelScript.ChartTitle#getHorizontalAlignment:member(1)'
- package: ExcelScript!
- fullName: getHorizontalAlignment()
- summary: Specifies the horizontal alignment for chart title.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHorizontalAlignment(): ChartTextHorizontalAlignment;'
- return:
- type: ''
- description: ''
- - name: getLeft()
- uid: 'ExcelScript!ExcelScript.ChartTitle#getLeft:member(1)'
- package: ExcelScript!
- fullName: getLeft()
- summary: >-
- Specifies the distance, in points, from the left edge of chart title to the left edge of chart area. Value is
- `null` if the chart title is not visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLeft(): number;'
- return:
- type: number
- description: ''
- - name: getOverlay()
- uid: 'ExcelScript!ExcelScript.ChartTitle#getOverlay:member(1)'
- package: ExcelScript!
- fullName: getOverlay()
- summary: Specifies if the chart title will overlay the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getOverlay(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getPosition()
- uid: 'ExcelScript!ExcelScript.ChartTitle#getPosition:member(1)'
- package: ExcelScript!
- fullName: getPosition()
- summary: Represents the position of chart title. See `ExcelScript.ChartTitlePosition` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPosition(): ChartTitlePosition;'
- return:
- type: ''
- description: ''
- - name: getShowShadow()
- uid: 'ExcelScript!ExcelScript.ChartTitle#getShowShadow:member(1)'
- package: ExcelScript!
- fullName: getShowShadow()
- summary: Represents a boolean value that determines if the chart title has a shadow.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowShadow(): boolean;'
- return:
- type: boolean
- description: ''
- - name: 'getSubstring(start, length)'
- uid: 'ExcelScript!ExcelScript.ChartTitle#getSubstring:member(1)'
- package: ExcelScript!
- fullName: 'getSubstring(start, length)'
- summary: Get the substring of a chart title. Line break '\\n' counts one character.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSubstring(start: number, length: number): ChartFormatString;'
- parameters:
- - id: start
- description: Start position of substring to be retrieved. Zero-indexed.
- type: number
- - id: length
- description: Length of the substring to be retrieved.
- type: number
- return:
- type: ''
- description: ''
- - name: getText()
- uid: 'ExcelScript!ExcelScript.ChartTitle#getText:member(1)'
- package: ExcelScript!
- fullName: getText()
- summary: Specifies the chart's title text.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getText(): string;'
- return:
- type: string
- description: ''
- - name: getTextOrientation()
- uid: 'ExcelScript!ExcelScript.ChartTitle#getTextOrientation:member(1)'
- package: ExcelScript!
- fullName: getTextOrientation()
- summary: >-
- Specifies the angle to which the text is oriented for the chart title. The value should either be an integer from
- -90 to 90 or the integer 180 for vertically-oriented text.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTextOrientation(): number;'
- return:
- type: number
- description: ''
- - name: getTop()
- uid: 'ExcelScript!ExcelScript.ChartTitle#getTop:member(1)'
- package: ExcelScript!
- fullName: getTop()
- summary: >-
- Specifies the distance, in points, from the top edge of chart title to the top of chart area. Value is `null` if
- the chart title is not visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTop(): number;'
- return:
- type: number
- description: ''
- - name: getVerticalAlignment()
- uid: 'ExcelScript!ExcelScript.ChartTitle#getVerticalAlignment:member(1)'
- package: ExcelScript!
- fullName: getVerticalAlignment()
- summary: Specifies the vertical alignment of chart title. See `ExcelScript.ChartTextVerticalAlignment` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVerticalAlignment(): ChartTextVerticalAlignment;'
- return:
- type: ''
- description: ''
- - name: getVisible()
- uid: 'ExcelScript!ExcelScript.ChartTitle#getVisible:member(1)'
- package: ExcelScript!
- fullName: getVisible()
- summary: Specifies if the chart title is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVisible(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getWidth()
- uid: 'ExcelScript!ExcelScript.ChartTitle#getWidth:member(1)'
- package: ExcelScript!
- fullName: getWidth()
- summary: 'Specifies the width, in points, of the chart title. Value is `null` if the chart title is not visible.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWidth(): number;'
- return:
- type: number
- description: ''
- - name: setFormula(formula)
- uid: 'ExcelScript!ExcelScript.ChartTitle#setFormula:member(1)'
- package: ExcelScript!
- fullName: setFormula(formula)
- summary: Sets a string value that represents the formula of chart title using A1-style notation.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFormula(formula: string): void;'
- parameters:
- - id: formula
- description: A string that represents the formula to set.
- type: string
- return:
- type: void
- description: ''
- - name: setHorizontalAlignment(horizontalAlignment)
- uid: 'ExcelScript!ExcelScript.ChartTitle#setHorizontalAlignment:member(1)'
- package: ExcelScript!
- fullName: setHorizontalAlignment(horizontalAlignment)
- summary: Specifies the horizontal alignment for chart title.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setHorizontalAlignment(
- horizontalAlignment: ChartTextHorizontalAlignment
- ): void;
- parameters:
- - id: horizontalAlignment
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setLeft(left)
- uid: 'ExcelScript!ExcelScript.ChartTitle#setLeft:member(1)'
- package: ExcelScript!
- fullName: setLeft(left)
- summary: >-
- Specifies the distance, in points, from the left edge of chart title to the left edge of chart area. Value is
- `null` if the chart title is not visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLeft(left: number): void;'
- parameters:
- - id: left
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setOverlay(overlay)
- uid: 'ExcelScript!ExcelScript.ChartTitle#setOverlay:member(1)'
- package: ExcelScript!
- fullName: setOverlay(overlay)
- summary: Specifies if the chart title will overlay the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setOverlay(overlay: boolean): void;'
- parameters:
- - id: overlay
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setPosition(position)
- uid: 'ExcelScript!ExcelScript.ChartTitle#setPosition:member(1)'
- package: ExcelScript!
- fullName: setPosition(position)
- summary: Represents the position of chart title. See `ExcelScript.ChartTitlePosition` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPosition(position: ChartTitlePosition): void;'
- parameters:
- - id: position
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setShowShadow(showShadow)
- uid: 'ExcelScript!ExcelScript.ChartTitle#setShowShadow:member(1)'
- package: ExcelScript!
- fullName: setShowShadow(showShadow)
- summary: Represents a boolean value that determines if the chart title has a shadow.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowShadow(showShadow: boolean): void;'
- parameters:
- - id: showShadow
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setText(text)
- uid: 'ExcelScript!ExcelScript.ChartTitle#setText:member(1)'
- package: ExcelScript!
- fullName: setText(text)
- summary: Specifies the chart's title text.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setText(text: string): void;'
- parameters:
- - id: text
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setTextOrientation(textOrientation)
- uid: 'ExcelScript!ExcelScript.ChartTitle#setTextOrientation:member(1)'
- package: ExcelScript!
- fullName: setTextOrientation(textOrientation)
- summary: >-
- Specifies the angle to which the text is oriented for the chart title. The value should either be an integer from
- -90 to 90 or the integer 180 for vertically-oriented text.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTextOrientation(textOrientation: number): void;'
- parameters:
- - id: textOrientation
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setTop(top)
- uid: 'ExcelScript!ExcelScript.ChartTitle#setTop:member(1)'
- package: ExcelScript!
- fullName: setTop(top)
- summary: >-
- Specifies the distance, in points, from the top edge of chart title to the top of chart area. Value is `null` if
- the chart title is not visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTop(top: number): void;'
- parameters:
- - id: top
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setVerticalAlignment(verticalAlignment)
- uid: 'ExcelScript!ExcelScript.ChartTitle#setVerticalAlignment:member(1)'
- package: ExcelScript!
- fullName: setVerticalAlignment(verticalAlignment)
- summary: Specifies the vertical alignment of chart title. See `ExcelScript.ChartTextVerticalAlignment` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setVerticalAlignment(
- verticalAlignment: ChartTextVerticalAlignment
- ): void;
- parameters:
- - id: verticalAlignment
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setVisible(visible)
- uid: 'ExcelScript!ExcelScript.ChartTitle#setVisible:member(1)'
- package: ExcelScript!
- fullName: setVisible(visible)
- summary: Specifies if the chart title is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setVisible(visible: boolean): void;'
- parameters:
- - id: visible
- description: ''
- type: boolean
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartTitle
+uid: 'ExcelScript!ExcelScript.ChartTitle:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartTitle
+summary: Represents a chart title object of a chart.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getFormat()
+ uid: 'ExcelScript!ExcelScript.ChartTitle#getFormat:member(1)'
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: 'Represents the formatting of a chart title, which includes fill and font formatting.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): ChartTitleFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getHeight()
+ uid: 'ExcelScript!ExcelScript.ChartTitle#getHeight:member(1)'
+ package: ExcelScript!
+ fullName: getHeight()
+ summary: 'Returns the height, in points, of the chart title. Value is `null` if the chart title is not visible.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHeight(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getHorizontalAlignment()
+ uid: 'ExcelScript!ExcelScript.ChartTitle#getHorizontalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: getHorizontalAlignment()
+ summary: Specifies the horizontal alignment for chart title.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHorizontalAlignment(): ChartTextHorizontalAlignment;'
+ return:
+ type: ''
+ description: ''
+ - name: getLeft()
+ uid: 'ExcelScript!ExcelScript.ChartTitle#getLeft:member(1)'
+ package: ExcelScript!
+ fullName: getLeft()
+ summary: >-
+ Specifies the distance, in points, from the left edge of chart title to the left edge of chart area. Value is
+ `null` if the chart title is not visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLeft(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getOverlay()
+ uid: 'ExcelScript!ExcelScript.ChartTitle#getOverlay:member(1)'
+ package: ExcelScript!
+ fullName: getOverlay()
+ summary: Specifies if the chart title will overlay the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getOverlay(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getPosition()
+ uid: 'ExcelScript!ExcelScript.ChartTitle#getPosition:member(1)'
+ package: ExcelScript!
+ fullName: getPosition()
+ summary: Represents the position of chart title. See `ExcelScript.ChartTitlePosition` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPosition(): ChartTitlePosition;'
+ return:
+ type: ''
+ description: ''
+ - name: getShowShadow()
+ uid: 'ExcelScript!ExcelScript.ChartTitle#getShowShadow:member(1)'
+ package: ExcelScript!
+ fullName: getShowShadow()
+ summary: Represents a boolean value that determines if the chart title has a shadow.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowShadow(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: 'getSubstring(start, length)'
+ uid: 'ExcelScript!ExcelScript.ChartTitle#getSubstring:member(1)'
+ package: ExcelScript!
+ fullName: 'getSubstring(start, length)'
+ summary: Get the substring of a chart title. Line break '\\n' counts one character.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSubstring(start: number, length: number): ChartFormatString;'
+ parameters:
+ - id: start
+ description: Start position of substring to be retrieved. Zero-indexed.
+ type: number
+ - id: length
+ description: Length of the substring to be retrieved.
+ type: number
+ return:
+ type: ''
+ description: ''
+ - name: getText()
+ uid: 'ExcelScript!ExcelScript.ChartTitle#getText:member(1)'
+ package: ExcelScript!
+ fullName: getText()
+ summary: Specifies the chart's title text.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getText(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getTextOrientation()
+ uid: 'ExcelScript!ExcelScript.ChartTitle#getTextOrientation:member(1)'
+ package: ExcelScript!
+ fullName: getTextOrientation()
+ summary: >-
+ Specifies the angle to which the text is oriented for the chart title. The value should either be an integer from
+ -90 to 90 or the integer 180 for vertically-oriented text.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTextOrientation(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getTop()
+ uid: 'ExcelScript!ExcelScript.ChartTitle#getTop:member(1)'
+ package: ExcelScript!
+ fullName: getTop()
+ summary: >-
+ Specifies the distance, in points, from the top edge of chart title to the top of chart area. Value is `null` if
+ the chart title is not visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTop(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getVerticalAlignment()
+ uid: 'ExcelScript!ExcelScript.ChartTitle#getVerticalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: getVerticalAlignment()
+ summary: Specifies the vertical alignment of chart title. See `ExcelScript.ChartTextVerticalAlignment` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVerticalAlignment(): ChartTextVerticalAlignment;'
+ return:
+ type: ''
+ description: ''
+ - name: getVisible()
+ uid: 'ExcelScript!ExcelScript.ChartTitle#getVisible:member(1)'
+ package: ExcelScript!
+ fullName: getVisible()
+ summary: Specifies if the chart title is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVisible(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getWidth()
+ uid: 'ExcelScript!ExcelScript.ChartTitle#getWidth:member(1)'
+ package: ExcelScript!
+ fullName: getWidth()
+ summary: 'Specifies the width, in points, of the chart title. Value is `null` if the chart title is not visible.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWidth(): number;'
+ return:
+ type: number
+ description: ''
+ - name: setFormula(formula)
+ uid: 'ExcelScript!ExcelScript.ChartTitle#setFormula:member(1)'
+ package: ExcelScript!
+ fullName: setFormula(formula)
+ summary: Sets a string value that represents the formula of chart title using A1-style notation.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFormula(formula: string): void;'
+ parameters:
+ - id: formula
+ description: A string that represents the formula to set.
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setHorizontalAlignment(horizontalAlignment)
+ uid: 'ExcelScript!ExcelScript.ChartTitle#setHorizontalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: setHorizontalAlignment(horizontalAlignment)
+ summary: Specifies the horizontal alignment for chart title.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setHorizontalAlignment(
+ horizontalAlignment: ChartTextHorizontalAlignment
+ ): void;
+ parameters:
+ - id: horizontalAlignment
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setLeft(left)
+ uid: 'ExcelScript!ExcelScript.ChartTitle#setLeft:member(1)'
+ package: ExcelScript!
+ fullName: setLeft(left)
+ summary: >-
+ Specifies the distance, in points, from the left edge of chart title to the left edge of chart area. Value is
+ `null` if the chart title is not visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLeft(left: number): void;'
+ parameters:
+ - id: left
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setOverlay(overlay)
+ uid: 'ExcelScript!ExcelScript.ChartTitle#setOverlay:member(1)'
+ package: ExcelScript!
+ fullName: setOverlay(overlay)
+ summary: Specifies if the chart title will overlay the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setOverlay(overlay: boolean): void;'
+ parameters:
+ - id: overlay
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setPosition(position)
+ uid: 'ExcelScript!ExcelScript.ChartTitle#setPosition:member(1)'
+ package: ExcelScript!
+ fullName: setPosition(position)
+ summary: Represents the position of chart title. See `ExcelScript.ChartTitlePosition` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPosition(position: ChartTitlePosition): void;'
+ parameters:
+ - id: position
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setShowShadow(showShadow)
+ uid: 'ExcelScript!ExcelScript.ChartTitle#setShowShadow:member(1)'
+ package: ExcelScript!
+ fullName: setShowShadow(showShadow)
+ summary: Represents a boolean value that determines if the chart title has a shadow.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowShadow(showShadow: boolean): void;'
+ parameters:
+ - id: showShadow
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setText(text)
+ uid: 'ExcelScript!ExcelScript.ChartTitle#setText:member(1)'
+ package: ExcelScript!
+ fullName: setText(text)
+ summary: Specifies the chart's title text.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setText(text: string): void;'
+ parameters:
+ - id: text
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setTextOrientation(textOrientation)
+ uid: 'ExcelScript!ExcelScript.ChartTitle#setTextOrientation:member(1)'
+ package: ExcelScript!
+ fullName: setTextOrientation(textOrientation)
+ summary: >-
+ Specifies the angle to which the text is oriented for the chart title. The value should either be an integer from
+ -90 to 90 or the integer 180 for vertically-oriented text.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTextOrientation(textOrientation: number): void;'
+ parameters:
+ - id: textOrientation
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setTop(top)
+ uid: 'ExcelScript!ExcelScript.ChartTitle#setTop:member(1)'
+ package: ExcelScript!
+ fullName: setTop(top)
+ summary: >-
+ Specifies the distance, in points, from the top edge of chart title to the top of chart area. Value is `null` if
+ the chart title is not visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTop(top: number): void;'
+ parameters:
+ - id: top
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setVerticalAlignment(verticalAlignment)
+ uid: 'ExcelScript!ExcelScript.ChartTitle#setVerticalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: setVerticalAlignment(verticalAlignment)
+ summary: Specifies the vertical alignment of chart title. See `ExcelScript.ChartTextVerticalAlignment` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setVerticalAlignment(
+ verticalAlignment: ChartTextVerticalAlignment
+ ): void;
+ parameters:
+ - id: verticalAlignment
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setVisible(visible)
+ uid: 'ExcelScript!ExcelScript.ChartTitle#setVisible:member(1)'
+ package: ExcelScript!
+ fullName: setVisible(visible)
+ summary: Specifies if the chart title is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setVisible(visible: boolean): void;'
+ parameters:
+ - id: visible
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.charttitleformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.charttitleformat.yml
index d9fc35c3..79db6c69 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.charttitleformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.charttitleformat.yml
@@ -1,50 +1,50 @@
-### YamlMime:TSType
-name: ExcelScript.ChartTitleFormat
-uid: 'ExcelScript!ExcelScript.ChartTitleFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartTitleFormat
-summary: Provides access to the formatting options for a chart title.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getBorder()
- uid: 'ExcelScript!ExcelScript.ChartTitleFormat#getBorder:member(1)'
- package: ExcelScript!
- fullName: getBorder()
- summary: 'Represents the border format of chart title, which includes color, linestyle, and weight.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBorder(): ChartBorder;'
- return:
- type: ''
- description: ''
- - name: getFill()
- uid: 'ExcelScript!ExcelScript.ChartTitleFormat#getFill:member(1)'
- package: ExcelScript!
- fullName: getFill()
- summary: 'Represents the fill format of an object, which includes background formatting information.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFill(): ChartFill;'
- return:
- type: ''
- description: ''
- - name: getFont()
- uid: 'ExcelScript!ExcelScript.ChartTitleFormat#getFont:member(1)'
- package: ExcelScript!
- fullName: getFont()
- summary: 'Represents the font attributes (such as font name, font size, and color) for an object.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFont(): ChartFont;'
- return:
- type: ''
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartTitleFormat
+uid: 'ExcelScript!ExcelScript.ChartTitleFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartTitleFormat
+summary: Provides access to the formatting options for a chart title.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getBorder()
+ uid: 'ExcelScript!ExcelScript.ChartTitleFormat#getBorder:member(1)'
+ package: ExcelScript!
+ fullName: getBorder()
+ summary: 'Represents the border format of chart title, which includes color, linestyle, and weight.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBorder(): ChartBorder;'
+ return:
+ type: ''
+ description: ''
+ - name: getFill()
+ uid: 'ExcelScript!ExcelScript.ChartTitleFormat#getFill:member(1)'
+ package: ExcelScript!
+ fullName: getFill()
+ summary: 'Represents the fill format of an object, which includes background formatting information.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFill(): ChartFill;'
+ return:
+ type: ''
+ description: ''
+ - name: getFont()
+ uid: 'ExcelScript!ExcelScript.ChartTitleFormat#getFont:member(1)'
+ package: ExcelScript!
+ fullName: getFont()
+ summary: 'Represents the font attributes (such as font name, font size, and color) for an object.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFont(): ChartFont;'
+ return:
+ type: ''
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.charttitleposition.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.charttitleposition.yml
index 8bf9e240..408ef986 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.charttitleposition.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.charttitleposition.yml
@@ -1,30 +1,30 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartTitlePosition
-uid: 'ExcelScript!ExcelScript.ChartTitlePosition:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartTitlePosition
-summary: Represents the position of the chart title.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: automatic
- uid: 'ExcelScript!ExcelScript.ChartTitlePosition.automatic:member'
- package: ExcelScript!
- summary: ''
- - name: bottom
- uid: 'ExcelScript!ExcelScript.ChartTitlePosition.bottom:member'
- package: ExcelScript!
- summary: ''
- - name: left
- uid: 'ExcelScript!ExcelScript.ChartTitlePosition.left:member'
- package: ExcelScript!
- summary: ''
- - name: right
- uid: 'ExcelScript!ExcelScript.ChartTitlePosition.right:member'
- package: ExcelScript!
- summary: ''
- - name: top
- uid: 'ExcelScript!ExcelScript.ChartTitlePosition.top:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartTitlePosition
+uid: 'ExcelScript!ExcelScript.ChartTitlePosition:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartTitlePosition
+summary: Represents the position of the chart title.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: automatic
+ uid: 'ExcelScript!ExcelScript.ChartTitlePosition.automatic:member'
+ package: ExcelScript!
+ summary: ''
+ - name: bottom
+ uid: 'ExcelScript!ExcelScript.ChartTitlePosition.bottom:member'
+ package: ExcelScript!
+ summary: ''
+ - name: left
+ uid: 'ExcelScript!ExcelScript.ChartTitlePosition.left:member'
+ package: ExcelScript!
+ summary: ''
+ - name: right
+ uid: 'ExcelScript!ExcelScript.ChartTitlePosition.right:member'
+ package: ExcelScript!
+ summary: ''
+ - name: top
+ uid: 'ExcelScript!ExcelScript.ChartTitlePosition.top:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.charttrendline.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.charttrendline.yml
index da737190..e974d949 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.charttrendline.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.charttrendline.yml
@@ -1,324 +1,324 @@
-### YamlMime:TSType
-name: ExcelScript.ChartTrendline
-uid: 'ExcelScript!ExcelScript.ChartTrendline:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartTrendline
-summary: This object represents the attributes for a chart trendline object.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: delete()
- uid: 'ExcelScript!ExcelScript.ChartTrendline#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: Delete the trendline object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: ''
- - name: getBackwardPeriod()
- uid: 'ExcelScript!ExcelScript.ChartTrendline#getBackwardPeriod:member(1)'
- package: ExcelScript!
- fullName: getBackwardPeriod()
- summary: Represents the number of periods that the trendline extends backward.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBackwardPeriod(): number;'
- return:
- type: number
- description: ''
- - name: getFormat()
- uid: 'ExcelScript!ExcelScript.ChartTrendline#getFormat:member(1)'
- package: ExcelScript!
- fullName: getFormat()
- summary: Represents the formatting of a chart trendline.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormat(): ChartTrendlineFormat;'
- return:
- type: ''
- description: ''
- - name: getForwardPeriod()
- uid: 'ExcelScript!ExcelScript.ChartTrendline#getForwardPeriod:member(1)'
- package: ExcelScript!
- fullName: getForwardPeriod()
- summary: Represents the number of periods that the trendline extends forward.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getForwardPeriod(): number;'
- return:
- type: number
- description: ''
- - name: getIntercept()
- uid: 'ExcelScript!ExcelScript.ChartTrendline#getIntercept:member(1)'
- package: ExcelScript!
- fullName: getIntercept()
- summary: Specifies the intercept value of the trendline.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIntercept(): number;'
- return:
- type: number
- description: ''
- - name: getLabel()
- uid: 'ExcelScript!ExcelScript.ChartTrendline#getLabel:member(1)'
- package: ExcelScript!
- fullName: getLabel()
- summary: Represents the label of a chart trendline.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLabel(): ChartTrendlineLabel;'
- return:
- type: ''
- description: ''
- - name: getMovingAveragePeriod()
- uid: 'ExcelScript!ExcelScript.ChartTrendline#getMovingAveragePeriod:member(1)'
- package: ExcelScript!
- fullName: getMovingAveragePeriod()
- summary: Represents the period of a chart trendline. Only applicable to trendlines with the type `MovingAverage`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMovingAveragePeriod(): number;'
- return:
- type: number
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.ChartTrendline#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: >-
- Represents the name of the trendline. Can be set to a string value, a `null` value represents automatic values.
- The returned value is always a string
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: getPolynomialOrder()
- uid: 'ExcelScript!ExcelScript.ChartTrendline#getPolynomialOrder:member(1)'
- package: ExcelScript!
- fullName: getPolynomialOrder()
- summary: Represents the order of a chart trendline. Only applicable to trendlines with the type `Polynomial`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPolynomialOrder(): number;'
- return:
- type: number
- description: ''
- - name: getShowEquation()
- uid: 'ExcelScript!ExcelScript.ChartTrendline#getShowEquation:member(1)'
- package: ExcelScript!
- fullName: getShowEquation()
- summary: True if the equation for the trendline is displayed on the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowEquation(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowRSquared()
- uid: 'ExcelScript!ExcelScript.ChartTrendline#getShowRSquared:member(1)'
- package: ExcelScript!
- fullName: getShowRSquared()
- summary: True if the r-squared value for the trendline is displayed on the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowRSquared(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getType()
- uid: 'ExcelScript!ExcelScript.ChartTrendline#getType:member(1)'
- package: ExcelScript!
- fullName: getType()
- summary: Represents the type of a chart trendline.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getType(): ChartTrendlineType;'
- return:
- type: ''
- description: ''
- - name: setBackwardPeriod(backwardPeriod)
- uid: 'ExcelScript!ExcelScript.ChartTrendline#setBackwardPeriod:member(1)'
- package: ExcelScript!
- fullName: setBackwardPeriod(backwardPeriod)
- summary: Represents the number of periods that the trendline extends backward.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setBackwardPeriod(backwardPeriod: number): void;'
- parameters:
- - id: backwardPeriod
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setForwardPeriod(forwardPeriod)
- uid: 'ExcelScript!ExcelScript.ChartTrendline#setForwardPeriod:member(1)'
- package: ExcelScript!
- fullName: setForwardPeriod(forwardPeriod)
- summary: Represents the number of periods that the trendline extends forward.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setForwardPeriod(forwardPeriod: number): void;'
- parameters:
- - id: forwardPeriod
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setIntercept(intercept)
- uid: 'ExcelScript!ExcelScript.ChartTrendline#setIntercept:member(1)'
- package: ExcelScript!
- fullName: setIntercept(intercept)
- summary: Specifies the intercept value of the trendline.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setIntercept(intercept: number): void;'
- parameters:
- - id: intercept
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setMovingAveragePeriod(movingAveragePeriod)
- uid: 'ExcelScript!ExcelScript.ChartTrendline#setMovingAveragePeriod:member(1)'
- package: ExcelScript!
- fullName: setMovingAveragePeriod(movingAveragePeriod)
- summary: Represents the period of a chart trendline. Only applicable to trendlines with the type `MovingAverage`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMovingAveragePeriod(movingAveragePeriod: number): void;'
- parameters:
- - id: movingAveragePeriod
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setName(name)
- uid: 'ExcelScript!ExcelScript.ChartTrendline#setName:member(1)'
- package: ExcelScript!
- fullName: setName(name)
- summary: >-
- Represents the name of the trendline. Can be set to a string value, a `null` value represents automatic values.
- The returned value is always a string
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setName(name: string): void;'
- parameters:
- - id: name
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setPolynomialOrder(polynomialOrder)
- uid: 'ExcelScript!ExcelScript.ChartTrendline#setPolynomialOrder:member(1)'
- package: ExcelScript!
- fullName: setPolynomialOrder(polynomialOrder)
- summary: Represents the order of a chart trendline. Only applicable to trendlines with the type `Polynomial`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPolynomialOrder(polynomialOrder: number): void;'
- parameters:
- - id: polynomialOrder
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setShowEquation(showEquation)
- uid: 'ExcelScript!ExcelScript.ChartTrendline#setShowEquation:member(1)'
- package: ExcelScript!
- fullName: setShowEquation(showEquation)
- summary: True if the equation for the trendline is displayed on the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowEquation(showEquation: boolean): void;'
- parameters:
- - id: showEquation
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowRSquared(showRSquared)
- uid: 'ExcelScript!ExcelScript.ChartTrendline#setShowRSquared:member(1)'
- package: ExcelScript!
- fullName: setShowRSquared(showRSquared)
- summary: True if the r-squared value for the trendline is displayed on the chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowRSquared(showRSquared: boolean): void;'
- parameters:
- - id: showRSquared
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setType(type)
- uid: 'ExcelScript!ExcelScript.ChartTrendline#setType:member(1)'
- package: ExcelScript!
- fullName: setType(type)
- summary: Represents the type of a chart trendline.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setType(type: ChartTrendlineType): void;'
- parameters:
- - id: type
- description: ''
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartTrendline
+uid: 'ExcelScript!ExcelScript.ChartTrendline:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartTrendline
+summary: This object represents the attributes for a chart trendline object.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.ChartTrendline#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: Delete the trendline object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getBackwardPeriod()
+ uid: 'ExcelScript!ExcelScript.ChartTrendline#getBackwardPeriod:member(1)'
+ package: ExcelScript!
+ fullName: getBackwardPeriod()
+ summary: Represents the number of periods that the trendline extends backward.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBackwardPeriod(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getFormat()
+ uid: 'ExcelScript!ExcelScript.ChartTrendline#getFormat:member(1)'
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: Represents the formatting of a chart trendline.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): ChartTrendlineFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getForwardPeriod()
+ uid: 'ExcelScript!ExcelScript.ChartTrendline#getForwardPeriod:member(1)'
+ package: ExcelScript!
+ fullName: getForwardPeriod()
+ summary: Represents the number of periods that the trendline extends forward.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getForwardPeriod(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getIntercept()
+ uid: 'ExcelScript!ExcelScript.ChartTrendline#getIntercept:member(1)'
+ package: ExcelScript!
+ fullName: getIntercept()
+ summary: Specifies the intercept value of the trendline.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIntercept(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getLabel()
+ uid: 'ExcelScript!ExcelScript.ChartTrendline#getLabel:member(1)'
+ package: ExcelScript!
+ fullName: getLabel()
+ summary: Represents the label of a chart trendline.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLabel(): ChartTrendlineLabel;'
+ return:
+ type: ''
+ description: ''
+ - name: getMovingAveragePeriod()
+ uid: 'ExcelScript!ExcelScript.ChartTrendline#getMovingAveragePeriod:member(1)'
+ package: ExcelScript!
+ fullName: getMovingAveragePeriod()
+ summary: Represents the period of a chart trendline. Only applicable to trendlines with the type `MovingAverage`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMovingAveragePeriod(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.ChartTrendline#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: >-
+ Represents the name of the trendline. Can be set to a string value, a `null` value represents automatic values.
+ The returned value is always a string
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getPolynomialOrder()
+ uid: 'ExcelScript!ExcelScript.ChartTrendline#getPolynomialOrder:member(1)'
+ package: ExcelScript!
+ fullName: getPolynomialOrder()
+ summary: Represents the order of a chart trendline. Only applicable to trendlines with the type `Polynomial`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPolynomialOrder(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getShowEquation()
+ uid: 'ExcelScript!ExcelScript.ChartTrendline#getShowEquation:member(1)'
+ package: ExcelScript!
+ fullName: getShowEquation()
+ summary: True if the equation for the trendline is displayed on the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowEquation(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowRSquared()
+ uid: 'ExcelScript!ExcelScript.ChartTrendline#getShowRSquared:member(1)'
+ package: ExcelScript!
+ fullName: getShowRSquared()
+ summary: True if the r-squared value for the trendline is displayed on the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowRSquared(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getType()
+ uid: 'ExcelScript!ExcelScript.ChartTrendline#getType:member(1)'
+ package: ExcelScript!
+ fullName: getType()
+ summary: Represents the type of a chart trendline.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getType(): ChartTrendlineType;'
+ return:
+ type: ''
+ description: ''
+ - name: setBackwardPeriod(backwardPeriod)
+ uid: 'ExcelScript!ExcelScript.ChartTrendline#setBackwardPeriod:member(1)'
+ package: ExcelScript!
+ fullName: setBackwardPeriod(backwardPeriod)
+ summary: Represents the number of periods that the trendline extends backward.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setBackwardPeriod(backwardPeriod: number): void;'
+ parameters:
+ - id: backwardPeriod
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setForwardPeriod(forwardPeriod)
+ uid: 'ExcelScript!ExcelScript.ChartTrendline#setForwardPeriod:member(1)'
+ package: ExcelScript!
+ fullName: setForwardPeriod(forwardPeriod)
+ summary: Represents the number of periods that the trendline extends forward.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setForwardPeriod(forwardPeriod: number): void;'
+ parameters:
+ - id: forwardPeriod
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setIntercept(intercept)
+ uid: 'ExcelScript!ExcelScript.ChartTrendline#setIntercept:member(1)'
+ package: ExcelScript!
+ fullName: setIntercept(intercept)
+ summary: Specifies the intercept value of the trendline.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setIntercept(intercept: number): void;'
+ parameters:
+ - id: intercept
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setMovingAveragePeriod(movingAveragePeriod)
+ uid: 'ExcelScript!ExcelScript.ChartTrendline#setMovingAveragePeriod:member(1)'
+ package: ExcelScript!
+ fullName: setMovingAveragePeriod(movingAveragePeriod)
+ summary: Represents the period of a chart trendline. Only applicable to trendlines with the type `MovingAverage`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMovingAveragePeriod(movingAveragePeriod: number): void;'
+ parameters:
+ - id: movingAveragePeriod
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setName(name)
+ uid: 'ExcelScript!ExcelScript.ChartTrendline#setName:member(1)'
+ package: ExcelScript!
+ fullName: setName(name)
+ summary: >-
+ Represents the name of the trendline. Can be set to a string value, a `null` value represents automatic values.
+ The returned value is always a string
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setName(name: string): void;'
+ parameters:
+ - id: name
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setPolynomialOrder(polynomialOrder)
+ uid: 'ExcelScript!ExcelScript.ChartTrendline#setPolynomialOrder:member(1)'
+ package: ExcelScript!
+ fullName: setPolynomialOrder(polynomialOrder)
+ summary: Represents the order of a chart trendline. Only applicable to trendlines with the type `Polynomial`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPolynomialOrder(polynomialOrder: number): void;'
+ parameters:
+ - id: polynomialOrder
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setShowEquation(showEquation)
+ uid: 'ExcelScript!ExcelScript.ChartTrendline#setShowEquation:member(1)'
+ package: ExcelScript!
+ fullName: setShowEquation(showEquation)
+ summary: True if the equation for the trendline is displayed on the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowEquation(showEquation: boolean): void;'
+ parameters:
+ - id: showEquation
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowRSquared(showRSquared)
+ uid: 'ExcelScript!ExcelScript.ChartTrendline#setShowRSquared:member(1)'
+ package: ExcelScript!
+ fullName: setShowRSquared(showRSquared)
+ summary: True if the r-squared value for the trendline is displayed on the chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowRSquared(showRSquared: boolean): void;'
+ parameters:
+ - id: showRSquared
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setType(type)
+ uid: 'ExcelScript!ExcelScript.ChartTrendline#setType:member(1)'
+ package: ExcelScript!
+ fullName: setType(type)
+ summary: Represents the type of a chart trendline.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setType(type: ChartTrendlineType): void;'
+ parameters:
+ - id: type
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.charttrendlineformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.charttrendlineformat.yml
index d67805f7..04941bd3 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.charttrendlineformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.charttrendlineformat.yml
@@ -1,24 +1,24 @@
-### YamlMime:TSType
-name: ExcelScript.ChartTrendlineFormat
-uid: 'ExcelScript!ExcelScript.ChartTrendlineFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartTrendlineFormat
-summary: Represents the format properties for the chart trendline.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getLine()
- uid: 'ExcelScript!ExcelScript.ChartTrendlineFormat#getLine:member(1)'
- package: ExcelScript!
- fullName: getLine()
- summary: Represents chart line formatting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLine(): ChartLineFormat;'
- return:
- type: ''
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartTrendlineFormat
+uid: 'ExcelScript!ExcelScript.ChartTrendlineFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartTrendlineFormat
+summary: Represents the format properties for the chart trendline.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getLine()
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineFormat#getLine:member(1)'
+ package: ExcelScript!
+ fullName: getLine()
+ summary: Represents chart line formatting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLine(): ChartLineFormat;'
+ return:
+ type: ''
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.charttrendlinelabel.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.charttrendlinelabel.yml
index bb0f4f37..1171a2c2 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.charttrendlinelabel.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.charttrendlinelabel.yml
@@ -1,384 +1,384 @@
-### YamlMime:TSType
-name: ExcelScript.ChartTrendlineLabel
-uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartTrendlineLabel
-summary: This object represents the attributes for a chart trendline label object.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getAutoText()
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getAutoText:member(1)'
- package: ExcelScript!
- fullName: getAutoText()
- summary: Specifies if the trendline label automatically generates appropriate text based on context.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAutoText(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getFormat()
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getFormat:member(1)'
- package: ExcelScript!
- fullName: getFormat()
- summary: The format of the chart trendline label.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormat(): ChartTrendlineLabelFormat;'
- return:
- type: ''
- description: ''
- - name: getFormula()
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getFormula:member(1)'
- package: ExcelScript!
- fullName: getFormula()
- summary: String value that represents the formula of the chart trendline label using A1-style notation.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormula(): string;'
- return:
- type: string
- description: ''
- - name: getHeight()
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getHeight:member(1)'
- package: ExcelScript!
- fullName: getHeight()
- summary: >-
- Returns the height, in points, of the chart trendline label. Value is `null` if the chart trendline label is not
- visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHeight(): number;'
- return:
- type: number
- description: ''
- - name: getHorizontalAlignment()
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getHorizontalAlignment:member(1)'
- package: ExcelScript!
- fullName: getHorizontalAlignment()
- summary: >-
- Represents the horizontal alignment of the chart trendline label. See `ExcelScript.ChartTextHorizontalAlignment`
- for details. This property is valid only when `TextOrientation` of a trendline label is -90, 90, or 180.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHorizontalAlignment(): ChartTextHorizontalAlignment;'
- return:
- type: ''
- description: ''
- - name: getLeft()
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getLeft:member(1)'
- package: ExcelScript!
- fullName: getLeft()
- summary: >-
- Represents the distance, in points, from the left edge of the chart trendline label to the left edge of the chart
- area. Value is `null` if the chart trendline label is not visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLeft(): number;'
- return:
- type: number
- description: ''
- - name: getLinkNumberFormat()
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getLinkNumberFormat:member(1)'
- package: ExcelScript!
- fullName: getLinkNumberFormat()
- summary: >-
- Specifies if the number format is linked to the cells (so that the number format changes in the labels when it
- changes in the cells).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLinkNumberFormat(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getNumberFormat()
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getNumberFormat:member(1)'
- package: ExcelScript!
- fullName: getNumberFormat()
- summary: String value that represents the format code for the trendline label.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNumberFormat(): string;'
- return:
- type: string
- description: ''
- - name: getText()
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getText:member(1)'
- package: ExcelScript!
- fullName: getText()
- summary: String representing the text of the trendline label on a chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getText(): string;'
- return:
- type: string
- description: ''
- - name: getTextOrientation()
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getTextOrientation:member(1)'
- package: ExcelScript!
- fullName: getTextOrientation()
- summary: >-
- Represents the angle to which the text is oriented for the chart trendline label. The value should either be an
- integer from -90 to 90 or the integer 180 for vertically-oriented text.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTextOrientation(): number;'
- return:
- type: number
- description: ''
- - name: getTop()
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getTop:member(1)'
- package: ExcelScript!
- fullName: getTop()
- summary: >-
- Represents the distance, in points, from the top edge of the chart trendline label to the top of the chart area.
- Value is `null` if the chart trendline label is not visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTop(): number;'
- return:
- type: number
- description: ''
- - name: getVerticalAlignment()
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getVerticalAlignment:member(1)'
- package: ExcelScript!
- fullName: getVerticalAlignment()
- summary: >-
- Represents the vertical alignment of the chart trendline label. See `ExcelScript.ChartTextVerticalAlignment` for
- details. This property is valid only when `TextOrientation` of a trendline label is 0.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVerticalAlignment(): ChartTextVerticalAlignment;'
- return:
- type: ''
- description: ''
- - name: getWidth()
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getWidth:member(1)'
- package: ExcelScript!
- fullName: getWidth()
- summary: >-
- Returns the width, in points, of the chart trendline label. Value is `null` if the chart trendline label is not
- visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWidth(): number;'
- return:
- type: number
- description: ''
- - name: setAutoText(autoText)
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#setAutoText:member(1)'
- package: ExcelScript!
- fullName: setAutoText(autoText)
- summary: Specifies if the trendline label automatically generates appropriate text based on context.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setAutoText(autoText: boolean): void;'
- parameters:
- - id: autoText
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setFormula(formula)
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#setFormula:member(1)'
- package: ExcelScript!
- fullName: setFormula(formula)
- summary: String value that represents the formula of the chart trendline label using A1-style notation.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFormula(formula: string): void;'
- parameters:
- - id: formula
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setHorizontalAlignment(horizontalAlignment)
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#setHorizontalAlignment:member(1)'
- package: ExcelScript!
- fullName: setHorizontalAlignment(horizontalAlignment)
- summary: >-
- Represents the horizontal alignment of the chart trendline label. See `ExcelScript.ChartTextHorizontalAlignment`
- for details. This property is valid only when `TextOrientation` of a trendline label is -90, 90, or 180.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setHorizontalAlignment(
- horizontalAlignment: ChartTextHorizontalAlignment
- ): void;
- parameters:
- - id: horizontalAlignment
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setLeft(left)
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#setLeft:member(1)'
- package: ExcelScript!
- fullName: setLeft(left)
- summary: >-
- Represents the distance, in points, from the left edge of the chart trendline label to the left edge of the chart
- area. Value is `null` if the chart trendline label is not visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLeft(left: number): void;'
- parameters:
- - id: left
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setLinkNumberFormat(linkNumberFormat)
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#setLinkNumberFormat:member(1)'
- package: ExcelScript!
- fullName: setLinkNumberFormat(linkNumberFormat)
- summary: >-
- Specifies if the number format is linked to the cells (so that the number format changes in the labels when it
- changes in the cells).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLinkNumberFormat(linkNumberFormat: boolean): void;'
- parameters:
- - id: linkNumberFormat
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setNumberFormat(numberFormat)
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#setNumberFormat:member(1)'
- package: ExcelScript!
- fullName: setNumberFormat(numberFormat)
- summary: String value that represents the format code for the trendline label.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setNumberFormat(numberFormat: string): void;'
- parameters:
- - id: numberFormat
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setText(text)
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#setText:member(1)'
- package: ExcelScript!
- fullName: setText(text)
- summary: String representing the text of the trendline label on a chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setText(text: string): void;'
- parameters:
- - id: text
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setTextOrientation(textOrientation)
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#setTextOrientation:member(1)'
- package: ExcelScript!
- fullName: setTextOrientation(textOrientation)
- summary: >-
- Represents the angle to which the text is oriented for the chart trendline label. The value should either be an
- integer from -90 to 90 or the integer 180 for vertically-oriented text.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTextOrientation(textOrientation: number): void;'
- parameters:
- - id: textOrientation
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setTop(top)
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#setTop:member(1)'
- package: ExcelScript!
- fullName: setTop(top)
- summary: >-
- Represents the distance, in points, from the top edge of the chart trendline label to the top of the chart area.
- Value is `null` if the chart trendline label is not visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTop(top: number): void;'
- parameters:
- - id: top
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setVerticalAlignment(verticalAlignment)
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#setVerticalAlignment:member(1)'
- package: ExcelScript!
- fullName: setVerticalAlignment(verticalAlignment)
- summary: >-
- Represents the vertical alignment of the chart trendline label. See `ExcelScript.ChartTextVerticalAlignment` for
- details. This property is valid only when `TextOrientation` of a trendline label is 0.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setVerticalAlignment(
- verticalAlignment: ChartTextVerticalAlignment
- ): void;
- parameters:
- - id: verticalAlignment
- description: ''
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartTrendlineLabel
+uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartTrendlineLabel
+summary: This object represents the attributes for a chart trendline label object.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getAutoText()
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getAutoText:member(1)'
+ package: ExcelScript!
+ fullName: getAutoText()
+ summary: Specifies if the trendline label automatically generates appropriate text based on context.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAutoText(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getFormat()
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getFormat:member(1)'
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: The format of the chart trendline label.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): ChartTrendlineLabelFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getFormula()
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getFormula:member(1)'
+ package: ExcelScript!
+ fullName: getFormula()
+ summary: String value that represents the formula of the chart trendline label using A1-style notation.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormula(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getHeight()
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getHeight:member(1)'
+ package: ExcelScript!
+ fullName: getHeight()
+ summary: >-
+ Returns the height, in points, of the chart trendline label. Value is `null` if the chart trendline label is not
+ visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHeight(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getHorizontalAlignment()
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getHorizontalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: getHorizontalAlignment()
+ summary: >-
+ Represents the horizontal alignment of the chart trendline label. See `ExcelScript.ChartTextHorizontalAlignment`
+ for details. This property is valid only when `TextOrientation` of a trendline label is -90, 90, or 180.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHorizontalAlignment(): ChartTextHorizontalAlignment;'
+ return:
+ type: ''
+ description: ''
+ - name: getLeft()
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getLeft:member(1)'
+ package: ExcelScript!
+ fullName: getLeft()
+ summary: >-
+ Represents the distance, in points, from the left edge of the chart trendline label to the left edge of the chart
+ area. Value is `null` if the chart trendline label is not visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLeft(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getLinkNumberFormat()
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getLinkNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: getLinkNumberFormat()
+ summary: >-
+ Specifies if the number format is linked to the cells (so that the number format changes in the labels when it
+ changes in the cells).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLinkNumberFormat(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getNumberFormat()
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: getNumberFormat()
+ summary: String value that represents the format code for the trendline label.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNumberFormat(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getText()
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getText:member(1)'
+ package: ExcelScript!
+ fullName: getText()
+ summary: String representing the text of the trendline label on a chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getText(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getTextOrientation()
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getTextOrientation:member(1)'
+ package: ExcelScript!
+ fullName: getTextOrientation()
+ summary: >-
+ Represents the angle to which the text is oriented for the chart trendline label. The value should either be an
+ integer from -90 to 90 or the integer 180 for vertically-oriented text.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTextOrientation(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getTop()
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getTop:member(1)'
+ package: ExcelScript!
+ fullName: getTop()
+ summary: >-
+ Represents the distance, in points, from the top edge of the chart trendline label to the top of the chart area.
+ Value is `null` if the chart trendline label is not visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTop(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getVerticalAlignment()
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getVerticalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: getVerticalAlignment()
+ summary: >-
+ Represents the vertical alignment of the chart trendline label. See `ExcelScript.ChartTextVerticalAlignment` for
+ details. This property is valid only when `TextOrientation` of a trendline label is 0.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVerticalAlignment(): ChartTextVerticalAlignment;'
+ return:
+ type: ''
+ description: ''
+ - name: getWidth()
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#getWidth:member(1)'
+ package: ExcelScript!
+ fullName: getWidth()
+ summary: >-
+ Returns the width, in points, of the chart trendline label. Value is `null` if the chart trendline label is not
+ visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWidth(): number;'
+ return:
+ type: number
+ description: ''
+ - name: setAutoText(autoText)
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#setAutoText:member(1)'
+ package: ExcelScript!
+ fullName: setAutoText(autoText)
+ summary: Specifies if the trendline label automatically generates appropriate text based on context.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setAutoText(autoText: boolean): void;'
+ parameters:
+ - id: autoText
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setFormula(formula)
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#setFormula:member(1)'
+ package: ExcelScript!
+ fullName: setFormula(formula)
+ summary: String value that represents the formula of the chart trendline label using A1-style notation.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFormula(formula: string): void;'
+ parameters:
+ - id: formula
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setHorizontalAlignment(horizontalAlignment)
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#setHorizontalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: setHorizontalAlignment(horizontalAlignment)
+ summary: >-
+ Represents the horizontal alignment of the chart trendline label. See `ExcelScript.ChartTextHorizontalAlignment`
+ for details. This property is valid only when `TextOrientation` of a trendline label is -90, 90, or 180.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setHorizontalAlignment(
+ horizontalAlignment: ChartTextHorizontalAlignment
+ ): void;
+ parameters:
+ - id: horizontalAlignment
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setLeft(left)
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#setLeft:member(1)'
+ package: ExcelScript!
+ fullName: setLeft(left)
+ summary: >-
+ Represents the distance, in points, from the left edge of the chart trendline label to the left edge of the chart
+ area. Value is `null` if the chart trendline label is not visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLeft(left: number): void;'
+ parameters:
+ - id: left
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setLinkNumberFormat(linkNumberFormat)
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#setLinkNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: setLinkNumberFormat(linkNumberFormat)
+ summary: >-
+ Specifies if the number format is linked to the cells (so that the number format changes in the labels when it
+ changes in the cells).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLinkNumberFormat(linkNumberFormat: boolean): void;'
+ parameters:
+ - id: linkNumberFormat
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setNumberFormat(numberFormat)
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#setNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: setNumberFormat(numberFormat)
+ summary: String value that represents the format code for the trendline label.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setNumberFormat(numberFormat: string): void;'
+ parameters:
+ - id: numberFormat
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setText(text)
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#setText:member(1)'
+ package: ExcelScript!
+ fullName: setText(text)
+ summary: String representing the text of the trendline label on a chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setText(text: string): void;'
+ parameters:
+ - id: text
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setTextOrientation(textOrientation)
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#setTextOrientation:member(1)'
+ package: ExcelScript!
+ fullName: setTextOrientation(textOrientation)
+ summary: >-
+ Represents the angle to which the text is oriented for the chart trendline label. The value should either be an
+ integer from -90 to 90 or the integer 180 for vertically-oriented text.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTextOrientation(textOrientation: number): void;'
+ parameters:
+ - id: textOrientation
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setTop(top)
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#setTop:member(1)'
+ package: ExcelScript!
+ fullName: setTop(top)
+ summary: >-
+ Represents the distance, in points, from the top edge of the chart trendline label to the top of the chart area.
+ Value is `null` if the chart trendline label is not visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTop(top: number): void;'
+ parameters:
+ - id: top
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setVerticalAlignment(verticalAlignment)
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabel#setVerticalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: setVerticalAlignment(verticalAlignment)
+ summary: >-
+ Represents the vertical alignment of the chart trendline label. See `ExcelScript.ChartTextVerticalAlignment` for
+ details. This property is valid only when `TextOrientation` of a trendline label is 0.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setVerticalAlignment(
+ verticalAlignment: ChartTextVerticalAlignment
+ ): void;
+ parameters:
+ - id: verticalAlignment
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.charttrendlinelabelformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.charttrendlinelabelformat.yml
index 41b10486..2b015a95 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.charttrendlinelabelformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.charttrendlinelabelformat.yml
@@ -1,50 +1,50 @@
-### YamlMime:TSType
-name: ExcelScript.ChartTrendlineLabelFormat
-uid: 'ExcelScript!ExcelScript.ChartTrendlineLabelFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.ChartTrendlineLabelFormat
-summary: Encapsulates the format properties for the chart trendline label.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getBorder()
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabelFormat#getBorder:member(1)'
- package: ExcelScript!
- fullName: getBorder()
- summary: 'Specifies the border format, which includes color, linestyle, and weight.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBorder(): ChartBorder;'
- return:
- type: ''
- description: ''
- - name: getFill()
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabelFormat#getFill:member(1)'
- package: ExcelScript!
- fullName: getFill()
- summary: Specifies the fill format of the current chart trendline label.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFill(): ChartFill;'
- return:
- type: ''
- description: ''
- - name: getFont()
- uid: 'ExcelScript!ExcelScript.ChartTrendlineLabelFormat#getFont:member(1)'
- package: ExcelScript!
- fullName: getFont()
- summary: 'Specifies the font attributes (such as font name, font size, and color) for a chart trendline label.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFont(): ChartFont;'
- return:
- type: ''
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ChartTrendlineLabelFormat
+uid: 'ExcelScript!ExcelScript.ChartTrendlineLabelFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.ChartTrendlineLabelFormat
+summary: Encapsulates the format properties for the chart trendline label.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getBorder()
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabelFormat#getBorder:member(1)'
+ package: ExcelScript!
+ fullName: getBorder()
+ summary: 'Specifies the border format, which includes color, linestyle, and weight.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBorder(): ChartBorder;'
+ return:
+ type: ''
+ description: ''
+ - name: getFill()
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabelFormat#getFill:member(1)'
+ package: ExcelScript!
+ fullName: getFill()
+ summary: Specifies the fill format of the current chart trendline label.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFill(): ChartFill;'
+ return:
+ type: ''
+ description: ''
+ - name: getFont()
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineLabelFormat#getFont:member(1)'
+ package: ExcelScript!
+ fullName: getFont()
+ summary: 'Specifies the font attributes (such as font name, font size, and color) for a chart trendline label.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFont(): ChartFont;'
+ return:
+ type: ''
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.charttrendlinetype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.charttrendlinetype.yml
index 400c6d2e..27093d11 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.charttrendlinetype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.charttrendlinetype.yml
@@ -1,34 +1,34 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartTrendlineType
-uid: 'ExcelScript!ExcelScript.ChartTrendlineType:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartTrendlineType
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: exponential
- uid: 'ExcelScript!ExcelScript.ChartTrendlineType.exponential:member'
- package: ExcelScript!
- summary: ''
- - name: linear
- uid: 'ExcelScript!ExcelScript.ChartTrendlineType.linear:member'
- package: ExcelScript!
- summary: ''
- - name: logarithmic
- uid: 'ExcelScript!ExcelScript.ChartTrendlineType.logarithmic:member'
- package: ExcelScript!
- summary: ''
- - name: movingAverage
- uid: 'ExcelScript!ExcelScript.ChartTrendlineType.movingAverage:member'
- package: ExcelScript!
- summary: ''
- - name: polynomial
- uid: 'ExcelScript!ExcelScript.ChartTrendlineType.polynomial:member'
- package: ExcelScript!
- summary: ''
- - name: power
- uid: 'ExcelScript!ExcelScript.ChartTrendlineType.power:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartTrendlineType
+uid: 'ExcelScript!ExcelScript.ChartTrendlineType:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartTrendlineType
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: exponential
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineType.exponential:member'
+ package: ExcelScript!
+ summary: ''
+ - name: linear
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineType.linear:member'
+ package: ExcelScript!
+ summary: ''
+ - name: logarithmic
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineType.logarithmic:member'
+ package: ExcelScript!
+ summary: ''
+ - name: movingAverage
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineType.movingAverage:member'
+ package: ExcelScript!
+ summary: ''
+ - name: polynomial
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineType.polynomial:member'
+ package: ExcelScript!
+ summary: ''
+ - name: power
+ uid: 'ExcelScript!ExcelScript.ChartTrendlineType.power:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.charttype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.charttype.yml
index e579fdfd..7eab460d 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.charttype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.charttype.yml
@@ -1,308 +1,308 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartType
-uid: 'ExcelScript!ExcelScript.ChartType:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartType
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample creates a column-clustered chart based on the current worksheet's data.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Get the data range.
- let range = selectedSheet.getUsedRange();
-
- // Insert a chart using the data on the current worksheet.
- let chart = selectedSheet.addChart(ExcelScript.ChartType.columnClustered, range);
-
- // Name the chart for easy access in other scripts.
- chart.setName("ColumnChart");
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: area
- uid: 'ExcelScript!ExcelScript.ChartType.area:member'
- package: ExcelScript!
- summary: ''
- - name: areaStacked
- uid: 'ExcelScript!ExcelScript.ChartType.areaStacked:member'
- package: ExcelScript!
- summary: ''
- - name: areaStacked100
- uid: 'ExcelScript!ExcelScript.ChartType.areaStacked100:member'
- package: ExcelScript!
- summary: ''
- - name: barClustered
- uid: 'ExcelScript!ExcelScript.ChartType.barClustered:member'
- package: ExcelScript!
- summary: ''
- - name: barOfPie
- uid: 'ExcelScript!ExcelScript.ChartType.barOfPie:member'
- package: ExcelScript!
- summary: ''
- - name: barStacked
- uid: 'ExcelScript!ExcelScript.ChartType.barStacked:member'
- package: ExcelScript!
- summary: ''
- - name: barStacked100
- uid: 'ExcelScript!ExcelScript.ChartType.barStacked100:member'
- package: ExcelScript!
- summary: ''
- - name: boxwhisker
- uid: 'ExcelScript!ExcelScript.ChartType.boxwhisker:member'
- package: ExcelScript!
- summary: ''
- - name: bubble
- uid: 'ExcelScript!ExcelScript.ChartType.bubble:member'
- package: ExcelScript!
- summary: ''
- - name: bubble3DEffect
- uid: 'ExcelScript!ExcelScript.ChartType.bubble3DEffect:member'
- package: ExcelScript!
- summary: ''
- - name: columnClustered
- uid: 'ExcelScript!ExcelScript.ChartType.columnClustered:member'
- package: ExcelScript!
- summary: ''
- - name: columnStacked
- uid: 'ExcelScript!ExcelScript.ChartType.columnStacked:member'
- package: ExcelScript!
- summary: ''
- - name: columnStacked100
- uid: 'ExcelScript!ExcelScript.ChartType.columnStacked100:member'
- package: ExcelScript!
- summary: ''
- - name: coneBarClustered
- uid: 'ExcelScript!ExcelScript.ChartType.coneBarClustered:member'
- package: ExcelScript!
- summary: ''
- - name: coneBarStacked
- uid: 'ExcelScript!ExcelScript.ChartType.coneBarStacked:member'
- package: ExcelScript!
- summary: ''
- - name: coneBarStacked100
- uid: 'ExcelScript!ExcelScript.ChartType.coneBarStacked100:member'
- package: ExcelScript!
- summary: ''
- - name: coneCol
- uid: 'ExcelScript!ExcelScript.ChartType.coneCol:member'
- package: ExcelScript!
- summary: ''
- - name: coneColClustered
- uid: 'ExcelScript!ExcelScript.ChartType.coneColClustered:member'
- package: ExcelScript!
- summary: ''
- - name: coneColStacked
- uid: 'ExcelScript!ExcelScript.ChartType.coneColStacked:member'
- package: ExcelScript!
- summary: ''
- - name: coneColStacked100
- uid: 'ExcelScript!ExcelScript.ChartType.coneColStacked100:member'
- package: ExcelScript!
- summary: ''
- - name: cylinderBarClustered
- uid: 'ExcelScript!ExcelScript.ChartType.cylinderBarClustered:member'
- package: ExcelScript!
- summary: ''
- - name: cylinderBarStacked
- uid: 'ExcelScript!ExcelScript.ChartType.cylinderBarStacked:member'
- package: ExcelScript!
- summary: ''
- - name: cylinderBarStacked100
- uid: 'ExcelScript!ExcelScript.ChartType.cylinderBarStacked100:member'
- package: ExcelScript!
- summary: ''
- - name: cylinderCol
- uid: 'ExcelScript!ExcelScript.ChartType.cylinderCol:member'
- package: ExcelScript!
- summary: ''
- - name: cylinderColClustered
- uid: 'ExcelScript!ExcelScript.ChartType.cylinderColClustered:member'
- package: ExcelScript!
- summary: ''
- - name: cylinderColStacked
- uid: 'ExcelScript!ExcelScript.ChartType.cylinderColStacked:member'
- package: ExcelScript!
- summary: ''
- - name: cylinderColStacked100
- uid: 'ExcelScript!ExcelScript.ChartType.cylinderColStacked100:member'
- package: ExcelScript!
- summary: ''
- - name: doughnut
- uid: 'ExcelScript!ExcelScript.ChartType.doughnut:member'
- package: ExcelScript!
- summary: ''
- - name: doughnutExploded
- uid: 'ExcelScript!ExcelScript.ChartType.doughnutExploded:member'
- package: ExcelScript!
- summary: ''
- - name: funnel
- uid: 'ExcelScript!ExcelScript.ChartType.funnel:member'
- package: ExcelScript!
- summary: ''
- - name: histogram
- uid: 'ExcelScript!ExcelScript.ChartType.histogram:member'
- package: ExcelScript!
- summary: ''
- - name: invalid
- uid: 'ExcelScript!ExcelScript.ChartType.invalid:member'
- package: ExcelScript!
- summary: ''
- - name: line
- uid: 'ExcelScript!ExcelScript.ChartType.line:member'
- package: ExcelScript!
- summary: ''
- - name: lineMarkers
- uid: 'ExcelScript!ExcelScript.ChartType.lineMarkers:member'
- package: ExcelScript!
- summary: ''
- - name: lineMarkersStacked
- uid: 'ExcelScript!ExcelScript.ChartType.lineMarkersStacked:member'
- package: ExcelScript!
- summary: ''
- - name: lineMarkersStacked100
- uid: 'ExcelScript!ExcelScript.ChartType.lineMarkersStacked100:member'
- package: ExcelScript!
- summary: ''
- - name: lineStacked
- uid: 'ExcelScript!ExcelScript.ChartType.lineStacked:member'
- package: ExcelScript!
- summary: ''
- - name: lineStacked100
- uid: 'ExcelScript!ExcelScript.ChartType.lineStacked100:member'
- package: ExcelScript!
- summary: ''
- - name: pareto
- uid: 'ExcelScript!ExcelScript.ChartType.pareto:member'
- package: ExcelScript!
- summary: ''
- - name: pie
- uid: 'ExcelScript!ExcelScript.ChartType.pie:member'
- package: ExcelScript!
- summary: ''
- - name: pieExploded
- uid: 'ExcelScript!ExcelScript.ChartType.pieExploded:member'
- package: ExcelScript!
- summary: ''
- - name: pieOfPie
- uid: 'ExcelScript!ExcelScript.ChartType.pieOfPie:member'
- package: ExcelScript!
- summary: ''
- - name: pyramidBarClustered
- uid: 'ExcelScript!ExcelScript.ChartType.pyramidBarClustered:member'
- package: ExcelScript!
- summary: ''
- - name: pyramidBarStacked
- uid: 'ExcelScript!ExcelScript.ChartType.pyramidBarStacked:member'
- package: ExcelScript!
- summary: ''
- - name: pyramidBarStacked100
- uid: 'ExcelScript!ExcelScript.ChartType.pyramidBarStacked100:member'
- package: ExcelScript!
- summary: ''
- - name: pyramidCol
- uid: 'ExcelScript!ExcelScript.ChartType.pyramidCol:member'
- package: ExcelScript!
- summary: ''
- - name: pyramidColClustered
- uid: 'ExcelScript!ExcelScript.ChartType.pyramidColClustered:member'
- package: ExcelScript!
- summary: ''
- - name: pyramidColStacked
- uid: 'ExcelScript!ExcelScript.ChartType.pyramidColStacked:member'
- package: ExcelScript!
- summary: ''
- - name: pyramidColStacked100
- uid: 'ExcelScript!ExcelScript.ChartType.pyramidColStacked100:member'
- package: ExcelScript!
- summary: ''
- - name: radar
- uid: 'ExcelScript!ExcelScript.ChartType.radar:member'
- package: ExcelScript!
- summary: ''
- - name: radarFilled
- uid: 'ExcelScript!ExcelScript.ChartType.radarFilled:member'
- package: ExcelScript!
- summary: ''
- - name: radarMarkers
- uid: 'ExcelScript!ExcelScript.ChartType.radarMarkers:member'
- package: ExcelScript!
- summary: ''
- - name: regionMap
- uid: 'ExcelScript!ExcelScript.ChartType.regionMap:member'
- package: ExcelScript!
- summary: ''
- - name: stockHLC
- uid: 'ExcelScript!ExcelScript.ChartType.stockHLC:member'
- package: ExcelScript!
- summary: ''
- - name: stockOHLC
- uid: 'ExcelScript!ExcelScript.ChartType.stockOHLC:member'
- package: ExcelScript!
- summary: ''
- - name: stockVHLC
- uid: 'ExcelScript!ExcelScript.ChartType.stockVHLC:member'
- package: ExcelScript!
- summary: ''
- - name: stockVOHLC
- uid: 'ExcelScript!ExcelScript.ChartType.stockVOHLC:member'
- package: ExcelScript!
- summary: ''
- - name: sunburst
- uid: 'ExcelScript!ExcelScript.ChartType.sunburst:member'
- package: ExcelScript!
- summary: ''
- - name: surface
- uid: 'ExcelScript!ExcelScript.ChartType.surface:member'
- package: ExcelScript!
- summary: ''
- - name: surfaceTopView
- uid: 'ExcelScript!ExcelScript.ChartType.surfaceTopView:member'
- package: ExcelScript!
- summary: ''
- - name: surfaceTopViewWireframe
- uid: 'ExcelScript!ExcelScript.ChartType.surfaceTopViewWireframe:member'
- package: ExcelScript!
- summary: ''
- - name: surfaceWireframe
- uid: 'ExcelScript!ExcelScript.ChartType.surfaceWireframe:member'
- package: ExcelScript!
- summary: ''
- - name: treemap
- uid: 'ExcelScript!ExcelScript.ChartType.treemap:member'
- package: ExcelScript!
- summary: ''
- - name: waterfall
- uid: 'ExcelScript!ExcelScript.ChartType.waterfall:member'
- package: ExcelScript!
- summary: ''
- - name: xyscatter
- uid: 'ExcelScript!ExcelScript.ChartType.xyscatter:member'
- package: ExcelScript!
- summary: ''
- - name: xyscatterLines
- uid: 'ExcelScript!ExcelScript.ChartType.xyscatterLines:member'
- package: ExcelScript!
- summary: ''
- - name: xyscatterLinesNoMarkers
- uid: 'ExcelScript!ExcelScript.ChartType.xyscatterLinesNoMarkers:member'
- package: ExcelScript!
- summary: ''
- - name: xyscatterSmooth
- uid: 'ExcelScript!ExcelScript.ChartType.xyscatterSmooth:member'
- package: ExcelScript!
- summary: ''
- - name: xyscatterSmoothNoMarkers
- uid: 'ExcelScript!ExcelScript.ChartType.xyscatterSmoothNoMarkers:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartType
+uid: 'ExcelScript!ExcelScript.ChartType:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartType
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample creates a column-clustered chart based on the current worksheet's data.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Get the data range.
+ let range = selectedSheet.getUsedRange();
+
+ // Insert a chart using the data on the current worksheet.
+ let chart = selectedSheet.addChart(ExcelScript.ChartType.columnClustered, range);
+
+ // Name the chart for easy access in other scripts.
+ chart.setName("ColumnChart");
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: area
+ uid: 'ExcelScript!ExcelScript.ChartType.area:member'
+ package: ExcelScript!
+ summary: ''
+ - name: areaStacked
+ uid: 'ExcelScript!ExcelScript.ChartType.areaStacked:member'
+ package: ExcelScript!
+ summary: ''
+ - name: areaStacked100
+ uid: 'ExcelScript!ExcelScript.ChartType.areaStacked100:member'
+ package: ExcelScript!
+ summary: ''
+ - name: barClustered
+ uid: 'ExcelScript!ExcelScript.ChartType.barClustered:member'
+ package: ExcelScript!
+ summary: ''
+ - name: barOfPie
+ uid: 'ExcelScript!ExcelScript.ChartType.barOfPie:member'
+ package: ExcelScript!
+ summary: ''
+ - name: barStacked
+ uid: 'ExcelScript!ExcelScript.ChartType.barStacked:member'
+ package: ExcelScript!
+ summary: ''
+ - name: barStacked100
+ uid: 'ExcelScript!ExcelScript.ChartType.barStacked100:member'
+ package: ExcelScript!
+ summary: ''
+ - name: boxwhisker
+ uid: 'ExcelScript!ExcelScript.ChartType.boxwhisker:member'
+ package: ExcelScript!
+ summary: ''
+ - name: bubble
+ uid: 'ExcelScript!ExcelScript.ChartType.bubble:member'
+ package: ExcelScript!
+ summary: ''
+ - name: bubble3DEffect
+ uid: 'ExcelScript!ExcelScript.ChartType.bubble3DEffect:member'
+ package: ExcelScript!
+ summary: ''
+ - name: columnClustered
+ uid: 'ExcelScript!ExcelScript.ChartType.columnClustered:member'
+ package: ExcelScript!
+ summary: ''
+ - name: columnStacked
+ uid: 'ExcelScript!ExcelScript.ChartType.columnStacked:member'
+ package: ExcelScript!
+ summary: ''
+ - name: columnStacked100
+ uid: 'ExcelScript!ExcelScript.ChartType.columnStacked100:member'
+ package: ExcelScript!
+ summary: ''
+ - name: coneBarClustered
+ uid: 'ExcelScript!ExcelScript.ChartType.coneBarClustered:member'
+ package: ExcelScript!
+ summary: ''
+ - name: coneBarStacked
+ uid: 'ExcelScript!ExcelScript.ChartType.coneBarStacked:member'
+ package: ExcelScript!
+ summary: ''
+ - name: coneBarStacked100
+ uid: 'ExcelScript!ExcelScript.ChartType.coneBarStacked100:member'
+ package: ExcelScript!
+ summary: ''
+ - name: coneCol
+ uid: 'ExcelScript!ExcelScript.ChartType.coneCol:member'
+ package: ExcelScript!
+ summary: ''
+ - name: coneColClustered
+ uid: 'ExcelScript!ExcelScript.ChartType.coneColClustered:member'
+ package: ExcelScript!
+ summary: ''
+ - name: coneColStacked
+ uid: 'ExcelScript!ExcelScript.ChartType.coneColStacked:member'
+ package: ExcelScript!
+ summary: ''
+ - name: coneColStacked100
+ uid: 'ExcelScript!ExcelScript.ChartType.coneColStacked100:member'
+ package: ExcelScript!
+ summary: ''
+ - name: cylinderBarClustered
+ uid: 'ExcelScript!ExcelScript.ChartType.cylinderBarClustered:member'
+ package: ExcelScript!
+ summary: ''
+ - name: cylinderBarStacked
+ uid: 'ExcelScript!ExcelScript.ChartType.cylinderBarStacked:member'
+ package: ExcelScript!
+ summary: ''
+ - name: cylinderBarStacked100
+ uid: 'ExcelScript!ExcelScript.ChartType.cylinderBarStacked100:member'
+ package: ExcelScript!
+ summary: ''
+ - name: cylinderCol
+ uid: 'ExcelScript!ExcelScript.ChartType.cylinderCol:member'
+ package: ExcelScript!
+ summary: ''
+ - name: cylinderColClustered
+ uid: 'ExcelScript!ExcelScript.ChartType.cylinderColClustered:member'
+ package: ExcelScript!
+ summary: ''
+ - name: cylinderColStacked
+ uid: 'ExcelScript!ExcelScript.ChartType.cylinderColStacked:member'
+ package: ExcelScript!
+ summary: ''
+ - name: cylinderColStacked100
+ uid: 'ExcelScript!ExcelScript.ChartType.cylinderColStacked100:member'
+ package: ExcelScript!
+ summary: ''
+ - name: doughnut
+ uid: 'ExcelScript!ExcelScript.ChartType.doughnut:member'
+ package: ExcelScript!
+ summary: ''
+ - name: doughnutExploded
+ uid: 'ExcelScript!ExcelScript.ChartType.doughnutExploded:member'
+ package: ExcelScript!
+ summary: ''
+ - name: funnel
+ uid: 'ExcelScript!ExcelScript.ChartType.funnel:member'
+ package: ExcelScript!
+ summary: ''
+ - name: histogram
+ uid: 'ExcelScript!ExcelScript.ChartType.histogram:member'
+ package: ExcelScript!
+ summary: ''
+ - name: invalid
+ uid: 'ExcelScript!ExcelScript.ChartType.invalid:member'
+ package: ExcelScript!
+ summary: ''
+ - name: line
+ uid: 'ExcelScript!ExcelScript.ChartType.line:member'
+ package: ExcelScript!
+ summary: ''
+ - name: lineMarkers
+ uid: 'ExcelScript!ExcelScript.ChartType.lineMarkers:member'
+ package: ExcelScript!
+ summary: ''
+ - name: lineMarkersStacked
+ uid: 'ExcelScript!ExcelScript.ChartType.lineMarkersStacked:member'
+ package: ExcelScript!
+ summary: ''
+ - name: lineMarkersStacked100
+ uid: 'ExcelScript!ExcelScript.ChartType.lineMarkersStacked100:member'
+ package: ExcelScript!
+ summary: ''
+ - name: lineStacked
+ uid: 'ExcelScript!ExcelScript.ChartType.lineStacked:member'
+ package: ExcelScript!
+ summary: ''
+ - name: lineStacked100
+ uid: 'ExcelScript!ExcelScript.ChartType.lineStacked100:member'
+ package: ExcelScript!
+ summary: ''
+ - name: pareto
+ uid: 'ExcelScript!ExcelScript.ChartType.pareto:member'
+ package: ExcelScript!
+ summary: ''
+ - name: pie
+ uid: 'ExcelScript!ExcelScript.ChartType.pie:member'
+ package: ExcelScript!
+ summary: ''
+ - name: pieExploded
+ uid: 'ExcelScript!ExcelScript.ChartType.pieExploded:member'
+ package: ExcelScript!
+ summary: ''
+ - name: pieOfPie
+ uid: 'ExcelScript!ExcelScript.ChartType.pieOfPie:member'
+ package: ExcelScript!
+ summary: ''
+ - name: pyramidBarClustered
+ uid: 'ExcelScript!ExcelScript.ChartType.pyramidBarClustered:member'
+ package: ExcelScript!
+ summary: ''
+ - name: pyramidBarStacked
+ uid: 'ExcelScript!ExcelScript.ChartType.pyramidBarStacked:member'
+ package: ExcelScript!
+ summary: ''
+ - name: pyramidBarStacked100
+ uid: 'ExcelScript!ExcelScript.ChartType.pyramidBarStacked100:member'
+ package: ExcelScript!
+ summary: ''
+ - name: pyramidCol
+ uid: 'ExcelScript!ExcelScript.ChartType.pyramidCol:member'
+ package: ExcelScript!
+ summary: ''
+ - name: pyramidColClustered
+ uid: 'ExcelScript!ExcelScript.ChartType.pyramidColClustered:member'
+ package: ExcelScript!
+ summary: ''
+ - name: pyramidColStacked
+ uid: 'ExcelScript!ExcelScript.ChartType.pyramidColStacked:member'
+ package: ExcelScript!
+ summary: ''
+ - name: pyramidColStacked100
+ uid: 'ExcelScript!ExcelScript.ChartType.pyramidColStacked100:member'
+ package: ExcelScript!
+ summary: ''
+ - name: radar
+ uid: 'ExcelScript!ExcelScript.ChartType.radar:member'
+ package: ExcelScript!
+ summary: ''
+ - name: radarFilled
+ uid: 'ExcelScript!ExcelScript.ChartType.radarFilled:member'
+ package: ExcelScript!
+ summary: ''
+ - name: radarMarkers
+ uid: 'ExcelScript!ExcelScript.ChartType.radarMarkers:member'
+ package: ExcelScript!
+ summary: ''
+ - name: regionMap
+ uid: 'ExcelScript!ExcelScript.ChartType.regionMap:member'
+ package: ExcelScript!
+ summary: ''
+ - name: stockHLC
+ uid: 'ExcelScript!ExcelScript.ChartType.stockHLC:member'
+ package: ExcelScript!
+ summary: ''
+ - name: stockOHLC
+ uid: 'ExcelScript!ExcelScript.ChartType.stockOHLC:member'
+ package: ExcelScript!
+ summary: ''
+ - name: stockVHLC
+ uid: 'ExcelScript!ExcelScript.ChartType.stockVHLC:member'
+ package: ExcelScript!
+ summary: ''
+ - name: stockVOHLC
+ uid: 'ExcelScript!ExcelScript.ChartType.stockVOHLC:member'
+ package: ExcelScript!
+ summary: ''
+ - name: sunburst
+ uid: 'ExcelScript!ExcelScript.ChartType.sunburst:member'
+ package: ExcelScript!
+ summary: ''
+ - name: surface
+ uid: 'ExcelScript!ExcelScript.ChartType.surface:member'
+ package: ExcelScript!
+ summary: ''
+ - name: surfaceTopView
+ uid: 'ExcelScript!ExcelScript.ChartType.surfaceTopView:member'
+ package: ExcelScript!
+ summary: ''
+ - name: surfaceTopViewWireframe
+ uid: 'ExcelScript!ExcelScript.ChartType.surfaceTopViewWireframe:member'
+ package: ExcelScript!
+ summary: ''
+ - name: surfaceWireframe
+ uid: 'ExcelScript!ExcelScript.ChartType.surfaceWireframe:member'
+ package: ExcelScript!
+ summary: ''
+ - name: treemap
+ uid: 'ExcelScript!ExcelScript.ChartType.treemap:member'
+ package: ExcelScript!
+ summary: ''
+ - name: waterfall
+ uid: 'ExcelScript!ExcelScript.ChartType.waterfall:member'
+ package: ExcelScript!
+ summary: ''
+ - name: xyscatter
+ uid: 'ExcelScript!ExcelScript.ChartType.xyscatter:member'
+ package: ExcelScript!
+ summary: ''
+ - name: xyscatterLines
+ uid: 'ExcelScript!ExcelScript.ChartType.xyscatterLines:member'
+ package: ExcelScript!
+ summary: ''
+ - name: xyscatterLinesNoMarkers
+ uid: 'ExcelScript!ExcelScript.ChartType.xyscatterLinesNoMarkers:member'
+ package: ExcelScript!
+ summary: ''
+ - name: xyscatterSmooth
+ uid: 'ExcelScript!ExcelScript.ChartType.xyscatterSmooth:member'
+ package: ExcelScript!
+ summary: ''
+ - name: xyscatterSmoothNoMarkers
+ uid: 'ExcelScript!ExcelScript.ChartType.xyscatterSmoothNoMarkers:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartunderlinestyle.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartunderlinestyle.yml
index 70c92f5d..7014660a 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartunderlinestyle.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartunderlinestyle.yml
@@ -1,18 +1,18 @@
-### YamlMime:TSEnum
-name: ExcelScript.ChartUnderlineStyle
-uid: 'ExcelScript!ExcelScript.ChartUnderlineStyle:enum'
-package: ExcelScript!
-fullName: ExcelScript.ChartUnderlineStyle
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: none
- uid: 'ExcelScript!ExcelScript.ChartUnderlineStyle.none:member'
- package: ExcelScript!
- summary: ''
- - name: single
- uid: 'ExcelScript!ExcelScript.ChartUnderlineStyle.single:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ChartUnderlineStyle
+uid: 'ExcelScript!ExcelScript.ChartUnderlineStyle:enum'
+package: ExcelScript!
+fullName: ExcelScript.ChartUnderlineStyle
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: none
+ uid: 'ExcelScript!ExcelScript.ChartUnderlineStyle.none:member'
+ package: ExcelScript!
+ summary: ''
+ - name: single
+ uid: 'ExcelScript!ExcelScript.ChartUnderlineStyle.single:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.checkboxcellcontrol.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.checkboxcellcontrol.yml
new file mode 100644
index 00000000..7d074f28
--- /dev/null
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.checkboxcellcontrol.yml
@@ -0,0 +1,23 @@
+### YamlMime:TSType
+name: ExcelScript.CheckboxCellControl
+uid: 'ExcelScript!ExcelScript.CheckboxCellControl:interface'
+package: ExcelScript!
+fullName: ExcelScript.CheckboxCellControl
+summary: Represents a checkbox. This is a cell control that allows a user to toggle the boolean value in a cell.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: type
+ uid: 'ExcelScript!ExcelScript.CheckboxCellControl#type:member'
+ package: ExcelScript!
+ fullName: type
+ summary: ''
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'type: CellControlType.checkbox;'
+ return:
+ type: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.clearapplyto.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.clearapplyto.yml
index aa26cc33..9d438ed6 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.clearapplyto.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.clearapplyto.yml
@@ -1,54 +1,60 @@
-### YamlMime:TSEnum
-name: ExcelScript.ClearApplyTo
-uid: 'ExcelScript!ExcelScript.ClearApplyTo:enum'
-package: ExcelScript!
-fullName: ExcelScript.ClearApplyTo
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script removes any extra formatting that's been applied to a table.
- * This leaves only the base table style effects.
- * Any formatting outside of the table will be left as is.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table on the current worksheet.
- let worksheet = workbook.getActiveWorksheet();
- let table = worksheet.getTables()[0];
-
- // Get the range used by the table.
- let range = table.getRange();
-
- // Clear all the formatting that is not applied by the table and the table style.
- range.clear(ExcelScript.ClearApplyTo.formats);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: all
- uid: 'ExcelScript!ExcelScript.ClearApplyTo.all:member'
- package: ExcelScript!
- summary: Clears everything in the range.
- - name: contents
- uid: 'ExcelScript!ExcelScript.ClearApplyTo.contents:member'
- package: ExcelScript!
- summary: 'Clears the contents of the range, leaving formatting intact.'
- - name: formats
- uid: 'ExcelScript!ExcelScript.ClearApplyTo.formats:member'
- package: ExcelScript!
- summary: 'Clears all formatting for the range, leaving values intact.'
- - name: hyperlinks
- uid: 'ExcelScript!ExcelScript.ClearApplyTo.hyperlinks:member'
- package: ExcelScript!
- summary: 'Clears all hyperlinks, but leaves all content and formatting intact.'
- - name: removeHyperlinks
- uid: 'ExcelScript!ExcelScript.ClearApplyTo.removeHyperlinks:member'
- package: ExcelScript!
- summary: >-
- Removes hyperlinks and formatting for the cell but leaves content, conditional formats, and data validation
- intact.
+### YamlMime:TSEnum
+name: ExcelScript.ClearApplyTo
+uid: 'ExcelScript!ExcelScript.ClearApplyTo:enum'
+package: ExcelScript!
+fullName: ExcelScript.ClearApplyTo
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script removes any extra formatting that's been applied to a table.
+ * This leaves only the base table style effects.
+ * Any formatting outside of the table will be left as is.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table on the current worksheet.
+ let worksheet = workbook.getActiveWorksheet();
+ let table = worksheet.getTables()[0];
+
+ // Get the range used by the table.
+ let range = table.getRange();
+
+ // Clear all the formatting that is not applied by the table and the table style.
+ range.clear(ExcelScript.ClearApplyTo.formats);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: all
+ uid: 'ExcelScript!ExcelScript.ClearApplyTo.all:member'
+ package: ExcelScript!
+ summary: Clears everything in the range.
+ - name: contents
+ uid: 'ExcelScript!ExcelScript.ClearApplyTo.contents:member'
+ package: ExcelScript!
+ summary: 'Clears the contents of the range, leaving formatting intact.'
+ - name: formats
+ uid: 'ExcelScript!ExcelScript.ClearApplyTo.formats:member'
+ package: ExcelScript!
+ summary: 'Clears all formatting for the range, leaving values intact.'
+ - name: hyperlinks
+ uid: 'ExcelScript!ExcelScript.ClearApplyTo.hyperlinks:member'
+ package: ExcelScript!
+ summary: 'Clears all hyperlinks, but leaves all content and formatting intact.'
+ - name: removeHyperlinks
+ uid: 'ExcelScript!ExcelScript.ClearApplyTo.removeHyperlinks:member'
+ package: ExcelScript!
+ summary: >-
+ Removes hyperlinks and formatting for the cell but leaves content, conditional formats, and data validation
+ intact.
+ - name: resetContents
+ uid: 'ExcelScript!ExcelScript.ClearApplyTo.resetContents:member'
+ package: ExcelScript!
+ summary: >-
+ Sets all cells in the range to their default state. Cells with cell controls are set to the default value defined
+ by each control. Cells without cell controls are set to blank.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.colorscaleconditionalformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.colorscaleconditionalformat.yml
index 1e3e4fc8..74353173 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.colorscaleconditionalformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.colorscaleconditionalformat.yml
@@ -1,56 +1,56 @@
-### YamlMime:TSType
-name: ExcelScript.ColorScaleConditionalFormat
-uid: 'ExcelScript!ExcelScript.ColorScaleConditionalFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.ColorScaleConditionalFormat
-summary: Represents the color scale criteria for conditional formatting.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getCriteria()
- uid: 'ExcelScript!ExcelScript.ColorScaleConditionalFormat#getCriteria:member(1)'
- package: ExcelScript!
- fullName: getCriteria()
- summary: The criteria of the color scale. Midpoint is optional when using a two point color scale.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCriteria(): ConditionalColorScaleCriteria;'
- return:
- type: ''
- description: ''
- - name: getThreeColorScale()
- uid: 'ExcelScript!ExcelScript.ColorScaleConditionalFormat#getThreeColorScale:member(1)'
- package: ExcelScript!
- fullName: getThreeColorScale()
- summary: >-
- If `true`, the color scale will have three points (minimum, midpoint, maximum), otherwise it will have two
- (minimum, maximum).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getThreeColorScale(): boolean;'
- return:
- type: boolean
- description: ''
- - name: setCriteria(criteria)
- uid: 'ExcelScript!ExcelScript.ColorScaleConditionalFormat#setCriteria:member(1)'
- package: ExcelScript!
- fullName: setCriteria(criteria)
- summary: The criteria of the color scale. Midpoint is optional when using a two point color scale.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setCriteria(criteria: ConditionalColorScaleCriteria): void;'
- parameters:
- - id: criteria
- description: ''
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ColorScaleConditionalFormat
+uid: 'ExcelScript!ExcelScript.ColorScaleConditionalFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.ColorScaleConditionalFormat
+summary: Represents the color scale criteria for conditional formatting.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getCriteria()
+ uid: 'ExcelScript!ExcelScript.ColorScaleConditionalFormat#getCriteria:member(1)'
+ package: ExcelScript!
+ fullName: getCriteria()
+ summary: The criteria of the color scale. Midpoint is optional when using a two point color scale.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCriteria(): ConditionalColorScaleCriteria;'
+ return:
+ type: ''
+ description: ''
+ - name: getThreeColorScale()
+ uid: 'ExcelScript!ExcelScript.ColorScaleConditionalFormat#getThreeColorScale:member(1)'
+ package: ExcelScript!
+ fullName: getThreeColorScale()
+ summary: >-
+ If `true`, the color scale will have three points (minimum, midpoint, maximum), otherwise it will have two
+ (minimum, maximum).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getThreeColorScale(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: setCriteria(criteria)
+ uid: 'ExcelScript!ExcelScript.ColorScaleConditionalFormat#setCriteria:member(1)'
+ package: ExcelScript!
+ fullName: setCriteria(criteria)
+ summary: The criteria of the color scale. Midpoint is optional when using a two point color scale.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setCriteria(criteria: ConditionalColorScaleCriteria): void;'
+ parameters:
+ - id: criteria
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.comment.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.comment.yml
index d31f8a35..e63256dc 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.comment.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.comment.yml
@@ -1,271 +1,271 @@
-### YamlMime:TSType
-name: ExcelScript.Comment
-uid: 'ExcelScript!ExcelScript.Comment:interface'
-package: ExcelScript!
-fullName: ExcelScript.Comment
-summary: Represents a comment in the workbook.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: 'addCommentReply(content, contentType)'
- uid: 'ExcelScript!ExcelScript.Comment#addCommentReply:member(1)'
- package: ExcelScript!
- fullName: 'addCommentReply(content, contentType)'
- summary: Creates a comment reply for a comment.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- addCommentReply(
- content: CommentRichContent | string,
- contentType?: ContentType
- ): CommentReply;
- parameters:
- - id: content
- description: >-
- The comment's content. This can be either a string or a `CommentRichContent` object (e.g., for comments with
- mentions).
- type: ' | string'
- - id: contentType
- description: >-
- Optional. The type of content contained within the comment. The default value is enum
- `ContentType.Plain`.
- type: ''
- return:
- type: ''
- description: ''
- - name: delete()
- uid: 'ExcelScript!ExcelScript.Comment#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: Deletes the comment and all the connected replies.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: ''
- - name: getAuthorEmail()
- uid: 'ExcelScript!ExcelScript.Comment#getAuthorEmail:member(1)'
- package: ExcelScript!
- fullName: getAuthorEmail()
- summary: Gets the email of the comment's author.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAuthorEmail(): string;'
- return:
- type: string
- description: ''
- - name: getAuthorName()
- uid: 'ExcelScript!ExcelScript.Comment#getAuthorName:member(1)'
- package: ExcelScript!
- fullName: getAuthorName()
- summary: Gets the name of the comment's author.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAuthorName(): string;'
- return:
- type: string
- description: ''
- - name: getCommentReply(commentReplyId)
- uid: 'ExcelScript!ExcelScript.Comment#getCommentReply:member(1)'
- package: ExcelScript!
- fullName: getCommentReply(commentReplyId)
- summary: >-
- Returns a comment reply identified by its ID. If the comment reply object does not exist, then this method returns
- `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCommentReply(commentReplyId: string): CommentReply | undefined;'
- parameters:
- - id: commentReplyId
- description: The identifier for the comment reply.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getContent()
- uid: 'ExcelScript!ExcelScript.Comment#getContent:member(1)'
- package: ExcelScript!
- fullName: getContent()
- summary: The comment's content. The string is plain text.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getContent(): string;'
- return:
- type: string
- description: ''
- - name: getContentType()
- uid: 'ExcelScript!ExcelScript.Comment#getContentType:member(1)'
- package: ExcelScript!
- fullName: getContentType()
- summary: Gets the content type of the comment.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getContentType(): ContentType;'
- return:
- type: ''
- description: ''
- - name: getCreationDate()
- uid: 'ExcelScript!ExcelScript.Comment#getCreationDate:member(1)'
- package: ExcelScript!
- fullName: getCreationDate()
- summary: >-
- Gets the creation time of the comment. Returns `null` if the comment was converted from a note, since the comment
- does not have a creation date.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCreationDate(): Date;'
- return:
- type: Date
- description: ''
- - name: getId()
- uid: 'ExcelScript!ExcelScript.Comment#getId:member(1)'
- package: ExcelScript!
- fullName: getId()
- summary: Specifies the comment identifier.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getId(): string;'
- return:
- type: string
- description: ''
- - name: getLocation()
- uid: 'ExcelScript!ExcelScript.Comment#getLocation:member(1)'
- package: ExcelScript!
- fullName: getLocation()
- summary: Gets the cell where this comment is located.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLocation(): Range;'
- return:
- type: ''
- description: ''
- - name: getMentions()
- uid: 'ExcelScript!ExcelScript.Comment#getMentions:member(1)'
- package: ExcelScript!
- fullName: getMentions()
- summary: 'Gets the entities (e.g., people) that are mentioned in comments.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMentions(): CommentMention[];'
- return:
- type: '[]'
- description: ''
- - name: getReplies()
- uid: 'ExcelScript!ExcelScript.Comment#getReplies:member(1)'
- package: ExcelScript!
- fullName: getReplies()
- summary: Represents a collection of reply objects associated with the comment.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getReplies(): CommentReply[];'
- return:
- type: '[]'
- description: ''
- - name: getResolved()
- uid: 'ExcelScript!ExcelScript.Comment#getResolved:member(1)'
- package: ExcelScript!
- fullName: getResolved()
- summary: The comment thread status. A value of `true` means that the comment thread is resolved.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getResolved(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getRichContent()
- uid: 'ExcelScript!ExcelScript.Comment#getRichContent:member(1)'
- package: ExcelScript!
- fullName: getRichContent()
- summary: >-
- Gets the rich comment content (e.g., mentions in comments). This string is not meant to be displayed to end-users.
- Your add-in should only use this to parse rich comment content.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRichContent(): string;'
- return:
- type: string
- description: ''
- - name: setContent(content)
- uid: 'ExcelScript!ExcelScript.Comment#setContent:member(1)'
- package: ExcelScript!
- fullName: setContent(content)
- summary: The comment's content. The string is plain text.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setContent(content: string): void;'
- parameters:
- - id: content
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setResolved(resolved)
- uid: 'ExcelScript!ExcelScript.Comment#setResolved:member(1)'
- package: ExcelScript!
- fullName: setResolved(resolved)
- summary: The comment thread status. A value of `true` means that the comment thread is resolved.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setResolved(resolved: boolean): void;'
- parameters:
- - id: resolved
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: updateMentions(contentWithMentions)
- uid: 'ExcelScript!ExcelScript.Comment#updateMentions:member(1)'
- package: ExcelScript!
- fullName: updateMentions(contentWithMentions)
- summary: Updates the comment content with a specially formatted string and a list of mentions.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'updateMentions(contentWithMentions: CommentRichContent): void;'
- parameters:
- - id: contentWithMentions
- description: >-
- The content for the comment. This contains a specially formatted string and a list of mentions that will be
- parsed into the string when displayed by Excel.
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.Comment
+uid: 'ExcelScript!ExcelScript.Comment:interface'
+package: ExcelScript!
+fullName: ExcelScript.Comment
+summary: Represents a comment in the workbook.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: 'addCommentReply(content, contentType)'
+ uid: 'ExcelScript!ExcelScript.Comment#addCommentReply:member(1)'
+ package: ExcelScript!
+ fullName: 'addCommentReply(content, contentType)'
+ summary: Creates a comment reply for a comment.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ addCommentReply(
+ content: CommentRichContent | string,
+ contentType?: ContentType
+ ): CommentReply;
+ parameters:
+ - id: content
+ description: >-
+ The comment's content. This can be either a string or a `CommentRichContent` object (e.g., for comments with
+ mentions).
+ type: ' | string'
+ - id: contentType
+ description: >-
+ Optional. The type of content contained within the comment. The default value is enum
+ `ContentType.Plain`.
+ type: ''
+ return:
+ type: ''
+ description: ''
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.Comment#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: Deletes the comment and all the connected replies.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getAuthorEmail()
+ uid: 'ExcelScript!ExcelScript.Comment#getAuthorEmail:member(1)'
+ package: ExcelScript!
+ fullName: getAuthorEmail()
+ summary: Gets the email of the comment's author.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAuthorEmail(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getAuthorName()
+ uid: 'ExcelScript!ExcelScript.Comment#getAuthorName:member(1)'
+ package: ExcelScript!
+ fullName: getAuthorName()
+ summary: Gets the name of the comment's author.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAuthorName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getCommentReply(commentReplyId)
+ uid: 'ExcelScript!ExcelScript.Comment#getCommentReply:member(1)'
+ package: ExcelScript!
+ fullName: getCommentReply(commentReplyId)
+ summary: >-
+ Returns a comment reply identified by its ID. If the comment reply object does not exist, then this method returns
+ `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCommentReply(commentReplyId: string): CommentReply | undefined;'
+ parameters:
+ - id: commentReplyId
+ description: The identifier for the comment reply.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getContent()
+ uid: 'ExcelScript!ExcelScript.Comment#getContent:member(1)'
+ package: ExcelScript!
+ fullName: getContent()
+ summary: The comment's content. The string is plain text.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getContent(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getContentType()
+ uid: 'ExcelScript!ExcelScript.Comment#getContentType:member(1)'
+ package: ExcelScript!
+ fullName: getContentType()
+ summary: Gets the content type of the comment.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getContentType(): ContentType;'
+ return:
+ type: ''
+ description: ''
+ - name: getCreationDate()
+ uid: 'ExcelScript!ExcelScript.Comment#getCreationDate:member(1)'
+ package: ExcelScript!
+ fullName: getCreationDate()
+ summary: >-
+ Gets the creation time of the comment. Returns `null` if the comment was converted from a note, since the comment
+ does not have a creation date.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCreationDate(): Date;'
+ return:
+ type: Date
+ description: ''
+ - name: getId()
+ uid: 'ExcelScript!ExcelScript.Comment#getId:member(1)'
+ package: ExcelScript!
+ fullName: getId()
+ summary: Specifies the comment identifier.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getId(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getLocation()
+ uid: 'ExcelScript!ExcelScript.Comment#getLocation:member(1)'
+ package: ExcelScript!
+ fullName: getLocation()
+ summary: Gets the cell where this comment is located.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLocation(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getMentions()
+ uid: 'ExcelScript!ExcelScript.Comment#getMentions:member(1)'
+ package: ExcelScript!
+ fullName: getMentions()
+ summary: 'Gets the entities (e.g., people) that are mentioned in comments.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMentions(): CommentMention[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getReplies()
+ uid: 'ExcelScript!ExcelScript.Comment#getReplies:member(1)'
+ package: ExcelScript!
+ fullName: getReplies()
+ summary: Represents a collection of reply objects associated with the comment.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getReplies(): CommentReply[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getResolved()
+ uid: 'ExcelScript!ExcelScript.Comment#getResolved:member(1)'
+ package: ExcelScript!
+ fullName: getResolved()
+ summary: The comment thread status. A value of `true` means that the comment thread is resolved.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getResolved(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getRichContent()
+ uid: 'ExcelScript!ExcelScript.Comment#getRichContent:member(1)'
+ package: ExcelScript!
+ fullName: getRichContent()
+ summary: >-
+ Gets the rich comment content (e.g., mentions in comments). This string is not meant to be displayed to end-users.
+ Your add-in should only use this to parse rich comment content.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRichContent(): string;'
+ return:
+ type: string
+ description: ''
+ - name: setContent(content)
+ uid: 'ExcelScript!ExcelScript.Comment#setContent:member(1)'
+ package: ExcelScript!
+ fullName: setContent(content)
+ summary: The comment's content. The string is plain text.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setContent(content: string): void;'
+ parameters:
+ - id: content
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setResolved(resolved)
+ uid: 'ExcelScript!ExcelScript.Comment#setResolved:member(1)'
+ package: ExcelScript!
+ fullName: setResolved(resolved)
+ summary: The comment thread status. A value of `true` means that the comment thread is resolved.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setResolved(resolved: boolean): void;'
+ parameters:
+ - id: resolved
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: updateMentions(contentWithMentions)
+ uid: 'ExcelScript!ExcelScript.Comment#updateMentions:member(1)'
+ package: ExcelScript!
+ fullName: updateMentions(contentWithMentions)
+ summary: Updates the comment content with a specially formatted string and a list of mentions.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'updateMentions(contentWithMentions: CommentRichContent): void;'
+ parameters:
+ - id: contentWithMentions
+ description: >-
+ The content for the comment. This contains a specially formatted string and a list of mentions that will be
+ parsed into the string when displayed by Excel.
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.commentmention.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.commentmention.yml
index b4e1f6ca..dbc9590e 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.commentmention.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.commentmention.yml
@@ -1,88 +1,88 @@
-### YamlMime:TSType
-name: ExcelScript.CommentMention
-uid: 'ExcelScript!ExcelScript.CommentMention:interface'
-package: ExcelScript!
-fullName: ExcelScript.CommentMention
-summary: Represents the entity that is mentioned in comments.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample creates a comment that mentions a specific person.
- * That person will get a notification and link to the workbook.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first cell in the current worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const cell = currentSheet.getCell(0,0);
-
- /* Create a CommentMention object for the comment.
- *
- * A CommentMention's properties are:
- * `name`: The name of the person being mentioned.
- * `id`: The zero-based index of this mention in the comment.
- * `email`: The email address of the person being mentioned.
- */
- const mention: ExcelScript.CommentMention = {
- name: "Alex",
- id: 0,
- email: "alex@contoso.com"
- };
-
- /* Create comment content that uses the mention.
- * The `` syntax embeds the mention with ID 0 in the comment text.
- * The name is displayed in the comment,
- * while an email is sent to the given address.
- */
- const content: ExcelScript.CommentRichContent = {
- richContent: '' + mention.name + " - Hello!",
- mentions: [mention]
- };
-
- // Add the comment.
- currentSheet.addComment(cell, content, ExcelScript.ContentType.mention);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: email
- uid: 'ExcelScript!ExcelScript.CommentMention#email:member'
- package: ExcelScript!
- fullName: email
- summary: The email address of the entity that is mentioned in a comment.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'email: string;'
- return:
- type: string
- - name: id
- uid: 'ExcelScript!ExcelScript.CommentMention#id:member'
- package: ExcelScript!
- fullName: id
- summary: The ID of the entity. The ID matches one of the IDs in `CommentRichContent.richContent`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'id: number;'
- return:
- type: number
- - name: name
- uid: 'ExcelScript!ExcelScript.CommentMention#name:member'
- package: ExcelScript!
- fullName: name
- summary: The name of the entity that is mentioned in a comment.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'name: string;'
- return:
- type: string
+### YamlMime:TSType
+name: ExcelScript.CommentMention
+uid: 'ExcelScript!ExcelScript.CommentMention:interface'
+package: ExcelScript!
+fullName: ExcelScript.CommentMention
+summary: Represents the entity that is mentioned in comments.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample creates a comment that mentions a specific person.
+ * That person will get a notification and link to the workbook.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first cell in the current worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const cell = currentSheet.getCell(0,0);
+
+ /* Create a CommentMention object for the comment.
+ *
+ * A CommentMention's properties are:
+ * `name`: The name of the person being mentioned.
+ * `id`: The zero-based index of this mention in the comment.
+ * `email`: The email address of the person being mentioned.
+ */
+ const mention: ExcelScript.CommentMention = {
+ name: "Alex",
+ id: 0,
+ email: "alex@contoso.com"
+ };
+
+ /* Create comment content that uses the mention.
+ * The `` syntax embeds the mention with ID 0 in the comment text.
+ * The name is displayed in the comment,
+ * while an email is sent to the given address.
+ */
+ const content: ExcelScript.CommentRichContent = {
+ richContent: '' + mention.name + " - Hello!",
+ mentions: [mention]
+ };
+
+ // Add the comment.
+ currentSheet.addComment(cell, content, ExcelScript.ContentType.mention);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: email
+ uid: 'ExcelScript!ExcelScript.CommentMention#email:member'
+ package: ExcelScript!
+ fullName: email
+ summary: The email address of the entity that is mentioned in a comment.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'email: string;'
+ return:
+ type: string
+ - name: id
+ uid: 'ExcelScript!ExcelScript.CommentMention#id:member'
+ package: ExcelScript!
+ fullName: id
+ summary: The ID of the entity. The ID matches one of the IDs in `CommentRichContent.richContent`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id: number;'
+ return:
+ type: number
+ - name: name
+ uid: 'ExcelScript!ExcelScript.CommentMention#name:member'
+ package: ExcelScript!
+ fullName: name
+ summary: The name of the entity that is mentioned in a comment.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'name: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.commentreply.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.commentreply.yml
index f2d782dd..eb6700bc 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.commentreply.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.commentreply.yml
@@ -1,205 +1,205 @@
-### YamlMime:TSType
-name: ExcelScript.CommentReply
-uid: 'ExcelScript!ExcelScript.CommentReply:interface'
-package: ExcelScript!
-fullName: ExcelScript.CommentReply
-summary: Represents a comment reply in the workbook.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: delete()
- uid: 'ExcelScript!ExcelScript.CommentReply#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: Deletes the comment reply.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: ''
- - name: getAuthorEmail()
- uid: 'ExcelScript!ExcelScript.CommentReply#getAuthorEmail:member(1)'
- package: ExcelScript!
- fullName: getAuthorEmail()
- summary: Gets the email of the comment reply's author.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAuthorEmail(): string;'
- return:
- type: string
- description: ''
- - name: getAuthorName()
- uid: 'ExcelScript!ExcelScript.CommentReply#getAuthorName:member(1)'
- package: ExcelScript!
- fullName: getAuthorName()
- summary: Gets the name of the comment reply's author.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAuthorName(): string;'
- return:
- type: string
- description: ''
- - name: getContent()
- uid: 'ExcelScript!ExcelScript.CommentReply#getContent:member(1)'
- package: ExcelScript!
- fullName: getContent()
- summary: The comment reply's content. The string is plain text.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getContent(): string;'
- return:
- type: string
- description: ''
- - name: getContentType()
- uid: 'ExcelScript!ExcelScript.CommentReply#getContentType:member(1)'
- package: ExcelScript!
- fullName: getContentType()
- summary: The content type of the reply.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getContentType(): ContentType;'
- return:
- type: ''
- description: ''
- - name: getCreationDate()
- uid: 'ExcelScript!ExcelScript.CommentReply#getCreationDate:member(1)'
- package: ExcelScript!
- fullName: getCreationDate()
- summary: Gets the creation time of the comment reply.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCreationDate(): Date;'
- return:
- type: Date
- description: ''
- - name: getId()
- uid: 'ExcelScript!ExcelScript.CommentReply#getId:member(1)'
- package: ExcelScript!
- fullName: getId()
- summary: Specifies the comment reply identifier.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getId(): string;'
- return:
- type: string
- description: ''
- - name: getLocation()
- uid: 'ExcelScript!ExcelScript.CommentReply#getLocation:member(1)'
- package: ExcelScript!
- fullName: getLocation()
- summary: Gets the cell where this comment reply is located.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLocation(): Range;'
- return:
- type: ''
- description: ''
- - name: getMentions()
- uid: 'ExcelScript!ExcelScript.CommentReply#getMentions:member(1)'
- package: ExcelScript!
- fullName: getMentions()
- summary: 'The entities (e.g., people) that are mentioned in comments.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMentions(): CommentMention[];'
- return:
- type: '[]'
- description: ''
- - name: getParentComment()
- uid: 'ExcelScript!ExcelScript.CommentReply#getParentComment:member(1)'
- package: ExcelScript!
- fullName: getParentComment()
- summary: Gets the parent comment of this reply.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getParentComment(): Comment;'
- return:
- type: ''
- description: ''
- - name: getResolved()
- uid: 'ExcelScript!ExcelScript.CommentReply#getResolved:member(1)'
- package: ExcelScript!
- fullName: getResolved()
- summary: The comment reply status. A value of `true` means the reply is in the resolved state.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getResolved(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getRichContent()
- uid: 'ExcelScript!ExcelScript.CommentReply#getRichContent:member(1)'
- package: ExcelScript!
- fullName: getRichContent()
- summary: >-
- The rich comment content (e.g., mentions in comments). This string is not meant to be displayed to end-users. Your
- add-in should only use this to parse rich comment content.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRichContent(): string;'
- return:
- type: string
- description: ''
- - name: setContent(content)
- uid: 'ExcelScript!ExcelScript.CommentReply#setContent:member(1)'
- package: ExcelScript!
- fullName: setContent(content)
- summary: The comment reply's content. The string is plain text.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setContent(content: string): void;'
- parameters:
- - id: content
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: updateMentions(contentWithMentions)
- uid: 'ExcelScript!ExcelScript.CommentReply#updateMentions:member(1)'
- package: ExcelScript!
- fullName: updateMentions(contentWithMentions)
- summary: Updates the comment content with a specially formatted string and a list of mentions.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'updateMentions(contentWithMentions: CommentRichContent): void;'
- parameters:
- - id: contentWithMentions
- description: >-
- The content for the comment. This contains a specially formatted string and a list of mentions that will be
- parsed into the string when displayed by Excel.
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.CommentReply
+uid: 'ExcelScript!ExcelScript.CommentReply:interface'
+package: ExcelScript!
+fullName: ExcelScript.CommentReply
+summary: Represents a comment reply in the workbook.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.CommentReply#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: Deletes the comment reply.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getAuthorEmail()
+ uid: 'ExcelScript!ExcelScript.CommentReply#getAuthorEmail:member(1)'
+ package: ExcelScript!
+ fullName: getAuthorEmail()
+ summary: Gets the email of the comment reply's author.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAuthorEmail(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getAuthorName()
+ uid: 'ExcelScript!ExcelScript.CommentReply#getAuthorName:member(1)'
+ package: ExcelScript!
+ fullName: getAuthorName()
+ summary: Gets the name of the comment reply's author.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAuthorName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getContent()
+ uid: 'ExcelScript!ExcelScript.CommentReply#getContent:member(1)'
+ package: ExcelScript!
+ fullName: getContent()
+ summary: The comment reply's content. The string is plain text.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getContent(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getContentType()
+ uid: 'ExcelScript!ExcelScript.CommentReply#getContentType:member(1)'
+ package: ExcelScript!
+ fullName: getContentType()
+ summary: The content type of the reply.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getContentType(): ContentType;'
+ return:
+ type: ''
+ description: ''
+ - name: getCreationDate()
+ uid: 'ExcelScript!ExcelScript.CommentReply#getCreationDate:member(1)'
+ package: ExcelScript!
+ fullName: getCreationDate()
+ summary: Gets the creation time of the comment reply.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCreationDate(): Date;'
+ return:
+ type: Date
+ description: ''
+ - name: getId()
+ uid: 'ExcelScript!ExcelScript.CommentReply#getId:member(1)'
+ package: ExcelScript!
+ fullName: getId()
+ summary: Specifies the comment reply identifier.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getId(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getLocation()
+ uid: 'ExcelScript!ExcelScript.CommentReply#getLocation:member(1)'
+ package: ExcelScript!
+ fullName: getLocation()
+ summary: Gets the cell where this comment reply is located.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLocation(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getMentions()
+ uid: 'ExcelScript!ExcelScript.CommentReply#getMentions:member(1)'
+ package: ExcelScript!
+ fullName: getMentions()
+ summary: 'The entities (e.g., people) that are mentioned in comments.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMentions(): CommentMention[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getParentComment()
+ uid: 'ExcelScript!ExcelScript.CommentReply#getParentComment:member(1)'
+ package: ExcelScript!
+ fullName: getParentComment()
+ summary: Gets the parent comment of this reply.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getParentComment(): Comment;'
+ return:
+ type: ''
+ description: ''
+ - name: getResolved()
+ uid: 'ExcelScript!ExcelScript.CommentReply#getResolved:member(1)'
+ package: ExcelScript!
+ fullName: getResolved()
+ summary: The comment reply status. A value of `true` means the reply is in the resolved state.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getResolved(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getRichContent()
+ uid: 'ExcelScript!ExcelScript.CommentReply#getRichContent:member(1)'
+ package: ExcelScript!
+ fullName: getRichContent()
+ summary: >-
+ The rich comment content (e.g., mentions in comments). This string is not meant to be displayed to end-users. Your
+ add-in should only use this to parse rich comment content.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRichContent(): string;'
+ return:
+ type: string
+ description: ''
+ - name: setContent(content)
+ uid: 'ExcelScript!ExcelScript.CommentReply#setContent:member(1)'
+ package: ExcelScript!
+ fullName: setContent(content)
+ summary: The comment reply's content. The string is plain text.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setContent(content: string): void;'
+ parameters:
+ - id: content
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: updateMentions(contentWithMentions)
+ uid: 'ExcelScript!ExcelScript.CommentReply#updateMentions:member(1)'
+ package: ExcelScript!
+ fullName: updateMentions(contentWithMentions)
+ summary: Updates the comment content with a specially formatted string and a list of mentions.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'updateMentions(contentWithMentions: CommentRichContent): void;'
+ parameters:
+ - id: contentWithMentions
+ description: >-
+ The content for the comment. This contains a specially formatted string and a list of mentions that will be
+ parsed into the string when displayed by Excel.
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.commentrichcontent.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.commentrichcontent.yml
index b9331f5b..ee244cae 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.commentrichcontent.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.commentrichcontent.yml
@@ -1,113 +1,113 @@
-### YamlMime:TSType
-name: ExcelScript.CommentRichContent
-uid: 'ExcelScript!ExcelScript.CommentRichContent:interface'
-package: ExcelScript!
-fullName: ExcelScript.CommentRichContent
-summary: >-
- 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.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: mentions
- uid: 'ExcelScript!ExcelScript.CommentRichContent#mentions:member'
- package: ExcelScript!
- fullName: mentions
- summary: 'An array containing all the entities (e.g., people) mentioned within the comment.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'mentions?: CommentMention[];'
- return:
- type: '[]'
- - name: richContent
- uid: 'ExcelScript!ExcelScript.CommentRichContent#richContent:member'
- package: ExcelScript!
- fullName: richContent
- summary: >-
- Specifies the rich content of the comment (e.g., comment content with mentions, the first mentioned entity has an
- ID attribute of 0, and the second mentioned entity has an ID attribute of 1).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'richContent: string;'
- return:
- type: string
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample finds overdue work items in a table and
- * lets their owners know with a comment that uses an @mention.
- *
- * This assumes the worksheet has a table with the columns:
- * "Work Item", "Project", "Owner", "Due Date"
- */
- function main(workbook: ExcelScript.Workbook) {
- let currentSheet = workbook.getActiveWorksheet();
-
- // Get the "Owner" column range and values.
- let table = currentSheet.getTables()[0];
- let ownerColumnRange = table.getColumn("Owner").getRangeBetweenHeaderAndTotal();
- let ownerColumnValues = ownerColumnRange.getValues();
-
- // Get the "Due Date" column range and values.
- let dueDateColumnRange = table.getColumn("Due Date").getRangeBetweenHeaderAndTotal();
- let dueDateColumnValues = dueDateColumnRange.getValues();
-
- // Look for overdue work items.
- for (let row = 0; row < dueDateColumnValues.length; row++) {
-
- /* Convert the Excel date into a JavaScript date.
- * This is necessary because Excel and JavaScript store
- * their dates as different numerical values.
- */
- let dueDate = new Date(Math.round((dueDateColumnValues[row][0] as number - 25569) * 86400 * 1000));
-
- // Check if the current date is greater than the due date.
- if (Date.now() > dueDate.valueOf()) {
-
- /* Create a CommentMention object for the comment,
- * based on the work item's owner.
- *
- * A CommentMention's properties are:
- * `name`: The name of the person being mentioned.
- * `id`: The index of this mention in the comment.
- * `email`: The email address of the person being mentioned.
- * In this sample, "Owner: is also the user name for the email.
- */
- let mention = {
- name: ownerColumnValues[row][0].toString(),
- id: 0,
- email: ownerColumnValues[row][0] + "@contoso.com"
- };
-
- /* Create the comment.
- * The `` syntax embeds the mention in the comment text.
- * The name is displayed in the comment,
- * while an email is sent to the given address.
- *
- * The addComment parameters are:
- * `cellAddress`: The location of the comment.
- * `content`: The text of the comment and any embedded mentions.
- * `contentType`: The type of comment ("Mention" or "Plain").
- */
- currentSheet.addComment(
- dueDateColumnRange.getCell(row, 0),
- {
- richContent: '' + mention.name + " - Your work item is overdue.",
- mentions: [mention]
- },
- ExcelScript.ContentType.mention
- );
- }
- }
- }
- ```
+### YamlMime:TSType
+name: ExcelScript.CommentRichContent
+uid: 'ExcelScript!ExcelScript.CommentRichContent:interface'
+package: ExcelScript!
+fullName: ExcelScript.CommentRichContent
+summary: >-
+ 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.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: mentions
+ uid: 'ExcelScript!ExcelScript.CommentRichContent#mentions:member'
+ package: ExcelScript!
+ fullName: mentions
+ summary: 'An array containing all the entities (e.g., people) mentioned within the comment.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'mentions?: CommentMention[];'
+ return:
+ type: '[]'
+ - name: richContent
+ uid: 'ExcelScript!ExcelScript.CommentRichContent#richContent:member'
+ package: ExcelScript!
+ fullName: richContent
+ summary: >-
+ Specifies the rich content of the comment (e.g., comment content with mentions, the first mentioned entity has an
+ ID attribute of 0, and the second mentioned entity has an ID attribute of 1).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'richContent: string;'
+ return:
+ type: string
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample finds overdue work items in a table and
+ * lets their owners know with a comment that uses an @mention.
+ *
+ * This assumes the worksheet has a table with the columns:
+ * "Work Item", "Project", "Owner", "Due Date"
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ let currentSheet = workbook.getActiveWorksheet();
+
+ // Get the "Owner" column range and values.
+ let table = currentSheet.getTables()[0];
+ let ownerColumnRange = table.getColumn("Owner").getRangeBetweenHeaderAndTotal();
+ let ownerColumnValues = ownerColumnRange.getValues();
+
+ // Get the "Due Date" column range and values.
+ let dueDateColumnRange = table.getColumn("Due Date").getRangeBetweenHeaderAndTotal();
+ let dueDateColumnValues = dueDateColumnRange.getValues();
+
+ // Look for overdue work items.
+ for (let row = 0; row < dueDateColumnValues.length; row++) {
+
+ /* Convert the Excel date into a JavaScript date.
+ * This is necessary because Excel and JavaScript store
+ * their dates as different numerical values.
+ */
+ let dueDate = new Date(Math.round((dueDateColumnValues[row][0] as number - 25569) * 86400 * 1000));
+
+ // Check if the current date is greater than the due date.
+ if (Date.now() > dueDate.valueOf()) {
+
+ /* Create a CommentMention object for the comment,
+ * based on the work item's owner.
+ *
+ * A CommentMention's properties are:
+ * `name`: The name of the person being mentioned.
+ * `id`: The index of this mention in the comment.
+ * `email`: The email address of the person being mentioned.
+ * In this sample, "Owner: is also the user name for the email.
+ */
+ let mention = {
+ name: ownerColumnValues[row][0].toString(),
+ id: 0,
+ email: ownerColumnValues[row][0] + "@contoso.com"
+ };
+
+ /* Create the comment.
+ * The `` syntax embeds the mention in the comment text.
+ * The name is displayed in the comment,
+ * while an email is sent to the given address.
+ *
+ * The addComment parameters are:
+ * `cellAddress`: The location of the comment.
+ * `content`: The text of the comment and any embedded mentions.
+ * `contentType`: The type of comment ("Mention" or "Plain").
+ */
+ currentSheet.addComment(
+ dueDateColumnRange.getCell(row, 0),
+ {
+ richContent: '' + mention.name + " - Your work item is overdue.",
+ mentions: [mention]
+ },
+ ExcelScript.ContentType.mention
+ );
+ }
+ }
+ }
+ ```
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalcellvalueoperator.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalcellvalueoperator.yml
index dd073589..55bd3cc4 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalcellvalueoperator.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalcellvalueoperator.yml
@@ -1,79 +1,79 @@
-### YamlMime:TSEnum
-name: ExcelScript.ConditionalCellValueOperator
-uid: 'ExcelScript!ExcelScript.ConditionalCellValueOperator:enum'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalCellValueOperator
-summary: Represents the operator of the text conditional format type.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies conditional formatting to a range.
- * That formatting is conditional upon the cell's numerical value.
- * Any value between 50 and 75 will have the cell fill color changed and the font made italic.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range to format.
- const sheet = workbook.getActiveWorksheet();
- const ratingColumn = sheet.getRange("D2:D20");
-
- // Add cell value conditional formatting.
- const cellValueConditionalFormatting =
- ratingColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.cellValue).getCellValue();
-
- // Set the format to apply when the condition is met.
- let format = cellValueConditionalFormatting.getFormat();
- format.getFill().setColor("yellow");
- format.getFont().setItalic(true);
-
- // Create the condition, in this case when the cell value is between 50 and 75.
- let rule: ExcelScript.ConditionalCellValueRule = {
- formula1: "50",
- formula2: "75",
- operator: ExcelScript.ConditionalCellValueOperator.between
- };
- cellValueConditionalFormatting.setRule(rule);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: between
- uid: 'ExcelScript!ExcelScript.ConditionalCellValueOperator.between:member'
- package: ExcelScript!
- summary: ''
- - name: equalTo
- uid: 'ExcelScript!ExcelScript.ConditionalCellValueOperator.equalTo:member'
- package: ExcelScript!
- summary: ''
- - name: greaterThan
- uid: 'ExcelScript!ExcelScript.ConditionalCellValueOperator.greaterThan:member'
- package: ExcelScript!
- summary: ''
- - name: greaterThanOrEqual
- uid: 'ExcelScript!ExcelScript.ConditionalCellValueOperator.greaterThanOrEqual:member'
- package: ExcelScript!
- summary: ''
- - name: invalid
- uid: 'ExcelScript!ExcelScript.ConditionalCellValueOperator.invalid:member'
- package: ExcelScript!
- summary: ''
- - name: lessThan
- uid: 'ExcelScript!ExcelScript.ConditionalCellValueOperator.lessThan:member'
- package: ExcelScript!
- summary: ''
- - name: lessThanOrEqual
- uid: 'ExcelScript!ExcelScript.ConditionalCellValueOperator.lessThanOrEqual:member'
- package: ExcelScript!
- summary: ''
- - name: notBetween
- uid: 'ExcelScript!ExcelScript.ConditionalCellValueOperator.notBetween:member'
- package: ExcelScript!
- summary: ''
- - name: notEqualTo
- uid: 'ExcelScript!ExcelScript.ConditionalCellValueOperator.notEqualTo:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ConditionalCellValueOperator
+uid: 'ExcelScript!ExcelScript.ConditionalCellValueOperator:enum'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalCellValueOperator
+summary: Represents the operator of the text conditional format type.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies conditional formatting to a range.
+ * That formatting is conditional upon the cell's numerical value.
+ * Any value between 50 and 75 will have the cell fill color changed and the font made italic.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range to format.
+ const sheet = workbook.getActiveWorksheet();
+ const ratingColumn = sheet.getRange("D2:D20");
+
+ // Add cell value conditional formatting.
+ const cellValueConditionalFormatting =
+ ratingColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.cellValue).getCellValue();
+
+ // Set the format to apply when the condition is met.
+ let format = cellValueConditionalFormatting.getFormat();
+ format.getFill().setColor("yellow");
+ format.getFont().setItalic(true);
+
+ // Create the condition, in this case when the cell value is between 50 and 75.
+ let rule: ExcelScript.ConditionalCellValueRule = {
+ formula1: "50",
+ formula2: "75",
+ operator: ExcelScript.ConditionalCellValueOperator.between
+ };
+ cellValueConditionalFormatting.setRule(rule);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: between
+ uid: 'ExcelScript!ExcelScript.ConditionalCellValueOperator.between:member'
+ package: ExcelScript!
+ summary: ''
+ - name: equalTo
+ uid: 'ExcelScript!ExcelScript.ConditionalCellValueOperator.equalTo:member'
+ package: ExcelScript!
+ summary: ''
+ - name: greaterThan
+ uid: 'ExcelScript!ExcelScript.ConditionalCellValueOperator.greaterThan:member'
+ package: ExcelScript!
+ summary: ''
+ - name: greaterThanOrEqual
+ uid: 'ExcelScript!ExcelScript.ConditionalCellValueOperator.greaterThanOrEqual:member'
+ package: ExcelScript!
+ summary: ''
+ - name: invalid
+ uid: 'ExcelScript!ExcelScript.ConditionalCellValueOperator.invalid:member'
+ package: ExcelScript!
+ summary: ''
+ - name: lessThan
+ uid: 'ExcelScript!ExcelScript.ConditionalCellValueOperator.lessThan:member'
+ package: ExcelScript!
+ summary: ''
+ - name: lessThanOrEqual
+ uid: 'ExcelScript!ExcelScript.ConditionalCellValueOperator.lessThanOrEqual:member'
+ package: ExcelScript!
+ summary: ''
+ - name: notBetween
+ uid: 'ExcelScript!ExcelScript.ConditionalCellValueOperator.notBetween:member'
+ package: ExcelScript!
+ summary: ''
+ - name: notEqualTo
+ uid: 'ExcelScript!ExcelScript.ConditionalCellValueOperator.notEqualTo:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalcellvaluerule.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalcellvaluerule.yml
index 8fd794dc..74cde76c 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalcellvaluerule.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalcellvaluerule.yml
@@ -1,80 +1,80 @@
-### YamlMime:TSType
-name: ExcelScript.ConditionalCellValueRule
-uid: 'ExcelScript!ExcelScript.ConditionalCellValueRule:interface'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalCellValueRule
-summary: Represents a cell value conditional format rule.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies conditional formatting to a range.
- * That formatting is conditional upon the cell's numerical value.
- * Any value between 50 and 75 will have the cell fill color changed and the font made italic.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range to format.
- const sheet = workbook.getActiveWorksheet();
- const ratingColumn = sheet.getRange("D2:D20");
-
- // Add cell value conditional formatting.
- const cellValueConditionalFormatting =
- ratingColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.cellValue).getCellValue();
-
- // Create the condition, in this case when the cell value is between 50 and 75.
- let rule: ExcelScript.ConditionalCellValueRule = {
- formula1: "50",
- formula2: "75",
- operator: ExcelScript.ConditionalCellValueOperator.between
- };
- cellValueConditionalFormatting.setRule(rule);
-
- // Set the format to apply when the condition is met.
- let format = cellValueConditionalFormatting.getFormat();
- format.getFill().setColor("yellow");
- format.getFont().setItalic(true);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: formula1
- uid: 'ExcelScript!ExcelScript.ConditionalCellValueRule#formula1:member'
- package: ExcelScript!
- fullName: formula1
- summary: 'The formula, if required, on which to evaluate the conditional format rule.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'formula1: string;'
- return:
- type: string
- - name: formula2
- uid: 'ExcelScript!ExcelScript.ConditionalCellValueRule#formula2:member'
- package: ExcelScript!
- fullName: formula2
- summary: 'The formula, if required, on which to evaluate the conditional format rule.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'formula2?: string;'
- return:
- type: string
- - name: operator
- uid: 'ExcelScript!ExcelScript.ConditionalCellValueRule#operator:member'
- package: ExcelScript!
- fullName: operator
- summary: The operator of the cell value conditional format.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'operator: ConditionalCellValueOperator;'
- return:
- type: ''
+### YamlMime:TSType
+name: ExcelScript.ConditionalCellValueRule
+uid: 'ExcelScript!ExcelScript.ConditionalCellValueRule:interface'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalCellValueRule
+summary: Represents a cell value conditional format rule.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies conditional formatting to a range.
+ * That formatting is conditional upon the cell's numerical value.
+ * Any value between 50 and 75 will have the cell fill color changed and the font made italic.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range to format.
+ const sheet = workbook.getActiveWorksheet();
+ const ratingColumn = sheet.getRange("D2:D20");
+
+ // Add cell value conditional formatting.
+ const cellValueConditionalFormatting =
+ ratingColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.cellValue).getCellValue();
+
+ // Create the condition, in this case when the cell value is between 50 and 75.
+ let rule: ExcelScript.ConditionalCellValueRule = {
+ formula1: "50",
+ formula2: "75",
+ operator: ExcelScript.ConditionalCellValueOperator.between
+ };
+ cellValueConditionalFormatting.setRule(rule);
+
+ // Set the format to apply when the condition is met.
+ let format = cellValueConditionalFormatting.getFormat();
+ format.getFill().setColor("yellow");
+ format.getFont().setItalic(true);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: formula1
+ uid: 'ExcelScript!ExcelScript.ConditionalCellValueRule#formula1:member'
+ package: ExcelScript!
+ fullName: formula1
+ summary: 'The formula, if required, on which to evaluate the conditional format rule.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'formula1: string;'
+ return:
+ type: string
+ - name: formula2
+ uid: 'ExcelScript!ExcelScript.ConditionalCellValueRule#formula2:member'
+ package: ExcelScript!
+ fullName: formula2
+ summary: 'The formula, if required, on which to evaluate the conditional format rule.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'formula2?: string;'
+ return:
+ type: string
+ - name: operator
+ uid: 'ExcelScript!ExcelScript.ConditionalCellValueRule#operator:member'
+ package: ExcelScript!
+ fullName: operator
+ summary: The operator of the cell value conditional format.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'operator: ConditionalCellValueOperator;'
+ return:
+ type: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalcolorscalecriteria.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalcolorscalecriteria.yml
index 9fd2c7f5..2fb8e6b9 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalcolorscalecriteria.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalcolorscalecriteria.yml
@@ -1,47 +1,47 @@
-### YamlMime:TSType
-name: ExcelScript.ConditionalColorScaleCriteria
-uid: 'ExcelScript!ExcelScript.ConditionalColorScaleCriteria:interface'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalColorScaleCriteria
-summary: Represents the criteria of the color scale.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: maximum
- uid: 'ExcelScript!ExcelScript.ConditionalColorScaleCriteria#maximum:member'
- package: ExcelScript!
- fullName: maximum
- summary: The maximum point of the color scale criterion.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'maximum: ConditionalColorScaleCriterion;'
- return:
- type: ''
- - name: midpoint
- uid: 'ExcelScript!ExcelScript.ConditionalColorScaleCriteria#midpoint:member'
- package: ExcelScript!
- fullName: midpoint
- summary: 'The midpoint of the color scale criterion, if the color scale is a 3-color scale.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'midpoint?: ConditionalColorScaleCriterion;'
- return:
- type: ''
- - name: minimum
- uid: 'ExcelScript!ExcelScript.ConditionalColorScaleCriteria#minimum:member'
- package: ExcelScript!
- fullName: minimum
- summary: The minimum point of the color scale criterion.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'minimum: ConditionalColorScaleCriterion;'
- return:
- type: ''
+### YamlMime:TSType
+name: ExcelScript.ConditionalColorScaleCriteria
+uid: 'ExcelScript!ExcelScript.ConditionalColorScaleCriteria:interface'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalColorScaleCriteria
+summary: Represents the criteria of the color scale.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: maximum
+ uid: 'ExcelScript!ExcelScript.ConditionalColorScaleCriteria#maximum:member'
+ package: ExcelScript!
+ fullName: maximum
+ summary: The maximum point of the color scale criterion.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'maximum: ConditionalColorScaleCriterion;'
+ return:
+ type: ''
+ - name: midpoint
+ uid: 'ExcelScript!ExcelScript.ConditionalColorScaleCriteria#midpoint:member'
+ package: ExcelScript!
+ fullName: midpoint
+ summary: 'The midpoint of the color scale criterion, if the color scale is a 3-color scale.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'midpoint?: ConditionalColorScaleCriterion;'
+ return:
+ type: ''
+ - name: minimum
+ uid: 'ExcelScript!ExcelScript.ConditionalColorScaleCriteria#minimum:member'
+ package: ExcelScript!
+ fullName: minimum
+ summary: The minimum point of the color scale criterion.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'minimum: ConditionalColorScaleCriterion;'
+ return:
+ type: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalcolorscalecriterion.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalcolorscalecriterion.yml
index 790abae8..e120a54e 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalcolorscalecriterion.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalcolorscalecriterion.yml
@@ -1,47 +1,47 @@
-### YamlMime:TSType
-name: ExcelScript.ConditionalColorScaleCriterion
-uid: 'ExcelScript!ExcelScript.ConditionalColorScaleCriterion:interface'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalColorScaleCriterion
-summary: 'Represents a color scale criterion which contains a type, value, and a color.'
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: color
- uid: 'ExcelScript!ExcelScript.ConditionalColorScaleCriterion#color:member'
- package: ExcelScript!
- fullName: color
- summary: 'HTML color code representation of the color scale color (e.g., \#FF0000 represents Red).'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'color?: string;'
- return:
- type: string
- - name: formula
- uid: 'ExcelScript!ExcelScript.ConditionalColorScaleCriterion#formula:member'
- package: ExcelScript!
- fullName: formula
- summary: 'A number, a formula, or `null` (if `type` is `lowestValue`).'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'formula?: string;'
- return:
- type: string
- - name: type
- uid: 'ExcelScript!ExcelScript.ConditionalColorScaleCriterion#type:member'
- package: ExcelScript!
- fullName: type
- summary: What the criterion conditional formula should be based on.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'type: ConditionalFormatColorCriterionType;'
- return:
- type: ''
+### YamlMime:TSType
+name: ExcelScript.ConditionalColorScaleCriterion
+uid: 'ExcelScript!ExcelScript.ConditionalColorScaleCriterion:interface'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalColorScaleCriterion
+summary: 'Represents a color scale criterion which contains a type, value, and a color.'
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: color
+ uid: 'ExcelScript!ExcelScript.ConditionalColorScaleCriterion#color:member'
+ package: ExcelScript!
+ fullName: color
+ summary: 'HTML color code representation of the color scale color (e.g., \#FF0000 represents Red).'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'color?: string;'
+ return:
+ type: string
+ - name: formula
+ uid: 'ExcelScript!ExcelScript.ConditionalColorScaleCriterion#formula:member'
+ package: ExcelScript!
+ fullName: formula
+ summary: 'A number, a formula, or `null` (if `type` is `lowestValue`).'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'formula?: string;'
+ return:
+ type: string
+ - name: type
+ uid: 'ExcelScript!ExcelScript.ConditionalColorScaleCriterion#type:member'
+ package: ExcelScript!
+ fullName: type
+ summary: What the criterion conditional formula should be based on.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'type: ConditionalFormatColorCriterionType;'
+ return:
+ type: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaldatabaraxisformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaldatabaraxisformat.yml
index 0aad1d7f..814c4d0b 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaldatabaraxisformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaldatabaraxisformat.yml
@@ -1,22 +1,22 @@
-### YamlMime:TSEnum
-name: ExcelScript.ConditionalDataBarAxisFormat
-uid: 'ExcelScript!ExcelScript.ConditionalDataBarAxisFormat:enum'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalDataBarAxisFormat
-summary: Represents the format options for a data bar axis.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: automatic
- uid: 'ExcelScript!ExcelScript.ConditionalDataBarAxisFormat.automatic:member'
- package: ExcelScript!
- summary: ''
- - name: cellMidPoint
- uid: 'ExcelScript!ExcelScript.ConditionalDataBarAxisFormat.cellMidPoint:member'
- package: ExcelScript!
- summary: ''
- - name: none
- uid: 'ExcelScript!ExcelScript.ConditionalDataBarAxisFormat.none:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ConditionalDataBarAxisFormat
+uid: 'ExcelScript!ExcelScript.ConditionalDataBarAxisFormat:enum'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalDataBarAxisFormat
+summary: Represents the format options for a data bar axis.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: automatic
+ uid: 'ExcelScript!ExcelScript.ConditionalDataBarAxisFormat.automatic:member'
+ package: ExcelScript!
+ summary: ''
+ - name: cellMidPoint
+ uid: 'ExcelScript!ExcelScript.ConditionalDataBarAxisFormat.cellMidPoint:member'
+ package: ExcelScript!
+ summary: ''
+ - name: none
+ uid: 'ExcelScript!ExcelScript.ConditionalDataBarAxisFormat.none:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaldatabardirection.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaldatabardirection.yml
index 2b8e84cd..34e5105d 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaldatabardirection.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaldatabardirection.yml
@@ -1,22 +1,22 @@
-### YamlMime:TSEnum
-name: ExcelScript.ConditionalDataBarDirection
-uid: 'ExcelScript!ExcelScript.ConditionalDataBarDirection:enum'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalDataBarDirection
-summary: Represents the data bar direction within a cell.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: context
- uid: 'ExcelScript!ExcelScript.ConditionalDataBarDirection.context:member'
- package: ExcelScript!
- summary: ''
- - name: leftToRight
- uid: 'ExcelScript!ExcelScript.ConditionalDataBarDirection.leftToRight:member'
- package: ExcelScript!
- summary: ''
- - name: rightToLeft
- uid: 'ExcelScript!ExcelScript.ConditionalDataBarDirection.rightToLeft:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ConditionalDataBarDirection
+uid: 'ExcelScript!ExcelScript.ConditionalDataBarDirection:enum'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalDataBarDirection
+summary: Represents the data bar direction within a cell.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: context
+ uid: 'ExcelScript!ExcelScript.ConditionalDataBarDirection.context:member'
+ package: ExcelScript!
+ summary: ''
+ - name: leftToRight
+ uid: 'ExcelScript!ExcelScript.ConditionalDataBarDirection.leftToRight:member'
+ package: ExcelScript!
+ summary: ''
+ - name: rightToLeft
+ uid: 'ExcelScript!ExcelScript.ConditionalDataBarDirection.rightToLeft:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaldatabarnegativeformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaldatabarnegativeformat.yml
index f3733f01..700c385c 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaldatabarnegativeformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaldatabarnegativeformat.yml
@@ -1,139 +1,139 @@
-### YamlMime:TSType
-name: ExcelScript.ConditionalDataBarNegativeFormat
-uid: 'ExcelScript!ExcelScript.ConditionalDataBarNegativeFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalDataBarNegativeFormat
-summary: Represents a conditional format for the negative side of the data bar.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getBorderColor()
- uid: 'ExcelScript!ExcelScript.ConditionalDataBarNegativeFormat#getBorderColor:member(1)'
- package: ExcelScript!
- fullName: getBorderColor()
- summary: >-
- HTML color code representing the color of the border line, in the form \#RRGGBB (e.g., "FFA500") or as a named
- HTML color (e.g., "orange"). Value is "" (an empty string) if no border is present or set.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBorderColor(): string;'
- return:
- type: string
- description: ''
- - name: getFillColor()
- uid: 'ExcelScript!ExcelScript.ConditionalDataBarNegativeFormat#getFillColor:member(1)'
- package: ExcelScript!
- fullName: getFillColor()
- summary: >-
- HTML color code representing the fill color, in the form \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g.,
- "orange").
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFillColor(): string;'
- return:
- type: string
- description: ''
- - name: getMatchPositiveBorderColor()
- uid: 'ExcelScript!ExcelScript.ConditionalDataBarNegativeFormat#getMatchPositiveBorderColor:member(1)'
- package: ExcelScript!
- fullName: getMatchPositiveBorderColor()
- summary: Specifies if the negative data bar has the same border color as the positive data bar.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMatchPositiveBorderColor(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getMatchPositiveFillColor()
- uid: 'ExcelScript!ExcelScript.ConditionalDataBarNegativeFormat#getMatchPositiveFillColor:member(1)'
- package: ExcelScript!
- fullName: getMatchPositiveFillColor()
- summary: Specifies if the negative data bar has the same fill color as the positive data bar.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMatchPositiveFillColor(): boolean;'
- return:
- type: boolean
- description: ''
- - name: setBorderColor(borderColor)
- uid: 'ExcelScript!ExcelScript.ConditionalDataBarNegativeFormat#setBorderColor:member(1)'
- package: ExcelScript!
- fullName: setBorderColor(borderColor)
- summary: >-
- HTML color code representing the color of the border line, in the form \#RRGGBB (e.g., "FFA500") or as a named
- HTML color (e.g., "orange"). Value is "" (an empty string) if no border is present or set.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setBorderColor(borderColor: string): void;'
- parameters:
- - id: borderColor
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setFillColor(fillColor)
- uid: 'ExcelScript!ExcelScript.ConditionalDataBarNegativeFormat#setFillColor:member(1)'
- package: ExcelScript!
- fullName: setFillColor(fillColor)
- summary: >-
- HTML color code representing the fill color, in the form \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g.,
- "orange").
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFillColor(fillColor: string): void;'
- parameters:
- - id: fillColor
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setMatchPositiveBorderColor(matchPositiveBorderColor)
- uid: 'ExcelScript!ExcelScript.ConditionalDataBarNegativeFormat#setMatchPositiveBorderColor:member(1)'
- package: ExcelScript!
- fullName: setMatchPositiveBorderColor(matchPositiveBorderColor)
- summary: Specifies if the negative data bar has the same border color as the positive data bar.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMatchPositiveBorderColor(matchPositiveBorderColor: boolean): void;'
- parameters:
- - id: matchPositiveBorderColor
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setMatchPositiveFillColor(matchPositiveFillColor)
- uid: 'ExcelScript!ExcelScript.ConditionalDataBarNegativeFormat#setMatchPositiveFillColor:member(1)'
- package: ExcelScript!
- fullName: setMatchPositiveFillColor(matchPositiveFillColor)
- summary: Specifies if the negative data bar has the same fill color as the positive data bar.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMatchPositiveFillColor(matchPositiveFillColor: boolean): void;'
- parameters:
- - id: matchPositiveFillColor
- description: ''
- type: boolean
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ConditionalDataBarNegativeFormat
+uid: 'ExcelScript!ExcelScript.ConditionalDataBarNegativeFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalDataBarNegativeFormat
+summary: Represents a conditional format for the negative side of the data bar.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getBorderColor()
+ uid: 'ExcelScript!ExcelScript.ConditionalDataBarNegativeFormat#getBorderColor:member(1)'
+ package: ExcelScript!
+ fullName: getBorderColor()
+ summary: >-
+ HTML color code representing the color of the border line, in the form \#RRGGBB (e.g., "FFA500") or as a named
+ HTML color (e.g., "orange"). Value is "" (an empty string) if no border is present or set.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBorderColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getFillColor()
+ uid: 'ExcelScript!ExcelScript.ConditionalDataBarNegativeFormat#getFillColor:member(1)'
+ package: ExcelScript!
+ fullName: getFillColor()
+ summary: >-
+ HTML color code representing the fill color, in the form \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g.,
+ "orange").
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFillColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getMatchPositiveBorderColor()
+ uid: 'ExcelScript!ExcelScript.ConditionalDataBarNegativeFormat#getMatchPositiveBorderColor:member(1)'
+ package: ExcelScript!
+ fullName: getMatchPositiveBorderColor()
+ summary: Specifies if the negative data bar has the same border color as the positive data bar.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMatchPositiveBorderColor(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getMatchPositiveFillColor()
+ uid: 'ExcelScript!ExcelScript.ConditionalDataBarNegativeFormat#getMatchPositiveFillColor:member(1)'
+ package: ExcelScript!
+ fullName: getMatchPositiveFillColor()
+ summary: Specifies if the negative data bar has the same fill color as the positive data bar.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMatchPositiveFillColor(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: setBorderColor(borderColor)
+ uid: 'ExcelScript!ExcelScript.ConditionalDataBarNegativeFormat#setBorderColor:member(1)'
+ package: ExcelScript!
+ fullName: setBorderColor(borderColor)
+ summary: >-
+ HTML color code representing the color of the border line, in the form \#RRGGBB (e.g., "FFA500") or as a named
+ HTML color (e.g., "orange"). Value is "" (an empty string) if no border is present or set.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setBorderColor(borderColor: string): void;'
+ parameters:
+ - id: borderColor
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setFillColor(fillColor)
+ uid: 'ExcelScript!ExcelScript.ConditionalDataBarNegativeFormat#setFillColor:member(1)'
+ package: ExcelScript!
+ fullName: setFillColor(fillColor)
+ summary: >-
+ HTML color code representing the fill color, in the form \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g.,
+ "orange").
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFillColor(fillColor: string): void;'
+ parameters:
+ - id: fillColor
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setMatchPositiveBorderColor(matchPositiveBorderColor)
+ uid: 'ExcelScript!ExcelScript.ConditionalDataBarNegativeFormat#setMatchPositiveBorderColor:member(1)'
+ package: ExcelScript!
+ fullName: setMatchPositiveBorderColor(matchPositiveBorderColor)
+ summary: Specifies if the negative data bar has the same border color as the positive data bar.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMatchPositiveBorderColor(matchPositiveBorderColor: boolean): void;'
+ parameters:
+ - id: matchPositiveBorderColor
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setMatchPositiveFillColor(matchPositiveFillColor)
+ uid: 'ExcelScript!ExcelScript.ConditionalDataBarNegativeFormat#setMatchPositiveFillColor:member(1)'
+ package: ExcelScript!
+ fullName: setMatchPositiveFillColor(matchPositiveFillColor)
+ summary: Specifies if the negative data bar has the same fill color as the positive data bar.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMatchPositiveFillColor(matchPositiveFillColor: boolean): void;'
+ parameters:
+ - id: matchPositiveFillColor
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaldatabarpositiveformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaldatabarpositiveformat.yml
index 990b0f19..50a201e7 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaldatabarpositiveformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaldatabarpositiveformat.yml
@@ -1,109 +1,109 @@
-### YamlMime:TSType
-name: ExcelScript.ConditionalDataBarPositiveFormat
-uid: 'ExcelScript!ExcelScript.ConditionalDataBarPositiveFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalDataBarPositiveFormat
-summary: Represents a conditional format for the positive side of the data bar.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getBorderColor()
- uid: 'ExcelScript!ExcelScript.ConditionalDataBarPositiveFormat#getBorderColor:member(1)'
- package: ExcelScript!
- fullName: getBorderColor()
- summary: >-
- HTML color code representing the color of the border line, in the form \#RRGGBB (e.g., "FFA500") or as a named
- HTML color (e.g., "orange"). Value is "" (an empty string) if no border is present or set.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBorderColor(): string;'
- return:
- type: string
- description: ''
- - name: getFillColor()
- uid: 'ExcelScript!ExcelScript.ConditionalDataBarPositiveFormat#getFillColor:member(1)'
- package: ExcelScript!
- fullName: getFillColor()
- summary: >-
- HTML color code representing the fill color, in the form \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g.,
- "orange").
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFillColor(): string;'
- return:
- type: string
- description: ''
- - name: getGradientFill()
- uid: 'ExcelScript!ExcelScript.ConditionalDataBarPositiveFormat#getGradientFill:member(1)'
- package: ExcelScript!
- fullName: getGradientFill()
- summary: Specifies if the data bar has a gradient.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGradientFill(): boolean;'
- return:
- type: boolean
- description: ''
- - name: setBorderColor(borderColor)
- uid: 'ExcelScript!ExcelScript.ConditionalDataBarPositiveFormat#setBorderColor:member(1)'
- package: ExcelScript!
- fullName: setBorderColor(borderColor)
- summary: >-
- HTML color code representing the color of the border line, in the form \#RRGGBB (e.g., "FFA500") or as a named
- HTML color (e.g., "orange"). Value is "" (an empty string) if no border is present or set.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setBorderColor(borderColor: string): void;'
- parameters:
- - id: borderColor
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setFillColor(fillColor)
- uid: 'ExcelScript!ExcelScript.ConditionalDataBarPositiveFormat#setFillColor:member(1)'
- package: ExcelScript!
- fullName: setFillColor(fillColor)
- summary: >-
- HTML color code representing the fill color, in the form \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g.,
- "orange").
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFillColor(fillColor: string): void;'
- parameters:
- - id: fillColor
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setGradientFill(gradientFill)
- uid: 'ExcelScript!ExcelScript.ConditionalDataBarPositiveFormat#setGradientFill:member(1)'
- package: ExcelScript!
- fullName: setGradientFill(gradientFill)
- summary: Specifies if the data bar has a gradient.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setGradientFill(gradientFill: boolean): void;'
- parameters:
- - id: gradientFill
- description: ''
- type: boolean
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ConditionalDataBarPositiveFormat
+uid: 'ExcelScript!ExcelScript.ConditionalDataBarPositiveFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalDataBarPositiveFormat
+summary: Represents a conditional format for the positive side of the data bar.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getBorderColor()
+ uid: 'ExcelScript!ExcelScript.ConditionalDataBarPositiveFormat#getBorderColor:member(1)'
+ package: ExcelScript!
+ fullName: getBorderColor()
+ summary: >-
+ HTML color code representing the color of the border line, in the form \#RRGGBB (e.g., "FFA500") or as a named
+ HTML color (e.g., "orange"). Value is "" (an empty string) if no border is present or set.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBorderColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getFillColor()
+ uid: 'ExcelScript!ExcelScript.ConditionalDataBarPositiveFormat#getFillColor:member(1)'
+ package: ExcelScript!
+ fullName: getFillColor()
+ summary: >-
+ HTML color code representing the fill color, in the form \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g.,
+ "orange").
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFillColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getGradientFill()
+ uid: 'ExcelScript!ExcelScript.ConditionalDataBarPositiveFormat#getGradientFill:member(1)'
+ package: ExcelScript!
+ fullName: getGradientFill()
+ summary: Specifies if the data bar has a gradient.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGradientFill(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: setBorderColor(borderColor)
+ uid: 'ExcelScript!ExcelScript.ConditionalDataBarPositiveFormat#setBorderColor:member(1)'
+ package: ExcelScript!
+ fullName: setBorderColor(borderColor)
+ summary: >-
+ HTML color code representing the color of the border line, in the form \#RRGGBB (e.g., "FFA500") or as a named
+ HTML color (e.g., "orange"). Value is "" (an empty string) if no border is present or set.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setBorderColor(borderColor: string): void;'
+ parameters:
+ - id: borderColor
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setFillColor(fillColor)
+ uid: 'ExcelScript!ExcelScript.ConditionalDataBarPositiveFormat#setFillColor:member(1)'
+ package: ExcelScript!
+ fullName: setFillColor(fillColor)
+ summary: >-
+ HTML color code representing the fill color, in the form \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g.,
+ "orange").
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFillColor(fillColor: string): void;'
+ parameters:
+ - id: fillColor
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setGradientFill(gradientFill)
+ uid: 'ExcelScript!ExcelScript.ConditionalDataBarPositiveFormat#setGradientFill:member(1)'
+ package: ExcelScript!
+ fullName: setGradientFill(gradientFill)
+ summary: Specifies if the data bar has a gradient.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setGradientFill(gradientFill: boolean): void;'
+ parameters:
+ - id: gradientFill
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaldatabarrule.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaldatabarrule.yml
index f47376cd..86ab5f97 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaldatabarrule.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaldatabarrule.yml
@@ -1,67 +1,67 @@
-### YamlMime:TSType
-name: ExcelScript.ConditionalDataBarRule
-uid: 'ExcelScript!ExcelScript.ConditionalDataBarRule:interface'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalDataBarRule
-summary: Represents a rule-type for a data bar.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates data bar conditional formatting on the selected range.
- * The scale of the data bar goes from 0 to 1000.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the selected range.
- const selected = workbook.getSelectedRange();
-
- // Create new conditional formatting on the range.
- const format = selected.addConditionalFormat(ExcelScript.ConditionalFormatType.dataBar);
- const dataBarFormat: ExcelScript.DataBarConditionalFormat = format.getDataBar();
-
- // Set the lower bound of the data bar formatting to be 0.
- const lowerBound: ExcelScript.ConditionalDataBarRule = {
- type: ExcelScript.ConditionalFormatRuleType.number,
- formula: "0"
- };
- dataBarFormat.setLowerBoundRule(lowerBound);
-
- // Set the upper bound of the data bar formatting to be 1000.
- const upperBound: ExcelScript.ConditionalDataBarRule = {
- type: ExcelScript.ConditionalFormatRuleType.number,
- formula: "1000"
- };
- dataBarFormat.setUpperBoundRule(upperBound);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: formula
- uid: 'ExcelScript!ExcelScript.ConditionalDataBarRule#formula:member'
- package: ExcelScript!
- fullName: formula
- summary: 'The formula, if required, on which to evaluate the data bar rule.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'formula?: string;'
- return:
- type: string
- - name: type
- uid: 'ExcelScript!ExcelScript.ConditionalDataBarRule#type:member'
- package: ExcelScript!
- fullName: type
- summary: The type of rule for the data bar.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'type: ConditionalFormatRuleType;'
- return:
- type: ''
+### YamlMime:TSType
+name: ExcelScript.ConditionalDataBarRule
+uid: 'ExcelScript!ExcelScript.ConditionalDataBarRule:interface'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalDataBarRule
+summary: Represents a rule-type for a data bar.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates data bar conditional formatting on the selected range.
+ * The scale of the data bar goes from 0 to 1000.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the selected range.
+ const selected = workbook.getSelectedRange();
+
+ // Create new conditional formatting on the range.
+ const format = selected.addConditionalFormat(ExcelScript.ConditionalFormatType.dataBar);
+ const dataBarFormat: ExcelScript.DataBarConditionalFormat = format.getDataBar();
+
+ // Set the lower bound of the data bar formatting to be 0.
+ const lowerBound: ExcelScript.ConditionalDataBarRule = {
+ type: ExcelScript.ConditionalFormatRuleType.number,
+ formula: "0"
+ };
+ dataBarFormat.setLowerBoundRule(lowerBound);
+
+ // Set the upper bound of the data bar formatting to be 1000.
+ const upperBound: ExcelScript.ConditionalDataBarRule = {
+ type: ExcelScript.ConditionalFormatRuleType.number,
+ formula: "1000"
+ };
+ dataBarFormat.setUpperBoundRule(upperBound);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: formula
+ uid: 'ExcelScript!ExcelScript.ConditionalDataBarRule#formula:member'
+ package: ExcelScript!
+ fullName: formula
+ summary: 'The formula, if required, on which to evaluate the data bar rule.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'formula?: string;'
+ return:
+ type: string
+ - name: type
+ uid: 'ExcelScript!ExcelScript.ConditionalDataBarRule#type:member'
+ package: ExcelScript!
+ fullName: type
+ summary: The type of rule for the data bar.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'type: ConditionalFormatRuleType;'
+ return:
+ type: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformat.yml
index b1b0bba6..27b0cd51 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformat.yml
@@ -1,498 +1,647 @@
-### YamlMime:TSType
-name: ExcelScript.ConditionalFormat
-uid: 'ExcelScript!ExcelScript.ConditionalFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalFormat
-summary: 'An object encapsulating a conditional format''s range, format, rule, and other properties.'
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: delete()
- uid: 'ExcelScript!ExcelScript.ConditionalFormat#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: Deletes this conditional format.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: ''
- - name: getCellValue()
- uid: 'ExcelScript!ExcelScript.ConditionalFormat#getCellValue:member(1)'
- package: ExcelScript!
- fullName: getCellValue()
- summary: Returns the cell value conditional format properties if the current conditional format is a `CellValue` type.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCellValue(): CellValueConditionalFormat | undefined;'
- return:
- type: ' | undefined'
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies conditional formatting to a range.
- * That formatting is conditional upon the cell's numerical value.
- * Any value between 50 and 75 will have the cell fill color changed and the font made italic.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range to format.
- const sheet = workbook.getActiveWorksheet();
- const ratingColumn = sheet.getRange("D2:D20");
-
- // Add cell value conditional formatting.
- const cellValueConditionalFormatting =
- ratingColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.cellValue).getCellValue();
-
- // Create the condition, in this case when the cell value is between 50 and 75.
- let rule: ExcelScript.ConditionalCellValueRule = {
- formula1: "50",
- formula2: "75",
- operator: ExcelScript.ConditionalCellValueOperator.between
- };
- cellValueConditionalFormatting.setRule(rule);
-
- // Set the format to apply when the condition is met.
- let format = cellValueConditionalFormatting.getFormat();
- format.getFill().setColor("yellow");
- format.getFont().setItalic(true);
-
- }
- ```
- - name: getColorScale()
- uid: 'ExcelScript!ExcelScript.ConditionalFormat#getColorScale:member(1)'
- package: ExcelScript!
- fullName: getColorScale()
- summary: Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColorScale(): ColorScaleConditionalFormat | undefined;'
- return:
- type: ' | undefined'
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a red, white, and blue color scale to the selected range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the selected range.
- let selectedRange = workbook.getSelectedRange();
-
- // Create a new conditional formatting object by adding one to the range.
- let conditionalFormatting = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.colorScale);
-
- // Set the colors for the three parts of the scale: minimum, midpoint, and maximum.
- conditionalFormatting.getColorScale().setCriteria({
- minimum: {
- color:"#F8696B", /* A pale red. */
- type:ExcelScript.ConditionalFormatColorCriterionType.lowestValue
- },
- midpoint: {
- color: "#FCFCFF", /* Slightly off-white. */
- formula:'=50',type:ExcelScript.ConditionalFormatColorCriterionType.percentile
- },
- maximum: {
- color: "#5A8AC6", /* A pale blue. */
- type:ExcelScript.ConditionalFormatColorCriterionType.highestValue
- }
- });
- }
- ```
- - name: getCustom()
- uid: 'ExcelScript!ExcelScript.ConditionalFormat#getCustom:member(1)'
- package: ExcelScript!
- fullName: getCustom()
- summary: Returns the custom conditional format properties if the current conditional format is a custom type.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCustom(): CustomConditionalFormat | undefined;'
- return:
- type: ' | undefined'
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a custom conditional formatting to the selected range.
- * A light-green fill is applied to a cell if the value is larger than the value in the row's previous column.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the selected cells.
- let selectedRange = workbook.getSelectedRange();
-
- // Apply a rule for positive change from the previous column.
- let positiveChange = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom);
- positiveChange.getCustom().getFormat().getFill().setColor("lightgreen");
- positiveChange.getCustom().getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}>${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`);
- }
- ```
- - name: getDataBar()
- uid: 'ExcelScript!ExcelScript.ConditionalFormat#getDataBar:member(1)'
- package: ExcelScript!
- fullName: getDataBar()
- summary: Returns the data bar properties if the current conditional format is a data bar.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDataBar(): DataBarConditionalFormat | undefined;'
- return:
- type: ' | undefined'
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates data bar conditional formatting on the selected range.
- * The scale of the data bar goes from 0 to 1000.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the selected range.
- const selected = workbook.getSelectedRange();
-
- // Create new conditional formatting on the range.
- const format = selected.addConditionalFormat(ExcelScript.ConditionalFormatType.dataBar);
- const dataBarFormat = format.getDataBar();
-
- // Set the lower bound of the data bar formatting to be 0.
- const lowerBound: ExcelScript.ConditionalDataBarRule = {
- type: ExcelScript.ConditionalFormatRuleType.number,
- formula: "0"
- };
- dataBarFormat.setLowerBoundRule(lowerBound);
-
- // Set the upper bound of the data bar formatting to be 1000.
- const upperBound: ExcelScript.ConditionalDataBarRule = {
- type: ExcelScript.ConditionalFormatRuleType.number,
- formula: "1000"
- };
- dataBarFormat.setUpperBoundRule(upperBound);
- }
- ```
- - name: getIconSet()
- uid: 'ExcelScript!ExcelScript.ConditionalFormat#getIconSet:member(1)'
- package: ExcelScript!
- fullName: getIconSet()
- summary: Returns the icon set conditional format properties if the current conditional format is an `IconSet` type.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIconSet(): IconSetConditionalFormat | undefined;'
- return:
- type: ' | undefined'
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies icon set conditional formatting to a range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range "A1:A5" on the current worksheet.
- const sheet = workbook.getActiveWorksheet();
- const range = sheet.getRange("A1:A5");
-
- // Create icon set conditional formatting on the range.
- const conditionalFormatting = range.addConditionalFormat(ExcelScript.ConditionalFormatType.iconSet);
-
- // Use the "3 Traffic Lights (Unrimmed)" set.
- conditionalFormatting.getIconSet().setStyle(ExcelScript.IconSet.threeTrafficLights1);
-
- // Set the criteria to use a different icon for the bottom, middle, and top thirds of the values in the range.
- conditionalFormatting.getIconSet().setCriteria([
- {
- formula:'=0',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
- type:ExcelScript.ConditionalFormatIconRuleType.percent
- },
- {
- formula:'=33',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
- type:ExcelScript.ConditionalFormatIconRuleType.percent},
- {
- formula:'=67',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
- type:ExcelScript.ConditionalFormatIconRuleType.percent
- }]);
- }
- ```
- - name: getId()
- uid: 'ExcelScript!ExcelScript.ConditionalFormat#getId:member(1)'
- package: ExcelScript!
- fullName: getId()
- summary: The priority of the conditional format in the current `ConditionalFormatCollection`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getId(): string;'
- return:
- type: string
- description: ''
- - name: getPreset()
- uid: 'ExcelScript!ExcelScript.ConditionalFormat#getPreset:member(1)'
- package: ExcelScript!
- fullName: getPreset()
- summary: >-
- Returns the preset criteria conditional format. See `ExcelScript.PresetCriteriaConditionalFormat` for more
- details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPreset(): PresetCriteriaConditionalFormat | undefined;'
- return:
- type: ' | undefined'
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a conditional format that uses a preset criterion.
- * Any cell in row 1 will have the color fill set to green if it is a duplicate value
- * (of anything else in row 1).
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range for row 1.
- const sheet = workbook.getActiveWorksheet();
- const formattedRange = sheet.getRange("1:1");
-
- // Add new conditional formatting to that range.
- const conditionalFormat = formattedRange.addConditionalFormat(
- ExcelScript.ConditionalFormatType.presetCriteria);
-
- // Set the conditional formatting to apply a green fill.
- const presetFormat = conditionalFormat.getPreset();
- presetFormat.getFormat().getFill().setColor("green");
-
- // Set a rule to apply the conditional format when values are duplicated in the range.
- const duplicateRule: ExcelScript.ConditionalPresetCriteriaRule = {
- criterion: ExcelScript.ConditionalFormatPresetCriterion.duplicateValues
- };
- presetFormat.setRule(duplicateRule);
- }
- ```
- - name: getPriority()
- uid: 'ExcelScript!ExcelScript.ConditionalFormat#getPriority:member(1)'
- package: ExcelScript!
- fullName: getPriority()
- summary: >-
- The priority (or index) within the conditional format collection that this conditional format currently exists in.
- Changing this also changes other conditional formats' priorities, to allow for a contiguous priority order. Use a
- negative priority to begin from the back. Priorities greater than the bounds will get and set to the maximum (or
- minimum if negative) priority. Also note that if you change the priority, you have to re-fetch a new copy of the
- object at that new priority location if you want to make further changes to it.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPriority(): number;'
- return:
- type: number
- description: ''
- - name: getRange()
- uid: 'ExcelScript!ExcelScript.ConditionalFormat#getRange:member(1)'
- package: ExcelScript!
- fullName: getRange()
- summary: >-
- Returns the range to which the conditional format is applied. If the conditional format is applied to multiple
- ranges, then this method returns `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRange(): Range;'
- return:
- type: ''
- description: ''
- - name: getRanges()
- uid: 'ExcelScript!ExcelScript.ConditionalFormat#getRanges:member(1)'
- package: ExcelScript!
- fullName: getRanges()
- summary: >-
- Returns the `RangeAreas`, comprising one or more rectangular ranges, to which the conditional format is
- applied.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRanges(): RangeAreas;'
- return:
- type: ''
- description: ''
- - name: getStopIfTrue()
- uid: 'ExcelScript!ExcelScript.ConditionalFormat#getStopIfTrue:member(1)'
- package: ExcelScript!
- fullName: getStopIfTrue()
- summary: >-
- If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell.
- Value is `null` on data bars, icon sets, and color scales as there's no concept of `StopIfTrue` for these.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getStopIfTrue(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getTextComparison()
- uid: 'ExcelScript!ExcelScript.ConditionalFormat#getTextComparison:member(1)'
- package: ExcelScript!
- fullName: getTextComparison()
- summary: >-
- Returns the specific text conditional format properties if the current conditional format is a text type. For
- example, to format cells matching the word "Text".
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTextComparison(): TextConditionalFormat | undefined;'
- return:
- type: ' | undefined'
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds conditional formatting to the first column in the worksheet.
- * This formatting gives the cells a green fill if they have text starting with "Excel".
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first column in the current worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const firstColumn = currentSheet.getRange("A:A");
-
- // Add conditional formatting based on the text in the cells.
- const textConditionFormat =
- firstColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.containsText).getTextComparison();
-
- // Set the conditional format to provide a green fill.
- textConditionFormat.getFormat().getFill().setColor("green");
-
- // Apply the condition rule that the text begins with "Excel".
- const textRule: ExcelScript.ConditionalTextComparisonRule = {
- operator: ExcelScript.ConditionalTextOperator.beginsWith,
- text: "Excel"
- };
- textConditionFormat.setRule(textRule);
- }
- ```
- - name: getTopBottom()
- uid: 'ExcelScript!ExcelScript.ConditionalFormat#getTopBottom:member(1)'
- package: ExcelScript!
- fullName: getTopBottom()
- summary: >-
- Returns the top/bottom conditional format properties if the current conditional format is a `TopBottom` type. For
- example, to format the top 10% or bottom 10 items.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTopBottom(): TopBottomConditionalFormat | undefined;'
- return:
- type: ' | undefined'
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies top/bottom conditional formatting to a range.
- * The top 2 values in the range will have the cell fill color changed to green.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range to format.
- const sheet = workbook.getWorksheet("TopBottom");
- const dataRange = sheet.getRange("B2:D5");
-
- // Set the fill color to green for the top 2 values in the range.
- const topBottomFormat = dataRange.addConditionalFormat(
- ExcelScript.ConditionalFormatType.topBottom).getTopBottom();
- topBottomFormat.getFormat().getFill().setColor("green");
- topBottomFormat.setRule({
- rank: 2, /* The numeric threshold. */
- type: ExcelScript.ConditionalTopBottomCriterionType.topItems /* The type of the top/bottom condition. */
- });
- }
- ```
- - name: getType()
- uid: 'ExcelScript!ExcelScript.ConditionalFormat#getType:member(1)'
- package: ExcelScript!
- fullName: getType()
- summary: A type of conditional format. Only one can be set at a time.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getType(): ConditionalFormatType;'
- return:
- type: ''
- description: ''
- - name: setPriority(priority)
- uid: 'ExcelScript!ExcelScript.ConditionalFormat#setPriority:member(1)'
- package: ExcelScript!
- fullName: setPriority(priority)
- summary: >-
- The priority (or index) within the conditional format collection that this conditional format currently exists in.
- Changing this also changes other conditional formats' priorities, to allow for a contiguous priority order. Use a
- negative priority to begin from the back. Priorities greater than the bounds will get and set to the maximum (or
- minimum if negative) priority. Also note that if you change the priority, you have to re-fetch a new copy of the
- object at that new priority location if you want to make further changes to it.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPriority(priority: number): void;'
- parameters:
- - id: priority
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setStopIfTrue(stopIfTrue)
- uid: 'ExcelScript!ExcelScript.ConditionalFormat#setStopIfTrue:member(1)'
- package: ExcelScript!
- fullName: setStopIfTrue(stopIfTrue)
- summary: >-
- If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell.
- Value is `null` on data bars, icon sets, and color scales as there's no concept of `StopIfTrue` for these.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setStopIfTrue(stopIfTrue: boolean): void;'
- parameters:
- - id: stopIfTrue
- description: ''
- type: boolean
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ConditionalFormat
+uid: 'ExcelScript!ExcelScript.ConditionalFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalFormat
+summary: 'An object encapsulating a conditional format''s range, format, rule, and other properties.'
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: changeRuleToCellValue(properties)
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#changeRuleToCellValue:member(1)'
+ package: ExcelScript!
+ fullName: changeRuleToCellValue(properties)
+ summary: Change the conditional format rule type to cell value.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'changeRuleToCellValue(properties: ConditionalCellValueRule): void;'
+ parameters:
+ - id: properties
+ description: The properties to set for the cell value conditional format rule.
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: changeRuleToColorScale()
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#changeRuleToColorScale:member(1)'
+ package: ExcelScript!
+ fullName: changeRuleToColorScale()
+ summary: Change the conditional format rule type to color scale.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'changeRuleToColorScale(): void;'
+ return:
+ type: void
+ description: ''
+ - name: changeRuleToContainsText(properties)
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#changeRuleToContainsText:member(1)'
+ package: ExcelScript!
+ fullName: changeRuleToContainsText(properties)
+ summary: Change the conditional format rule type to text comparison.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ changeRuleToContainsText(
+ properties: ConditionalTextComparisonRule
+ ): void;
+ parameters:
+ - id: properties
+ description: The properties to set for the text comparison conditional format rule.
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: changeRuleToCustom(formula)
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#changeRuleToCustom:member(1)'
+ package: ExcelScript!
+ fullName: changeRuleToCustom(formula)
+ summary: Change the conditional format rule type to custom.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'changeRuleToCustom(formula: string): void;'
+ parameters:
+ - id: formula
+ description: The formula to set for the custom conditional format rule.
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: changeRuleToDataBar()
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#changeRuleToDataBar:member(1)'
+ package: ExcelScript!
+ fullName: changeRuleToDataBar()
+ summary: Change the conditional format rule type to data bar.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'changeRuleToDataBar(): void;'
+ return:
+ type: void
+ description: ''
+ - name: changeRuleToIconSet()
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#changeRuleToIconSet:member(1)'
+ package: ExcelScript!
+ fullName: changeRuleToIconSet()
+ summary: Change the conditional format rule type to icon set.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'changeRuleToIconSet(): void;'
+ return:
+ type: void
+ description: ''
+ - name: changeRuleToPresetCriteria(properties)
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#changeRuleToPresetCriteria:member(1)'
+ package: ExcelScript!
+ fullName: changeRuleToPresetCriteria(properties)
+ summary: Change the conditional format rule type to preset criteria.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ changeRuleToPresetCriteria(
+ properties: ConditionalPresetCriteriaRule
+ ): void;
+ parameters:
+ - id: properties
+ description: The properties to set for the preset criteria conditional format rule.
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: changeRuleToTopBottom(properties)
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#changeRuleToTopBottom:member(1)'
+ package: ExcelScript!
+ fullName: changeRuleToTopBottom(properties)
+ summary: Change the conditional format rule type to top/bottom.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'changeRuleToTopBottom(properties: ConditionalTopBottomRule): void;'
+ parameters:
+ - id: properties
+ description: The properties to set for the top/bottom conditional format rule.
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: Deletes this conditional format.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getCellValue()
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#getCellValue:member(1)'
+ package: ExcelScript!
+ fullName: getCellValue()
+ summary: Returns the cell value conditional format properties if the current conditional format is a `CellValue` type.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCellValue(): CellValueConditionalFormat | undefined;'
+ return:
+ type: ' | undefined'
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies conditional formatting to a range.
+ * That formatting is conditional upon the cell's numerical value.
+ * Any value between 50 and 75 will have the cell fill color changed and the font made italic.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range to format.
+ const sheet = workbook.getActiveWorksheet();
+ const ratingColumn = sheet.getRange("D2:D20");
+
+ // Add cell value conditional formatting.
+ const cellValueConditionalFormatting =
+ ratingColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.cellValue).getCellValue();
+
+ // Create the condition, in this case when the cell value is between 50 and 75.
+ let rule: ExcelScript.ConditionalCellValueRule = {
+ formula1: "50",
+ formula2: "75",
+ operator: ExcelScript.ConditionalCellValueOperator.between
+ };
+ cellValueConditionalFormatting.setRule(rule);
+
+ // Set the format to apply when the condition is met.
+ let format = cellValueConditionalFormatting.getFormat();
+ format.getFill().setColor("yellow");
+ format.getFont().setItalic(true);
+
+ }
+ ```
+ - name: getColorScale()
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#getColorScale:member(1)'
+ package: ExcelScript!
+ fullName: getColorScale()
+ summary: Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColorScale(): ColorScaleConditionalFormat | undefined;'
+ return:
+ type: ' | undefined'
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a red, white, and blue color scale to the selected range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the selected range.
+ let selectedRange = workbook.getSelectedRange();
+
+ // Create a new conditional formatting object by adding one to the range.
+ let conditionalFormatting = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.colorScale);
+
+ // Set the colors for the three parts of the scale: minimum, midpoint, and maximum.
+ conditionalFormatting.getColorScale().setCriteria({
+ minimum: {
+ color:"#F8696B", /* A pale red. */
+ type:ExcelScript.ConditionalFormatColorCriterionType.lowestValue
+ },
+ midpoint: {
+ color: "#FCFCFF", /* Slightly off-white. */
+ formula:'=50',type:ExcelScript.ConditionalFormatColorCriterionType.percentile
+ },
+ maximum: {
+ color: "#5A8AC6", /* A pale blue. */
+ type:ExcelScript.ConditionalFormatColorCriterionType.highestValue
+ }
+ });
+ }
+ ```
+ - name: getCustom()
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#getCustom:member(1)'
+ package: ExcelScript!
+ fullName: getCustom()
+ summary: Returns the custom conditional format properties if the current conditional format is a custom type.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCustom(): CustomConditionalFormat | undefined;'
+ return:
+ type: ' | undefined'
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a custom conditional formatting to the selected range.
+ * A light-green fill is applied to a cell if the value is larger than the value in the row's previous column.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the selected cells.
+ let selectedRange = workbook.getSelectedRange();
+
+ // Apply a rule for positive change from the previous column.
+ let positiveChange = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom);
+ positiveChange.getCustom().getFormat().getFill().setColor("lightgreen");
+ positiveChange.getCustom().getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}>${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`);
+ }
+ ```
+ - name: getDataBar()
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#getDataBar:member(1)'
+ package: ExcelScript!
+ fullName: getDataBar()
+ summary: Returns the data bar properties if the current conditional format is a data bar.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDataBar(): DataBarConditionalFormat | undefined;'
+ return:
+ type: ' | undefined'
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates data bar conditional formatting on the selected range.
+ * The scale of the data bar goes from 0 to 1000.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the selected range.
+ const selected = workbook.getSelectedRange();
+
+ // Create new conditional formatting on the range.
+ const format = selected.addConditionalFormat(ExcelScript.ConditionalFormatType.dataBar);
+ const dataBarFormat = format.getDataBar();
+
+ // Set the lower bound of the data bar formatting to be 0.
+ const lowerBound: ExcelScript.ConditionalDataBarRule = {
+ type: ExcelScript.ConditionalFormatRuleType.number,
+ formula: "0"
+ };
+ dataBarFormat.setLowerBoundRule(lowerBound);
+
+ // Set the upper bound of the data bar formatting to be 1000.
+ const upperBound: ExcelScript.ConditionalDataBarRule = {
+ type: ExcelScript.ConditionalFormatRuleType.number,
+ formula: "1000"
+ };
+ dataBarFormat.setUpperBoundRule(upperBound);
+ }
+ ```
+ - name: getIconSet()
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#getIconSet:member(1)'
+ package: ExcelScript!
+ fullName: getIconSet()
+ summary: Returns the icon set conditional format properties if the current conditional format is an `IconSet` type.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIconSet(): IconSetConditionalFormat | undefined;'
+ return:
+ type: ' | undefined'
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies icon set conditional formatting to a range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range "A1:A5" on the current worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const range = sheet.getRange("A1:A5");
+
+ // Create icon set conditional formatting on the range.
+ const conditionalFormatting = range.addConditionalFormat(ExcelScript.ConditionalFormatType.iconSet);
+
+ // Use the "3 Traffic Lights (Unrimmed)" set.
+ conditionalFormatting.getIconSet().setStyle(ExcelScript.IconSet.threeTrafficLights1);
+
+ // Set the criteria to use a different icon for the bottom, middle, and top thirds of the values in the range.
+ conditionalFormatting.getIconSet().setCriteria([
+ {
+ formula:'=0',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
+ type:ExcelScript.ConditionalFormatIconRuleType.percent
+ },
+ {
+ formula:'=33',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
+ type:ExcelScript.ConditionalFormatIconRuleType.percent},
+ {
+ formula:'=67',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
+ type:ExcelScript.ConditionalFormatIconRuleType.percent
+ }]);
+ }
+ ```
+ - name: getId()
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#getId:member(1)'
+ package: ExcelScript!
+ fullName: getId()
+ summary: The priority of the conditional format in the current `ConditionalFormatCollection`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getId(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getPreset()
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#getPreset:member(1)'
+ package: ExcelScript!
+ fullName: getPreset()
+ summary: >-
+ Returns the preset criteria conditional format. See `ExcelScript.PresetCriteriaConditionalFormat` for more
+ details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPreset(): PresetCriteriaConditionalFormat | undefined;'
+ return:
+ type: ' | undefined'
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a conditional format that uses a preset criterion.
+ * Any cell in row 1 will have the color fill set to green if it is a duplicate value
+ * (of anything else in row 1).
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range for row 1.
+ const sheet = workbook.getActiveWorksheet();
+ const formattedRange = sheet.getRange("1:1");
+
+ // Add new conditional formatting to that range.
+ const conditionalFormat = formattedRange.addConditionalFormat(
+ ExcelScript.ConditionalFormatType.presetCriteria);
+
+ // Set the conditional formatting to apply a green fill.
+ const presetFormat = conditionalFormat.getPreset();
+ presetFormat.getFormat().getFill().setColor("green");
+
+ // Set a rule to apply the conditional format when values are duplicated in the range.
+ const duplicateRule: ExcelScript.ConditionalPresetCriteriaRule = {
+ criterion: ExcelScript.ConditionalFormatPresetCriterion.duplicateValues
+ };
+ presetFormat.setRule(duplicateRule);
+ }
+ ```
+ - name: getPriority()
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#getPriority:member(1)'
+ package: ExcelScript!
+ fullName: getPriority()
+ summary: >-
+ The priority (or index) within the conditional format collection that this conditional format currently exists in.
+ Changing this also changes other conditional formats' priorities, to allow for a contiguous priority order. Use a
+ negative priority to begin from the back. Priorities greater than the bounds will get and set to the maximum (or
+ minimum if negative) priority. Also note that if you change the priority, you have to re-fetch a new copy of the
+ object at that new priority location if you want to make further changes to it.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPriority(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getRange()
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#getRange:member(1)'
+ package: ExcelScript!
+ fullName: getRange()
+ summary: >-
+ Returns the range to which the conditional format is applied. If the conditional format is applied to multiple
+ ranges, then this method returns `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRange(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getRanges()
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#getRanges:member(1)'
+ package: ExcelScript!
+ fullName: getRanges()
+ summary: >-
+ Returns the `RangeAreas`, comprising one or more rectangular ranges, to which the conditional format is
+ applied.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRanges(): RangeAreas;'
+ return:
+ type: ''
+ description: ''
+ - name: getStopIfTrue()
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#getStopIfTrue:member(1)'
+ package: ExcelScript!
+ fullName: getStopIfTrue()
+ summary: >-
+ If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell.
+ Value is `null` on data bars, icon sets, and color scales as there's no concept of `StopIfTrue` for these.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getStopIfTrue(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getTextComparison()
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#getTextComparison:member(1)'
+ package: ExcelScript!
+ fullName: getTextComparison()
+ summary: >-
+ Returns the specific text conditional format properties if the current conditional format is a text type. For
+ example, to format cells matching the word "Text".
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTextComparison(): TextConditionalFormat | undefined;'
+ return:
+ type: ' | undefined'
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds conditional formatting to the first column in the worksheet.
+ * This formatting gives the cells a green fill if they have text starting with "Excel".
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first column in the current worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const firstColumn = currentSheet.getRange("A:A");
+
+ // Add conditional formatting based on the text in the cells.
+ const textConditionFormat =
+ firstColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.containsText).getTextComparison();
+
+ // Set the conditional format to provide a green fill.
+ textConditionFormat.getFormat().getFill().setColor("green");
+
+ // Apply the condition rule that the text begins with "Excel".
+ const textRule: ExcelScript.ConditionalTextComparisonRule = {
+ operator: ExcelScript.ConditionalTextOperator.beginsWith,
+ text: "Excel"
+ };
+ textConditionFormat.setRule(textRule);
+ }
+ ```
+ - name: getTopBottom()
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#getTopBottom:member(1)'
+ package: ExcelScript!
+ fullName: getTopBottom()
+ summary: >-
+ Returns the top/bottom conditional format properties if the current conditional format is a `TopBottom` type. For
+ example, to format the top 10% or bottom 10 items.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTopBottom(): TopBottomConditionalFormat | undefined;'
+ return:
+ type: ' | undefined'
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies top/bottom conditional formatting to a range.
+ * The top 2 values in the range will have the cell fill color changed to green.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range to format.
+ const sheet = workbook.getWorksheet("TopBottom");
+ const dataRange = sheet.getRange("B2:D5");
+
+ // Set the fill color to green for the top 2 values in the range.
+ const topBottomFormat = dataRange.addConditionalFormat(
+ ExcelScript.ConditionalFormatType.topBottom).getTopBottom();
+ topBottomFormat.getFormat().getFill().setColor("green");
+ topBottomFormat.setRule({
+ rank: 2, /* The numeric threshold. */
+ type: ExcelScript.ConditionalTopBottomCriterionType.topItems /* The type of the top/bottom condition. */
+ });
+ }
+ ```
+ - name: getType()
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#getType:member(1)'
+ package: ExcelScript!
+ fullName: getType()
+ summary: A type of conditional format. Only one can be set at a time.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getType(): ConditionalFormatType;'
+ return:
+ type: ''
+ description: ''
+ - name: setPriority(priority)
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#setPriority:member(1)'
+ package: ExcelScript!
+ fullName: setPriority(priority)
+ summary: >-
+ The priority (or index) within the conditional format collection that this conditional format currently exists in.
+ Changing this also changes other conditional formats' priorities, to allow for a contiguous priority order. Use a
+ negative priority to begin from the back. Priorities greater than the bounds will get and set to the maximum (or
+ minimum if negative) priority. Also note that if you change the priority, you have to re-fetch a new copy of the
+ object at that new priority location if you want to make further changes to it.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPriority(priority: number): void;'
+ parameters:
+ - id: priority
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setRanges(ranges)
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#setRanges:member(1)'
+ package: ExcelScript!
+ fullName: setRanges(ranges)
+ summary: Set the ranges that the conditional format rule is applied to.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setRanges(ranges: Range | RangeAreas | string): void;'
+ parameters:
+ - id: ranges
+ description: Collection of one or more ranges for this rule to be applied to.
+ type: >-
+ | | string
+ return:
+ type: void
+ description: ''
+ - name: setStopIfTrue(stopIfTrue)
+ uid: 'ExcelScript!ExcelScript.ConditionalFormat#setStopIfTrue:member(1)'
+ package: ExcelScript!
+ fullName: setStopIfTrue(stopIfTrue)
+ summary: >-
+ If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell.
+ Value is `null` on data bars, icon sets, and color scales as there's no concept of `StopIfTrue` for these.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setStopIfTrue(stopIfTrue: boolean): void;'
+ parameters:
+ - id: stopIfTrue
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatcolorcriteriontype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatcolorcriteriontype.yml
index d2fa9189..2efa0b2f 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatcolorcriteriontype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatcolorcriteriontype.yml
@@ -1,70 +1,70 @@
-### YamlMime:TSEnum
-name: ExcelScript.ConditionalFormatColorCriterionType
-uid: 'ExcelScript!ExcelScript.ConditionalFormatColorCriterionType:enum'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalFormatColorCriterionType
-summary: Represents the types of color criterion for conditional formatting.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a red, white, and blue color scale to the selected range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the selected range.
- let selectedRange = workbook.getSelectedRange();
-
- // Create a new conditional formatting object by adding one to the range.
- let conditionalFormatting = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.colorScale);
-
- // Set the colors for the three parts of the scale: minimum, midpoint, and maximum.
- conditionalFormatting.getColorScale().setCriteria({
- minimum: {
- color:"#F8696B", /* A pale red. */
- type:ExcelScript.ConditionalFormatColorCriterionType.lowestValue
- },
- midpoint: {
- color: "#FCFCFF", /* Slightly off-white. */
- formula:'=50',type:ExcelScript.ConditionalFormatColorCriterionType.percentile
- },
- maximum: {
- color: "#5A8AC6", /* A pale blue. */
- type:ExcelScript.ConditionalFormatColorCriterionType.highestValue
- }
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: formula
- uid: 'ExcelScript!ExcelScript.ConditionalFormatColorCriterionType.formula:member'
- package: ExcelScript!
- summary: ''
- - name: highestValue
- uid: 'ExcelScript!ExcelScript.ConditionalFormatColorCriterionType.highestValue:member'
- package: ExcelScript!
- summary: ''
- - name: invalid
- uid: 'ExcelScript!ExcelScript.ConditionalFormatColorCriterionType.invalid:member'
- package: ExcelScript!
- summary: ''
- - name: lowestValue
- uid: 'ExcelScript!ExcelScript.ConditionalFormatColorCriterionType.lowestValue:member'
- package: ExcelScript!
- summary: ''
- - name: number
- uid: 'ExcelScript!ExcelScript.ConditionalFormatColorCriterionType.number:member'
- package: ExcelScript!
- summary: ''
- - name: percent
- uid: 'ExcelScript!ExcelScript.ConditionalFormatColorCriterionType.percent:member'
- package: ExcelScript!
- summary: ''
- - name: percentile
- uid: 'ExcelScript!ExcelScript.ConditionalFormatColorCriterionType.percentile:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ConditionalFormatColorCriterionType
+uid: 'ExcelScript!ExcelScript.ConditionalFormatColorCriterionType:enum'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalFormatColorCriterionType
+summary: Represents the types of color criterion for conditional formatting.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a red, white, and blue color scale to the selected range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the selected range.
+ let selectedRange = workbook.getSelectedRange();
+
+ // Create a new conditional formatting object by adding one to the range.
+ let conditionalFormatting = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.colorScale);
+
+ // Set the colors for the three parts of the scale: minimum, midpoint, and maximum.
+ conditionalFormatting.getColorScale().setCriteria({
+ minimum: {
+ color:"#F8696B", /* A pale red. */
+ type:ExcelScript.ConditionalFormatColorCriterionType.lowestValue
+ },
+ midpoint: {
+ color: "#FCFCFF", /* Slightly off-white. */
+ formula:'=50',type:ExcelScript.ConditionalFormatColorCriterionType.percentile
+ },
+ maximum: {
+ color: "#5A8AC6", /* A pale blue. */
+ type:ExcelScript.ConditionalFormatColorCriterionType.highestValue
+ }
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: formula
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatColorCriterionType.formula:member'
+ package: ExcelScript!
+ summary: ''
+ - name: highestValue
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatColorCriterionType.highestValue:member'
+ package: ExcelScript!
+ summary: ''
+ - name: invalid
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatColorCriterionType.invalid:member'
+ package: ExcelScript!
+ summary: ''
+ - name: lowestValue
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatColorCriterionType.lowestValue:member'
+ package: ExcelScript!
+ summary: ''
+ - name: number
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatColorCriterionType.number:member'
+ package: ExcelScript!
+ summary: ''
+ - name: percent
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatColorCriterionType.percent:member'
+ package: ExcelScript!
+ summary: ''
+ - name: percentile
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatColorCriterionType.percentile:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatdirection.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatdirection.yml
index 3a98b710..3a5e0661 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatdirection.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatdirection.yml
@@ -1,18 +1,18 @@
-### YamlMime:TSEnum
-name: ExcelScript.ConditionalFormatDirection
-uid: 'ExcelScript!ExcelScript.ConditionalFormatDirection:enum'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalFormatDirection
-summary: Represents the direction for a selection.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: bottom
- uid: 'ExcelScript!ExcelScript.ConditionalFormatDirection.bottom:member'
- package: ExcelScript!
- summary: ''
- - name: top
- uid: 'ExcelScript!ExcelScript.ConditionalFormatDirection.top:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ConditionalFormatDirection
+uid: 'ExcelScript!ExcelScript.ConditionalFormatDirection:enum'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalFormatDirection
+summary: Represents the direction for a selection.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: bottom
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatDirection.bottom:member'
+ package: ExcelScript!
+ summary: ''
+ - name: top
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatDirection.top:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformaticonruletype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformaticonruletype.yml
index 6f551192..d26ead87 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformaticonruletype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformaticonruletype.yml
@@ -1,66 +1,66 @@
-### YamlMime:TSEnum
-name: ExcelScript.ConditionalFormatIconRuleType
-uid: 'ExcelScript!ExcelScript.ConditionalFormatIconRuleType:enum'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalFormatIconRuleType
-summary: Represents the types of icon conditional format.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies icon set conditional formatting to a range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range "A1:A5" on the current worksheet.
- const sheet = workbook.getActiveWorksheet();
- const range = sheet.getRange("A1:A5");
-
- // Create icon set conditional formatting on the range.
- const conditionalFormatting = range.addConditionalFormat(ExcelScript.ConditionalFormatType.iconSet);
-
- // Use the "3 Traffic Lights (Unrimmed)" set.
- conditionalFormatting.getIconSet().setStyle(ExcelScript.IconSet.threeTrafficLights1);
-
- // Set the criteria to use a different icon for the bottom, middle, and top thirds of the values in the range.
- const criteria: ExcelScript.ConditionalIconCriterion[] = [
- {
- formula: '=0', operator: ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
- type: ExcelScript.ConditionalFormatIconRuleType.percent
- },
- {
- formula: '=33', operator: ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
- type: ExcelScript.ConditionalFormatIconRuleType.percent
- },
- {
- formula: '=67', operator: ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
- type: ExcelScript.ConditionalFormatIconRuleType.percent
- }];
- conditionalFormatting.getIconSet().setCriteria(criteria);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: formula
- uid: 'ExcelScript!ExcelScript.ConditionalFormatIconRuleType.formula:member'
- package: ExcelScript!
- summary: ''
- - name: invalid
- uid: 'ExcelScript!ExcelScript.ConditionalFormatIconRuleType.invalid:member'
- package: ExcelScript!
- summary: ''
- - name: number
- uid: 'ExcelScript!ExcelScript.ConditionalFormatIconRuleType.number:member'
- package: ExcelScript!
- summary: ''
- - name: percent
- uid: 'ExcelScript!ExcelScript.ConditionalFormatIconRuleType.percent:member'
- package: ExcelScript!
- summary: ''
- - name: percentile
- uid: 'ExcelScript!ExcelScript.ConditionalFormatIconRuleType.percentile:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ConditionalFormatIconRuleType
+uid: 'ExcelScript!ExcelScript.ConditionalFormatIconRuleType:enum'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalFormatIconRuleType
+summary: Represents the types of icon conditional format.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies icon set conditional formatting to a range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range "A1:A5" on the current worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const range = sheet.getRange("A1:A5");
+
+ // Create icon set conditional formatting on the range.
+ const conditionalFormatting = range.addConditionalFormat(ExcelScript.ConditionalFormatType.iconSet);
+
+ // Use the "3 Traffic Lights (Unrimmed)" set.
+ conditionalFormatting.getIconSet().setStyle(ExcelScript.IconSet.threeTrafficLights1);
+
+ // Set the criteria to use a different icon for the bottom, middle, and top thirds of the values in the range.
+ const criteria: ExcelScript.ConditionalIconCriterion[] = [
+ {
+ formula: '=0', operator: ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
+ type: ExcelScript.ConditionalFormatIconRuleType.percent
+ },
+ {
+ formula: '=33', operator: ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
+ type: ExcelScript.ConditionalFormatIconRuleType.percent
+ },
+ {
+ formula: '=67', operator: ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
+ type: ExcelScript.ConditionalFormatIconRuleType.percent
+ }];
+ conditionalFormatting.getIconSet().setCriteria(criteria);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: formula
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatIconRuleType.formula:member'
+ package: ExcelScript!
+ summary: ''
+ - name: invalid
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatIconRuleType.invalid:member'
+ package: ExcelScript!
+ summary: ''
+ - name: number
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatIconRuleType.number:member'
+ package: ExcelScript!
+ summary: ''
+ - name: percent
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatIconRuleType.percent:member'
+ package: ExcelScript!
+ summary: ''
+ - name: percentile
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatIconRuleType.percentile:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatpresetcriterion.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatpresetcriterion.yml
index f1bf5990..850fdb96 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatpresetcriterion.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatpresetcriterion.yml
@@ -1,148 +1,148 @@
-### YamlMime:TSEnum
-name: ExcelScript.ConditionalFormatPresetCriterion
-uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion:enum'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalFormatPresetCriterion
-summary: Represents the criteria of the preset criteria conditional format type.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a conditional format that uses a preset criterion.
- * Any cell in row 1 will have the color fill set to green if it is a duplicate value
- * (of anything else in row 1).
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range for row 1.
- const sheet = workbook.getActiveWorksheet();
- const formattedRange = sheet.getRange("1:1");
-
- // Add new conditional formatting to that range.
- const conditionalFormat = formattedRange.addConditionalFormat(
- ExcelScript.ConditionalFormatType.presetCriteria);
-
- // Set the conditional formatting to apply a green fill.
- const presetFormat = conditionalFormat.getPreset();
- presetFormat.getFormat().getFill().setColor("green");
-
- // Set a rule to apply the conditional format when values are duplicated in the range.
- const duplicateRule: ExcelScript.ConditionalPresetCriteriaRule = {
- criterion: ExcelScript.ConditionalFormatPresetCriterion.duplicateValues
- };
- presetFormat.setRule(duplicateRule);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: aboveAverage
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.aboveAverage:member'
- package: ExcelScript!
- summary: ''
- - name: belowAverage
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.belowAverage:member'
- package: ExcelScript!
- summary: ''
- - name: blanks
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.blanks:member'
- package: ExcelScript!
- summary: ''
- - name: duplicateValues
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.duplicateValues:member'
- package: ExcelScript!
- summary: ''
- - name: equalOrAboveAverage
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.equalOrAboveAverage:member'
- package: ExcelScript!
- summary: ''
- - name: equalOrBelowAverage
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.equalOrBelowAverage:member'
- package: ExcelScript!
- summary: ''
- - name: errors
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.errors:member'
- package: ExcelScript!
- summary: ''
- - name: invalid
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.invalid:member'
- package: ExcelScript!
- summary: ''
- - name: lastMonth
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.lastMonth:member'
- package: ExcelScript!
- summary: ''
- - name: lastSevenDays
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.lastSevenDays:member'
- package: ExcelScript!
- summary: ''
- - name: lastWeek
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.lastWeek:member'
- package: ExcelScript!
- summary: ''
- - name: nextMonth
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.nextMonth:member'
- package: ExcelScript!
- summary: ''
- - name: nextWeek
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.nextWeek:member'
- package: ExcelScript!
- summary: ''
- - name: nonBlanks
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.nonBlanks:member'
- package: ExcelScript!
- summary: ''
- - name: nonErrors
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.nonErrors:member'
- package: ExcelScript!
- summary: ''
- - name: oneStdDevAboveAverage
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.oneStdDevAboveAverage:member'
- package: ExcelScript!
- summary: ''
- - name: oneStdDevBelowAverage
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.oneStdDevBelowAverage:member'
- package: ExcelScript!
- summary: ''
- - name: thisMonth
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.thisMonth:member'
- package: ExcelScript!
- summary: ''
- - name: thisWeek
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.thisWeek:member'
- package: ExcelScript!
- summary: ''
- - name: threeStdDevAboveAverage
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.threeStdDevAboveAverage:member'
- package: ExcelScript!
- summary: ''
- - name: threeStdDevBelowAverage
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.threeStdDevBelowAverage:member'
- package: ExcelScript!
- summary: ''
- - name: today
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.today:member'
- package: ExcelScript!
- summary: ''
- - name: tomorrow
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.tomorrow:member'
- package: ExcelScript!
- summary: ''
- - name: twoStdDevAboveAverage
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.twoStdDevAboveAverage:member'
- package: ExcelScript!
- summary: ''
- - name: twoStdDevBelowAverage
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.twoStdDevBelowAverage:member'
- package: ExcelScript!
- summary: ''
- - name: uniqueValues
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.uniqueValues:member'
- package: ExcelScript!
- summary: ''
- - name: yesterday
- uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.yesterday:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ConditionalFormatPresetCriterion
+uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion:enum'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalFormatPresetCriterion
+summary: Represents the criteria of the preset criteria conditional format type.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a conditional format that uses a preset criterion.
+ * Any cell in row 1 will have the color fill set to green if it is a duplicate value
+ * (of anything else in row 1).
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range for row 1.
+ const sheet = workbook.getActiveWorksheet();
+ const formattedRange = sheet.getRange("1:1");
+
+ // Add new conditional formatting to that range.
+ const conditionalFormat = formattedRange.addConditionalFormat(
+ ExcelScript.ConditionalFormatType.presetCriteria);
+
+ // Set the conditional formatting to apply a green fill.
+ const presetFormat = conditionalFormat.getPreset();
+ presetFormat.getFormat().getFill().setColor("green");
+
+ // Set a rule to apply the conditional format when values are duplicated in the range.
+ const duplicateRule: ExcelScript.ConditionalPresetCriteriaRule = {
+ criterion: ExcelScript.ConditionalFormatPresetCriterion.duplicateValues
+ };
+ presetFormat.setRule(duplicateRule);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: aboveAverage
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.aboveAverage:member'
+ package: ExcelScript!
+ summary: ''
+ - name: belowAverage
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.belowAverage:member'
+ package: ExcelScript!
+ summary: ''
+ - name: blanks
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.blanks:member'
+ package: ExcelScript!
+ summary: ''
+ - name: duplicateValues
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.duplicateValues:member'
+ package: ExcelScript!
+ summary: ''
+ - name: equalOrAboveAverage
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.equalOrAboveAverage:member'
+ package: ExcelScript!
+ summary: ''
+ - name: equalOrBelowAverage
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.equalOrBelowAverage:member'
+ package: ExcelScript!
+ summary: ''
+ - name: errors
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.errors:member'
+ package: ExcelScript!
+ summary: ''
+ - name: invalid
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.invalid:member'
+ package: ExcelScript!
+ summary: ''
+ - name: lastMonth
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.lastMonth:member'
+ package: ExcelScript!
+ summary: ''
+ - name: lastSevenDays
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.lastSevenDays:member'
+ package: ExcelScript!
+ summary: ''
+ - name: lastWeek
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.lastWeek:member'
+ package: ExcelScript!
+ summary: ''
+ - name: nextMonth
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.nextMonth:member'
+ package: ExcelScript!
+ summary: ''
+ - name: nextWeek
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.nextWeek:member'
+ package: ExcelScript!
+ summary: ''
+ - name: nonBlanks
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.nonBlanks:member'
+ package: ExcelScript!
+ summary: ''
+ - name: nonErrors
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.nonErrors:member'
+ package: ExcelScript!
+ summary: ''
+ - name: oneStdDevAboveAverage
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.oneStdDevAboveAverage:member'
+ package: ExcelScript!
+ summary: ''
+ - name: oneStdDevBelowAverage
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.oneStdDevBelowAverage:member'
+ package: ExcelScript!
+ summary: ''
+ - name: thisMonth
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.thisMonth:member'
+ package: ExcelScript!
+ summary: ''
+ - name: thisWeek
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.thisWeek:member'
+ package: ExcelScript!
+ summary: ''
+ - name: threeStdDevAboveAverage
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.threeStdDevAboveAverage:member'
+ package: ExcelScript!
+ summary: ''
+ - name: threeStdDevBelowAverage
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.threeStdDevBelowAverage:member'
+ package: ExcelScript!
+ summary: ''
+ - name: today
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.today:member'
+ package: ExcelScript!
+ summary: ''
+ - name: tomorrow
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.tomorrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: twoStdDevAboveAverage
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.twoStdDevAboveAverage:member'
+ package: ExcelScript!
+ summary: ''
+ - name: twoStdDevBelowAverage
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.twoStdDevBelowAverage:member'
+ package: ExcelScript!
+ summary: ''
+ - name: uniqueValues
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.uniqueValues:member'
+ package: ExcelScript!
+ summary: ''
+ - name: yesterday
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatPresetCriterion.yesterday:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatrule.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatrule.yml
index 2f57c174..9ccb7447 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatrule.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatrule.yml
@@ -1,96 +1,96 @@
-### YamlMime:TSType
-name: ExcelScript.ConditionalFormatRule
-uid: 'ExcelScript!ExcelScript.ConditionalFormatRule:interface'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalFormatRule
-summary: 'Represents a rule, for all traditional rule/format pairings.'
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a custom conditional formatting to the selected range.
- * A light-green fill is applied to a cell if the value is larger than the value in the row's previous column.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the selected cells.
- let selectedRange = workbook.getSelectedRange();
-
- // Apply a rule for positive change from the previous column.
- let positiveChange: ExcelScript.ConditionalFormat = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom);
-
- // Set the conditional format to be a lightgreen fill.
- let positiveCustom: ExcelScript.CustomConditionalFormat = positiveChange.getCustom();
- positiveCustom.getFormat().getFill().setColor("lightgreen");
-
- // Set the conditional rule to be if there is positive change across the row.
- let positiveRule: ExcelScript.ConditionalFormatRule = positiveCustom.getRule();
- positiveRule.setFormula(`=${selectedRange.getCell(0, 0).getAddress()}>${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getFormula()
- uid: 'ExcelScript!ExcelScript.ConditionalFormatRule#getFormula:member(1)'
- package: ExcelScript!
- fullName: getFormula()
- summary: 'The formula, if required, on which to evaluate the conditional format rule.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormula(): string;'
- return:
- type: string
- description: ''
- - name: getFormulaLocal()
- uid: 'ExcelScript!ExcelScript.ConditionalFormatRule#getFormulaLocal:member(1)'
- package: ExcelScript!
- fullName: getFormulaLocal()
- summary: 'The formula, if required, on which to evaluate the conditional format rule in the user''s language.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormulaLocal(): string;'
- return:
- type: string
- description: ''
- - name: setFormula(formula)
- uid: 'ExcelScript!ExcelScript.ConditionalFormatRule#setFormula:member(1)'
- package: ExcelScript!
- fullName: setFormula(formula)
- summary: 'The formula, if required, on which to evaluate the conditional format rule.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFormula(formula: string): void;'
- parameters:
- - id: formula
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setFormulaLocal(formulaLocal)
- uid: 'ExcelScript!ExcelScript.ConditionalFormatRule#setFormulaLocal:member(1)'
- package: ExcelScript!
- fullName: setFormulaLocal(formulaLocal)
- summary: 'The formula, if required, on which to evaluate the conditional format rule in the user''s language.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFormulaLocal(formulaLocal: string): void;'
- parameters:
- - id: formulaLocal
- description: ''
- type: string
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ConditionalFormatRule
+uid: 'ExcelScript!ExcelScript.ConditionalFormatRule:interface'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalFormatRule
+summary: 'Represents a rule, for all traditional rule/format pairings.'
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a custom conditional formatting to the selected range.
+ * A light-green fill is applied to a cell if the value is larger than the value in the row's previous column.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the selected cells.
+ let selectedRange = workbook.getSelectedRange();
+
+ // Apply a rule for positive change from the previous column.
+ let positiveChange: ExcelScript.ConditionalFormat = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom);
+
+ // Set the conditional format to be a lightgreen fill.
+ let positiveCustom: ExcelScript.CustomConditionalFormat = positiveChange.getCustom();
+ positiveCustom.getFormat().getFill().setColor("lightgreen");
+
+ // Set the conditional rule to be if there is positive change across the row.
+ let positiveRule: ExcelScript.ConditionalFormatRule = positiveCustom.getRule();
+ positiveRule.setFormula(`=${selectedRange.getCell(0, 0).getAddress()}>${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getFormula()
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatRule#getFormula:member(1)'
+ package: ExcelScript!
+ fullName: getFormula()
+ summary: 'The formula, if required, on which to evaluate the conditional format rule.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormula(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getFormulaLocal()
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatRule#getFormulaLocal:member(1)'
+ package: ExcelScript!
+ fullName: getFormulaLocal()
+ summary: 'The formula, if required, on which to evaluate the conditional format rule in the user''s language.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormulaLocal(): string;'
+ return:
+ type: string
+ description: ''
+ - name: setFormula(formula)
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatRule#setFormula:member(1)'
+ package: ExcelScript!
+ fullName: setFormula(formula)
+ summary: 'The formula, if required, on which to evaluate the conditional format rule.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFormula(formula: string): void;'
+ parameters:
+ - id: formula
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setFormulaLocal(formulaLocal)
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatRule#setFormulaLocal:member(1)'
+ package: ExcelScript!
+ fullName: setFormulaLocal(formulaLocal)
+ summary: 'The formula, if required, on which to evaluate the conditional format rule in the user''s language.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFormulaLocal(formulaLocal: string): void;'
+ parameters:
+ - id: formulaLocal
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatruletype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatruletype.yml
index 6f971dab..61700ad8 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatruletype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatruletype.yml
@@ -1,74 +1,74 @@
-### YamlMime:TSEnum
-name: ExcelScript.ConditionalFormatRuleType
-uid: 'ExcelScript!ExcelScript.ConditionalFormatRuleType:enum'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalFormatRuleType
-summary: Represents the types of conditional format values.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates data bar conditional formatting on the selected range.
- * The scale of the data bar goes from 0 to 1000.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the selected range.
- const selected = workbook.getSelectedRange();
-
- // Create new conditional formatting on the range.
- const format = selected.addConditionalFormat(ExcelScript.ConditionalFormatType.dataBar);
- const dataBarFormat = format.getDataBar();
-
- // Set the lower bound of the data bar formatting to be 0.
- const lowerBound: ExcelScript.ConditionalDataBarRule = {
- type: ExcelScript.ConditionalFormatRuleType.number,
- formula: "0"
- };
- dataBarFormat.setLowerBoundRule(lowerBound);
-
- // Set the upper bound of the data bar formatting to be 1000.
- const upperBound: ExcelScript.ConditionalDataBarRule = {
- type: ExcelScript.ConditionalFormatRuleType.number,
- formula: "1000"
- };
- dataBarFormat.setUpperBoundRule(upperBound);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: automatic
- uid: 'ExcelScript!ExcelScript.ConditionalFormatRuleType.automatic:member'
- package: ExcelScript!
- summary: ''
- - name: formula
- uid: 'ExcelScript!ExcelScript.ConditionalFormatRuleType.formula:member'
- package: ExcelScript!
- summary: ''
- - name: highestValue
- uid: 'ExcelScript!ExcelScript.ConditionalFormatRuleType.highestValue:member'
- package: ExcelScript!
- summary: ''
- - name: invalid
- uid: 'ExcelScript!ExcelScript.ConditionalFormatRuleType.invalid:member'
- package: ExcelScript!
- summary: ''
- - name: lowestValue
- uid: 'ExcelScript!ExcelScript.ConditionalFormatRuleType.lowestValue:member'
- package: ExcelScript!
- summary: ''
- - name: number
- uid: 'ExcelScript!ExcelScript.ConditionalFormatRuleType.number:member'
- package: ExcelScript!
- summary: ''
- - name: percent
- uid: 'ExcelScript!ExcelScript.ConditionalFormatRuleType.percent:member'
- package: ExcelScript!
- summary: ''
- - name: percentile
- uid: 'ExcelScript!ExcelScript.ConditionalFormatRuleType.percentile:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ConditionalFormatRuleType
+uid: 'ExcelScript!ExcelScript.ConditionalFormatRuleType:enum'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalFormatRuleType
+summary: Represents the types of conditional format values.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates data bar conditional formatting on the selected range.
+ * The scale of the data bar goes from 0 to 1000.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the selected range.
+ const selected = workbook.getSelectedRange();
+
+ // Create new conditional formatting on the range.
+ const format = selected.addConditionalFormat(ExcelScript.ConditionalFormatType.dataBar);
+ const dataBarFormat = format.getDataBar();
+
+ // Set the lower bound of the data bar formatting to be 0.
+ const lowerBound: ExcelScript.ConditionalDataBarRule = {
+ type: ExcelScript.ConditionalFormatRuleType.number,
+ formula: "0"
+ };
+ dataBarFormat.setLowerBoundRule(lowerBound);
+
+ // Set the upper bound of the data bar formatting to be 1000.
+ const upperBound: ExcelScript.ConditionalDataBarRule = {
+ type: ExcelScript.ConditionalFormatRuleType.number,
+ formula: "1000"
+ };
+ dataBarFormat.setUpperBoundRule(upperBound);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: automatic
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatRuleType.automatic:member'
+ package: ExcelScript!
+ summary: ''
+ - name: formula
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatRuleType.formula:member'
+ package: ExcelScript!
+ summary: ''
+ - name: highestValue
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatRuleType.highestValue:member'
+ package: ExcelScript!
+ summary: ''
+ - name: invalid
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatRuleType.invalid:member'
+ package: ExcelScript!
+ summary: ''
+ - name: lowestValue
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatRuleType.lowestValue:member'
+ package: ExcelScript!
+ summary: ''
+ - name: number
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatRuleType.number:member'
+ package: ExcelScript!
+ summary: ''
+ - name: percent
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatRuleType.percent:member'
+ package: ExcelScript!
+ summary: ''
+ - name: percentile
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatRuleType.percentile:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformattype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformattype.yml
index 86b4d6a1..b6079a0d 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformattype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformattype.yml
@@ -1,74 +1,74 @@
-### YamlMime:TSEnum
-name: ExcelScript.ConditionalFormatType
-uid: 'ExcelScript!ExcelScript.ConditionalFormatType:enum'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalFormatType
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a red, white, and blue color scale to the selected range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the selected range.
- let selectedRange = workbook.getSelectedRange();
-
- // Create a new conditional formatting object by adding one to the range.
- let conditionalFormatting = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.colorScale);
-
- // Set the colors for the three parts of the scale: minimum, midpoint, and maximum.
- conditionalFormatting.getColorScale().setCriteria({
- minimum: {
- color:"#F8696B", /* A pale red. */
- type:ExcelScript.ConditionalFormatColorCriterionType.lowestValue
- },
- midpoint: {
- color: "#FCFCFF", /* Slightly off-white. */
- formula:'=50',type:ExcelScript.ConditionalFormatColorCriterionType.percentile
- },
- maximum: {
- color: "#5A8AC6", /* A pale blue. */
- type:ExcelScript.ConditionalFormatColorCriterionType.highestValue
- }
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: cellValue
- uid: 'ExcelScript!ExcelScript.ConditionalFormatType.cellValue:member'
- package: ExcelScript!
- summary: ''
- - name: colorScale
- uid: 'ExcelScript!ExcelScript.ConditionalFormatType.colorScale:member'
- package: ExcelScript!
- summary: ''
- - name: containsText
- uid: 'ExcelScript!ExcelScript.ConditionalFormatType.containsText:member'
- package: ExcelScript!
- summary: ''
- - name: custom
- uid: 'ExcelScript!ExcelScript.ConditionalFormatType.custom:member'
- package: ExcelScript!
- summary: ''
- - name: dataBar
- uid: 'ExcelScript!ExcelScript.ConditionalFormatType.dataBar:member'
- package: ExcelScript!
- summary: ''
- - name: iconSet
- uid: 'ExcelScript!ExcelScript.ConditionalFormatType.iconSet:member'
- package: ExcelScript!
- summary: ''
- - name: presetCriteria
- uid: 'ExcelScript!ExcelScript.ConditionalFormatType.presetCriteria:member'
- package: ExcelScript!
- summary: ''
- - name: topBottom
- uid: 'ExcelScript!ExcelScript.ConditionalFormatType.topBottom:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ConditionalFormatType
+uid: 'ExcelScript!ExcelScript.ConditionalFormatType:enum'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalFormatType
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a red, white, and blue color scale to the selected range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the selected range.
+ let selectedRange = workbook.getSelectedRange();
+
+ // Create a new conditional formatting object by adding one to the range.
+ let conditionalFormatting = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.colorScale);
+
+ // Set the colors for the three parts of the scale: minimum, midpoint, and maximum.
+ conditionalFormatting.getColorScale().setCriteria({
+ minimum: {
+ color:"#F8696B", /* A pale red. */
+ type:ExcelScript.ConditionalFormatColorCriterionType.lowestValue
+ },
+ midpoint: {
+ color: "#FCFCFF", /* Slightly off-white. */
+ formula:'=50',type:ExcelScript.ConditionalFormatColorCriterionType.percentile
+ },
+ maximum: {
+ color: "#5A8AC6", /* A pale blue. */
+ type:ExcelScript.ConditionalFormatColorCriterionType.highestValue
+ }
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: cellValue
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatType.cellValue:member'
+ package: ExcelScript!
+ summary: ''
+ - name: colorScale
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatType.colorScale:member'
+ package: ExcelScript!
+ summary: ''
+ - name: containsText
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatType.containsText:member'
+ package: ExcelScript!
+ summary: ''
+ - name: custom
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatType.custom:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dataBar
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatType.dataBar:member'
+ package: ExcelScript!
+ summary: ''
+ - name: iconSet
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatType.iconSet:member'
+ package: ExcelScript!
+ summary: ''
+ - name: presetCriteria
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatType.presetCriteria:member'
+ package: ExcelScript!
+ summary: ''
+ - name: topBottom
+ uid: 'ExcelScript!ExcelScript.ConditionalFormatType.topBottom:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaliconcriterion.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaliconcriterion.yml
index ae1ef227..a5795bd7 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaliconcriterion.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaliconcriterion.yml
@@ -1,97 +1,97 @@
-### YamlMime:TSType
-name: ExcelScript.ConditionalIconCriterion
-uid: 'ExcelScript!ExcelScript.ConditionalIconCriterion:interface'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalIconCriterion
-summary: >-
- Represents an icon criterion which contains a type, value, an operator, and an optional custom icon, if not using an
- icon set.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies icon set conditional formatting to a range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range "A1:A5" on the current worksheet.
- const sheet = workbook.getActiveWorksheet();
- const range = sheet.getRange("A1:A5");
-
- // Create icon set conditional formatting on the range.
- const conditionalFormatting = range.addConditionalFormat(ExcelScript.ConditionalFormatType.iconSet);
-
- // Use the "3 Traffic Lights (Unrimmed)" set.
- conditionalFormatting.getIconSet().setStyle(ExcelScript.IconSet.threeTrafficLights1);
-
- // Set the criteria to use a different icon for the bottom, middle, and top thirds of the values in the range.
- const criteria: ExcelScript.ConditionalIconCriterion[] = [
- {
- formula: '=0', operator: ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
- type: ExcelScript.ConditionalFormatIconRuleType.percent
- },
- {
- formula: '=33', operator: ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
- type: ExcelScript.ConditionalFormatIconRuleType.percent
- },
- {
- formula: '=67', operator: ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
- type: ExcelScript.ConditionalFormatIconRuleType.percent
- }];
- conditionalFormatting.getIconSet().setCriteria(criteria);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: customIcon
- uid: 'ExcelScript!ExcelScript.ConditionalIconCriterion#customIcon:member'
- package: ExcelScript!
- fullName: customIcon
- summary: 'The custom icon for the current criterion, if different from the default icon set, else `null` will be returned.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'customIcon?: Icon;'
- return:
- type: ''
- - name: formula
- uid: 'ExcelScript!ExcelScript.ConditionalIconCriterion#formula:member'
- package: ExcelScript!
- fullName: formula
- summary: A number or a formula depending on the type.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'formula: string;'
- return:
- type: string
- - name: operator
- uid: 'ExcelScript!ExcelScript.ConditionalIconCriterion#operator:member'
- package: ExcelScript!
- fullName: operator
- summary: '`greaterThan` or `greaterThanOrEqual` for each of the rule types for the icon conditional format.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'operator: ConditionalIconCriterionOperator;'
- return:
- type: ''
- - name: type
- uid: 'ExcelScript!ExcelScript.ConditionalIconCriterion#type:member'
- package: ExcelScript!
- fullName: type
- summary: What the icon conditional formula should be based on.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'type: ConditionalFormatIconRuleType;'
- return:
- type: ''
+### YamlMime:TSType
+name: ExcelScript.ConditionalIconCriterion
+uid: 'ExcelScript!ExcelScript.ConditionalIconCriterion:interface'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalIconCriterion
+summary: >-
+ Represents an icon criterion which contains a type, value, an operator, and an optional custom icon, if not using an
+ icon set.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies icon set conditional formatting to a range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range "A1:A5" on the current worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const range = sheet.getRange("A1:A5");
+
+ // Create icon set conditional formatting on the range.
+ const conditionalFormatting = range.addConditionalFormat(ExcelScript.ConditionalFormatType.iconSet);
+
+ // Use the "3 Traffic Lights (Unrimmed)" set.
+ conditionalFormatting.getIconSet().setStyle(ExcelScript.IconSet.threeTrafficLights1);
+
+ // Set the criteria to use a different icon for the bottom, middle, and top thirds of the values in the range.
+ const criteria: ExcelScript.ConditionalIconCriterion[] = [
+ {
+ formula: '=0', operator: ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
+ type: ExcelScript.ConditionalFormatIconRuleType.percent
+ },
+ {
+ formula: '=33', operator: ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
+ type: ExcelScript.ConditionalFormatIconRuleType.percent
+ },
+ {
+ formula: '=67', operator: ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
+ type: ExcelScript.ConditionalFormatIconRuleType.percent
+ }];
+ conditionalFormatting.getIconSet().setCriteria(criteria);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: customIcon
+ uid: 'ExcelScript!ExcelScript.ConditionalIconCriterion#customIcon:member'
+ package: ExcelScript!
+ fullName: customIcon
+ summary: 'The custom icon for the current criterion, if different from the default icon set, else `null` will be returned.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'customIcon?: Icon;'
+ return:
+ type: ''
+ - name: formula
+ uid: 'ExcelScript!ExcelScript.ConditionalIconCriterion#formula:member'
+ package: ExcelScript!
+ fullName: formula
+ summary: A number or a formula depending on the type.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'formula: string;'
+ return:
+ type: string
+ - name: operator
+ uid: 'ExcelScript!ExcelScript.ConditionalIconCriterion#operator:member'
+ package: ExcelScript!
+ fullName: operator
+ summary: '`greaterThan` or `greaterThanOrEqual` for each of the rule types for the icon conditional format.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'operator: ConditionalIconCriterionOperator;'
+ return:
+ type: ''
+ - name: type
+ uid: 'ExcelScript!ExcelScript.ConditionalIconCriterion#type:member'
+ package: ExcelScript!
+ fullName: type
+ summary: What the icon conditional formula should be based on.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'type: ConditionalFormatIconRuleType;'
+ return:
+ type: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaliconcriterionoperator.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaliconcriterionoperator.yml
index 18ae8745..20bfde16 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaliconcriterionoperator.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaliconcriterionoperator.yml
@@ -1,58 +1,58 @@
-### YamlMime:TSEnum
-name: ExcelScript.ConditionalIconCriterionOperator
-uid: 'ExcelScript!ExcelScript.ConditionalIconCriterionOperator:enum'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalIconCriterionOperator
-summary: Represents the operator for each icon criteria.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies icon set conditional formatting to a range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range "A1:A5" on the current worksheet.
- const sheet = workbook.getActiveWorksheet();
- const range = sheet.getRange("A1:A5");
-
- // Create icon set conditional formatting on the range.
- const conditionalFormatting = range.addConditionalFormat(ExcelScript.ConditionalFormatType.iconSet);
-
- // Use the "3 Traffic Lights (Unrimmed)" set.
- conditionalFormatting.getIconSet().setStyle(ExcelScript.IconSet.threeTrafficLights1);
-
- // Set the criteria to use a different icon for the bottom, middle, and top thirds of the values in the range.
- const criteria: ExcelScript.ConditionalIconCriterion[] = [
- {
- formula: '=0', operator: ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
- type: ExcelScript.ConditionalFormatIconRuleType.percent
- },
- {
- formula: '=33', operator: ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
- type: ExcelScript.ConditionalFormatIconRuleType.percent
- },
- {
- formula: '=67', operator: ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
- type: ExcelScript.ConditionalFormatIconRuleType.percent
- }];
- conditionalFormatting.getIconSet().setCriteria(criteria);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: greaterThan
- uid: 'ExcelScript!ExcelScript.ConditionalIconCriterionOperator.greaterThan:member'
- package: ExcelScript!
- summary: ''
- - name: greaterThanOrEqual
- uid: 'ExcelScript!ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual:member'
- package: ExcelScript!
- summary: ''
- - name: invalid
- uid: 'ExcelScript!ExcelScript.ConditionalIconCriterionOperator.invalid:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ConditionalIconCriterionOperator
+uid: 'ExcelScript!ExcelScript.ConditionalIconCriterionOperator:enum'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalIconCriterionOperator
+summary: Represents the operator for each icon criteria.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies icon set conditional formatting to a range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range "A1:A5" on the current worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const range = sheet.getRange("A1:A5");
+
+ // Create icon set conditional formatting on the range.
+ const conditionalFormatting = range.addConditionalFormat(ExcelScript.ConditionalFormatType.iconSet);
+
+ // Use the "3 Traffic Lights (Unrimmed)" set.
+ conditionalFormatting.getIconSet().setStyle(ExcelScript.IconSet.threeTrafficLights1);
+
+ // Set the criteria to use a different icon for the bottom, middle, and top thirds of the values in the range.
+ const criteria: ExcelScript.ConditionalIconCriterion[] = [
+ {
+ formula: '=0', operator: ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
+ type: ExcelScript.ConditionalFormatIconRuleType.percent
+ },
+ {
+ formula: '=33', operator: ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
+ type: ExcelScript.ConditionalFormatIconRuleType.percent
+ },
+ {
+ formula: '=67', operator: ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
+ type: ExcelScript.ConditionalFormatIconRuleType.percent
+ }];
+ conditionalFormatting.getIconSet().setCriteria(criteria);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: greaterThan
+ uid: 'ExcelScript!ExcelScript.ConditionalIconCriterionOperator.greaterThan:member'
+ package: ExcelScript!
+ summary: ''
+ - name: greaterThanOrEqual
+ uid: 'ExcelScript!ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual:member'
+ package: ExcelScript!
+ summary: ''
+ - name: invalid
+ uid: 'ExcelScript!ExcelScript.ConditionalIconCriterionOperator.invalid:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalpresetcriteriarule.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalpresetcriteriarule.yml
index d915d0b9..0527b324 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalpresetcriteriarule.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalpresetcriteriarule.yml
@@ -1,53 +1,53 @@
-### YamlMime:TSType
-name: ExcelScript.ConditionalPresetCriteriaRule
-uid: 'ExcelScript!ExcelScript.ConditionalPresetCriteriaRule:interface'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalPresetCriteriaRule
-summary: Represents the preset criteria conditional format rule.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a conditional format that uses a preset criterion.
- * Any cell in row 1 will have the color fill set to green if it is a duplicate value
- * (of anything else in row 1).
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range for row 1.
- const sheet = workbook.getActiveWorksheet();
- const formattedRange = sheet.getRange("1:1");
-
- // Add new conditional formatting to that range.
- const conditionalFormat = formattedRange.addConditionalFormat(
- ExcelScript.ConditionalFormatType.presetCriteria);
-
- // Set the conditional formatting to apply a green fill.
- const presetFormat = conditionalFormat.getPreset();
- presetFormat.getFormat().getFill().setColor("green");
-
- // Set a rule to apply the conditional format when values are duplicated in the range.
- const duplicateRule: ExcelScript.ConditionalPresetCriteriaRule = {
- criterion: ExcelScript.ConditionalFormatPresetCriterion.duplicateValues
- };
- presetFormat.setRule(duplicateRule);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: criterion
- uid: 'ExcelScript!ExcelScript.ConditionalPresetCriteriaRule#criterion:member'
- package: ExcelScript!
- fullName: criterion
- summary: The criterion of the conditional format.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'criterion: ConditionalFormatPresetCriterion;'
- return:
- type: ''
+### YamlMime:TSType
+name: ExcelScript.ConditionalPresetCriteriaRule
+uid: 'ExcelScript!ExcelScript.ConditionalPresetCriteriaRule:interface'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalPresetCriteriaRule
+summary: Represents the preset criteria conditional format rule.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a conditional format that uses a preset criterion.
+ * Any cell in row 1 will have the color fill set to green if it is a duplicate value
+ * (of anything else in row 1).
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range for row 1.
+ const sheet = workbook.getActiveWorksheet();
+ const formattedRange = sheet.getRange("1:1");
+
+ // Add new conditional formatting to that range.
+ const conditionalFormat = formattedRange.addConditionalFormat(
+ ExcelScript.ConditionalFormatType.presetCriteria);
+
+ // Set the conditional formatting to apply a green fill.
+ const presetFormat = conditionalFormat.getPreset();
+ presetFormat.getFormat().getFill().setColor("green");
+
+ // Set a rule to apply the conditional format when values are duplicated in the range.
+ const duplicateRule: ExcelScript.ConditionalPresetCriteriaRule = {
+ criterion: ExcelScript.ConditionalFormatPresetCriterion.duplicateValues
+ };
+ presetFormat.setRule(duplicateRule);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: criterion
+ uid: 'ExcelScript!ExcelScript.ConditionalPresetCriteriaRule#criterion:member'
+ package: ExcelScript!
+ fullName: criterion
+ summary: The criterion of the conditional format.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'criterion: ConditionalFormatPresetCriterion;'
+ return:
+ type: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangeborder.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangeborder.yml
index 025dd7f7..a014a648 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangeborder.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangeborder.yml
@@ -1,94 +1,94 @@
-### YamlMime:TSType
-name: ExcelScript.ConditionalRangeBorder
-uid: 'ExcelScript!ExcelScript.ConditionalRangeBorder:interface'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalRangeBorder
-summary: Represents the border of an object.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getColor()
- uid: 'ExcelScript!ExcelScript.ConditionalRangeBorder#getColor:member(1)'
- package: ExcelScript!
- fullName: getColor()
- summary: >-
- HTML color code representing the color of the border line, in the form \#RRGGBB (e.g., "FFA500") or as a named
- HTML color (e.g., "orange").
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColor(): string;'
- return:
- type: string
- description: ''
- - name: getSideIndex()
- uid: 'ExcelScript!ExcelScript.ConditionalRangeBorder#getSideIndex:member(1)'
- package: ExcelScript!
- fullName: getSideIndex()
- summary: >-
- Constant value that indicates the specific side of the border. See `ExcelScript.ConditionalRangeBorderIndex` for
- details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSideIndex(): ConditionalRangeBorderIndex;'
- return:
- type: ''
- description: ''
- - name: getStyle()
- uid: 'ExcelScript!ExcelScript.ConditionalRangeBorder#getStyle:member(1)'
- package: ExcelScript!
- fullName: getStyle()
- summary: >-
- One of the constants of line style specifying the line style for the border. See `ExcelScript.BorderLineStyle` for
- details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getStyle(): ConditionalRangeBorderLineStyle;'
- return:
- type: ''
- description: ''
- - name: setColor(color)
- uid: 'ExcelScript!ExcelScript.ConditionalRangeBorder#setColor:member(1)'
- package: ExcelScript!
- fullName: setColor(color)
- summary: >-
- HTML color code representing the color of the border line, in the form \#RRGGBB (e.g., "FFA500") or as a named
- HTML color (e.g., "orange").
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setColor(color: string): void;'
- parameters:
- - id: color
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setStyle(style)
- uid: 'ExcelScript!ExcelScript.ConditionalRangeBorder#setStyle:member(1)'
- package: ExcelScript!
- fullName: setStyle(style)
- summary: >-
- One of the constants of line style specifying the line style for the border. See `ExcelScript.BorderLineStyle` for
- details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setStyle(style: ConditionalRangeBorderLineStyle): void;'
- parameters:
- - id: style
- description: ''
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ConditionalRangeBorder
+uid: 'ExcelScript!ExcelScript.ConditionalRangeBorder:interface'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalRangeBorder
+summary: Represents the border of an object.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getColor()
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeBorder#getColor:member(1)'
+ package: ExcelScript!
+ fullName: getColor()
+ summary: >-
+ HTML color code representing the color of the border line, in the form \#RRGGBB (e.g., "FFA500") or as a named
+ HTML color (e.g., "orange").
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getSideIndex()
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeBorder#getSideIndex:member(1)'
+ package: ExcelScript!
+ fullName: getSideIndex()
+ summary: >-
+ Constant value that indicates the specific side of the border. See `ExcelScript.ConditionalRangeBorderIndex` for
+ details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSideIndex(): ConditionalRangeBorderIndex;'
+ return:
+ type: ''
+ description: ''
+ - name: getStyle()
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeBorder#getStyle:member(1)'
+ package: ExcelScript!
+ fullName: getStyle()
+ summary: >-
+ One of the constants of line style specifying the line style for the border. See `ExcelScript.BorderLineStyle` for
+ details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getStyle(): ConditionalRangeBorderLineStyle;'
+ return:
+ type: ''
+ description: ''
+ - name: setColor(color)
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeBorder#setColor:member(1)'
+ package: ExcelScript!
+ fullName: setColor(color)
+ summary: >-
+ HTML color code representing the color of the border line, in the form \#RRGGBB (e.g., "FFA500") or as a named
+ HTML color (e.g., "orange").
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setColor(color: string): void;'
+ parameters:
+ - id: color
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setStyle(style)
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeBorder#setStyle:member(1)'
+ package: ExcelScript!
+ fullName: setStyle(style)
+ summary: >-
+ One of the constants of line style specifying the line style for the border. See `ExcelScript.BorderLineStyle` for
+ details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setStyle(style: ConditionalRangeBorderLineStyle): void;'
+ parameters:
+ - id: style
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangeborderindex.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangeborderindex.yml
index 3ba29361..c5199c2f 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangeborderindex.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangeborderindex.yml
@@ -1,26 +1,26 @@
-### YamlMime:TSEnum
-name: ExcelScript.ConditionalRangeBorderIndex
-uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderIndex:enum'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalRangeBorderIndex
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: edgeBottom
- uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderIndex.edgeBottom:member'
- package: ExcelScript!
- summary: ''
- - name: edgeLeft
- uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderIndex.edgeLeft:member'
- package: ExcelScript!
- summary: ''
- - name: edgeRight
- uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderIndex.edgeRight:member'
- package: ExcelScript!
- summary: ''
- - name: edgeTop
- uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderIndex.edgeTop:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ConditionalRangeBorderIndex
+uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderIndex:enum'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalRangeBorderIndex
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: edgeBottom
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderIndex.edgeBottom:member'
+ package: ExcelScript!
+ summary: ''
+ - name: edgeLeft
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderIndex.edgeLeft:member'
+ package: ExcelScript!
+ summary: ''
+ - name: edgeRight
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderIndex.edgeRight:member'
+ package: ExcelScript!
+ summary: ''
+ - name: edgeTop
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderIndex.edgeTop:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangeborderlinestyle.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangeborderlinestyle.yml
index 2e4285e1..436688af 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangeborderlinestyle.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangeborderlinestyle.yml
@@ -1,34 +1,34 @@
-### YamlMime:TSEnum
-name: ExcelScript.ConditionalRangeBorderLineStyle
-uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderLineStyle:enum'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalRangeBorderLineStyle
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: continuous
- uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderLineStyle.continuous:member'
- package: ExcelScript!
- summary: ''
- - name: dash
- uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderLineStyle.dash:member'
- package: ExcelScript!
- summary: ''
- - name: dashDot
- uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderLineStyle.dashDot:member'
- package: ExcelScript!
- summary: ''
- - name: dashDotDot
- uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderLineStyle.dashDotDot:member'
- package: ExcelScript!
- summary: ''
- - name: dot
- uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderLineStyle.dot:member'
- package: ExcelScript!
- summary: ''
- - name: none
- uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderLineStyle.none:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ConditionalRangeBorderLineStyle
+uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderLineStyle:enum'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalRangeBorderLineStyle
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: continuous
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderLineStyle.continuous:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dash
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderLineStyle.dash:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dashDot
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderLineStyle.dashDot:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dashDotDot
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderLineStyle.dashDotDot:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dot
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderLineStyle.dot:member'
+ package: ExcelScript!
+ summary: ''
+ - name: none
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeBorderLineStyle.none:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangefill.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangefill.yml
index 7cb68e67..48d0d154 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangefill.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangefill.yml
@@ -1,90 +1,90 @@
-### YamlMime:TSType
-name: ExcelScript.ConditionalRangeFill
-uid: 'ExcelScript!ExcelScript.ConditionalRangeFill:interface'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalRangeFill
-summary: Represents the background of a conditional range object.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies cell value conditional formatting to a range.
- * Any value less than 60 will have the cell's fill color changed and the font made italic.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range to format.
- const selectedRange = workbook.getSelectedRange();
-
- // Add cell value conditional formatting.
- const cellValueConditionalFormatting =
- selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.cellValue).getCellValue();
-
- // Create the condition, in this case when the cell value is less than 60.
- const rule: ExcelScript.ConditionalCellValueRule = {
- formula1: "60",
- operator: ExcelScript.ConditionalCellValueOperator.lessThan
- };
- cellValueConditionalFormatting.setRule(rule);
-
- // Set the format to apply when the condition is met.
- const format: ExcelScript.ConditionalRangeFormat = cellValueConditionalFormatting.getFormat();
- const fill: ExcelScript.ConditionalRangeFill = format.getFill();
- const font: ExcelScript.ConditionalRangeFont = format.getFont();
- fill.setColor("yellow");
- font.setItalic(true);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: clear()
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFill#clear:member(1)'
- package: ExcelScript!
- fullName: clear()
- summary: Resets the fill.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'clear(): void;'
- return:
- type: void
- description: ''
- - name: getColor()
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFill#getColor:member(1)'
- package: ExcelScript!
- fullName: getColor()
- summary: >-
- HTML color code representing the color of the fill, in the form \#RRGGBB (e.g., "FFA500") or as a named HTML color
- (e.g., "orange").
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColor(): string;'
- return:
- type: string
- description: ''
- - name: setColor(color)
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFill#setColor:member(1)'
- package: ExcelScript!
- fullName: setColor(color)
- summary: >-
- HTML color code representing the color of the fill, in the form \#RRGGBB (e.g., "FFA500") or as a named HTML color
- (e.g., "orange").
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setColor(color: string): void;'
- parameters:
- - id: color
- description: ''
- type: string
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ConditionalRangeFill
+uid: 'ExcelScript!ExcelScript.ConditionalRangeFill:interface'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalRangeFill
+summary: Represents the background of a conditional range object.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies cell value conditional formatting to a range.
+ * Any value less than 60 will have the cell's fill color changed and the font made italic.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range to format.
+ const selectedRange = workbook.getSelectedRange();
+
+ // Add cell value conditional formatting.
+ const cellValueConditionalFormatting =
+ selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.cellValue).getCellValue();
+
+ // Create the condition, in this case when the cell value is less than 60.
+ const rule: ExcelScript.ConditionalCellValueRule = {
+ formula1: "60",
+ operator: ExcelScript.ConditionalCellValueOperator.lessThan
+ };
+ cellValueConditionalFormatting.setRule(rule);
+
+ // Set the format to apply when the condition is met.
+ const format: ExcelScript.ConditionalRangeFormat = cellValueConditionalFormatting.getFormat();
+ const fill: ExcelScript.ConditionalRangeFill = format.getFill();
+ const font: ExcelScript.ConditionalRangeFont = format.getFont();
+ fill.setColor("yellow");
+ font.setItalic(true);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: clear()
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFill#clear:member(1)'
+ package: ExcelScript!
+ fullName: clear()
+ summary: Resets the fill.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clear(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getColor()
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFill#getColor:member(1)'
+ package: ExcelScript!
+ fullName: getColor()
+ summary: >-
+ HTML color code representing the color of the fill, in the form \#RRGGBB (e.g., "FFA500") or as a named HTML color
+ (e.g., "orange").
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: setColor(color)
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFill#setColor:member(1)'
+ package: ExcelScript!
+ fullName: setColor(color)
+ summary: >-
+ HTML color code representing the color of the fill, in the form \#RRGGBB (e.g., "FFA500") or as a named HTML color
+ (e.g., "orange").
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setColor(color: string): void;'
+ parameters:
+ - id: color
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangefont.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangefont.yml
index 1b23cdab..a87d6723 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangefont.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangefont.yml
@@ -1,206 +1,206 @@
-### YamlMime:TSType
-name: ExcelScript.ConditionalRangeFont
-uid: 'ExcelScript!ExcelScript.ConditionalRangeFont:interface'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalRangeFont
-summary: 'This object represents the font attributes (font style, color, etc.) for an object.'
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies cell value conditional formatting to a range.
- * Any value less than 60 will have the cell's fill color changed and the font made italic.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range to format.
- const selectedRange = workbook.getSelectedRange();
-
- // Add cell value conditional formatting.
- const cellValueConditionalFormatting =
- selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.cellValue).getCellValue();
-
- // Create the condition, in this case when the cell value is less than 60.
- const rule: ExcelScript.ConditionalCellValueRule = {
- formula1: "60",
- operator: ExcelScript.ConditionalCellValueOperator.lessThan
- };
- cellValueConditionalFormatting.setRule(rule);
-
- // Set the format to apply when the condition is met.
- const format: ExcelScript.ConditionalRangeFormat = cellValueConditionalFormatting.getFormat();
- const fill: ExcelScript.ConditionalRangeFill = format.getFill();
- const font: ExcelScript.ConditionalRangeFont = format.getFont();
- fill.setColor("yellow");
- font.setItalic(true);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: clear()
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#clear:member(1)'
- package: ExcelScript!
- fullName: clear()
- summary: Resets the font formats.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'clear(): void;'
- return:
- type: void
- description: ''
- - name: getBold()
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#getBold:member(1)'
- package: ExcelScript!
- fullName: getBold()
- summary: Specifies if the font is bold.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBold(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getColor()
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#getColor:member(1)'
- package: ExcelScript!
- fullName: getColor()
- summary: 'HTML color code representation of the text color (e.g., \#FF0000 represents Red).'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColor(): string;'
- return:
- type: string
- description: ''
- - name: getItalic()
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#getItalic:member(1)'
- package: ExcelScript!
- fullName: getItalic()
- summary: Specifies if the font is italic.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getItalic(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getStrikethrough()
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#getStrikethrough:member(1)'
- package: ExcelScript!
- fullName: getStrikethrough()
- summary: Specifies the strikethrough status of the font.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getStrikethrough(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getUnderline()
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#getUnderline:member(1)'
- package: ExcelScript!
- fullName: getUnderline()
- summary: The type of underline applied to the font. See `ExcelScript.ConditionalRangeFontUnderlineStyle` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getUnderline(): ConditionalRangeFontUnderlineStyle;'
- return:
- type: ''
- description: ''
- - name: setBold(bold)
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#setBold:member(1)'
- package: ExcelScript!
- fullName: setBold(bold)
- summary: Specifies if the font is bold.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setBold(bold: boolean): void;'
- parameters:
- - id: bold
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setColor(color)
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#setColor:member(1)'
- package: ExcelScript!
- fullName: setColor(color)
- summary: 'HTML color code representation of the text color (e.g., \#FF0000 represents Red).'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setColor(color: string): void;'
- parameters:
- - id: color
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setItalic(italic)
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#setItalic:member(1)'
- package: ExcelScript!
- fullName: setItalic(italic)
- summary: Specifies if the font is italic.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setItalic(italic: boolean): void;'
- parameters:
- - id: italic
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setStrikethrough(strikethrough)
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#setStrikethrough:member(1)'
- package: ExcelScript!
- fullName: setStrikethrough(strikethrough)
- summary: Specifies the strikethrough status of the font.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setStrikethrough(strikethrough: boolean): void;'
- parameters:
- - id: strikethrough
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setUnderline(underline)
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#setUnderline:member(1)'
- package: ExcelScript!
- fullName: setUnderline(underline)
- summary: The type of underline applied to the font. See `ExcelScript.ConditionalRangeFontUnderlineStyle` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setUnderline(underline: ConditionalRangeFontUnderlineStyle): void;'
- parameters:
- - id: underline
- description: ''
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ConditionalRangeFont
+uid: 'ExcelScript!ExcelScript.ConditionalRangeFont:interface'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalRangeFont
+summary: 'This object represents the font attributes (font style, color, etc.) for an object.'
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies cell value conditional formatting to a range.
+ * Any value less than 60 will have the cell's fill color changed and the font made italic.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range to format.
+ const selectedRange = workbook.getSelectedRange();
+
+ // Add cell value conditional formatting.
+ const cellValueConditionalFormatting =
+ selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.cellValue).getCellValue();
+
+ // Create the condition, in this case when the cell value is less than 60.
+ const rule: ExcelScript.ConditionalCellValueRule = {
+ formula1: "60",
+ operator: ExcelScript.ConditionalCellValueOperator.lessThan
+ };
+ cellValueConditionalFormatting.setRule(rule);
+
+ // Set the format to apply when the condition is met.
+ const format: ExcelScript.ConditionalRangeFormat = cellValueConditionalFormatting.getFormat();
+ const fill: ExcelScript.ConditionalRangeFill = format.getFill();
+ const font: ExcelScript.ConditionalRangeFont = format.getFont();
+ fill.setColor("yellow");
+ font.setItalic(true);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: clear()
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#clear:member(1)'
+ package: ExcelScript!
+ fullName: clear()
+ summary: Resets the font formats.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clear(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getBold()
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#getBold:member(1)'
+ package: ExcelScript!
+ fullName: getBold()
+ summary: Specifies if the font is bold.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBold(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getColor()
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#getColor:member(1)'
+ package: ExcelScript!
+ fullName: getColor()
+ summary: 'HTML color code representation of the text color (e.g., \#FF0000 represents Red).'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getItalic()
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#getItalic:member(1)'
+ package: ExcelScript!
+ fullName: getItalic()
+ summary: Specifies if the font is italic.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItalic(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getStrikethrough()
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#getStrikethrough:member(1)'
+ package: ExcelScript!
+ fullName: getStrikethrough()
+ summary: Specifies the strikethrough status of the font.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getStrikethrough(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getUnderline()
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#getUnderline:member(1)'
+ package: ExcelScript!
+ fullName: getUnderline()
+ summary: The type of underline applied to the font. See `ExcelScript.ConditionalRangeFontUnderlineStyle` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getUnderline(): ConditionalRangeFontUnderlineStyle;'
+ return:
+ type: ''
+ description: ''
+ - name: setBold(bold)
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#setBold:member(1)'
+ package: ExcelScript!
+ fullName: setBold(bold)
+ summary: Specifies if the font is bold.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setBold(bold: boolean): void;'
+ parameters:
+ - id: bold
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setColor(color)
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#setColor:member(1)'
+ package: ExcelScript!
+ fullName: setColor(color)
+ summary: 'HTML color code representation of the text color (e.g., \#FF0000 represents Red).'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setColor(color: string): void;'
+ parameters:
+ - id: color
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setItalic(italic)
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#setItalic:member(1)'
+ package: ExcelScript!
+ fullName: setItalic(italic)
+ summary: Specifies if the font is italic.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setItalic(italic: boolean): void;'
+ parameters:
+ - id: italic
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setStrikethrough(strikethrough)
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#setStrikethrough:member(1)'
+ package: ExcelScript!
+ fullName: setStrikethrough(strikethrough)
+ summary: Specifies the strikethrough status of the font.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setStrikethrough(strikethrough: boolean): void;'
+ parameters:
+ - id: strikethrough
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setUnderline(underline)
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFont#setUnderline:member(1)'
+ package: ExcelScript!
+ fullName: setUnderline(underline)
+ summary: The type of underline applied to the font. See `ExcelScript.ConditionalRangeFontUnderlineStyle` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setUnderline(underline: ConditionalRangeFontUnderlineStyle): void;'
+ parameters:
+ - id: underline
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangefontunderlinestyle.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangefontunderlinestyle.yml
index c3cb0390..d5189575 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangefontunderlinestyle.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangefontunderlinestyle.yml
@@ -1,22 +1,22 @@
-### YamlMime:TSEnum
-name: ExcelScript.ConditionalRangeFontUnderlineStyle
-uid: 'ExcelScript!ExcelScript.ConditionalRangeFontUnderlineStyle:enum'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalRangeFontUnderlineStyle
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: double
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFontUnderlineStyle.double:member'
- package: ExcelScript!
- summary: ''
- - name: none
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFontUnderlineStyle.none:member'
- package: ExcelScript!
- summary: ''
- - name: single
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFontUnderlineStyle.single:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ConditionalRangeFontUnderlineStyle
+uid: 'ExcelScript!ExcelScript.ConditionalRangeFontUnderlineStyle:enum'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalRangeFontUnderlineStyle
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: double
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFontUnderlineStyle.double:member'
+ package: ExcelScript!
+ summary: ''
+ - name: none
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFontUnderlineStyle.none:member'
+ package: ExcelScript!
+ summary: ''
+ - name: single
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFontUnderlineStyle.single:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangeformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangeformat.yml
index bc096bf9..d8fe7044 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangeformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalrangeformat.yml
@@ -1,182 +1,195 @@
-### YamlMime:TSType
-name: ExcelScript.ConditionalRangeFormat
-uid: 'ExcelScript!ExcelScript.ConditionalRangeFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalRangeFormat
-summary: 'A format object encapsulating the conditional formats range''s font, fill, borders, and other properties.'
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies cell value conditional formatting to a range.
- * Any value less than 60 will have the cell's fill color changed and the font made italic.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range to format.
- const selectedRange = workbook.getSelectedRange();
-
- // Add cell value conditional formatting.
- const cellValueConditionalFormatting =
- selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.cellValue).getCellValue();
-
- // Create the condition, in this case when the cell value is less than 60.
- const rule: ExcelScript.ConditionalCellValueRule = {
- formula1: "60",
- operator: ExcelScript.ConditionalCellValueOperator.lessThan
- };
- cellValueConditionalFormatting.setRule(rule);
-
- // Set the format to apply when the condition is met.
- const format: ExcelScript.ConditionalRangeFormat = cellValueConditionalFormatting.getFormat();
- format.getFill().setColor("yellow");
- format.getFont().setItalic(true);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getBorders()
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFormat#getBorders:member(1)'
- package: ExcelScript!
- fullName: getBorders()
- summary: Collection of border objects that apply to the overall conditional format range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBorders(): ConditionalRangeBorder[];'
- return:
- type: '[]'
- description: ''
- - name: getConditionalRangeBorder(index)
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFormat#getConditionalRangeBorder:member(1)'
- package: ExcelScript!
- fullName: getConditionalRangeBorder(index)
- summary: Gets a border object using its name.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- getConditionalRangeBorder(
- index: ConditionalRangeBorderIndex
- ): ConditionalRangeBorder;
- parameters:
- - id: index
- description: Index value of the border object to be retrieved. See `ExcelScript.ConditionalRangeBorderIndex` for details.
- type: ''
- return:
- type: ''
- description: ''
- - name: getConditionalRangeBorderBottom()
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFormat#getConditionalRangeBorderBottom:member(1)'
- package: ExcelScript!
- fullName: getConditionalRangeBorderBottom()
- summary: Gets the bottom border.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getConditionalRangeBorderBottom(): ConditionalRangeBorder;'
- return:
- type: ''
- description: ''
- - name: getConditionalRangeBorderLeft()
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFormat#getConditionalRangeBorderLeft:member(1)'
- package: ExcelScript!
- fullName: getConditionalRangeBorderLeft()
- summary: Gets the left border.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getConditionalRangeBorderLeft(): ConditionalRangeBorder;'
- return:
- type: ''
- description: ''
- - name: getConditionalRangeBorderRight()
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFormat#getConditionalRangeBorderRight:member(1)'
- package: ExcelScript!
- fullName: getConditionalRangeBorderRight()
- summary: Gets the right border.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getConditionalRangeBorderRight(): ConditionalRangeBorder;'
- return:
- type: ''
- description: ''
- - name: getConditionalRangeBorderTop()
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFormat#getConditionalRangeBorderTop:member(1)'
- package: ExcelScript!
- fullName: getConditionalRangeBorderTop()
- summary: Gets the top border.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getConditionalRangeBorderTop(): ConditionalRangeBorder;'
- return:
- type: ''
- description: ''
- - name: getFill()
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFormat#getFill:member(1)'
- package: ExcelScript!
- fullName: getFill()
- summary: Returns the fill object defined on the overall conditional format range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFill(): ConditionalRangeFill;'
- return:
- type: ''
- description: ''
- - name: getFont()
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFormat#getFont:member(1)'
- package: ExcelScript!
- fullName: getFont()
- summary: Returns the font object defined on the overall conditional format range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFont(): ConditionalRangeFont;'
- return:
- type: ''
- description: ''
- - name: getNumberFormat()
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFormat#getNumberFormat:member(1)'
- package: ExcelScript!
- fullName: getNumberFormat()
- summary: Represents Excel's number format code for the given range. Cleared if `null` is passed in.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNumberFormat(): string;'
- return:
- type: string
- description: ''
- - name: setNumberFormat(numberFormat)
- uid: 'ExcelScript!ExcelScript.ConditionalRangeFormat#setNumberFormat:member(1)'
- package: ExcelScript!
- fullName: setNumberFormat(numberFormat)
- summary: Represents Excel's number format code for the given range. Cleared if `null` is passed in.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setNumberFormat(numberFormat: string): void;'
- parameters:
- - id: numberFormat
- description: ''
- type: string
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ConditionalRangeFormat
+uid: 'ExcelScript!ExcelScript.ConditionalRangeFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalRangeFormat
+summary: 'A format object encapsulating the conditional formats range''s font, fill, borders, and other properties.'
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies cell value conditional formatting to a range.
+ * Any value less than 60 will have the cell's fill color changed and the font made italic.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range to format.
+ const selectedRange = workbook.getSelectedRange();
+
+ // Add cell value conditional formatting.
+ const cellValueConditionalFormatting =
+ selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.cellValue).getCellValue();
+
+ // Create the condition, in this case when the cell value is less than 60.
+ const rule: ExcelScript.ConditionalCellValueRule = {
+ formula1: "60",
+ operator: ExcelScript.ConditionalCellValueOperator.lessThan
+ };
+ cellValueConditionalFormatting.setRule(rule);
+
+ // Set the format to apply when the condition is met.
+ const format: ExcelScript.ConditionalRangeFormat = cellValueConditionalFormatting.getFormat();
+ format.getFill().setColor("yellow");
+ format.getFont().setItalic(true);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: clearFormat()
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFormat#clearFormat:member(1)'
+ package: ExcelScript!
+ fullName: clearFormat()
+ summary: Remove the format properties from a conditional format rule. This creates a rule with no format settings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clearFormat(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getBorders()
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFormat#getBorders:member(1)'
+ package: ExcelScript!
+ fullName: getBorders()
+ summary: Collection of border objects that apply to the overall conditional format range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBorders(): ConditionalRangeBorder[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getConditionalRangeBorder(index)
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFormat#getConditionalRangeBorder:member(1)'
+ package: ExcelScript!
+ fullName: getConditionalRangeBorder(index)
+ summary: Gets a border object using its name.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ getConditionalRangeBorder(
+ index: ConditionalRangeBorderIndex
+ ): ConditionalRangeBorder;
+ parameters:
+ - id: index
+ description: Index value of the border object to be retrieved. See `ExcelScript.ConditionalRangeBorderIndex` for details.
+ type: ''
+ return:
+ type: ''
+ description: ''
+ - name: getConditionalRangeBorderBottom()
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFormat#getConditionalRangeBorderBottom:member(1)'
+ package: ExcelScript!
+ fullName: getConditionalRangeBorderBottom()
+ summary: Gets the bottom border.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getConditionalRangeBorderBottom(): ConditionalRangeBorder;'
+ return:
+ type: ''
+ description: ''
+ - name: getConditionalRangeBorderLeft()
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFormat#getConditionalRangeBorderLeft:member(1)'
+ package: ExcelScript!
+ fullName: getConditionalRangeBorderLeft()
+ summary: Gets the left border.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getConditionalRangeBorderLeft(): ConditionalRangeBorder;'
+ return:
+ type: ''
+ description: ''
+ - name: getConditionalRangeBorderRight()
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFormat#getConditionalRangeBorderRight:member(1)'
+ package: ExcelScript!
+ fullName: getConditionalRangeBorderRight()
+ summary: Gets the right border.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getConditionalRangeBorderRight(): ConditionalRangeBorder;'
+ return:
+ type: ''
+ description: ''
+ - name: getConditionalRangeBorderTop()
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFormat#getConditionalRangeBorderTop:member(1)'
+ package: ExcelScript!
+ fullName: getConditionalRangeBorderTop()
+ summary: Gets the top border.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getConditionalRangeBorderTop(): ConditionalRangeBorder;'
+ return:
+ type: ''
+ description: ''
+ - name: getFill()
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFormat#getFill:member(1)'
+ package: ExcelScript!
+ fullName: getFill()
+ summary: Returns the fill object defined on the overall conditional format range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFill(): ConditionalRangeFill;'
+ return:
+ type: ''
+ description: ''
+ - name: getFont()
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFormat#getFont:member(1)'
+ package: ExcelScript!
+ fullName: getFont()
+ summary: Returns the font object defined on the overall conditional format range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFont(): ConditionalRangeFont;'
+ return:
+ type: ''
+ description: ''
+ - name: getNumberFormat()
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFormat#getNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: getNumberFormat()
+ summary: Represents Excel's number format code for the given range. Cleared if `null` is passed in.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNumberFormat(): string;'
+ return:
+ type: string
+ description: ''
+ - name: setNumberFormat(numberFormat)
+ uid: 'ExcelScript!ExcelScript.ConditionalRangeFormat#setNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: setNumberFormat(numberFormat)
+ summary: Represents Excel's number format code for the given range. Cleared if `null` is passed in.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setNumberFormat(numberFormat: string): void;'
+ parameters:
+ - id: numberFormat
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaltextcomparisonrule.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaltextcomparisonrule.yml
index b0b44207..cc5ea8e9 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaltextcomparisonrule.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaltextcomparisonrule.yml
@@ -1,64 +1,64 @@
-### YamlMime:TSType
-name: ExcelScript.ConditionalTextComparisonRule
-uid: 'ExcelScript!ExcelScript.ConditionalTextComparisonRule:interface'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalTextComparisonRule
-summary: Represents a cell value conditional format rule.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds conditional formatting to the first column in the worksheet.
- * This formatting gives the cells a green fill if they have text starting with "Excel".
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first column in the current worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const firstColumn = currentSheet.getRange("A:A");
-
- // Add conditional formatting based on the text in the cells.
- const textConditionFormat =
- firstColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.containsText).getTextComparison();
-
- // Set the conditional format to provide a green fill.
- textConditionFormat.getFormat().getFill().setColor("green");
-
- // Apply the condition rule that the text begins with "Excel".
- const textRule: ExcelScript.ConditionalTextComparisonRule = {
- operator: ExcelScript.ConditionalTextOperator.beginsWith,
- text: "Excel"
- };
- textConditionFormat.setRule(textRule);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: operator
- uid: 'ExcelScript!ExcelScript.ConditionalTextComparisonRule#operator:member'
- package: ExcelScript!
- fullName: operator
- summary: The operator of the text conditional format.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'operator: ConditionalTextOperator;'
- return:
- type: ''
- - name: text
- uid: 'ExcelScript!ExcelScript.ConditionalTextComparisonRule#text:member'
- package: ExcelScript!
- fullName: text
- summary: The text value of the conditional format.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'text: string;'
- return:
- type: string
+### YamlMime:TSType
+name: ExcelScript.ConditionalTextComparisonRule
+uid: 'ExcelScript!ExcelScript.ConditionalTextComparisonRule:interface'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalTextComparisonRule
+summary: Represents a cell value conditional format rule.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds conditional formatting to the first column in the worksheet.
+ * This formatting gives the cells a green fill if they have text starting with "Excel".
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first column in the current worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const firstColumn = currentSheet.getRange("A:A");
+
+ // Add conditional formatting based on the text in the cells.
+ const textConditionFormat =
+ firstColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.containsText).getTextComparison();
+
+ // Set the conditional format to provide a green fill.
+ textConditionFormat.getFormat().getFill().setColor("green");
+
+ // Apply the condition rule that the text begins with "Excel".
+ const textRule: ExcelScript.ConditionalTextComparisonRule = {
+ operator: ExcelScript.ConditionalTextOperator.beginsWith,
+ text: "Excel"
+ };
+ textConditionFormat.setRule(textRule);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: operator
+ uid: 'ExcelScript!ExcelScript.ConditionalTextComparisonRule#operator:member'
+ package: ExcelScript!
+ fullName: operator
+ summary: The operator of the text conditional format.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'operator: ConditionalTextOperator;'
+ return:
+ type: ''
+ - name: text
+ uid: 'ExcelScript!ExcelScript.ConditionalTextComparisonRule#text:member'
+ package: ExcelScript!
+ fullName: text
+ summary: The text value of the conditional format.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'text: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaltextoperator.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaltextoperator.yml
index 695a5785..8cdd45e1 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaltextoperator.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaltextoperator.yml
@@ -1,59 +1,59 @@
-### YamlMime:TSEnum
-name: ExcelScript.ConditionalTextOperator
-uid: 'ExcelScript!ExcelScript.ConditionalTextOperator:enum'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalTextOperator
-summary: Represents the operator of the text conditional format type.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds conditional formatting to the first column in the worksheet.
- * This formatting gives the cells a green fill if they have text starting with "Excel".
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first column in the current worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const firstColumn = currentSheet.getRange("A:A");
-
- // Add conditional formatting based on the text in the cells.
- const textConditionFormat =
- firstColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.containsText).getTextComparison();
-
- // Set the conditional format to provide a green fill.
- textConditionFormat.getFormat().getFill().setColor("green");
-
- // Apply the condition rule that the text begins with "Excel".
- const textRule: ExcelScript.ConditionalTextComparisonRule = {
- operator: ExcelScript.ConditionalTextOperator.beginsWith,
- text: "Excel"
- };
- textConditionFormat.setRule(textRule);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: beginsWith
- uid: 'ExcelScript!ExcelScript.ConditionalTextOperator.beginsWith:member'
- package: ExcelScript!
- summary: ''
- - name: contains
- uid: 'ExcelScript!ExcelScript.ConditionalTextOperator.contains:member'
- package: ExcelScript!
- summary: ''
- - name: endsWith
- uid: 'ExcelScript!ExcelScript.ConditionalTextOperator.endsWith:member'
- package: ExcelScript!
- summary: ''
- - name: invalid
- uid: 'ExcelScript!ExcelScript.ConditionalTextOperator.invalid:member'
- package: ExcelScript!
- summary: ''
- - name: notContains
- uid: 'ExcelScript!ExcelScript.ConditionalTextOperator.notContains:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ConditionalTextOperator
+uid: 'ExcelScript!ExcelScript.ConditionalTextOperator:enum'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalTextOperator
+summary: Represents the operator of the text conditional format type.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds conditional formatting to the first column in the worksheet.
+ * This formatting gives the cells a green fill if they have text starting with "Excel".
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first column in the current worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const firstColumn = currentSheet.getRange("A:A");
+
+ // Add conditional formatting based on the text in the cells.
+ const textConditionFormat =
+ firstColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.containsText).getTextComparison();
+
+ // Set the conditional format to provide a green fill.
+ textConditionFormat.getFormat().getFill().setColor("green");
+
+ // Apply the condition rule that the text begins with "Excel".
+ const textRule: ExcelScript.ConditionalTextComparisonRule = {
+ operator: ExcelScript.ConditionalTextOperator.beginsWith,
+ text: "Excel"
+ };
+ textConditionFormat.setRule(textRule);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: beginsWith
+ uid: 'ExcelScript!ExcelScript.ConditionalTextOperator.beginsWith:member'
+ package: ExcelScript!
+ summary: ''
+ - name: contains
+ uid: 'ExcelScript!ExcelScript.ConditionalTextOperator.contains:member'
+ package: ExcelScript!
+ summary: ''
+ - name: endsWith
+ uid: 'ExcelScript!ExcelScript.ConditionalTextOperator.endsWith:member'
+ package: ExcelScript!
+ summary: ''
+ - name: invalid
+ uid: 'ExcelScript!ExcelScript.ConditionalTextOperator.invalid:member'
+ package: ExcelScript!
+ summary: ''
+ - name: notContains
+ uid: 'ExcelScript!ExcelScript.ConditionalTextOperator.notContains:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaltopbottomcriteriontype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaltopbottomcriteriontype.yml
index ab60243b..67aa73f4 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaltopbottomcriteriontype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaltopbottomcriteriontype.yml
@@ -1,30 +1,30 @@
-### YamlMime:TSEnum
-name: ExcelScript.ConditionalTopBottomCriterionType
-uid: 'ExcelScript!ExcelScript.ConditionalTopBottomCriterionType:enum'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalTopBottomCriterionType
-summary: Represents the criteria for the above/below average conditional format type.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: bottomItems
- uid: 'ExcelScript!ExcelScript.ConditionalTopBottomCriterionType.bottomItems:member'
- package: ExcelScript!
- summary: ''
- - name: bottomPercent
- uid: 'ExcelScript!ExcelScript.ConditionalTopBottomCriterionType.bottomPercent:member'
- package: ExcelScript!
- summary: ''
- - name: invalid
- uid: 'ExcelScript!ExcelScript.ConditionalTopBottomCriterionType.invalid:member'
- package: ExcelScript!
- summary: ''
- - name: topItems
- uid: 'ExcelScript!ExcelScript.ConditionalTopBottomCriterionType.topItems:member'
- package: ExcelScript!
- summary: ''
- - name: topPercent
- uid: 'ExcelScript!ExcelScript.ConditionalTopBottomCriterionType.topPercent:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ConditionalTopBottomCriterionType
+uid: 'ExcelScript!ExcelScript.ConditionalTopBottomCriterionType:enum'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalTopBottomCriterionType
+summary: Represents the criteria for the above/below average conditional format type.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: bottomItems
+ uid: 'ExcelScript!ExcelScript.ConditionalTopBottomCriterionType.bottomItems:member'
+ package: ExcelScript!
+ summary: ''
+ - name: bottomPercent
+ uid: 'ExcelScript!ExcelScript.ConditionalTopBottomCriterionType.bottomPercent:member'
+ package: ExcelScript!
+ summary: ''
+ - name: invalid
+ uid: 'ExcelScript!ExcelScript.ConditionalTopBottomCriterionType.invalid:member'
+ package: ExcelScript!
+ summary: ''
+ - name: topItems
+ uid: 'ExcelScript!ExcelScript.ConditionalTopBottomCriterionType.topItems:member'
+ package: ExcelScript!
+ summary: ''
+ - name: topPercent
+ uid: 'ExcelScript!ExcelScript.ConditionalTopBottomCriterionType.topPercent:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaltopbottomrule.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaltopbottomrule.yml
index b69a07f1..b83f618b 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaltopbottomrule.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaltopbottomrule.yml
@@ -1,60 +1,60 @@
-### YamlMime:TSType
-name: ExcelScript.ConditionalTopBottomRule
-uid: 'ExcelScript!ExcelScript.ConditionalTopBottomRule:interface'
-package: ExcelScript!
-fullName: ExcelScript.ConditionalTopBottomRule
-summary: Represents the rule of the top/bottom conditional format.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample applies conditional formatting to the currently used range in the worksheet.
- * The conditional formatting is a pink fill for the 5 lowest values.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Get the used range in the worksheet.
- let range = selectedSheet.getUsedRange();
-
- // Set the fill color to pink for the lowest 5 values in the range.
- let conditionalFormat = range.addConditionalFormat(ExcelScript.ConditionalFormatType.topBottom)
- conditionalFormat.getTopBottom().getFormat().getFill().setColor("pink");
- conditionalFormat.getTopBottom().setRule({
- rank: 5, /* The numerical threshold. */
- type: ExcelScript.ConditionalTopBottomCriterionType.bottomItems /* The type of the top/bottom condition. */
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: rank
- uid: 'ExcelScript!ExcelScript.ConditionalTopBottomRule#rank:member'
- package: ExcelScript!
- fullName: rank
- summary: The rank between 1 and 1000 for numeric ranks or 1 and 100 for percent ranks.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'rank: number;'
- return:
- type: number
- - name: type
- uid: 'ExcelScript!ExcelScript.ConditionalTopBottomRule#type:member'
- package: ExcelScript!
- fullName: type
- summary: Format values based on the top or bottom rank.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'type: ConditionalTopBottomCriterionType;'
- return:
- type: ''
+### YamlMime:TSType
+name: ExcelScript.ConditionalTopBottomRule
+uid: 'ExcelScript!ExcelScript.ConditionalTopBottomRule:interface'
+package: ExcelScript!
+fullName: ExcelScript.ConditionalTopBottomRule
+summary: Represents the rule of the top/bottom conditional format.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample applies conditional formatting to the currently used range in the worksheet.
+ * The conditional formatting is a pink fill for the 5 lowest values.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Get the used range in the worksheet.
+ let range = selectedSheet.getUsedRange();
+
+ // Set the fill color to pink for the lowest 5 values in the range.
+ let conditionalFormat = range.addConditionalFormat(ExcelScript.ConditionalFormatType.topBottom)
+ conditionalFormat.getTopBottom().getFormat().getFill().setColor("pink");
+ conditionalFormat.getTopBottom().setRule({
+ rank: 5, /* The numerical threshold. */
+ type: ExcelScript.ConditionalTopBottomCriterionType.bottomItems /* The type of the top/bottom condition. */
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: rank
+ uid: 'ExcelScript!ExcelScript.ConditionalTopBottomRule#rank:member'
+ package: ExcelScript!
+ fullName: rank
+ summary: The rank between 1 and 1000 for numeric ranks or 1 and 100 for percent ranks.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rank: number;'
+ return:
+ type: number
+ - name: type
+ uid: 'ExcelScript!ExcelScript.ConditionalTopBottomRule#type:member'
+ package: ExcelScript!
+ fullName: type
+ summary: Format values based on the top or bottom rank.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'type: ConditionalTopBottomCriterionType;'
+ return:
+ type: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.connectortype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.connectortype.yml
index fc053b43..af82633d 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.connectortype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.connectortype.yml
@@ -1,47 +1,47 @@
-### YamlMime:TSEnum
-name: ExcelScript.ConnectorType
-uid: 'ExcelScript!ExcelScript.ConnectorType:enum'
-package: ExcelScript!
-fullName: ExcelScript.ConnectorType
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a line that goes from cell B2 to cell F4 on the current worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- const sheet = workbook.getActiveWorksheet();
-
- // Get the ranges for the two cells.
- const b2Range = sheet.getRange("B2");
- const f4Range = sheet.getRange("F4");
-
- // Add a straight line that connects the top-left corners of both cells.
- const line = sheet.addLine(
- b2Range.getLeft(),
- b2Range.getTop(),
- f4Range.getLeft(),
- f4Range.getTop(),
- ExcelScript.ConnectorType.straight);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: curve
- uid: 'ExcelScript!ExcelScript.ConnectorType.curve:member'
- package: ExcelScript!
- summary: ''
- - name: elbow
- uid: 'ExcelScript!ExcelScript.ConnectorType.elbow:member'
- package: ExcelScript!
- summary: ''
- - name: straight
- uid: 'ExcelScript!ExcelScript.ConnectorType.straight:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ConnectorType
+uid: 'ExcelScript!ExcelScript.ConnectorType:enum'
+package: ExcelScript!
+fullName: ExcelScript.ConnectorType
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a line that goes from cell B2 to cell F4 on the current worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ const sheet = workbook.getActiveWorksheet();
+
+ // Get the ranges for the two cells.
+ const b2Range = sheet.getRange("B2");
+ const f4Range = sheet.getRange("F4");
+
+ // Add a straight line that connects the top-left corners of both cells.
+ const line = sheet.addLine(
+ b2Range.getLeft(),
+ b2Range.getTop(),
+ f4Range.getLeft(),
+ f4Range.getTop(),
+ ExcelScript.ConnectorType.straight);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: curve
+ uid: 'ExcelScript!ExcelScript.ConnectorType.curve:member'
+ package: ExcelScript!
+ summary: ''
+ - name: elbow
+ uid: 'ExcelScript!ExcelScript.ConnectorType.elbow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: straight
+ uid: 'ExcelScript!ExcelScript.ConnectorType.straight:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.contenttype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.contenttype.yml
index 3cc585fc..17c8bd76 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.contenttype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.contenttype.yml
@@ -1,59 +1,59 @@
-### YamlMime:TSEnum
-name: ExcelScript.ContentType
-uid: 'ExcelScript!ExcelScript.ContentType:enum'
-package: ExcelScript!
-fullName: ExcelScript.ContentType
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample creates a comment that mentions a specific person.
- * That person will get a notification and link to the workbook.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first cell in the current worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const cell = currentSheet.getCell(0,0);
-
- /* Create a CommentMention object for the comment.
- *
- * A CommentMention's properties are:
- * `name`: The name of the person being mentioned.
- * `id`: The zero-based index of this mention in the comment.
- * `email`: The email address of the person being mentioned.
- */
- const mention: ExcelScript.CommentMention = {
- name: "Alex",
- id: 0,
- email: "alex@contoso.com"
- };
-
- /* Create comment content that uses the mention.
- * The `` syntax embeds the mention with ID 0 in the comment text.
- * The name is displayed in the comment,
- * while an email is sent to the given address.
- */
- const content: ExcelScript.CommentRichContent = {
- richContent: '' + mention.name + " - Hello!",
- mentions: [mention]
- };
-
- // Add the comment.
- currentSheet.addComment(cell, content, ExcelScript.ContentType.mention);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: mention
- uid: 'ExcelScript!ExcelScript.ContentType.mention:member'
- package: ExcelScript!
- summary: Comment content containing mentions.
- - name: plain
- uid: 'ExcelScript!ExcelScript.ContentType.plain:member'
- package: ExcelScript!
- summary: Indicates a plain format type for the comment content.
+### YamlMime:TSEnum
+name: ExcelScript.ContentType
+uid: 'ExcelScript!ExcelScript.ContentType:enum'
+package: ExcelScript!
+fullName: ExcelScript.ContentType
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample creates a comment that mentions a specific person.
+ * That person will get a notification and link to the workbook.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first cell in the current worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const cell = currentSheet.getCell(0,0);
+
+ /* Create a CommentMention object for the comment.
+ *
+ * A CommentMention's properties are:
+ * `name`: The name of the person being mentioned.
+ * `id`: The zero-based index of this mention in the comment.
+ * `email`: The email address of the person being mentioned.
+ */
+ const mention: ExcelScript.CommentMention = {
+ name: "Alex",
+ id: 0,
+ email: "alex@contoso.com"
+ };
+
+ /* Create comment content that uses the mention.
+ * The `` syntax embeds the mention with ID 0 in the comment text.
+ * The name is displayed in the comment,
+ * while an email is sent to the given address.
+ */
+ const content: ExcelScript.CommentRichContent = {
+ richContent: '' + mention.name + " - Hello!",
+ mentions: [mention]
+ };
+
+ // Add the comment.
+ currentSheet.addComment(cell, content, ExcelScript.ContentType.mention);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: mention
+ uid: 'ExcelScript!ExcelScript.ContentType.mention:member'
+ package: ExcelScript!
+ summary: Comment content containing mentions.
+ - name: plain
+ uid: 'ExcelScript!ExcelScript.ContentType.plain:member'
+ package: ExcelScript!
+ summary: Indicates a plain format type for the comment content.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.cultureinfo.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.cultureinfo.yml
index fa350efa..cf5949e9 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.cultureinfo.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.cultureinfo.yml
@@ -1,82 +1,82 @@
-### YamlMime:TSType
-name: ExcelScript.CultureInfo
-uid: 'ExcelScript!ExcelScript.CultureInfo:interface'
-package: ExcelScript!
-fullName: ExcelScript.CultureInfo
-summary: >-
- Provides information based on current system culture settings. This includes the culture names, number formatting, and
- other culturally dependent settings.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the value of a cell to a date string for January 2, 2023.
- * It writes the day or month first in the string based on system settings.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first cell in the current worksheet.
- const cell = workbook.getActiveWorksheet().getCell(0,0);
-
- // Get the date format.
- const cultureInfo : ExcelScript.CultureInfo = workbook.getApplication().getCultureInfo();
- const systemDateTimeFormat : ExcelScript.DatetimeFormatInfo = cultureInfo.getDatetimeFormat();
- const shortDatePattern : string = systemDateTimeFormat.getShortDatePattern();
-
- // Determine if the date should start with the month or day.
- if (shortDatePattern.startsWith("m")) {
- cell.setValue("1/2/2023");
- } else {
- cell.setValue("2/1/2023");
- }
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getDatetimeFormat()
- uid: 'ExcelScript!ExcelScript.CultureInfo#getDatetimeFormat:member(1)'
- package: ExcelScript!
- fullName: getDatetimeFormat()
- summary: >-
- Defines the culturally appropriate format of displaying date and time. This is based on current system culture
- settings.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDatetimeFormat(): DatetimeFormatInfo;'
- return:
- type: ''
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.CultureInfo#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: >-
- Gets the culture name in the format languagecode2-country/regioncode2 (e.g., "zh-cn" or "en-us"). This is based on
- current system settings.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: getNumberFormat()
- uid: 'ExcelScript!ExcelScript.CultureInfo#getNumberFormat:member(1)'
- package: ExcelScript!
- fullName: getNumberFormat()
- summary: Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNumberFormat(): NumberFormatInfo;'
- return:
- type: ''
- description: ''
+### YamlMime:TSType
+name: ExcelScript.CultureInfo
+uid: 'ExcelScript!ExcelScript.CultureInfo:interface'
+package: ExcelScript!
+fullName: ExcelScript.CultureInfo
+summary: >-
+ Provides information based on current system culture settings. This includes the culture names, number formatting, and
+ other culturally dependent settings.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the value of a cell to a date string for January 2, 2023.
+ * It writes the day or month first in the string based on system settings.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first cell in the current worksheet.
+ const cell = workbook.getActiveWorksheet().getCell(0,0);
+
+ // Get the date format.
+ const cultureInfo : ExcelScript.CultureInfo = workbook.getApplication().getCultureInfo();
+ const systemDateTimeFormat : ExcelScript.DatetimeFormatInfo = cultureInfo.getDatetimeFormat();
+ const shortDatePattern : string = systemDateTimeFormat.getShortDatePattern();
+
+ // Determine if the date should start with the month or day.
+ if (shortDatePattern.startsWith("m")) {
+ cell.setValue("1/2/2023");
+ } else {
+ cell.setValue("2/1/2023");
+ }
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getDatetimeFormat()
+ uid: 'ExcelScript!ExcelScript.CultureInfo#getDatetimeFormat:member(1)'
+ package: ExcelScript!
+ fullName: getDatetimeFormat()
+ summary: >-
+ Defines the culturally appropriate format of displaying date and time. This is based on current system culture
+ settings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDatetimeFormat(): DatetimeFormatInfo;'
+ return:
+ type: ''
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.CultureInfo#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: >-
+ Gets the culture name in the format languagecode2-country/regioncode2 (e.g., "zh-cn" or "en-us"). This is based on
+ current system settings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getNumberFormat()
+ uid: 'ExcelScript!ExcelScript.CultureInfo#getNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: getNumberFormat()
+ summary: Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNumberFormat(): NumberFormatInfo;'
+ return:
+ type: ''
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.customconditionalformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.customconditionalformat.yml
index b85d1f35..ddc18520 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.customconditionalformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.customconditionalformat.yml
@@ -1,69 +1,69 @@
-### YamlMime:TSType
-name: ExcelScript.CustomConditionalFormat
-uid: 'ExcelScript!ExcelScript.CustomConditionalFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.CustomConditionalFormat
-summary: Represents a custom conditional format type.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a custom three-color conditional formatting to the selected range.
- * The three colors represent positive, negative, or no changes from the values in the previous column.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the selected cells.
- let selectedRange = workbook.getSelectedRange();
-
- // Apply a rule for positive change from the previous column.
- let positiveChange: ExcelScript.ConditionalFormat = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom);
- let positiveCustom: ExcelScript.CustomConditionalFormat = positiveChange.getCustom();
- positiveCustom.getFormat().getFill().setColor("lightgreen");
- positiveCustom.getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}>${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`);
-
- // Apply a rule for negative change from the previous column.
- let negativeChange: ExcelScript.ConditionalFormat = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom);
- let negativeCustom: ExcelScript.CustomConditionalFormat = negativeChange.getCustom();
- negativeCustom.getFormat().getFill().setColor("pink");
- negativeCustom.getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}<${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`);
-
- // Apply a rule for no change from the previous column.
- let sameChange: ExcelScript.ConditionalFormat = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom);
- let sameCustom: ExcelScript.CustomConditionalFormat = sameChange.getCustom();
- sameCustom.getFormat().getFill().setColor("lightyellow");
- sameCustom.getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}=${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getFormat()
- uid: 'ExcelScript!ExcelScript.CustomConditionalFormat#getFormat:member(1)'
- package: ExcelScript!
- fullName: getFormat()
- summary: 'Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormat(): ConditionalRangeFormat;'
- return:
- type: ''
- description: ''
- - name: getRule()
- uid: 'ExcelScript!ExcelScript.CustomConditionalFormat#getRule:member(1)'
- package: ExcelScript!
- fullName: getRule()
- summary: Specifies the `Rule` object on this conditional format.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRule(): ConditionalFormatRule;'
- return:
- type: ''
- description: ''
+### YamlMime:TSType
+name: ExcelScript.CustomConditionalFormat
+uid: 'ExcelScript!ExcelScript.CustomConditionalFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.CustomConditionalFormat
+summary: Represents a custom conditional format type.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a custom three-color conditional formatting to the selected range.
+ * The three colors represent positive, negative, or no changes from the values in the previous column.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the selected cells.
+ let selectedRange = workbook.getSelectedRange();
+
+ // Apply a rule for positive change from the previous column.
+ let positiveChange: ExcelScript.ConditionalFormat = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom);
+ let positiveCustom: ExcelScript.CustomConditionalFormat = positiveChange.getCustom();
+ positiveCustom.getFormat().getFill().setColor("lightgreen");
+ positiveCustom.getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}>${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`);
+
+ // Apply a rule for negative change from the previous column.
+ let negativeChange: ExcelScript.ConditionalFormat = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom);
+ let negativeCustom: ExcelScript.CustomConditionalFormat = negativeChange.getCustom();
+ negativeCustom.getFormat().getFill().setColor("pink");
+ negativeCustom.getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}<${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`);
+
+ // Apply a rule for no change from the previous column.
+ let sameChange: ExcelScript.ConditionalFormat = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom);
+ let sameCustom: ExcelScript.CustomConditionalFormat = sameChange.getCustom();
+ sameCustom.getFormat().getFill().setColor("lightyellow");
+ sameCustom.getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}=${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getFormat()
+ uid: 'ExcelScript!ExcelScript.CustomConditionalFormat#getFormat:member(1)'
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: 'Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): ConditionalRangeFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getRule()
+ uid: 'ExcelScript!ExcelScript.CustomConditionalFormat#getRule:member(1)'
+ package: ExcelScript!
+ fullName: getRule()
+ summary: Specifies the `Rule` object on this conditional format.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRule(): ConditionalFormatRule;'
+ return:
+ type: ''
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.customdatavalidation.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.customdatavalidation.yml
index d7afcaea..08e31f36 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.customdatavalidation.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.customdatavalidation.yml
@@ -1,50 +1,50 @@
-### YamlMime:TSType
-name: ExcelScript.CustomDataValidation
-uid: 'ExcelScript!ExcelScript.CustomDataValidation:interface'
-package: ExcelScript!
-fullName: ExcelScript.CustomDataValidation
-summary: Represents the custom data validation criteria.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds data validation to a range.
- * The validation prevents duplicate entries within that range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range "B2:B20".
- const sheet = workbook.getActiveWorksheet();
- const range = sheet.getRange("B2:B20");
-
- // Set data validation on the range to prevent duplicate, non-blank entries.
- const dataValidation = range.getDataValidation();
- dataValidation.setIgnoreBlanks(true);
- const duplicateRule : ExcelScript.CustomDataValidation = {
- formula: "=COUNTIF($B$2:$B$20, B2)=1"
- };
- dataValidation.setRule({
- custom: duplicateRule
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: formula
- uid: 'ExcelScript!ExcelScript.CustomDataValidation#formula:member'
- package: ExcelScript!
- fullName: formula
- summary: >-
- A custom data validation formula. This creates special input rules, such as preventing duplicates, or limiting the
- total in a range of cells.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'formula: string;'
- return:
- type: string
+### YamlMime:TSType
+name: ExcelScript.CustomDataValidation
+uid: 'ExcelScript!ExcelScript.CustomDataValidation:interface'
+package: ExcelScript!
+fullName: ExcelScript.CustomDataValidation
+summary: Represents the custom data validation criteria.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds data validation to a range.
+ * The validation prevents duplicate entries within that range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range "B2:B20".
+ const sheet = workbook.getActiveWorksheet();
+ const range = sheet.getRange("B2:B20");
+
+ // Set data validation on the range to prevent duplicate, non-blank entries.
+ const dataValidation = range.getDataValidation();
+ dataValidation.setIgnoreBlanks(true);
+ const duplicateRule : ExcelScript.CustomDataValidation = {
+ formula: "=COUNTIF($B$2:$B$20, B2)=1"
+ };
+ dataValidation.setRule({
+ custom: duplicateRule
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: formula
+ uid: 'ExcelScript!ExcelScript.CustomDataValidation#formula:member'
+ package: ExcelScript!
+ fullName: formula
+ summary: >-
+ A custom data validation formula. This creates special input rules, such as preventing duplicates, or limiting the
+ total in a range of cells.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'formula: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.customproperty.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.customproperty.yml
index 8a3ed2bd..310a8944 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.customproperty.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.customproperty.yml
@@ -1,86 +1,86 @@
-### YamlMime:TSType
-name: ExcelScript.CustomProperty
-uid: 'ExcelScript!ExcelScript.CustomProperty:interface'
-package: ExcelScript!
-fullName: ExcelScript.CustomProperty
-summary: Represents a custom property.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: delete()
- uid: 'ExcelScript!ExcelScript.CustomProperty#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: Deletes the custom property.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: ''
- - name: getKey()
- uid: 'ExcelScript!ExcelScript.CustomProperty#getKey:member(1)'
- package: ExcelScript!
- fullName: getKey()
- summary: >-
- The key of the custom property. The key is limited to 255 characters outside of Excel on the web (larger keys are
- automatically trimmed to 255 characters on other platforms).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getKey(): string;'
- return:
- type: string
- description: ''
- - name: getType()
- uid: 'ExcelScript!ExcelScript.CustomProperty#getType:member(1)'
- package: ExcelScript!
- fullName: getType()
- summary: The type of the value used for the custom property.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getType(): DocumentPropertyType;'
- return:
- type: ''
- description: ''
- - name: getValue()
- uid: 'ExcelScript!ExcelScript.CustomProperty#getValue:member(1)'
- package: ExcelScript!
- fullName: getValue()
- summary: >-
- The value of the custom property. The value is limited to 255 characters outside of Excel on the web (larger
- values are automatically trimmed to 255 characters on other platforms).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getValue(): any;'
- return:
- type: any
- description: ''
- - name: setValue(value)
- uid: 'ExcelScript!ExcelScript.CustomProperty#setValue:member(1)'
- package: ExcelScript!
- fullName: setValue(value)
- summary: >-
- The value of the custom property. The value is limited to 255 characters outside of Excel on the web (larger
- values are automatically trimmed to 255 characters on other platforms).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setValue(value: any): void;'
- parameters:
- - id: value
- description: ''
- type: any
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.CustomProperty
+uid: 'ExcelScript!ExcelScript.CustomProperty:interface'
+package: ExcelScript!
+fullName: ExcelScript.CustomProperty
+summary: Represents a custom property.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.CustomProperty#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: Deletes the custom property.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getKey()
+ uid: 'ExcelScript!ExcelScript.CustomProperty#getKey:member(1)'
+ package: ExcelScript!
+ fullName: getKey()
+ summary: >-
+ The key of the custom property. The key is limited to 255 characters outside of Excel on the web (larger keys are
+ automatically trimmed to 255 characters on other platforms).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getKey(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getType()
+ uid: 'ExcelScript!ExcelScript.CustomProperty#getType:member(1)'
+ package: ExcelScript!
+ fullName: getType()
+ summary: The type of the value used for the custom property.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getType(): DocumentPropertyType;'
+ return:
+ type: ''
+ description: ''
+ - name: getValue()
+ uid: 'ExcelScript!ExcelScript.CustomProperty#getValue:member(1)'
+ package: ExcelScript!
+ fullName: getValue()
+ summary: >-
+ The value of the custom property. The value is limited to 255 characters outside of Excel on the web (larger
+ values are automatically trimmed to 255 characters on other platforms).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getValue(): any;'
+ return:
+ type: any
+ description: ''
+ - name: setValue(value)
+ uid: 'ExcelScript!ExcelScript.CustomProperty#setValue:member(1)'
+ package: ExcelScript!
+ fullName: setValue(value)
+ summary: >-
+ The value of the custom property. The value is limited to 255 characters outside of Excel on the web (larger
+ values are automatically trimmed to 255 characters on other platforms).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setValue(value: any): void;'
+ parameters:
+ - id: value
+ description: ''
+ type: any
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.customxmlpart.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.customxmlpart.yml
index 9977a4eb..df34ad3a 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.customxmlpart.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.customxmlpart.yml
@@ -1,80 +1,80 @@
-### YamlMime:TSType
-name: ExcelScript.CustomXmlPart
-uid: 'ExcelScript!ExcelScript.CustomXmlPart:interface'
-package: ExcelScript!
-fullName: ExcelScript.CustomXmlPart
-summary: Represents a custom XML part object in a workbook.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: delete()
- uid: 'ExcelScript!ExcelScript.CustomXmlPart#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: Deletes the custom XML part.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: ''
- - name: getId()
- uid: 'ExcelScript!ExcelScript.CustomXmlPart#getId:member(1)'
- package: ExcelScript!
- fullName: getId()
- summary: The custom XML part's ID.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getId(): string;'
- return:
- type: string
- description: ''
- - name: getNamespaceUri()
- uid: 'ExcelScript!ExcelScript.CustomXmlPart#getNamespaceUri:member(1)'
- package: ExcelScript!
- fullName: getNamespaceUri()
- summary: The custom XML part's namespace URI.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNamespaceUri(): string;'
- return:
- type: string
- description: ''
- - name: getXml()
- uid: 'ExcelScript!ExcelScript.CustomXmlPart#getXml:member(1)'
- package: ExcelScript!
- fullName: getXml()
- summary: Gets the custom XML part's full XML content.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getXml(): string;'
- return:
- type: string
- description: ''
- - name: setXml(xml)
- uid: 'ExcelScript!ExcelScript.CustomXmlPart#setXml:member(1)'
- package: ExcelScript!
- fullName: setXml(xml)
- summary: Sets the custom XML part's full XML content.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setXml(xml: string): void;'
- parameters:
- - id: xml
- description: XML content for the part.
- type: string
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.CustomXmlPart
+uid: 'ExcelScript!ExcelScript.CustomXmlPart:interface'
+package: ExcelScript!
+fullName: ExcelScript.CustomXmlPart
+summary: Represents a custom XML part object in a workbook.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.CustomXmlPart#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: Deletes the custom XML part.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getId()
+ uid: 'ExcelScript!ExcelScript.CustomXmlPart#getId:member(1)'
+ package: ExcelScript!
+ fullName: getId()
+ summary: The custom XML part's ID.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getId(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getNamespaceUri()
+ uid: 'ExcelScript!ExcelScript.CustomXmlPart#getNamespaceUri:member(1)'
+ package: ExcelScript!
+ fullName: getNamespaceUri()
+ summary: The custom XML part's namespace URI.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNamespaceUri(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getXml()
+ uid: 'ExcelScript!ExcelScript.CustomXmlPart#getXml:member(1)'
+ package: ExcelScript!
+ fullName: getXml()
+ summary: Gets the custom XML part's full XML content.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getXml(): string;'
+ return:
+ type: string
+ description: ''
+ - name: setXml(xml)
+ uid: 'ExcelScript!ExcelScript.CustomXmlPart#setXml:member(1)'
+ package: ExcelScript!
+ fullName: setXml(xml)
+ summary: Sets the custom XML part's full XML content.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setXml(xml: string): void;'
+ parameters:
+ - id: xml
+ description: XML content for the part.
+ type: string
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.databarconditionalformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.databarconditionalformat.yml
index e55767af..fcb2732e 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.databarconditionalformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.databarconditionalformat.yml
@@ -1,265 +1,265 @@
-### YamlMime:TSType
-name: ExcelScript.DataBarConditionalFormat
-uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.DataBarConditionalFormat
-summary: Represents an Excel conditional data bar type.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates data bar conditional formatting on the selected range.
- * The scale of the data bar goes from 0 to 1000.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the selected range.
- const selected = workbook.getSelectedRange();
-
- // Create new conditional formatting on the range.
- const format = selected.addConditionalFormat(ExcelScript.ConditionalFormatType.dataBar);
- const dataBarFormat: ExcelScript.DataBarConditionalFormat = format.getDataBar();
-
- // Set the lower bound of the data bar formatting to be 0.
- const lowerBound: ExcelScript.ConditionalDataBarRule = {
- type: ExcelScript.ConditionalFormatRuleType.number,
- formula: "0"
- };
- dataBarFormat.setLowerBoundRule(lowerBound);
-
- // Set the upper bound of the data bar formatting to be 1000.
- const upperBound: ExcelScript.ConditionalDataBarRule = {
- type: ExcelScript.ConditionalFormatRuleType.number,
- formula: "1000"
- };
- dataBarFormat.setUpperBoundRule(upperBound);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getAxisColor()
- uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#getAxisColor:member(1)'
- package: ExcelScript!
- fullName: getAxisColor()
- summary: >-
- HTML color code representing the color of the Axis line, in the form \#RRGGBB (e.g., "FFA500") or as a named HTML
- color (e.g., "orange"). Value is "" (an empty string) if no axis is present or set.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAxisColor(): string;'
- return:
- type: string
- description: ''
- - name: getAxisFormat()
- uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#getAxisFormat:member(1)'
- package: ExcelScript!
- fullName: getAxisFormat()
- summary: Representation of how the axis is determined for an Excel data bar.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAxisFormat(): ConditionalDataBarAxisFormat;'
- return:
- type: ''
- description: ''
- - name: getBarDirection()
- uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#getBarDirection:member(1)'
- package: ExcelScript!
- fullName: getBarDirection()
- summary: Specifies the direction that the data bar graphic should be based on.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBarDirection(): ConditionalDataBarDirection;'
- return:
- type: ''
- description: ''
- - name: getLowerBoundRule()
- uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#getLowerBoundRule:member(1)'
- package: ExcelScript!
- fullName: getLowerBoundRule()
- summary: >-
- The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar. The
- `ConditionalDataBarRule` object must be set as a JSON object (use `x.lowerBoundRule = {...}` instead of
- `x.lowerBoundRule.formula = ...`).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLowerBoundRule(): ConditionalDataBarRule;'
- return:
- type: ''
- description: ''
- - name: getNegativeFormat()
- uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#getNegativeFormat:member(1)'
- package: ExcelScript!
- fullName: getNegativeFormat()
- summary: Representation of all values to the left of the axis in an Excel data bar.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNegativeFormat(): ConditionalDataBarNegativeFormat;'
- return:
- type: ''
- description: ''
- - name: getPositiveFormat()
- uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#getPositiveFormat:member(1)'
- package: ExcelScript!
- fullName: getPositiveFormat()
- summary: Representation of all values to the right of the axis in an Excel data bar.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPositiveFormat(): ConditionalDataBarPositiveFormat;'
- return:
- type: ''
- description: ''
- - name: getShowDataBarOnly()
- uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#getShowDataBarOnly:member(1)'
- package: ExcelScript!
- fullName: getShowDataBarOnly()
- summary: 'If `true`, hides the values from the cells where the data bar is applied.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowDataBarOnly(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getUpperBoundRule()
- uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#getUpperBoundRule:member(1)'
- package: ExcelScript!
- fullName: getUpperBoundRule()
- summary: >-
- The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar. The
- `ConditionalDataBarRule` object must be set as a JSON object (use `x.upperBoundRule = {...}` instead of
- `x.upperBoundRule.formula = ...`).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getUpperBoundRule(): ConditionalDataBarRule;'
- return:
- type: ''
- description: ''
- - name: setAxisColor(axisColor)
- uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#setAxisColor:member(1)'
- package: ExcelScript!
- fullName: setAxisColor(axisColor)
- summary: >-
- HTML color code representing the color of the Axis line, in the form \#RRGGBB (e.g., "FFA500") or as a named HTML
- color (e.g., "orange"). Value is "" (an empty string) if no axis is present or set.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setAxisColor(axisColor: string): void;'
- parameters:
- - id: axisColor
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setAxisFormat(axisFormat)
- uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#setAxisFormat:member(1)'
- package: ExcelScript!
- fullName: setAxisFormat(axisFormat)
- summary: Representation of how the axis is determined for an Excel data bar.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setAxisFormat(axisFormat: ConditionalDataBarAxisFormat): void;'
- parameters:
- - id: axisFormat
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setBarDirection(barDirection)
- uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#setBarDirection:member(1)'
- package: ExcelScript!
- fullName: setBarDirection(barDirection)
- summary: Specifies the direction that the data bar graphic should be based on.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setBarDirection(barDirection: ConditionalDataBarDirection): void;'
- parameters:
- - id: barDirection
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setLowerBoundRule(lowerBoundRule)
- uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#setLowerBoundRule:member(1)'
- package: ExcelScript!
- fullName: setLowerBoundRule(lowerBoundRule)
- summary: >-
- The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar. The
- `ConditionalDataBarRule` object must be set as a JSON object (use `x.lowerBoundRule = {...}` instead of
- `x.lowerBoundRule.formula = ...`).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLowerBoundRule(lowerBoundRule: ConditionalDataBarRule): void;'
- parameters:
- - id: lowerBoundRule
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setShowDataBarOnly(showDataBarOnly)
- uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#setShowDataBarOnly:member(1)'
- package: ExcelScript!
- fullName: setShowDataBarOnly(showDataBarOnly)
- summary: 'If `true`, hides the values from the cells where the data bar is applied.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowDataBarOnly(showDataBarOnly: boolean): void;'
- parameters:
- - id: showDataBarOnly
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setUpperBoundRule(upperBoundRule)
- uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#setUpperBoundRule:member(1)'
- package: ExcelScript!
- fullName: setUpperBoundRule(upperBoundRule)
- summary: >-
- The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar. The
- `ConditionalDataBarRule` object must be set as a JSON object (use `x.upperBoundRule = {...}` instead of
- `x.upperBoundRule.formula = ...`).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setUpperBoundRule(upperBoundRule: ConditionalDataBarRule): void;'
- parameters:
- - id: upperBoundRule
- description: ''
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.DataBarConditionalFormat
+uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.DataBarConditionalFormat
+summary: Represents an Excel conditional data bar type.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates data bar conditional formatting on the selected range.
+ * The scale of the data bar goes from 0 to 1000.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the selected range.
+ const selected = workbook.getSelectedRange();
+
+ // Create new conditional formatting on the range.
+ const format = selected.addConditionalFormat(ExcelScript.ConditionalFormatType.dataBar);
+ const dataBarFormat: ExcelScript.DataBarConditionalFormat = format.getDataBar();
+
+ // Set the lower bound of the data bar formatting to be 0.
+ const lowerBound: ExcelScript.ConditionalDataBarRule = {
+ type: ExcelScript.ConditionalFormatRuleType.number,
+ formula: "0"
+ };
+ dataBarFormat.setLowerBoundRule(lowerBound);
+
+ // Set the upper bound of the data bar formatting to be 1000.
+ const upperBound: ExcelScript.ConditionalDataBarRule = {
+ type: ExcelScript.ConditionalFormatRuleType.number,
+ formula: "1000"
+ };
+ dataBarFormat.setUpperBoundRule(upperBound);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getAxisColor()
+ uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#getAxisColor:member(1)'
+ package: ExcelScript!
+ fullName: getAxisColor()
+ summary: >-
+ HTML color code representing the color of the Axis line, in the form \#RRGGBB (e.g., "FFA500") or as a named HTML
+ color (e.g., "orange"). Value is "" (an empty string) if no axis is present or set.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAxisColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getAxisFormat()
+ uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#getAxisFormat:member(1)'
+ package: ExcelScript!
+ fullName: getAxisFormat()
+ summary: Representation of how the axis is determined for an Excel data bar.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAxisFormat(): ConditionalDataBarAxisFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getBarDirection()
+ uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#getBarDirection:member(1)'
+ package: ExcelScript!
+ fullName: getBarDirection()
+ summary: Specifies the direction that the data bar graphic should be based on.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBarDirection(): ConditionalDataBarDirection;'
+ return:
+ type: ''
+ description: ''
+ - name: getLowerBoundRule()
+ uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#getLowerBoundRule:member(1)'
+ package: ExcelScript!
+ fullName: getLowerBoundRule()
+ summary: >-
+ The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar. The
+ `ConditionalDataBarRule` object must be set as a JSON object (use `x.lowerBoundRule = {...}` instead of
+ `x.lowerBoundRule.formula = ...`).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLowerBoundRule(): ConditionalDataBarRule;'
+ return:
+ type: ''
+ description: ''
+ - name: getNegativeFormat()
+ uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#getNegativeFormat:member(1)'
+ package: ExcelScript!
+ fullName: getNegativeFormat()
+ summary: Representation of all values to the left of the axis in an Excel data bar.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNegativeFormat(): ConditionalDataBarNegativeFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getPositiveFormat()
+ uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#getPositiveFormat:member(1)'
+ package: ExcelScript!
+ fullName: getPositiveFormat()
+ summary: Representation of all values to the right of the axis in an Excel data bar.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPositiveFormat(): ConditionalDataBarPositiveFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getShowDataBarOnly()
+ uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#getShowDataBarOnly:member(1)'
+ package: ExcelScript!
+ fullName: getShowDataBarOnly()
+ summary: 'If `true`, hides the values from the cells where the data bar is applied.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowDataBarOnly(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getUpperBoundRule()
+ uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#getUpperBoundRule:member(1)'
+ package: ExcelScript!
+ fullName: getUpperBoundRule()
+ summary: >-
+ The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar. The
+ `ConditionalDataBarRule` object must be set as a JSON object (use `x.upperBoundRule = {...}` instead of
+ `x.upperBoundRule.formula = ...`).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getUpperBoundRule(): ConditionalDataBarRule;'
+ return:
+ type: ''
+ description: ''
+ - name: setAxisColor(axisColor)
+ uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#setAxisColor:member(1)'
+ package: ExcelScript!
+ fullName: setAxisColor(axisColor)
+ summary: >-
+ HTML color code representing the color of the Axis line, in the form \#RRGGBB (e.g., "FFA500") or as a named HTML
+ color (e.g., "orange"). Value is "" (an empty string) if no axis is present or set.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setAxisColor(axisColor: string): void;'
+ parameters:
+ - id: axisColor
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setAxisFormat(axisFormat)
+ uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#setAxisFormat:member(1)'
+ package: ExcelScript!
+ fullName: setAxisFormat(axisFormat)
+ summary: Representation of how the axis is determined for an Excel data bar.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setAxisFormat(axisFormat: ConditionalDataBarAxisFormat): void;'
+ parameters:
+ - id: axisFormat
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setBarDirection(barDirection)
+ uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#setBarDirection:member(1)'
+ package: ExcelScript!
+ fullName: setBarDirection(barDirection)
+ summary: Specifies the direction that the data bar graphic should be based on.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setBarDirection(barDirection: ConditionalDataBarDirection): void;'
+ parameters:
+ - id: barDirection
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setLowerBoundRule(lowerBoundRule)
+ uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#setLowerBoundRule:member(1)'
+ package: ExcelScript!
+ fullName: setLowerBoundRule(lowerBoundRule)
+ summary: >-
+ The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar. The
+ `ConditionalDataBarRule` object must be set as a JSON object (use `x.lowerBoundRule = {...}` instead of
+ `x.lowerBoundRule.formula = ...`).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLowerBoundRule(lowerBoundRule: ConditionalDataBarRule): void;'
+ parameters:
+ - id: lowerBoundRule
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setShowDataBarOnly(showDataBarOnly)
+ uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#setShowDataBarOnly:member(1)'
+ package: ExcelScript!
+ fullName: setShowDataBarOnly(showDataBarOnly)
+ summary: 'If `true`, hides the values from the cells where the data bar is applied.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowDataBarOnly(showDataBarOnly: boolean): void;'
+ parameters:
+ - id: showDataBarOnly
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setUpperBoundRule(upperBoundRule)
+ uid: 'ExcelScript!ExcelScript.DataBarConditionalFormat#setUpperBoundRule:member(1)'
+ package: ExcelScript!
+ fullName: setUpperBoundRule(upperBoundRule)
+ summary: >-
+ The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar. The
+ `ConditionalDataBarRule` object must be set as a JSON object (use `x.upperBoundRule = {...}` instead of
+ `x.upperBoundRule.formula = ...`).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setUpperBoundRule(upperBoundRule: ConditionalDataBarRule): void;'
+ parameters:
+ - id: upperBoundRule
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.datapivothierarchy.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.datapivothierarchy.yml
index 4a8d7285..cd9d1a2d 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.datapivothierarchy.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.datapivothierarchy.yml
@@ -1,262 +1,262 @@
-### YamlMime:TSType
-name: ExcelScript.DataPivotHierarchy
-uid: 'ExcelScript!ExcelScript.DataPivotHierarchy:interface'
-package: ExcelScript!
-fullName: ExcelScript.DataPivotHierarchy
-summary: Represents the Excel DataPivotHierarchy.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample sorts the rows of a PivotTable.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get an existing PivotTable.
- const pivotTable = workbook.getPivotTable("Farm Sales");
-
- // Get the data hierarchy to use as the basis of the sort.
- const valueFieldToSortOn: ExcelScript.DataPivotHierarchy = pivotTable.getDataHierarchy("Sum of Crates Sold Wholesale");
-
- // Get the row to sort.
- const rowToSort: ExcelScript.RowColumnPivotHierarchy = pivotTable.getRowHierarchy("Farm");
-
- // Sort the "Farm" row's only field by the values in "Sum of Crates Sold Wholesale".
- rowToSort.getFields()[0].sortByValues(ExcelScript.SortBy.descending, valueFieldToSortOn);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getField()
- uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#getField:member(1)'
- package: ExcelScript!
- fullName: getField()
- summary: Returns the PivotFields associated with the DataPivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getField(): PivotField;'
- return:
- type: ''
- description: ''
- - name: getId()
- uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#getId:member(1)'
- package: ExcelScript!
- fullName: getId()
- summary: ID of the DataPivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getId(): string;'
- return:
- type: string
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: Name of the DataPivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: getNumberFormat()
- uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#getNumberFormat:member(1)'
- package: ExcelScript!
- fullName: getNumberFormat()
- summary: Number format of the DataPivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNumberFormat(): string;'
- return:
- type: string
- description: ''
- - name: getPosition()
- uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#getPosition:member(1)'
- package: ExcelScript!
- fullName: getPosition()
- summary: Position of the DataPivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPosition(): number;'
- return:
- type: number
- description: ''
- - name: getShowAs()
- uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#getShowAs:member(1)'
- package: ExcelScript!
- fullName: getShowAs()
- summary: Specifies if the data should be shown as a specific summary calculation.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowAs(): ShowAsRule;'
- return:
- type: ''
- description: ''
- - name: getSummarizeBy()
- uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#getSummarizeBy:member(1)'
- package: ExcelScript!
- fullName: getSummarizeBy()
- summary: Specifies if all items of the DataPivotHierarchy are shown.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSummarizeBy(): AggregationFunction;'
- return:
- type: ''
- description: ''
- - name: setName(name)
- uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#setName:member(1)'
- package: ExcelScript!
- fullName: setName(name)
- summary: Name of the DataPivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setName(name: string): void;'
- parameters:
- - id: name
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setNumberFormat(numberFormat)
- uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#setNumberFormat:member(1)'
- package: ExcelScript!
- fullName: setNumberFormat(numberFormat)
- summary: Number format of the DataPivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setNumberFormat(numberFormat: string): void;'
- parameters:
- - id: numberFormat
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setPosition(position)
- uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#setPosition:member(1)'
- package: ExcelScript!
- fullName: setPosition(position)
- summary: Position of the DataPivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPosition(position: number): void;'
- parameters:
- - id: position
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setShowAs(showAs)
- uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#setShowAs:member(1)'
- package: ExcelScript!
- fullName: setShowAs(showAs)
- summary: Specifies if the data should be shown as a specific summary calculation.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowAs(showAs: ShowAsRule): void;'
- parameters:
- - id: showAs
- description: ''
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * The script changes the display for "Crates Sold at Farm".
- * It shows the percentage of the grand total,
- * instead of the default sum.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the PivotTable named "Farm Pivot".
- const farmPivot = workbook.getPivotTable("Farm Pivot");
-
- // Get the data hierarchy "Sum of Crates Sold at Farm".
- const farmSales = farmPivot.getDataHierarchy("Sum of Crates Sold at Farm");
-
- // Show the data as a percentage of the grand total.
- farmSales.setShowAs({
- calculation: ExcelScript.ShowAsCalculation.percentOfGrandTotal
- });
- }
- ```
- - name: setSummarizeBy(summarizeBy)
- uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#setSummarizeBy:member(1)'
- package: ExcelScript!
- fullName: setSummarizeBy(summarizeBy)
- summary: Specifies if all items of the DataPivotHierarchy are shown.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setSummarizeBy(summarizeBy: AggregationFunction): void;'
- parameters:
- - id: summarizeBy
- description: ''
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script changes how the data in a PivotTable is aggregated.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first PivotTable in the workbook.
- const pivotTable = workbook.getPivotTables()[0];
-
- // Set the first data hierarchy to summarize with an average value, instead of a sum.
- const dataHierarchy = pivotTable.getDataHierarchies()[0];
- dataHierarchy.setSummarizeBy(ExcelScript.AggregationFunction.average);
- }
- ```
- - name: setToDefault()
- uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#setToDefault:member(1)'
- package: ExcelScript!
- fullName: setToDefault()
- summary: Reset the DataPivotHierarchy back to its default values.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setToDefault(): void;'
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.DataPivotHierarchy
+uid: 'ExcelScript!ExcelScript.DataPivotHierarchy:interface'
+package: ExcelScript!
+fullName: ExcelScript.DataPivotHierarchy
+summary: Represents the Excel DataPivotHierarchy.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample sorts the rows of a PivotTable.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get an existing PivotTable.
+ const pivotTable = workbook.getPivotTable("Farm Sales");
+
+ // Get the data hierarchy to use as the basis of the sort.
+ const valueFieldToSortOn: ExcelScript.DataPivotHierarchy = pivotTable.getDataHierarchy("Sum of Crates Sold Wholesale");
+
+ // Get the row to sort.
+ const rowToSort: ExcelScript.RowColumnPivotHierarchy = pivotTable.getRowHierarchy("Farm");
+
+ // Sort the "Farm" row's only field by the values in "Sum of Crates Sold Wholesale".
+ rowToSort.getFields()[0].sortByValues(ExcelScript.SortBy.descending, valueFieldToSortOn);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getField()
+ uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#getField:member(1)'
+ package: ExcelScript!
+ fullName: getField()
+ summary: Returns the PivotFields associated with the DataPivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getField(): PivotField;'
+ return:
+ type: ''
+ description: ''
+ - name: getId()
+ uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#getId:member(1)'
+ package: ExcelScript!
+ fullName: getId()
+ summary: ID of the DataPivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getId(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: Name of the DataPivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getNumberFormat()
+ uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#getNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: getNumberFormat()
+ summary: Number format of the DataPivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNumberFormat(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getPosition()
+ uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#getPosition:member(1)'
+ package: ExcelScript!
+ fullName: getPosition()
+ summary: Position of the DataPivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPosition(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getShowAs()
+ uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#getShowAs:member(1)'
+ package: ExcelScript!
+ fullName: getShowAs()
+ summary: Specifies if the data should be shown as a specific summary calculation.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowAs(): ShowAsRule;'
+ return:
+ type: ''
+ description: ''
+ - name: getSummarizeBy()
+ uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#getSummarizeBy:member(1)'
+ package: ExcelScript!
+ fullName: getSummarizeBy()
+ summary: Specifies if all items of the DataPivotHierarchy are shown.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSummarizeBy(): AggregationFunction;'
+ return:
+ type: ''
+ description: ''
+ - name: setName(name)
+ uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#setName:member(1)'
+ package: ExcelScript!
+ fullName: setName(name)
+ summary: Name of the DataPivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setName(name: string): void;'
+ parameters:
+ - id: name
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setNumberFormat(numberFormat)
+ uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#setNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: setNumberFormat(numberFormat)
+ summary: Number format of the DataPivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setNumberFormat(numberFormat: string): void;'
+ parameters:
+ - id: numberFormat
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setPosition(position)
+ uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#setPosition:member(1)'
+ package: ExcelScript!
+ fullName: setPosition(position)
+ summary: Position of the DataPivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPosition(position: number): void;'
+ parameters:
+ - id: position
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setShowAs(showAs)
+ uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#setShowAs:member(1)'
+ package: ExcelScript!
+ fullName: setShowAs(showAs)
+ summary: Specifies if the data should be shown as a specific summary calculation.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowAs(showAs: ShowAsRule): void;'
+ parameters:
+ - id: showAs
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * The script changes the display for "Crates Sold at Farm".
+ * It shows the percentage of the grand total,
+ * instead of the default sum.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the PivotTable named "Farm Pivot".
+ const farmPivot = workbook.getPivotTable("Farm Pivot");
+
+ // Get the data hierarchy "Sum of Crates Sold at Farm".
+ const farmSales = farmPivot.getDataHierarchy("Sum of Crates Sold at Farm");
+
+ // Show the data as a percentage of the grand total.
+ farmSales.setShowAs({
+ calculation: ExcelScript.ShowAsCalculation.percentOfGrandTotal
+ });
+ }
+ ```
+ - name: setSummarizeBy(summarizeBy)
+ uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#setSummarizeBy:member(1)'
+ package: ExcelScript!
+ fullName: setSummarizeBy(summarizeBy)
+ summary: Specifies if all items of the DataPivotHierarchy are shown.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSummarizeBy(summarizeBy: AggregationFunction): void;'
+ parameters:
+ - id: summarizeBy
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script changes how the data in a PivotTable is aggregated.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first PivotTable in the workbook.
+ const pivotTable = workbook.getPivotTables()[0];
+
+ // Set the first data hierarchy to summarize with an average value, instead of a sum.
+ const dataHierarchy = pivotTable.getDataHierarchies()[0];
+ dataHierarchy.setSummarizeBy(ExcelScript.AggregationFunction.average);
+ }
+ ```
+ - name: setToDefault()
+ uid: 'ExcelScript!ExcelScript.DataPivotHierarchy#setToDefault:member(1)'
+ package: ExcelScript!
+ fullName: setToDefault()
+ summary: Reset the DataPivotHierarchy back to its default values.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setToDefault(): void;'
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.datasourcetype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.datasourcetype.yml
new file mode 100644
index 00000000..5bbe29b2
--- /dev/null
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.datasourcetype.yml
@@ -0,0 +1,22 @@
+### YamlMime:TSEnum
+name: ExcelScript.DataSourceType
+uid: 'ExcelScript!ExcelScript.DataSourceType:enum'
+package: ExcelScript!
+fullName: ExcelScript.DataSourceType
+summary: Represents a command type of `DataConnection`.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: localRange
+ uid: 'ExcelScript!ExcelScript.DataSourceType.localRange:member'
+ package: ExcelScript!
+ summary: The data source type is a range in the current workbook.
+ - name: localTable
+ uid: 'ExcelScript!ExcelScript.DataSourceType.localTable:member'
+ package: ExcelScript!
+ summary: The data source type is a table in the current workbook.
+ - name: unknown
+ uid: 'ExcelScript!ExcelScript.DataSourceType.unknown:member'
+ package: ExcelScript!
+ summary: The data source type is unknown or unsupported.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidation.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidation.yml
index bd6d1b1a..1ab520cc 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidation.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidation.yml
@@ -1,274 +1,274 @@
-### YamlMime:TSType
-name: ExcelScript.DataValidation
-uid: 'ExcelScript!ExcelScript.DataValidation:interface'
-package: ExcelScript!
-fullName: ExcelScript.DataValidation
-summary: Represents the data validation applied to the current range.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: clear()
- uid: 'ExcelScript!ExcelScript.DataValidation#clear:member(1)'
- package: ExcelScript!
- fullName: clear()
- summary: Clears the data validation from the current range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'clear(): void;'
- return:
- type: void
- description: ''
- - name: getErrorAlert()
- uid: 'ExcelScript!ExcelScript.DataValidation#getErrorAlert:member(1)'
- package: ExcelScript!
- fullName: getErrorAlert()
- summary: Error alert when user enters invalid data.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getErrorAlert(): DataValidationErrorAlert;'
- return:
- type: ''
- description: ''
- - name: getIgnoreBlanks()
- uid: 'ExcelScript!ExcelScript.DataValidation#getIgnoreBlanks:member(1)'
- package: ExcelScript!
- fullName: getIgnoreBlanks()
- summary: Specifies if data validation will be performed on blank cells. Default is `true`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIgnoreBlanks(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getInvalidCells()
- uid: 'ExcelScript!ExcelScript.DataValidation#getInvalidCells:member(1)'
- package: ExcelScript!
- fullName: getInvalidCells()
- summary: >-
- Returns a `RangeAreas` object, comprising one or more rectangular ranges, with invalid cell values. If all cell
- values are valid, this function will return `null`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getInvalidCells(): RangeAreas;'
- return:
- type: ''
- description: ''
- - name: getPrompt()
- uid: 'ExcelScript!ExcelScript.DataValidation#getPrompt:member(1)'
- package: ExcelScript!
- fullName: getPrompt()
- summary: Prompt when users select a cell.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPrompt(): DataValidationPrompt;'
- return:
- type: ''
- description: ''
- - name: getRule()
- uid: 'ExcelScript!ExcelScript.DataValidation#getRule:member(1)'
- package: ExcelScript!
- fullName: getRule()
- summary: Data validation rule that contains different type of data validation criteria.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRule(): DataValidationRule;'
- return:
- type: ''
- description: ''
- - name: getType()
- uid: 'ExcelScript!ExcelScript.DataValidation#getType:member(1)'
- package: ExcelScript!
- fullName: getType()
- summary: 'Type of the data validation, see `ExcelScript.DataValidationType` for details.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getType(): DataValidationType;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample reads and logs the data validation type of the currently selected range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the currently selected range.
- let range = workbook.getSelectedRange();
-
- // Get the type (`DataValidationType`) of data validation applied to the range.
- let validationType = range.getDataValidation().getType();
-
- /*
- * Log the data validation type.
- * If the range has a single value, it logs that type.
- * If the range doesn't have data validation applied, it logs "None".
- * If the range has multiple different types of data validation, it logs "Inconsistent" or "MixedCriteria".
- */
- console.log(validationType.toString());
- }
- ```
- - name: getValid()
- uid: 'ExcelScript!ExcelScript.DataValidation#getValid:member(1)'
- package: ExcelScript!
- fullName: getValid()
- summary: >-
- Represents if all cell values are valid according to the data validation rules. Returns `true` if all cell values
- are valid, or `false` if all cell values are invalid. Returns `null` if there are both valid and invalid cell
- values within the range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getValid(): boolean;'
- return:
- type: boolean
- description: ''
- - name: setErrorAlert(errorAlert)
- uid: 'ExcelScript!ExcelScript.DataValidation#setErrorAlert:member(1)'
- package: ExcelScript!
- fullName: setErrorAlert(errorAlert)
- summary: Error alert when user enters invalid data.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setErrorAlert(errorAlert: DataValidationErrorAlert): void;'
- parameters:
- - id: errorAlert
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setIgnoreBlanks(ignoreBlanks)
- uid: 'ExcelScript!ExcelScript.DataValidation#setIgnoreBlanks:member(1)'
- package: ExcelScript!
- fullName: setIgnoreBlanks(ignoreBlanks)
- summary: Specifies if data validation will be performed on blank cells. Default is `true`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setIgnoreBlanks(ignoreBlanks: boolean): void;'
- parameters:
- - id: ignoreBlanks
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setPrompt(prompt)
- uid: 'ExcelScript!ExcelScript.DataValidation#setPrompt:member(1)'
- package: ExcelScript!
- fullName: setPrompt(prompt)
- summary: Prompt when users select a cell.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPrompt(prompt: DataValidationPrompt): void;'
- parameters:
- - id: prompt
- description: ''
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a text prompt that's shown in C2:C8 when a user enters the cell.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the data validation object for C2:C8 in the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
- let dataValidation = selectedSheet.getRange("C2:C8").getDataValidation();
-
- // Clear any previous validation to avoid conflicts.
- dataValidation.clear();
-
- // Create a prompt to remind users to only enter first names in this column.
- dataValidation.setPrompt({
- showPrompt: true,
- title: "First names only",
- message: "Only enter the first name of the employee, not the full name."
- });
- }
- ```
- - name: setRule(rule)
- uid: 'ExcelScript!ExcelScript.DataValidation#setRule:member(1)'
- package: ExcelScript!
- fullName: setRule(rule)
- summary: Data validation rule that contains different type of data validation criteria.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setRule(rule: DataValidationRule): void;'
- parameters:
- - id: rule
- description: ''
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a data validation rule for the range B1:B5.
- * All values in that range must be a positive number.
- * Attempts to enter other values are blocked and an error message appears.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range B1:B5 in the active worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const positiveNumberOnlyCells = currentSheet.getRange("B1:B5");
-
- // Create a data validation rule to only allow positive numbers.
- const positiveNumberValidation: ExcelScript.BasicDataValidation = {
- formula1: "0",
- operator: ExcelScript.DataValidationOperator.greaterThan
- };
- const positiveNumberOnlyRule: ExcelScript.DataValidationRule = {
- wholeNumber: positiveNumberValidation
- };
-
- // Set the rule on the range.
- const rangeDataValidation = positiveNumberOnlyCells.getDataValidation();
- rangeDataValidation.setRule(positiveNumberOnlyRule);
-
- // Create an alert to appear when data other than positive numbers are entered.
- const positiveNumberOnlyAlert: ExcelScript.DataValidationErrorAlert = {
- message: "Positive numbers only",
- showAlert: true,
- style: ExcelScript.DataValidationAlertStyle.stop,
- title: "Invalid data"
- };
- rangeDataValidation.setErrorAlert(positiveNumberOnlyAlert);
- }
- ```
+### YamlMime:TSType
+name: ExcelScript.DataValidation
+uid: 'ExcelScript!ExcelScript.DataValidation:interface'
+package: ExcelScript!
+fullName: ExcelScript.DataValidation
+summary: Represents the data validation applied to the current range.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: clear()
+ uid: 'ExcelScript!ExcelScript.DataValidation#clear:member(1)'
+ package: ExcelScript!
+ fullName: clear()
+ summary: Clears the data validation from the current range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clear(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getErrorAlert()
+ uid: 'ExcelScript!ExcelScript.DataValidation#getErrorAlert:member(1)'
+ package: ExcelScript!
+ fullName: getErrorAlert()
+ summary: Error alert when user enters invalid data.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getErrorAlert(): DataValidationErrorAlert;'
+ return:
+ type: ''
+ description: ''
+ - name: getIgnoreBlanks()
+ uid: 'ExcelScript!ExcelScript.DataValidation#getIgnoreBlanks:member(1)'
+ package: ExcelScript!
+ fullName: getIgnoreBlanks()
+ summary: Specifies if data validation will be performed on blank cells. Default is `true`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIgnoreBlanks(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getInvalidCells()
+ uid: 'ExcelScript!ExcelScript.DataValidation#getInvalidCells:member(1)'
+ package: ExcelScript!
+ fullName: getInvalidCells()
+ summary: >-
+ Returns a `RangeAreas` object, comprising one or more rectangular ranges, with invalid cell values. If all cell
+ values are valid, this function will return `null`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getInvalidCells(): RangeAreas;'
+ return:
+ type: ''
+ description: ''
+ - name: getPrompt()
+ uid: 'ExcelScript!ExcelScript.DataValidation#getPrompt:member(1)'
+ package: ExcelScript!
+ fullName: getPrompt()
+ summary: Prompt when users select a cell.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPrompt(): DataValidationPrompt;'
+ return:
+ type: ''
+ description: ''
+ - name: getRule()
+ uid: 'ExcelScript!ExcelScript.DataValidation#getRule:member(1)'
+ package: ExcelScript!
+ fullName: getRule()
+ summary: Data validation rule that contains different type of data validation criteria.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRule(): DataValidationRule;'
+ return:
+ type: ''
+ description: ''
+ - name: getType()
+ uid: 'ExcelScript!ExcelScript.DataValidation#getType:member(1)'
+ package: ExcelScript!
+ fullName: getType()
+ summary: 'Type of the data validation, see `ExcelScript.DataValidationType` for details.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getType(): DataValidationType;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample reads and logs the data validation type of the currently selected range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the currently selected range.
+ let range = workbook.getSelectedRange();
+
+ // Get the type (`DataValidationType`) of data validation applied to the range.
+ let validationType = range.getDataValidation().getType();
+
+ /*
+ * Log the data validation type.
+ * If the range has a single value, it logs that type.
+ * If the range doesn't have data validation applied, it logs "None".
+ * If the range has multiple different types of data validation, it logs "Inconsistent" or "MixedCriteria".
+ */
+ console.log(validationType.toString());
+ }
+ ```
+ - name: getValid()
+ uid: 'ExcelScript!ExcelScript.DataValidation#getValid:member(1)'
+ package: ExcelScript!
+ fullName: getValid()
+ summary: >-
+ Represents if all cell values are valid according to the data validation rules. Returns `true` if all cell values
+ are valid, or `false` if all cell values are invalid. Returns `null` if there are both valid and invalid cell
+ values within the range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getValid(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: setErrorAlert(errorAlert)
+ uid: 'ExcelScript!ExcelScript.DataValidation#setErrorAlert:member(1)'
+ package: ExcelScript!
+ fullName: setErrorAlert(errorAlert)
+ summary: Error alert when user enters invalid data.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setErrorAlert(errorAlert: DataValidationErrorAlert): void;'
+ parameters:
+ - id: errorAlert
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setIgnoreBlanks(ignoreBlanks)
+ uid: 'ExcelScript!ExcelScript.DataValidation#setIgnoreBlanks:member(1)'
+ package: ExcelScript!
+ fullName: setIgnoreBlanks(ignoreBlanks)
+ summary: Specifies if data validation will be performed on blank cells. Default is `true`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setIgnoreBlanks(ignoreBlanks: boolean): void;'
+ parameters:
+ - id: ignoreBlanks
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setPrompt(prompt)
+ uid: 'ExcelScript!ExcelScript.DataValidation#setPrompt:member(1)'
+ package: ExcelScript!
+ fullName: setPrompt(prompt)
+ summary: Prompt when users select a cell.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPrompt(prompt: DataValidationPrompt): void;'
+ parameters:
+ - id: prompt
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a text prompt that's shown in C2:C8 when a user enters the cell.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the data validation object for C2:C8 in the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+ let dataValidation = selectedSheet.getRange("C2:C8").getDataValidation();
+
+ // Clear any previous validation to avoid conflicts.
+ dataValidation.clear();
+
+ // Create a prompt to remind users to only enter first names in this column.
+ dataValidation.setPrompt({
+ showPrompt: true,
+ title: "First names only",
+ message: "Only enter the first name of the employee, not the full name."
+ });
+ }
+ ```
+ - name: setRule(rule)
+ uid: 'ExcelScript!ExcelScript.DataValidation#setRule:member(1)'
+ package: ExcelScript!
+ fullName: setRule(rule)
+ summary: Data validation rule that contains different type of data validation criteria.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setRule(rule: DataValidationRule): void;'
+ parameters:
+ - id: rule
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a data validation rule for the range B1:B5.
+ * All values in that range must be a positive number.
+ * Attempts to enter other values are blocked and an error message appears.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range B1:B5 in the active worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const positiveNumberOnlyCells = currentSheet.getRange("B1:B5");
+
+ // Create a data validation rule to only allow positive numbers.
+ const positiveNumberValidation: ExcelScript.BasicDataValidation = {
+ formula1: "0",
+ operator: ExcelScript.DataValidationOperator.greaterThan
+ };
+ const positiveNumberOnlyRule: ExcelScript.DataValidationRule = {
+ wholeNumber: positiveNumberValidation
+ };
+
+ // Set the rule on the range.
+ const rangeDataValidation = positiveNumberOnlyCells.getDataValidation();
+ rangeDataValidation.setRule(positiveNumberOnlyRule);
+
+ // Create an alert to appear when data other than positive numbers are entered.
+ const positiveNumberOnlyAlert: ExcelScript.DataValidationErrorAlert = {
+ message: "Positive numbers only",
+ showAlert: true,
+ style: ExcelScript.DataValidationAlertStyle.stop,
+ title: "Invalid data"
+ };
+ rangeDataValidation.setErrorAlert(positiveNumberOnlyAlert);
+ }
+ ```
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidationalertstyle.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidationalertstyle.yml
index 571a555d..8f541274 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidationalertstyle.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidationalertstyle.yml
@@ -1,60 +1,60 @@
-### YamlMime:TSEnum
-name: ExcelScript.DataValidationAlertStyle
-uid: 'ExcelScript!ExcelScript.DataValidationAlertStyle:enum'
-package: ExcelScript!
-fullName: ExcelScript.DataValidationAlertStyle
-summary: Represents the data validation error alert style. The default is `Stop`.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a data validation rule for the range B1:B5.
- * All values in that range must be a positive number.
- * Attempts to enter other values are blocked and an error message appears.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range B1:B5 in the active worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const positiveNumberOnlyCells = currentSheet.getRange("B1:B5");
-
- // Create a data validation rule to only allow positive numbers.
- const positiveNumberValidation: ExcelScript.BasicDataValidation = {
- formula1: "0",
- operator: ExcelScript.DataValidationOperator.greaterThan
- };
- const positiveNumberOnlyRule: ExcelScript.DataValidationRule = {
- wholeNumber: positiveNumberValidation
- };
-
- // Set the rule on the range.
- const rangeDataValidation = positiveNumberOnlyCells.getDataValidation();
- rangeDataValidation.setRule(positiveNumberOnlyRule);
-
- // Create an alert to appear when data other than positive numbers are entered.
- const positiveNumberOnlyAlert: ExcelScript.DataValidationErrorAlert = {
- message: "Positive numbers only",
- showAlert: true,
- style: ExcelScript.DataValidationAlertStyle.stop,
- title: "Invalid data"
- };
- rangeDataValidation.setErrorAlert(positiveNumberOnlyAlert);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: information
- uid: 'ExcelScript!ExcelScript.DataValidationAlertStyle.information:member'
- package: ExcelScript!
- summary: ''
- - name: stop
- uid: 'ExcelScript!ExcelScript.DataValidationAlertStyle.stop:member'
- package: ExcelScript!
- summary: ''
- - name: warning
- uid: 'ExcelScript!ExcelScript.DataValidationAlertStyle.warning:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.DataValidationAlertStyle
+uid: 'ExcelScript!ExcelScript.DataValidationAlertStyle:enum'
+package: ExcelScript!
+fullName: ExcelScript.DataValidationAlertStyle
+summary: Represents the data validation error alert style. The default is `Stop`.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a data validation rule for the range B1:B5.
+ * All values in that range must be a positive number.
+ * Attempts to enter other values are blocked and an error message appears.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range B1:B5 in the active worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const positiveNumberOnlyCells = currentSheet.getRange("B1:B5");
+
+ // Create a data validation rule to only allow positive numbers.
+ const positiveNumberValidation: ExcelScript.BasicDataValidation = {
+ formula1: "0",
+ operator: ExcelScript.DataValidationOperator.greaterThan
+ };
+ const positiveNumberOnlyRule: ExcelScript.DataValidationRule = {
+ wholeNumber: positiveNumberValidation
+ };
+
+ // Set the rule on the range.
+ const rangeDataValidation = positiveNumberOnlyCells.getDataValidation();
+ rangeDataValidation.setRule(positiveNumberOnlyRule);
+
+ // Create an alert to appear when data other than positive numbers are entered.
+ const positiveNumberOnlyAlert: ExcelScript.DataValidationErrorAlert = {
+ message: "Positive numbers only",
+ showAlert: true,
+ style: ExcelScript.DataValidationAlertStyle.stop,
+ title: "Invalid data"
+ };
+ rangeDataValidation.setErrorAlert(positiveNumberOnlyAlert);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: information
+ uid: 'ExcelScript!ExcelScript.DataValidationAlertStyle.information:member'
+ package: ExcelScript!
+ summary: ''
+ - name: stop
+ uid: 'ExcelScript!ExcelScript.DataValidationAlertStyle.stop:member'
+ package: ExcelScript!
+ summary: ''
+ - name: warning
+ uid: 'ExcelScript!ExcelScript.DataValidationAlertStyle.warning:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidationerroralert.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidationerroralert.yml
index e6d24d9f..c1b4cd06 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidationerroralert.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidationerroralert.yml
@@ -1,97 +1,97 @@
-### YamlMime:TSType
-name: ExcelScript.DataValidationErrorAlert
-uid: 'ExcelScript!ExcelScript.DataValidationErrorAlert:interface'
-package: ExcelScript!
-fullName: ExcelScript.DataValidationErrorAlert
-summary: Represents the error alert properties for the data validation.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a data validation rule for the range B1:B5.
- * All values in that range must be a positive number.
- * Attempts to enter other values are blocked and an error message appears.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range B1:B5 in the active worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const positiveNumberOnlyCells = currentSheet.getRange("B1:B5");
-
- // Create a data validation rule to only allow positive numbers.
- const positiveNumberValidation: ExcelScript.BasicDataValidation = {
- formula1: "0",
- operator: ExcelScript.DataValidationOperator.greaterThan
- };
- const positiveNumberOnlyRule: ExcelScript.DataValidationRule = {
- wholeNumber: positiveNumberValidation
- };
-
- // Set the rule on the range.
- const rangeDataValidation = positiveNumberOnlyCells.getDataValidation();
- rangeDataValidation.setRule(positiveNumberOnlyRule);
-
- // Create an alert to appear when data other than positive numbers are entered.
- const positiveNumberOnlyAlert: ExcelScript.DataValidationErrorAlert = {
- message: "Positive numbers only",
- showAlert: true,
- style: ExcelScript.DataValidationAlertStyle.stop,
- title: "Invalid data"
- };
- rangeDataValidation.setErrorAlert(positiveNumberOnlyAlert);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: message
- uid: 'ExcelScript!ExcelScript.DataValidationErrorAlert#message:member'
- package: ExcelScript!
- fullName: message
- summary: Represents the error alert message.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'message: string;'
- return:
- type: string
- - name: showAlert
- uid: 'ExcelScript!ExcelScript.DataValidationErrorAlert#showAlert:member'
- package: ExcelScript!
- fullName: showAlert
- summary: Specifies whether to show an error alert dialog when a user enters invalid data. The default is `true`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'showAlert: boolean;'
- return:
- type: boolean
- - name: style
- uid: 'ExcelScript!ExcelScript.DataValidationErrorAlert#style:member'
- package: ExcelScript!
- fullName: style
- summary: 'The data validation alert type, please see `ExcelScript.DataValidationAlertStyle` for details.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'style: DataValidationAlertStyle;'
- return:
- type: ''
- - name: title
- uid: 'ExcelScript!ExcelScript.DataValidationErrorAlert#title:member'
- package: ExcelScript!
- fullName: title
- summary: Represents the error alert dialog title.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'title: string;'
- return:
- type: string
+### YamlMime:TSType
+name: ExcelScript.DataValidationErrorAlert
+uid: 'ExcelScript!ExcelScript.DataValidationErrorAlert:interface'
+package: ExcelScript!
+fullName: ExcelScript.DataValidationErrorAlert
+summary: Represents the error alert properties for the data validation.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a data validation rule for the range B1:B5.
+ * All values in that range must be a positive number.
+ * Attempts to enter other values are blocked and an error message appears.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range B1:B5 in the active worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const positiveNumberOnlyCells = currentSheet.getRange("B1:B5");
+
+ // Create a data validation rule to only allow positive numbers.
+ const positiveNumberValidation: ExcelScript.BasicDataValidation = {
+ formula1: "0",
+ operator: ExcelScript.DataValidationOperator.greaterThan
+ };
+ const positiveNumberOnlyRule: ExcelScript.DataValidationRule = {
+ wholeNumber: positiveNumberValidation
+ };
+
+ // Set the rule on the range.
+ const rangeDataValidation = positiveNumberOnlyCells.getDataValidation();
+ rangeDataValidation.setRule(positiveNumberOnlyRule);
+
+ // Create an alert to appear when data other than positive numbers are entered.
+ const positiveNumberOnlyAlert: ExcelScript.DataValidationErrorAlert = {
+ message: "Positive numbers only",
+ showAlert: true,
+ style: ExcelScript.DataValidationAlertStyle.stop,
+ title: "Invalid data"
+ };
+ rangeDataValidation.setErrorAlert(positiveNumberOnlyAlert);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: message
+ uid: 'ExcelScript!ExcelScript.DataValidationErrorAlert#message:member'
+ package: ExcelScript!
+ fullName: message
+ summary: Represents the error alert message.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'message: string;'
+ return:
+ type: string
+ - name: showAlert
+ uid: 'ExcelScript!ExcelScript.DataValidationErrorAlert#showAlert:member'
+ package: ExcelScript!
+ fullName: showAlert
+ summary: Specifies whether to show an error alert dialog when a user enters invalid data. The default is `true`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'showAlert: boolean;'
+ return:
+ type: boolean
+ - name: style
+ uid: 'ExcelScript!ExcelScript.DataValidationErrorAlert#style:member'
+ package: ExcelScript!
+ fullName: style
+ summary: 'The data validation alert type, please see `ExcelScript.DataValidationAlertStyle` for details.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'style: DataValidationAlertStyle;'
+ return:
+ type: ''
+ - name: title
+ uid: 'ExcelScript!ExcelScript.DataValidationErrorAlert#title:member'
+ package: ExcelScript!
+ fullName: title
+ summary: Represents the error alert dialog title.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'title: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidationoperator.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidationoperator.yml
index b27093da..15dde142 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidationoperator.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidationoperator.yml
@@ -1,70 +1,70 @@
-### YamlMime:TSEnum
-name: ExcelScript.DataValidationOperator
-uid: 'ExcelScript!ExcelScript.DataValidationOperator:enum'
-package: ExcelScript!
-fullName: ExcelScript.DataValidationOperator
-summary: Represents the data validation operator enum.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a data validation rule for the range B1:B5.
- * All values in that range must be a positive number.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range B1:B5 in the active worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const positiveNumberOnlyCells = currentSheet.getRange("B1:B5");
-
- // Create a data validation rule to only allow positive numbers.
- const positiveNumberValidation: ExcelScript.BasicDataValidation = {
- formula1: "0",
- operator: ExcelScript.DataValidationOperator.greaterThan
- };
- const positiveNumberOnlyRule: ExcelScript.DataValidationRule = {
- wholeNumber: positiveNumberValidation
- };
-
- // Set the rule on the range.
- const rangeDataValidation = positiveNumberOnlyCells.getDataValidation();
- rangeDataValidation.setRule(positiveNumberOnlyRule);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: between
- uid: 'ExcelScript!ExcelScript.DataValidationOperator.between:member'
- package: ExcelScript!
- summary: ''
- - name: equalTo
- uid: 'ExcelScript!ExcelScript.DataValidationOperator.equalTo:member'
- package: ExcelScript!
- summary: ''
- - name: greaterThan
- uid: 'ExcelScript!ExcelScript.DataValidationOperator.greaterThan:member'
- package: ExcelScript!
- summary: ''
- - name: greaterThanOrEqualTo
- uid: 'ExcelScript!ExcelScript.DataValidationOperator.greaterThanOrEqualTo:member'
- package: ExcelScript!
- summary: ''
- - name: lessThan
- uid: 'ExcelScript!ExcelScript.DataValidationOperator.lessThan:member'
- package: ExcelScript!
- summary: ''
- - name: lessThanOrEqualTo
- uid: 'ExcelScript!ExcelScript.DataValidationOperator.lessThanOrEqualTo:member'
- package: ExcelScript!
- summary: ''
- - name: notBetween
- uid: 'ExcelScript!ExcelScript.DataValidationOperator.notBetween:member'
- package: ExcelScript!
- summary: ''
- - name: notEqualTo
- uid: 'ExcelScript!ExcelScript.DataValidationOperator.notEqualTo:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.DataValidationOperator
+uid: 'ExcelScript!ExcelScript.DataValidationOperator:enum'
+package: ExcelScript!
+fullName: ExcelScript.DataValidationOperator
+summary: Represents the data validation operator enum.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a data validation rule for the range B1:B5.
+ * All values in that range must be a positive number.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range B1:B5 in the active worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const positiveNumberOnlyCells = currentSheet.getRange("B1:B5");
+
+ // Create a data validation rule to only allow positive numbers.
+ const positiveNumberValidation: ExcelScript.BasicDataValidation = {
+ formula1: "0",
+ operator: ExcelScript.DataValidationOperator.greaterThan
+ };
+ const positiveNumberOnlyRule: ExcelScript.DataValidationRule = {
+ wholeNumber: positiveNumberValidation
+ };
+
+ // Set the rule on the range.
+ const rangeDataValidation = positiveNumberOnlyCells.getDataValidation();
+ rangeDataValidation.setRule(positiveNumberOnlyRule);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: between
+ uid: 'ExcelScript!ExcelScript.DataValidationOperator.between:member'
+ package: ExcelScript!
+ summary: ''
+ - name: equalTo
+ uid: 'ExcelScript!ExcelScript.DataValidationOperator.equalTo:member'
+ package: ExcelScript!
+ summary: ''
+ - name: greaterThan
+ uid: 'ExcelScript!ExcelScript.DataValidationOperator.greaterThan:member'
+ package: ExcelScript!
+ summary: ''
+ - name: greaterThanOrEqualTo
+ uid: 'ExcelScript!ExcelScript.DataValidationOperator.greaterThanOrEqualTo:member'
+ package: ExcelScript!
+ summary: ''
+ - name: lessThan
+ uid: 'ExcelScript!ExcelScript.DataValidationOperator.lessThan:member'
+ package: ExcelScript!
+ summary: ''
+ - name: lessThanOrEqualTo
+ uid: 'ExcelScript!ExcelScript.DataValidationOperator.lessThanOrEqualTo:member'
+ package: ExcelScript!
+ summary: ''
+ - name: notBetween
+ uid: 'ExcelScript!ExcelScript.DataValidationOperator.notBetween:member'
+ package: ExcelScript!
+ summary: ''
+ - name: notEqualTo
+ uid: 'ExcelScript!ExcelScript.DataValidationOperator.notEqualTo:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidationprompt.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidationprompt.yml
index 70238111..cc540448 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidationprompt.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidationprompt.yml
@@ -1,72 +1,72 @@
-### YamlMime:TSType
-name: ExcelScript.DataValidationPrompt
-uid: 'ExcelScript!ExcelScript.DataValidationPrompt:interface'
-package: ExcelScript!
-fullName: ExcelScript.DataValidationPrompt
-summary: Represents the user prompt properties for the data validation.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a text prompt that's shown in C2:C8 when a user enters the cell.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the data validation object for C2:C8 in the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
- let dataValidation = selectedSheet.getRange("C2:C8").getDataValidation();
-
- // Clear any previous validation to avoid conflicts.
- dataValidation.clear();
-
- // Create a prompt to remind users to only enter first names in this column.
- const prompt: ExcelScript.DataValidationPrompt = {
- showPrompt: true,
- title: "First names only",
- message: "Only enter the first name of the employee, not the full name."
- }
- dataValidation.setPrompt(prompt);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: message
- uid: 'ExcelScript!ExcelScript.DataValidationPrompt#message:member'
- package: ExcelScript!
- fullName: message
- summary: Specifies the message of the prompt.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'message: string;'
- return:
- type: string
- - name: showPrompt
- uid: 'ExcelScript!ExcelScript.DataValidationPrompt#showPrompt:member'
- package: ExcelScript!
- fullName: showPrompt
- summary: Specifies if a prompt is shown when a user selects a cell with data validation.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'showPrompt: boolean;'
- return:
- type: boolean
- - name: title
- uid: 'ExcelScript!ExcelScript.DataValidationPrompt#title:member'
- package: ExcelScript!
- fullName: title
- summary: Specifies the title for the prompt.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'title: string;'
- return:
- type: string
+### YamlMime:TSType
+name: ExcelScript.DataValidationPrompt
+uid: 'ExcelScript!ExcelScript.DataValidationPrompt:interface'
+package: ExcelScript!
+fullName: ExcelScript.DataValidationPrompt
+summary: Represents the user prompt properties for the data validation.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a text prompt that's shown in C2:C8 when a user enters the cell.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the data validation object for C2:C8 in the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+ let dataValidation = selectedSheet.getRange("C2:C8").getDataValidation();
+
+ // Clear any previous validation to avoid conflicts.
+ dataValidation.clear();
+
+ // Create a prompt to remind users to only enter first names in this column.
+ const prompt: ExcelScript.DataValidationPrompt = {
+ showPrompt: true,
+ title: "First names only",
+ message: "Only enter the first name of the employee, not the full name."
+ }
+ dataValidation.setPrompt(prompt);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: message
+ uid: 'ExcelScript!ExcelScript.DataValidationPrompt#message:member'
+ package: ExcelScript!
+ fullName: message
+ summary: Specifies the message of the prompt.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'message: string;'
+ return:
+ type: string
+ - name: showPrompt
+ uid: 'ExcelScript!ExcelScript.DataValidationPrompt#showPrompt:member'
+ package: ExcelScript!
+ fullName: showPrompt
+ summary: Specifies if a prompt is shown when a user selects a cell with data validation.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'showPrompt: boolean;'
+ return:
+ type: boolean
+ - name: title
+ uid: 'ExcelScript!ExcelScript.DataValidationPrompt#title:member'
+ package: ExcelScript!
+ fullName: title
+ summary: Specifies the title for the prompt.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'title: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidationrule.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidationrule.yml
index be7064e9..c36da860 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidationrule.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidationrule.yml
@@ -1,203 +1,203 @@
-### YamlMime:TSType
-name: ExcelScript.DataValidationRule
-uid: 'ExcelScript!ExcelScript.DataValidationRule:interface'
-package: ExcelScript!
-fullName: ExcelScript.DataValidationRule
-summary: >-
- A data validation rule contains different types of data validation. You can only use one of them at a time according
- the `ExcelScript.DataValidationType`.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: custom
- uid: 'ExcelScript!ExcelScript.DataValidationRule#custom:member'
- package: ExcelScript!
- fullName: custom
- summary: Custom data validation criteria.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'custom?: CustomDataValidation;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds data validation to a range.
- * The validation prevents duplicate entries within that range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range "B2:B20".
- const sheet = workbook.getActiveWorksheet();
- const range = sheet.getRange("B2:B20");
-
- // Set data validation on the range to prevent duplicate, non-blank entries.
- const dataValidation = range.getDataValidation();
- dataValidation.setIgnoreBlanks(true);
- const duplicateRule : ExcelScript.CustomDataValidation = {
- formula: "=COUNTIF($B$2:$B$20, B2)=1"
- };
- dataValidation.setRule({
- custom: duplicateRule
- });
- }
- ```
- - name: date
- uid: 'ExcelScript!ExcelScript.DataValidationRule#date:member'
- package: ExcelScript!
- fullName: date
- summary: Date data validation criteria.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'date?: DateTimeDataValidation;'
- return:
- type: ''
- - name: decimal
- uid: 'ExcelScript!ExcelScript.DataValidationRule#decimal:member'
- package: ExcelScript!
- fullName: decimal
- summary: Decimal data validation criteria.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'decimal?: BasicDataValidation;'
- return:
- type: ''
- - name: list
- uid: 'ExcelScript!ExcelScript.DataValidationRule#list:member'
- package: ExcelScript!
- fullName: list
- summary: List data validation criteria.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'list?: ListDataValidation;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a dropdown selection list for a cell.
- * It uses the existing values of the selected range as the choices for the list.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the values for data validation.
- const selectedRange = workbook.getSelectedRange();
- const rangeValues = selectedRange.getValues();
-
- // Convert the values into a comma-delimited string.
- let dataValidationListString = "";
- rangeValues.forEach((rangeValueRow) => {
- rangeValueRow.forEach((value) => {
- dataValidationListString += value + ",";
- });
- });
-
- // Clear the old range.
- selectedRange.clear(ExcelScript.ClearApplyTo.contents);
-
- // Apply the data validation to the first cell in the selected range.
- const targetCell = selectedRange.getCell(0, 0);
- const dataValidation = targetCell.getDataValidation();
-
- // Set the content of the dropdown list.
- let validationCriteria : ExcelScript.ListDataValidation = {
- inCellDropDown: true,
- source: dataValidationListString
- };
- let validationRule: ExcelScript.DataValidationRule = {
- list: validationCriteria
- };
- dataValidation.setRule(validationRule);
- }
- ```
- - name: textLength
- uid: 'ExcelScript!ExcelScript.DataValidationRule#textLength:member'
- package: ExcelScript!
- fullName: textLength
- summary: Text length data validation criteria.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'textLength?: BasicDataValidation;'
- return:
- type: ''
- - name: time
- uid: 'ExcelScript!ExcelScript.DataValidationRule#time:member'
- package: ExcelScript!
- fullName: time
- summary: Time data validation criteria.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'time?: DateTimeDataValidation;'
- return:
- type: ''
- - name: wholeNumber
- uid: 'ExcelScript!ExcelScript.DataValidationRule#wholeNumber:member'
- package: ExcelScript!
- fullName: wholeNumber
- summary: Whole number data validation criteria.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'wholeNumber?: BasicDataValidation;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a data validation rule for the range B1:B5.
- * All values in that range must be a positive number.
- * Attempts to enter other values are blocked and an error message appears.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range B1:B5 in the active worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const positiveNumberOnlyCells = currentSheet.getRange("B1:B5");
-
- // Create a data validation rule to only allow positive numbers.
- const positiveNumberValidation: ExcelScript.BasicDataValidation = {
- formula1: "0",
- operator: ExcelScript.DataValidationOperator.greaterThan
- };
- const positiveNumberOnlyRule: ExcelScript.DataValidationRule = {
- wholeNumber: positiveNumberValidation
- };
-
- // Set the rule on the range.
- const rangeDataValidation = positiveNumberOnlyCells.getDataValidation();
- rangeDataValidation.setRule(positiveNumberOnlyRule);
-
- // Create an alert to appear when data other than positive numbers are entered.
- const positiveNumberOnlyAlert: ExcelScript.DataValidationErrorAlert = {
- message: "Positive numbers only",
- showAlert: true,
- style: ExcelScript.DataValidationAlertStyle.stop,
- title: "Invalid data"
- };
- rangeDataValidation.setErrorAlert(positiveNumberOnlyAlert);
- }
- ```
+### YamlMime:TSType
+name: ExcelScript.DataValidationRule
+uid: 'ExcelScript!ExcelScript.DataValidationRule:interface'
+package: ExcelScript!
+fullName: ExcelScript.DataValidationRule
+summary: >-
+ A data validation rule contains different types of data validation. You can only use one of them at a time according
+ the `ExcelScript.DataValidationType`.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: custom
+ uid: 'ExcelScript!ExcelScript.DataValidationRule#custom:member'
+ package: ExcelScript!
+ fullName: custom
+ summary: Custom data validation criteria.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'custom?: CustomDataValidation;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds data validation to a range.
+ * The validation prevents duplicate entries within that range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range "B2:B20".
+ const sheet = workbook.getActiveWorksheet();
+ const range = sheet.getRange("B2:B20");
+
+ // Set data validation on the range to prevent duplicate, non-blank entries.
+ const dataValidation = range.getDataValidation();
+ dataValidation.setIgnoreBlanks(true);
+ const duplicateRule : ExcelScript.CustomDataValidation = {
+ formula: "=COUNTIF($B$2:$B$20, B2)=1"
+ };
+ dataValidation.setRule({
+ custom: duplicateRule
+ });
+ }
+ ```
+ - name: date
+ uid: 'ExcelScript!ExcelScript.DataValidationRule#date:member'
+ package: ExcelScript!
+ fullName: date
+ summary: Date data validation criteria.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'date?: DateTimeDataValidation;'
+ return:
+ type: ''
+ - name: decimal
+ uid: 'ExcelScript!ExcelScript.DataValidationRule#decimal:member'
+ package: ExcelScript!
+ fullName: decimal
+ summary: Decimal data validation criteria.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'decimal?: BasicDataValidation;'
+ return:
+ type: ''
+ - name: list
+ uid: 'ExcelScript!ExcelScript.DataValidationRule#list:member'
+ package: ExcelScript!
+ fullName: list
+ summary: List data validation criteria.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'list?: ListDataValidation;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a dropdown selection list for a cell.
+ * It uses the existing values of the selected range as the choices for the list.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the values for data validation.
+ const selectedRange = workbook.getSelectedRange();
+ const rangeValues = selectedRange.getValues();
+
+ // Convert the values into a comma-delimited string.
+ let dataValidationListString = "";
+ rangeValues.forEach((rangeValueRow) => {
+ rangeValueRow.forEach((value) => {
+ dataValidationListString += value + ",";
+ });
+ });
+
+ // Clear the old range.
+ selectedRange.clear(ExcelScript.ClearApplyTo.contents);
+
+ // Apply the data validation to the first cell in the selected range.
+ const targetCell = selectedRange.getCell(0, 0);
+ const dataValidation = targetCell.getDataValidation();
+
+ // Set the content of the dropdown list.
+ let validationCriteria : ExcelScript.ListDataValidation = {
+ inCellDropDown: true,
+ source: dataValidationListString
+ };
+ let validationRule: ExcelScript.DataValidationRule = {
+ list: validationCriteria
+ };
+ dataValidation.setRule(validationRule);
+ }
+ ```
+ - name: textLength
+ uid: 'ExcelScript!ExcelScript.DataValidationRule#textLength:member'
+ package: ExcelScript!
+ fullName: textLength
+ summary: Text length data validation criteria.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'textLength?: BasicDataValidation;'
+ return:
+ type: ''
+ - name: time
+ uid: 'ExcelScript!ExcelScript.DataValidationRule#time:member'
+ package: ExcelScript!
+ fullName: time
+ summary: Time data validation criteria.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'time?: DateTimeDataValidation;'
+ return:
+ type: ''
+ - name: wholeNumber
+ uid: 'ExcelScript!ExcelScript.DataValidationRule#wholeNumber:member'
+ package: ExcelScript!
+ fullName: wholeNumber
+ summary: Whole number data validation criteria.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'wholeNumber?: BasicDataValidation;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a data validation rule for the range B1:B5.
+ * All values in that range must be a positive number.
+ * Attempts to enter other values are blocked and an error message appears.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range B1:B5 in the active worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const positiveNumberOnlyCells = currentSheet.getRange("B1:B5");
+
+ // Create a data validation rule to only allow positive numbers.
+ const positiveNumberValidation: ExcelScript.BasicDataValidation = {
+ formula1: "0",
+ operator: ExcelScript.DataValidationOperator.greaterThan
+ };
+ const positiveNumberOnlyRule: ExcelScript.DataValidationRule = {
+ wholeNumber: positiveNumberValidation
+ };
+
+ // Set the rule on the range.
+ const rangeDataValidation = positiveNumberOnlyCells.getDataValidation();
+ rangeDataValidation.setRule(positiveNumberOnlyRule);
+
+ // Create an alert to appear when data other than positive numbers are entered.
+ const positiveNumberOnlyAlert: ExcelScript.DataValidationErrorAlert = {
+ message: "Positive numbers only",
+ showAlert: true,
+ style: ExcelScript.DataValidationAlertStyle.stop,
+ title: "Invalid data"
+ };
+ rangeDataValidation.setErrorAlert(positiveNumberOnlyAlert);
+ }
+ ```
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidationtype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidationtype.yml
index c8776030..5d42069d 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidationtype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidationtype.yml
@@ -1,76 +1,76 @@
-### YamlMime:TSEnum
-name: ExcelScript.DataValidationType
-uid: 'ExcelScript!ExcelScript.DataValidationType:enum'
-package: ExcelScript!
-fullName: ExcelScript.DataValidationType
-summary: Represents the data validation type enum.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample reads and logs the data validation type of the currently selected range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the currently selected range.
- let range = workbook.getSelectedRange();
-
- // Get the type (`DataValidationType`) of data validation applied to the range.
- let validationType = range.getDataValidation().getType();
-
- /*
- * Log the data validation type.
- * If the range has a single value, it logs that type.
- * If the range doesn't have data validation applied, it logs "None".
- * If the range has multiple different types of data validation, it logs "Inconsistent" or "MixedCriteria".
- */
- console.log(validationType.toString());
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: custom
- uid: 'ExcelScript!ExcelScript.DataValidationType.custom:member'
- package: ExcelScript!
- summary: The custom data validation type.
- - name: date
- uid: 'ExcelScript!ExcelScript.DataValidationType.date:member'
- package: ExcelScript!
- summary: The date data validation type.
- - name: decimal
- uid: 'ExcelScript!ExcelScript.DataValidationType.decimal:member'
- package: ExcelScript!
- summary: The decimal data validation type.
- - name: inconsistent
- uid: 'ExcelScript!ExcelScript.DataValidationType.inconsistent:member'
- package: ExcelScript!
- summary: >-
- Inconsistent means that the range has inconsistent data validation, indicating that there are different rules on
- different cells.
- - name: list
- uid: 'ExcelScript!ExcelScript.DataValidationType.list:member'
- package: ExcelScript!
- summary: The list data validation type.
- - name: mixedCriteria
- uid: 'ExcelScript!ExcelScript.DataValidationType.mixedCriteria:member'
- package: ExcelScript!
- summary: Mixed criteria means that the range has data validation present on some but not all cells.
- - name: none
- uid: 'ExcelScript!ExcelScript.DataValidationType.none:member'
- package: ExcelScript!
- summary: 'None means allow any value, indicating that there is no data validation in the range.'
- - name: textLength
- uid: 'ExcelScript!ExcelScript.DataValidationType.textLength:member'
- package: ExcelScript!
- summary: The text length data validation type.
- - name: time
- uid: 'ExcelScript!ExcelScript.DataValidationType.time:member'
- package: ExcelScript!
- summary: The time data validation type.
- - name: wholeNumber
- uid: 'ExcelScript!ExcelScript.DataValidationType.wholeNumber:member'
- package: ExcelScript!
- summary: The whole number data validation type.
+### YamlMime:TSEnum
+name: ExcelScript.DataValidationType
+uid: 'ExcelScript!ExcelScript.DataValidationType:enum'
+package: ExcelScript!
+fullName: ExcelScript.DataValidationType
+summary: Represents the data validation type enum.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample reads and logs the data validation type of the currently selected range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the currently selected range.
+ let range = workbook.getSelectedRange();
+
+ // Get the type (`DataValidationType`) of data validation applied to the range.
+ let validationType = range.getDataValidation().getType();
+
+ /*
+ * Log the data validation type.
+ * If the range has a single value, it logs that type.
+ * If the range doesn't have data validation applied, it logs "None".
+ * If the range has multiple different types of data validation, it logs "Inconsistent" or "MixedCriteria".
+ */
+ console.log(validationType.toString());
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: custom
+ uid: 'ExcelScript!ExcelScript.DataValidationType.custom:member'
+ package: ExcelScript!
+ summary: The custom data validation type.
+ - name: date
+ uid: 'ExcelScript!ExcelScript.DataValidationType.date:member'
+ package: ExcelScript!
+ summary: The date data validation type.
+ - name: decimal
+ uid: 'ExcelScript!ExcelScript.DataValidationType.decimal:member'
+ package: ExcelScript!
+ summary: The decimal data validation type.
+ - name: inconsistent
+ uid: 'ExcelScript!ExcelScript.DataValidationType.inconsistent:member'
+ package: ExcelScript!
+ summary: >-
+ Inconsistent means that the range has inconsistent data validation, indicating that there are different rules on
+ different cells.
+ - name: list
+ uid: 'ExcelScript!ExcelScript.DataValidationType.list:member'
+ package: ExcelScript!
+ summary: The list data validation type.
+ - name: mixedCriteria
+ uid: 'ExcelScript!ExcelScript.DataValidationType.mixedCriteria:member'
+ package: ExcelScript!
+ summary: Mixed criteria means that the range has data validation present on some but not all cells.
+ - name: none
+ uid: 'ExcelScript!ExcelScript.DataValidationType.none:member'
+ package: ExcelScript!
+ summary: 'None means allow any value, indicating that there is no data validation in the range.'
+ - name: textLength
+ uid: 'ExcelScript!ExcelScript.DataValidationType.textLength:member'
+ package: ExcelScript!
+ summary: The text length data validation type.
+ - name: time
+ uid: 'ExcelScript!ExcelScript.DataValidationType.time:member'
+ package: ExcelScript!
+ summary: The time data validation type.
+ - name: wholeNumber
+ uid: 'ExcelScript!ExcelScript.DataValidationType.wholeNumber:member'
+ package: ExcelScript!
+ summary: The whole number data validation type.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.datefiltercondition.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.datefiltercondition.yml
index 3a0cf438..142055ef 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.datefiltercondition.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.datefiltercondition.yml
@@ -1,216 +1,216 @@
-### YamlMime:TSEnum
-name: ExcelScript.DateFilterCondition
-uid: 'ExcelScript!ExcelScript.DateFilterCondition:enum'
-package: ExcelScript!
-fullName: ExcelScript.DateFilterCondition
-summary: >-
- 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.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a filter to a PivotTable that filters out rows
- * that aren't from this month.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the "Date Recorded" field to filter.
- // The data in this field must be dates in order for the filter to work.
- const pivot = workbook.getPivotTables()[0];
- const rowHierarchy = pivot.getRowHierarchy("Date Recorded");
- const rowField = rowHierarchy.getFields()[0];
-
- // Apply the date filter.
- rowField.applyFilter({
- dateFilter: {
- // Setting the condition to `thisMonth` means items that are before or
- // after this month will not be displayed.
- condition: ExcelScript.DateFilterCondition.thisMonth
- }
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: after
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.after:member'
- package: ExcelScript!
- summary: |-
- Date is after comparator date.
-
- Required Criteria: {`comparator`}. Optional Criteria: {`wholeDays`}.
- - name: afterOrEqualTo
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.afterOrEqualTo:member'
- package: ExcelScript!
- summary: |-
- Date is after or equal to comparator date.
-
- Required Criteria: {`comparator`}. Optional Criteria: {`wholeDays`}.
- - name: allDatesInPeriodApril
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodApril:member'
- package: ExcelScript!
- summary: Date is in April.
- - name: allDatesInPeriodAugust
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodAugust:member'
- package: ExcelScript!
- summary: Date is in August.
- - name: allDatesInPeriodDecember
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodDecember:member'
- package: ExcelScript!
- summary: Date is in December.
- - name: allDatesInPeriodFebruary
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodFebruary:member'
- package: ExcelScript!
- summary: Date is in February.
- - name: allDatesInPeriodJanuary
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodJanuary:member'
- package: ExcelScript!
- summary: Date is in January.
- - name: allDatesInPeriodJuly
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodJuly:member'
- package: ExcelScript!
- summary: Date is in July.
- - name: allDatesInPeriodJune
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodJune:member'
- package: ExcelScript!
- summary: Date is in June.
- - name: allDatesInPeriodMarch
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodMarch:member'
- package: ExcelScript!
- summary: Date is in March.
- - name: allDatesInPeriodMay
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodMay:member'
- package: ExcelScript!
- summary: Date is in May.
- - name: allDatesInPeriodNovember
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodNovember:member'
- package: ExcelScript!
- summary: Date is in November.
- - name: allDatesInPeriodOctober
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodOctober:member'
- package: ExcelScript!
- summary: Date is in October.
- - name: allDatesInPeriodQuarter1
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodQuarter1:member'
- package: ExcelScript!
- summary: Date is in Quarter 1.
- - name: allDatesInPeriodQuarter2
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodQuarter2:member'
- package: ExcelScript!
- summary: Date is in Quarter 2.
- - name: allDatesInPeriodQuarter3
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodQuarter3:member'
- package: ExcelScript!
- summary: Date is in Quarter 3.
- - name: allDatesInPeriodQuarter4
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodQuarter4:member'
- package: ExcelScript!
- summary: Date is in Quarter 4.
- - name: allDatesInPeriodSeptember
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodSeptember:member'
- package: ExcelScript!
- summary: Date is in September.
- - name: before
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.before:member'
- package: ExcelScript!
- summary: |-
- Date is before comparator date.
-
- Required Criteria: {`comparator`}. Optional Criteria: {`wholeDays`}.
- - name: beforeOrEqualTo
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.beforeOrEqualTo:member'
- package: ExcelScript!
- summary: |-
- Date is before or equal to comparator date.
-
- Required Criteria: {`comparator`}. Optional Criteria: {`wholeDays`}.
- - name: between
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.between:member'
- package: ExcelScript!
- summary: >-
- Between `lowerBound` and `upperBound` dates.
-
-
- Required Criteria: {`lowerBound`, `upperBound`}. Optional Criteria: {`wholeDays`,
- `exclusive`}.
- - name: equals
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.equals:member'
- package: ExcelScript!
- summary: >-
- Equals comparator criterion.
-
-
- Required Criteria: {`comparator`}. Optional Criteria: {`wholeDays`, `exclusive`}.
- - name: lastMonth
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.lastMonth:member'
- package: ExcelScript!
- summary: Date is last month.
- - name: lastQuarter
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.lastQuarter:member'
- package: ExcelScript!
- summary: Date is last quarter.
- - name: lastWeek
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.lastWeek:member'
- package: ExcelScript!
- summary: Date is last week.
- - name: lastYear
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.lastYear:member'
- package: ExcelScript!
- summary: Date is last year.
- - name: nextMonth
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.nextMonth:member'
- package: ExcelScript!
- summary: Date is next month.
- - name: nextQuarter
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.nextQuarter:member'
- package: ExcelScript!
- summary: Date is next quarter.
- - name: nextWeek
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.nextWeek:member'
- package: ExcelScript!
- summary: Date is next week.
- - name: nextYear
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.nextYear:member'
- package: ExcelScript!
- summary: Date is next year.
- - name: thisMonth
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.thisMonth:member'
- package: ExcelScript!
- summary: Date is this month.
- - name: thisQuarter
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.thisQuarter:member'
- package: ExcelScript!
- summary: Date is this quarter.
- - name: thisWeek
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.thisWeek:member'
- package: ExcelScript!
- summary: Date is this week.
- - name: thisYear
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.thisYear:member'
- package: ExcelScript!
- summary: Date is this year.
- - name: today
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.today:member'
- package: ExcelScript!
- summary: Date is today.
- - name: tomorrow
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.tomorrow:member'
- package: ExcelScript!
- summary: Date is tomorrow.
- - name: unknown
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.unknown:member'
- package: ExcelScript!
- summary: '`DateFilterCondition` is unknown or unsupported.'
- - name: yearToDate
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.yearToDate:member'
- package: ExcelScript!
- summary: Date is in the same year to date.
- - name: yesterday
- uid: 'ExcelScript!ExcelScript.DateFilterCondition.yesterday:member'
- package: ExcelScript!
- summary: Date is yesterday.
+### YamlMime:TSEnum
+name: ExcelScript.DateFilterCondition
+uid: 'ExcelScript!ExcelScript.DateFilterCondition:enum'
+package: ExcelScript!
+fullName: ExcelScript.DateFilterCondition
+summary: >-
+ 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.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a filter to a PivotTable that filters out rows
+ * that aren't from this month.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the "Date Recorded" field to filter.
+ // The data in this field must be dates in order for the filter to work.
+ const pivot = workbook.getPivotTables()[0];
+ const rowHierarchy = pivot.getRowHierarchy("Date Recorded");
+ const rowField = rowHierarchy.getFields()[0];
+
+ // Apply the date filter.
+ rowField.applyFilter({
+ dateFilter: {
+ // Setting the condition to `thisMonth` means items that are before or
+ // after this month will not be displayed.
+ condition: ExcelScript.DateFilterCondition.thisMonth
+ }
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: after
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.after:member'
+ package: ExcelScript!
+ summary: |-
+ Date is after comparator date.
+
+ Required Criteria: {`comparator`}. Optional Criteria: {`wholeDays`}.
+ - name: afterOrEqualTo
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.afterOrEqualTo:member'
+ package: ExcelScript!
+ summary: |-
+ Date is after or equal to comparator date.
+
+ Required Criteria: {`comparator`}. Optional Criteria: {`wholeDays`}.
+ - name: allDatesInPeriodApril
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodApril:member'
+ package: ExcelScript!
+ summary: Date is in April.
+ - name: allDatesInPeriodAugust
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodAugust:member'
+ package: ExcelScript!
+ summary: Date is in August.
+ - name: allDatesInPeriodDecember
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodDecember:member'
+ package: ExcelScript!
+ summary: Date is in December.
+ - name: allDatesInPeriodFebruary
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodFebruary:member'
+ package: ExcelScript!
+ summary: Date is in February.
+ - name: allDatesInPeriodJanuary
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodJanuary:member'
+ package: ExcelScript!
+ summary: Date is in January.
+ - name: allDatesInPeriodJuly
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodJuly:member'
+ package: ExcelScript!
+ summary: Date is in July.
+ - name: allDatesInPeriodJune
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodJune:member'
+ package: ExcelScript!
+ summary: Date is in June.
+ - name: allDatesInPeriodMarch
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodMarch:member'
+ package: ExcelScript!
+ summary: Date is in March.
+ - name: allDatesInPeriodMay
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodMay:member'
+ package: ExcelScript!
+ summary: Date is in May.
+ - name: allDatesInPeriodNovember
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodNovember:member'
+ package: ExcelScript!
+ summary: Date is in November.
+ - name: allDatesInPeriodOctober
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodOctober:member'
+ package: ExcelScript!
+ summary: Date is in October.
+ - name: allDatesInPeriodQuarter1
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodQuarter1:member'
+ package: ExcelScript!
+ summary: Date is in Quarter 1.
+ - name: allDatesInPeriodQuarter2
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodQuarter2:member'
+ package: ExcelScript!
+ summary: Date is in Quarter 2.
+ - name: allDatesInPeriodQuarter3
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodQuarter3:member'
+ package: ExcelScript!
+ summary: Date is in Quarter 3.
+ - name: allDatesInPeriodQuarter4
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodQuarter4:member'
+ package: ExcelScript!
+ summary: Date is in Quarter 4.
+ - name: allDatesInPeriodSeptember
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.allDatesInPeriodSeptember:member'
+ package: ExcelScript!
+ summary: Date is in September.
+ - name: before
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.before:member'
+ package: ExcelScript!
+ summary: |-
+ Date is before comparator date.
+
+ Required Criteria: {`comparator`}. Optional Criteria: {`wholeDays`}.
+ - name: beforeOrEqualTo
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.beforeOrEqualTo:member'
+ package: ExcelScript!
+ summary: |-
+ Date is before or equal to comparator date.
+
+ Required Criteria: {`comparator`}. Optional Criteria: {`wholeDays`}.
+ - name: between
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.between:member'
+ package: ExcelScript!
+ summary: >-
+ Between `lowerBound` and `upperBound` dates.
+
+
+ Required Criteria: {`lowerBound`, `upperBound`}. Optional Criteria: {`wholeDays`,
+ `exclusive`}.
+ - name: equals
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.equals:member'
+ package: ExcelScript!
+ summary: >-
+ Equals comparator criterion.
+
+
+ Required Criteria: {`comparator`}. Optional Criteria: {`wholeDays`, `exclusive`}.
+ - name: lastMonth
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.lastMonth:member'
+ package: ExcelScript!
+ summary: Date is last month.
+ - name: lastQuarter
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.lastQuarter:member'
+ package: ExcelScript!
+ summary: Date is last quarter.
+ - name: lastWeek
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.lastWeek:member'
+ package: ExcelScript!
+ summary: Date is last week.
+ - name: lastYear
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.lastYear:member'
+ package: ExcelScript!
+ summary: Date is last year.
+ - name: nextMonth
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.nextMonth:member'
+ package: ExcelScript!
+ summary: Date is next month.
+ - name: nextQuarter
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.nextQuarter:member'
+ package: ExcelScript!
+ summary: Date is next quarter.
+ - name: nextWeek
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.nextWeek:member'
+ package: ExcelScript!
+ summary: Date is next week.
+ - name: nextYear
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.nextYear:member'
+ package: ExcelScript!
+ summary: Date is next year.
+ - name: thisMonth
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.thisMonth:member'
+ package: ExcelScript!
+ summary: Date is this month.
+ - name: thisQuarter
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.thisQuarter:member'
+ package: ExcelScript!
+ summary: Date is this quarter.
+ - name: thisWeek
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.thisWeek:member'
+ package: ExcelScript!
+ summary: Date is this week.
+ - name: thisYear
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.thisYear:member'
+ package: ExcelScript!
+ summary: Date is this year.
+ - name: today
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.today:member'
+ package: ExcelScript!
+ summary: Date is today.
+ - name: tomorrow
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.tomorrow:member'
+ package: ExcelScript!
+ summary: Date is tomorrow.
+ - name: unknown
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.unknown:member'
+ package: ExcelScript!
+ summary: '`DateFilterCondition` is unknown or unsupported.'
+ - name: yearToDate
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.yearToDate:member'
+ package: ExcelScript!
+ summary: Date is in the same year to date.
+ - name: yesterday
+ uid: 'ExcelScript!ExcelScript.DateFilterCondition.yesterday:member'
+ package: ExcelScript!
+ summary: Date is yesterday.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.datetimedatavalidation.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.datetimedatavalidation.yml
index 568e8eb4..e5f3886d 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.datetimedatavalidation.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.datetimedatavalidation.yml
@@ -1,89 +1,89 @@
-### YamlMime:TSType
-name: ExcelScript.DateTimeDataValidation
-uid: 'ExcelScript!ExcelScript.DateTimeDataValidation:interface'
-package: ExcelScript!
-fullName: ExcelScript.DateTimeDataValidation
-summary: Represents the date data validation criteria.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets a validation rule that only allows for certain dates to be entered.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range D2:D6 in the current worksheet.
- const selectedSheet = workbook.getActiveWorksheet();
- const range = selectedSheet.getRange("D2:D6");
-
- // Set a validation rule to only allow values that are dates in the year 2023.
- let dataValidation = range.getDataValidation();
- const dateValidationRule: ExcelScript.DateTimeDataValidation = {
- formula1: "1/1/2023",
- formula2: "12/31/2023",
- operator: ExcelScript.DataValidationOperator.between
- };
- dataValidation.setRule({ date: dateValidationRule});
-
- // Set an appropriate error message.
- dataValidation.setErrorAlert({
- showAlert: true,
- title: "2023 date required",
- message: "Please enter a date in the year 2023.",
- style: ExcelScript.DataValidationAlertStyle.stop
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: formula1
- uid: 'ExcelScript!ExcelScript.DateTimeDataValidation#formula1:member'
- package: ExcelScript!
- fullName: formula1
- summary: >-
- Specifies the right-hand operand when the operator property is set to a binary operator such as GreaterThan (the
- left-hand operand is the value the user tries to enter in the cell). With the ternary operators Between and
- NotBetween, specifies the lower bound operand. When setting the value, it can be passed in as a Date, a Range
- object, or a string formula (where the string is either a stringified date/time in ISO8601 format, a cell
- reference like "=A1", or a formula like "=MIN(A1, B1)"). When retrieving the value, it will always be returned as
- a string formula, for example: "=10", "=A1", "=SUM(A1:B5)", etc.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'formula1: string | Date | Range;'
- return:
- type: 'string | Date | '
- - name: formula2
- uid: 'ExcelScript!ExcelScript.DateTimeDataValidation#formula2:member'
- package: ExcelScript!
- fullName: formula2
- summary: >-
- With the ternary operators Between and NotBetween, specifies the upper bound operand. Is not used with the binary
- operators, such as GreaterThan. When setting the value, it can be passed in as a Date, a Range object, or a string
- (where the string is either a stringified date/time in ISO8601 format, a cell reference like "=A1", or a formula
- like "=MIN(A1, B1)"). When retrieving the value, it will always be returned as a string formula, for example:
- "=10", "=A1", "=SUM(A1:B5)", etc.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'formula2?: string | Date | Range;'
- return:
- type: 'string | Date | '
- - name: operator
- uid: 'ExcelScript!ExcelScript.DateTimeDataValidation#operator:member'
- package: ExcelScript!
- fullName: operator
- summary: The operator to use for validating the data.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'operator: DataValidationOperator;'
- return:
- type: ''
+### YamlMime:TSType
+name: ExcelScript.DateTimeDataValidation
+uid: 'ExcelScript!ExcelScript.DateTimeDataValidation:interface'
+package: ExcelScript!
+fullName: ExcelScript.DateTimeDataValidation
+summary: Represents the date data validation criteria.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets a validation rule that only allows for certain dates to be entered.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range D2:D6 in the current worksheet.
+ const selectedSheet = workbook.getActiveWorksheet();
+ const range = selectedSheet.getRange("D2:D6");
+
+ // Set a validation rule to only allow values that are dates in the year 2023.
+ let dataValidation = range.getDataValidation();
+ const dateValidationRule: ExcelScript.DateTimeDataValidation = {
+ formula1: "1/1/2023",
+ formula2: "12/31/2023",
+ operator: ExcelScript.DataValidationOperator.between
+ };
+ dataValidation.setRule({ date: dateValidationRule});
+
+ // Set an appropriate error message.
+ dataValidation.setErrorAlert({
+ showAlert: true,
+ title: "2023 date required",
+ message: "Please enter a date in the year 2023.",
+ style: ExcelScript.DataValidationAlertStyle.stop
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: formula1
+ uid: 'ExcelScript!ExcelScript.DateTimeDataValidation#formula1:member'
+ package: ExcelScript!
+ fullName: formula1
+ summary: >-
+ Specifies the right-hand operand when the operator property is set to a binary operator such as GreaterThan (the
+ left-hand operand is the value the user tries to enter in the cell). With the ternary operators Between and
+ NotBetween, specifies the lower bound operand. When setting the value, it can be passed in as a Date, a Range
+ object, or a string formula (where the string is either a stringified date/time in ISO8601 format, a cell
+ reference like "=A1", or a formula like "=MIN(A1, B1)"). When retrieving the value, it will always be returned as
+ a string formula, for example: "=10", "=A1", "=SUM(A1:B5)", etc.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'formula1: string | Date | Range;'
+ return:
+ type: 'string | Date | '
+ - name: formula2
+ uid: 'ExcelScript!ExcelScript.DateTimeDataValidation#formula2:member'
+ package: ExcelScript!
+ fullName: formula2
+ summary: >-
+ With the ternary operators Between and NotBetween, specifies the upper bound operand. Is not used with the binary
+ operators, such as GreaterThan. When setting the value, it can be passed in as a Date, a Range object, or a string
+ (where the string is either a stringified date/time in ISO8601 format, a cell reference like "=A1", or a formula
+ like "=MIN(A1, B1)"). When retrieving the value, it will always be returned as a string formula, for example:
+ "=10", "=A1", "=SUM(A1:B5)", etc.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'formula2?: string | Date | Range;'
+ return:
+ type: 'string | Date | '
+ - name: operator
+ uid: 'ExcelScript!ExcelScript.DateTimeDataValidation#operator:member'
+ package: ExcelScript!
+ fullName: operator
+ summary: The operator to use for validating the data.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'operator: DataValidationOperator;'
+ return:
+ type: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.datetimeformatinfo.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.datetimeformatinfo.yml
index 5bbee430..bf944395 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.datetimeformatinfo.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.datetimeformatinfo.yml
@@ -1,168 +1,168 @@
-### YamlMime:TSType
-name: ExcelScript.DatetimeFormatInfo
-uid: 'ExcelScript!ExcelScript.DatetimeFormatInfo:interface'
-package: ExcelScript!
-fullName: ExcelScript.DatetimeFormatInfo
-summary: Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the value of a cell to a date string for January 2, 2023.
- * It writes the day or month first in the string based on system settings.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first cell in the current worksheet.
- const cell = workbook.getActiveWorksheet().getCell(0,0);
-
- // Get the date format.
- const cultureInfo : ExcelScript.CultureInfo = workbook.getApplication().getCultureInfo();
- const systemDateTimeFormat : ExcelScript.DatetimeFormatInfo = cultureInfo.getDatetimeFormat();
- const shortDatePattern : string = systemDateTimeFormat.getShortDatePattern();
-
- // Determine if the date should start with the month or day.
- if (shortDatePattern.startsWith("m")) {
- cell.setValue("1/2/2023");
- } else {
- cell.setValue("2/1/2023");
- }
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getDateSeparator()
- uid: 'ExcelScript!ExcelScript.DatetimeFormatInfo#getDateSeparator:member(1)'
- package: ExcelScript!
- fullName: getDateSeparator()
- summary: Gets the string used as the date separator. This is based on current system settings.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDateSeparator(): string;'
- return:
- type: string
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script writes the current date, month, and year.
- * It uses the system's date separator character.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first cell in the current worksheet.
- const cell = workbook.getActiveWorksheet().getCell(0,0);
-
- // Get the date separation string.
- const cultureInfo = workbook.getApplication().getCultureInfo();
- const systemDateTimeFormat = cultureInfo.getDatetimeFormat();
- const separator = systemDateTimeFormat.getDateSeparator();
-
- // Get the current date.
- const currentDate = new Date(Date.now());
-
- // Write the date using the system's separator character.
- cell.setValue(`${currentDate.getMonth()}${separator}${currentDate.getDate()}${separator}${currentDate.getFullYear()}`);
- }
- ```
- - name: getLongDatePattern()
- uid: 'ExcelScript!ExcelScript.DatetimeFormatInfo#getLongDatePattern:member(1)'
- package: ExcelScript!
- fullName: getLongDatePattern()
- summary: Gets the format string for a long date value. This is based on current system settings.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLongDatePattern(): string;'
- return:
- type: string
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script returns the system's long date pattern.
- * This could be used in a Power Automate flow to keep date formatting consistent.
- */
- function main(workbook: ExcelScript.Workbook) : string {
- const cultureInfo = workbook.getApplication().getCultureInfo();
- const dateTimeInfo = cultureInfo.getDatetimeFormat();
-
- return dateTimeInfo.getLongDatePattern();
- }
- ```
- - name: getLongTimePattern()
- uid: 'ExcelScript!ExcelScript.DatetimeFormatInfo#getLongTimePattern:member(1)'
- package: ExcelScript!
- fullName: getLongTimePattern()
- summary: Gets the format string for a long time value. This is based on current system settings.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLongTimePattern(): string;'
- return:
- type: string
- description: ''
- - name: getShortDatePattern()
- uid: 'ExcelScript!ExcelScript.DatetimeFormatInfo#getShortDatePattern:member(1)'
- package: ExcelScript!
- fullName: getShortDatePattern()
- summary: Gets the format string for a short date value. This is based on current system settings.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShortDatePattern(): string;'
- return:
- type: string
- description: ''
- - name: getTimeSeparator()
- uid: 'ExcelScript!ExcelScript.DatetimeFormatInfo#getTimeSeparator:member(1)'
- package: ExcelScript!
- fullName: getTimeSeparator()
- summary: Gets the string used as the time separator. This is based on current system settings.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTimeSeparator(): string;'
- return:
- type: string
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script writes the current hour, minute, and second.
- * It uses the system's time separator character.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first cell in the current worksheet.
- const cell = workbook.getActiveWorksheet().getCell(0, 0);
-
- // Get the date separation string.
- const cultureInfo = workbook.getApplication().getCultureInfo();
- const systemDateTimeFormat = cultureInfo.getDatetimeFormat();
- const separator = systemDateTimeFormat.getTimeSeparator();
-
- // Get the current time.
- const currentTime = new Date(Date.now());
-
- // Write the date using the system's separator character.
- cell.setValue(`${currentTime.getHours()}${separator}${currentTime.getMinutes()}${separator}${currentTime.getSeconds()}`);
- }
- ```
+### YamlMime:TSType
+name: ExcelScript.DatetimeFormatInfo
+uid: 'ExcelScript!ExcelScript.DatetimeFormatInfo:interface'
+package: ExcelScript!
+fullName: ExcelScript.DatetimeFormatInfo
+summary: Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the value of a cell to a date string for January 2, 2023.
+ * It writes the day or month first in the string based on system settings.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first cell in the current worksheet.
+ const cell = workbook.getActiveWorksheet().getCell(0,0);
+
+ // Get the date format.
+ const cultureInfo : ExcelScript.CultureInfo = workbook.getApplication().getCultureInfo();
+ const systemDateTimeFormat : ExcelScript.DatetimeFormatInfo = cultureInfo.getDatetimeFormat();
+ const shortDatePattern : string = systemDateTimeFormat.getShortDatePattern();
+
+ // Determine if the date should start with the month or day.
+ if (shortDatePattern.startsWith("m")) {
+ cell.setValue("1/2/2023");
+ } else {
+ cell.setValue("2/1/2023");
+ }
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getDateSeparator()
+ uid: 'ExcelScript!ExcelScript.DatetimeFormatInfo#getDateSeparator:member(1)'
+ package: ExcelScript!
+ fullName: getDateSeparator()
+ summary: Gets the string used as the date separator. This is based on current system settings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDateSeparator(): string;'
+ return:
+ type: string
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script writes the current date, month, and year.
+ * It uses the system's date separator character.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first cell in the current worksheet.
+ const cell = workbook.getActiveWorksheet().getCell(0,0);
+
+ // Get the date separation string.
+ const cultureInfo = workbook.getApplication().getCultureInfo();
+ const systemDateTimeFormat = cultureInfo.getDatetimeFormat();
+ const separator = systemDateTimeFormat.getDateSeparator();
+
+ // Get the current date.
+ const currentDate = new Date(Date.now());
+
+ // Write the date using the system's separator character.
+ cell.setValue(`${currentDate.getMonth()}${separator}${currentDate.getDate()}${separator}${currentDate.getFullYear()}`);
+ }
+ ```
+ - name: getLongDatePattern()
+ uid: 'ExcelScript!ExcelScript.DatetimeFormatInfo#getLongDatePattern:member(1)'
+ package: ExcelScript!
+ fullName: getLongDatePattern()
+ summary: Gets the format string for a long date value. This is based on current system settings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLongDatePattern(): string;'
+ return:
+ type: string
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script returns the system's long date pattern.
+ * This could be used in a Power Automate flow to keep date formatting consistent.
+ */
+ function main(workbook: ExcelScript.Workbook) : string {
+ const cultureInfo = workbook.getApplication().getCultureInfo();
+ const dateTimeInfo = cultureInfo.getDatetimeFormat();
+
+ return dateTimeInfo.getLongDatePattern();
+ }
+ ```
+ - name: getLongTimePattern()
+ uid: 'ExcelScript!ExcelScript.DatetimeFormatInfo#getLongTimePattern:member(1)'
+ package: ExcelScript!
+ fullName: getLongTimePattern()
+ summary: Gets the format string for a long time value. This is based on current system settings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLongTimePattern(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getShortDatePattern()
+ uid: 'ExcelScript!ExcelScript.DatetimeFormatInfo#getShortDatePattern:member(1)'
+ package: ExcelScript!
+ fullName: getShortDatePattern()
+ summary: Gets the format string for a short date value. This is based on current system settings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShortDatePattern(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getTimeSeparator()
+ uid: 'ExcelScript!ExcelScript.DatetimeFormatInfo#getTimeSeparator:member(1)'
+ package: ExcelScript!
+ fullName: getTimeSeparator()
+ summary: Gets the string used as the time separator. This is based on current system settings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTimeSeparator(): string;'
+ return:
+ type: string
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script writes the current hour, minute, and second.
+ * It uses the system's time separator character.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first cell in the current worksheet.
+ const cell = workbook.getActiveWorksheet().getCell(0, 0);
+
+ // Get the date separation string.
+ const cultureInfo = workbook.getApplication().getCultureInfo();
+ const systemDateTimeFormat = cultureInfo.getDatetimeFormat();
+ const separator = systemDateTimeFormat.getTimeSeparator();
+
+ // Get the current time.
+ const currentTime = new Date(Date.now());
+
+ // Write the date using the system's separator character.
+ cell.setValue(`${currentTime.getHours()}${separator}${currentTime.getMinutes()}${separator}${currentTime.getSeconds()}`);
+ }
+ ```
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.deleteshiftdirection.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.deleteshiftdirection.yml
index 0de1cb3b..3eb78372 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.deleteshiftdirection.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.deleteshiftdirection.yml
@@ -1,54 +1,54 @@
-### YamlMime:TSEnum
-name: ExcelScript.DeleteShiftDirection
-uid: 'ExcelScript!ExcelScript.DeleteShiftDirection:enum'
-package: ExcelScript!
-fullName: ExcelScript.DeleteShiftDirection
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample creates a sample range, then deletes
- * "A1" using different DeleteShiftDirection values.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Add sample data to better visualize the delete changes.
- const currentSheet = workbook.getActiveWorksheet();
- currentSheet.getRange("A1:D4").setValues([
- [1,2,3,4],
- [5,6,7,8],
- [9,10,11,12],
- [13,14,15,16]]);
-
- // Delete A1 and shift the cells from the right to fill the space.
- // The value being deleted is 1.
- currentSheet.getRange("A1").delete(ExcelScript.DeleteShiftDirection.left);
-
- // Delete A1 and shift the cells from the bottom to fill the space.
- // The value being deleted is 2.
- currentSheet.getRange("A1").delete(ExcelScript.DeleteShiftDirection.up);
-
- // Log the sample range. The values should be:
- /*
- 5, 3, 4, "",
- 9, 6, 7, 8,
- 13, 10, 11, 12,
- "", 14, 15, 16
- */
- console.log(currentSheet.getRange("A1:D4").getValues());
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: left
- uid: 'ExcelScript!ExcelScript.DeleteShiftDirection.left:member'
- package: ExcelScript!
- summary: ''
- - name: up
- uid: 'ExcelScript!ExcelScript.DeleteShiftDirection.up:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.DeleteShiftDirection
+uid: 'ExcelScript!ExcelScript.DeleteShiftDirection:enum'
+package: ExcelScript!
+fullName: ExcelScript.DeleteShiftDirection
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample creates a sample range, then deletes
+ * "A1" using different DeleteShiftDirection values.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Add sample data to better visualize the delete changes.
+ const currentSheet = workbook.getActiveWorksheet();
+ currentSheet.getRange("A1:D4").setValues([
+ [1,2,3,4],
+ [5,6,7,8],
+ [9,10,11,12],
+ [13,14,15,16]]);
+
+ // Delete A1 and shift the cells from the right to fill the space.
+ // The value being deleted is 1.
+ currentSheet.getRange("A1").delete(ExcelScript.DeleteShiftDirection.left);
+
+ // Delete A1 and shift the cells from the bottom to fill the space.
+ // The value being deleted is 2.
+ currentSheet.getRange("A1").delete(ExcelScript.DeleteShiftDirection.up);
+
+ // Log the sample range. The values should be:
+ /*
+ 5, 3, 4, "",
+ 9, 6, 7, 8,
+ 13, 10, 11, 12,
+ "", 14, 15, 16
+ */
+ console.log(currentSheet.getRange("A1:D4").getValues());
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: left
+ uid: 'ExcelScript!ExcelScript.DeleteShiftDirection.left:member'
+ package: ExcelScript!
+ summary: ''
+ - name: up
+ uid: 'ExcelScript!ExcelScript.DeleteShiftDirection.up:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.documentproperties.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.documentproperties.yml
index 7439f731..6e0c2965 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.documentproperties.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.documentproperties.yml
@@ -1,440 +1,440 @@
-### YamlMime:TSType
-name: ExcelScript.DocumentProperties
-uid: 'ExcelScript!ExcelScript.DocumentProperties:interface'
-package: ExcelScript!
-fullName: ExcelScript.DocumentProperties
-summary: Represents workbook properties.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a new worksheet that displays some of the document properties.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the document properties.
- const properties: ExcelScript.DocumentProperties = workbook.getProperties();
-
- // Create a new worksheet called "Metadata".
- const newWorksheet = workbook.addWorksheet("Metadata");
-
- // Create an array to store the string values of properties to save.
- let values: string[][] = [];
- values.push(["Creation Date", properties.getCreationDate().toString()]);
- values.push(["Author", properties.getAuthor()]);
- values.push(["Last Edited By", properties.getLastAuthor()]);
-
- // Set the property values to a range on the new worksheet.
- newWorksheet.getRange("A1:B3").setValues(values);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: 'addCustomProperty(key, value)'
- uid: 'ExcelScript!ExcelScript.DocumentProperties#addCustomProperty:member(1)'
- package: ExcelScript!
- fullName: 'addCustomProperty(key, value)'
- summary: Creates a new or sets an existing custom property.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addCustomProperty(key: string, value: any): CustomProperty;'
- parameters:
- - id: key
- description: >-
- Required. The custom property's key, which is case-insensitive. The key is limited to 255 characters outside
- of Excel on the web (larger keys are automatically trimmed to 255 characters on other platforms).
- type: string
- - id: value
- description: >-
- Required. The custom property's value. The value is limited to 255 characters outside of Excel on the web
- (larger values are automatically trimmed to 255 characters on other platforms).
- type: any
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a workbook-level custom property.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the property collection.
- const properties = workbook.getProperties();
-
- // Add a new property called "Project" with the value "FA".
- properties.addCustomProperty("Project", "FA");
- }
- ```
- - name: deleteAllCustomProperties()
- uid: 'ExcelScript!ExcelScript.DocumentProperties#deleteAllCustomProperties:member(1)'
- package: ExcelScript!
- fullName: deleteAllCustomProperties()
- summary: Deletes all custom properties in this collection.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'deleteAllCustomProperties(): void;'
- return:
- type: void
- description: ''
- - name: getAuthor()
- uid: 'ExcelScript!ExcelScript.DocumentProperties#getAuthor:member(1)'
- package: ExcelScript!
- fullName: getAuthor()
- summary: The author of the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAuthor(): string;'
- return:
- type: string
- description: ''
- - name: getCategory()
- uid: 'ExcelScript!ExcelScript.DocumentProperties#getCategory:member(1)'
- package: ExcelScript!
- fullName: getCategory()
- summary: The category of the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCategory(): string;'
- return:
- type: string
- description: ''
- - name: getComments()
- uid: 'ExcelScript!ExcelScript.DocumentProperties#getComments:member(1)'
- package: ExcelScript!
- fullName: getComments()
- summary: >-
- The comment field in the metadata of the workbook. These have no connection to comments by users made in the
- workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getComments(): string;'
- return:
- type: string
- description: ''
- - name: getCompany()
- uid: 'ExcelScript!ExcelScript.DocumentProperties#getCompany:member(1)'
- package: ExcelScript!
- fullName: getCompany()
- summary: The company of the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCompany(): string;'
- return:
- type: string
- description: ''
- - name: getCreationDate()
- uid: 'ExcelScript!ExcelScript.DocumentProperties#getCreationDate:member(1)'
- package: ExcelScript!
- fullName: getCreationDate()
- summary: Gets the creation date of the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCreationDate(): Date;'
- return:
- type: Date
- description: ''
- - name: getCustom()
- uid: 'ExcelScript!ExcelScript.DocumentProperties#getCustom:member(1)'
- package: ExcelScript!
- fullName: getCustom()
- summary: Gets the collection of custom properties of the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCustom(): CustomProperty[];'
- return:
- type: '[]'
- description: ''
- - name: getCustomProperty(key)
- uid: 'ExcelScript!ExcelScript.DocumentProperties#getCustomProperty:member(1)'
- package: ExcelScript!
- fullName: getCustomProperty(key)
- summary: >-
- Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then
- this method returns `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCustomProperty(key: string): CustomProperty | undefined;'
- parameters:
- - id: key
- description: Required. The key that identifies the custom property object.
- type: string
- return:
- type: ' | undefined'
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script gets a workbook-level custom property called "Project".
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the property collection.
- const properties = workbook.getProperties();
-
- // Get the "Project" property.
- const project = properties.getCustomProperty("Project");
-
- // Show the property value in the console.
- console.log(project.getValue());
- }
- ```
- - name: getKeywords()
- uid: 'ExcelScript!ExcelScript.DocumentProperties#getKeywords:member(1)'
- package: ExcelScript!
- fullName: getKeywords()
- summary: The keywords of the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getKeywords(): string;'
- return:
- type: string
- description: ''
- - name: getLastAuthor()
- uid: 'ExcelScript!ExcelScript.DocumentProperties#getLastAuthor:member(1)'
- package: ExcelScript!
- fullName: getLastAuthor()
- summary: Gets the last author of the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLastAuthor(): string;'
- return:
- type: string
- description: ''
- - name: getManager()
- uid: 'ExcelScript!ExcelScript.DocumentProperties#getManager:member(1)'
- package: ExcelScript!
- fullName: getManager()
- summary: The manager of the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getManager(): string;'
- return:
- type: string
- description: ''
- - name: getRevisionNumber()
- uid: 'ExcelScript!ExcelScript.DocumentProperties#getRevisionNumber:member(1)'
- package: ExcelScript!
- fullName: getRevisionNumber()
- summary: Gets the revision number of the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRevisionNumber(): number;'
- return:
- type: number
- description: ''
- - name: getSubject()
- uid: 'ExcelScript!ExcelScript.DocumentProperties#getSubject:member(1)'
- package: ExcelScript!
- fullName: getSubject()
- summary: The subject of the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSubject(): string;'
- return:
- type: string
- description: ''
- - name: getTitle()
- uid: 'ExcelScript!ExcelScript.DocumentProperties#getTitle:member(1)'
- package: ExcelScript!
- fullName: getTitle()
- summary: The title of the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTitle(): string;'
- return:
- type: string
- description: ''
- - name: setAuthor(author)
- uid: 'ExcelScript!ExcelScript.DocumentProperties#setAuthor:member(1)'
- package: ExcelScript!
- fullName: setAuthor(author)
- summary: The author of the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setAuthor(author: string): void;'
- parameters:
- - id: author
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setCategory(category)
- uid: 'ExcelScript!ExcelScript.DocumentProperties#setCategory:member(1)'
- package: ExcelScript!
- fullName: setCategory(category)
- summary: The category of the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setCategory(category: string): void;'
- parameters:
- - id: category
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setComments(comments)
- uid: 'ExcelScript!ExcelScript.DocumentProperties#setComments:member(1)'
- package: ExcelScript!
- fullName: setComments(comments)
- summary: >-
- The comment field in the metadata of the workbook. These have no connection to comments by users made in the
- workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setComments(comments: string): void;'
- parameters:
- - id: comments
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setCompany(company)
- uid: 'ExcelScript!ExcelScript.DocumentProperties#setCompany:member(1)'
- package: ExcelScript!
- fullName: setCompany(company)
- summary: The company of the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setCompany(company: string): void;'
- parameters:
- - id: company
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setKeywords(keywords)
- uid: 'ExcelScript!ExcelScript.DocumentProperties#setKeywords:member(1)'
- package: ExcelScript!
- fullName: setKeywords(keywords)
- summary: The keywords of the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setKeywords(keywords: string): void;'
- parameters:
- - id: keywords
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setManager(manager)
- uid: 'ExcelScript!ExcelScript.DocumentProperties#setManager:member(1)'
- package: ExcelScript!
- fullName: setManager(manager)
- summary: The manager of the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setManager(manager: string): void;'
- parameters:
- - id: manager
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setRevisionNumber(revisionNumber)
- uid: 'ExcelScript!ExcelScript.DocumentProperties#setRevisionNumber:member(1)'
- package: ExcelScript!
- fullName: setRevisionNumber(revisionNumber)
- summary: Gets the revision number of the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setRevisionNumber(revisionNumber: number): void;'
- parameters:
- - id: revisionNumber
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setSubject(subject)
- uid: 'ExcelScript!ExcelScript.DocumentProperties#setSubject:member(1)'
- package: ExcelScript!
- fullName: setSubject(subject)
- summary: The subject of the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setSubject(subject: string): void;'
- parameters:
- - id: subject
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setTitle(title)
- uid: 'ExcelScript!ExcelScript.DocumentProperties#setTitle:member(1)'
- package: ExcelScript!
- fullName: setTitle(title)
- summary: The title of the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTitle(title: string): void;'
- parameters:
- - id: title
- description: ''
- type: string
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.DocumentProperties
+uid: 'ExcelScript!ExcelScript.DocumentProperties:interface'
+package: ExcelScript!
+fullName: ExcelScript.DocumentProperties
+summary: Represents workbook properties.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a new worksheet that displays some of the document properties.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the document properties.
+ const properties: ExcelScript.DocumentProperties = workbook.getProperties();
+
+ // Create a new worksheet called "Metadata".
+ const newWorksheet = workbook.addWorksheet("Metadata");
+
+ // Create an array to store the string values of properties to save.
+ let values: string[][] = [];
+ values.push(["Creation Date", properties.getCreationDate().toString()]);
+ values.push(["Author", properties.getAuthor()]);
+ values.push(["Last Edited By", properties.getLastAuthor()]);
+
+ // Set the property values to a range on the new worksheet.
+ newWorksheet.getRange("A1:B3").setValues(values);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: 'addCustomProperty(key, value)'
+ uid: 'ExcelScript!ExcelScript.DocumentProperties#addCustomProperty:member(1)'
+ package: ExcelScript!
+ fullName: 'addCustomProperty(key, value)'
+ summary: Creates a new or sets an existing custom property.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addCustomProperty(key: string, value: any): CustomProperty;'
+ parameters:
+ - id: key
+ description: >-
+ Required. The custom property's key, which is case-insensitive. The key is limited to 255 characters outside
+ of Excel on the web (larger keys are automatically trimmed to 255 characters on other platforms).
+ type: string
+ - id: value
+ description: >-
+ Required. The custom property's value. The value is limited to 255 characters outside of Excel on the web
+ (larger values are automatically trimmed to 255 characters on other platforms).
+ type: any
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a workbook-level custom property.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the property collection.
+ const properties = workbook.getProperties();
+
+ // Add a new property called "Project" with the value "FA".
+ properties.addCustomProperty("Project", "FA");
+ }
+ ```
+ - name: deleteAllCustomProperties()
+ uid: 'ExcelScript!ExcelScript.DocumentProperties#deleteAllCustomProperties:member(1)'
+ package: ExcelScript!
+ fullName: deleteAllCustomProperties()
+ summary: Deletes all custom properties in this collection.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'deleteAllCustomProperties(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getAuthor()
+ uid: 'ExcelScript!ExcelScript.DocumentProperties#getAuthor:member(1)'
+ package: ExcelScript!
+ fullName: getAuthor()
+ summary: The author of the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAuthor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getCategory()
+ uid: 'ExcelScript!ExcelScript.DocumentProperties#getCategory:member(1)'
+ package: ExcelScript!
+ fullName: getCategory()
+ summary: The category of the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCategory(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getComments()
+ uid: 'ExcelScript!ExcelScript.DocumentProperties#getComments:member(1)'
+ package: ExcelScript!
+ fullName: getComments()
+ summary: >-
+ The Comments field in the metadata of the workbook. These have no connection to comments by users made in the
+ workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getComments(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getCompany()
+ uid: 'ExcelScript!ExcelScript.DocumentProperties#getCompany:member(1)'
+ package: ExcelScript!
+ fullName: getCompany()
+ summary: The company of the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCompany(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getCreationDate()
+ uid: 'ExcelScript!ExcelScript.DocumentProperties#getCreationDate:member(1)'
+ package: ExcelScript!
+ fullName: getCreationDate()
+ summary: Gets the creation date of the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCreationDate(): Date;'
+ return:
+ type: Date
+ description: ''
+ - name: getCustom()
+ uid: 'ExcelScript!ExcelScript.DocumentProperties#getCustom:member(1)'
+ package: ExcelScript!
+ fullName: getCustom()
+ summary: Gets the collection of custom properties of the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCustom(): CustomProperty[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getCustomProperty(key)
+ uid: 'ExcelScript!ExcelScript.DocumentProperties#getCustomProperty:member(1)'
+ package: ExcelScript!
+ fullName: getCustomProperty(key)
+ summary: >-
+ Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then
+ this method returns `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCustomProperty(key: string): CustomProperty | undefined;'
+ parameters:
+ - id: key
+ description: Required. The key that identifies the custom property object.
+ type: string
+ return:
+ type: ' | undefined'
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script gets a workbook-level custom property called "Project".
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the property collection.
+ const properties = workbook.getProperties();
+
+ // Get the "Project" property.
+ const project = properties.getCustomProperty("Project");
+
+ // Show the property value in the console.
+ console.log(project.getValue());
+ }
+ ```
+ - name: getKeywords()
+ uid: 'ExcelScript!ExcelScript.DocumentProperties#getKeywords:member(1)'
+ package: ExcelScript!
+ fullName: getKeywords()
+ summary: The keywords of the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getKeywords(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getLastAuthor()
+ uid: 'ExcelScript!ExcelScript.DocumentProperties#getLastAuthor:member(1)'
+ package: ExcelScript!
+ fullName: getLastAuthor()
+ summary: Gets the last author of the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLastAuthor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getManager()
+ uid: 'ExcelScript!ExcelScript.DocumentProperties#getManager:member(1)'
+ package: ExcelScript!
+ fullName: getManager()
+ summary: The manager of the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getManager(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getRevisionNumber()
+ uid: 'ExcelScript!ExcelScript.DocumentProperties#getRevisionNumber:member(1)'
+ package: ExcelScript!
+ fullName: getRevisionNumber()
+ summary: Gets the revision number of the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRevisionNumber(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getSubject()
+ uid: 'ExcelScript!ExcelScript.DocumentProperties#getSubject:member(1)'
+ package: ExcelScript!
+ fullName: getSubject()
+ summary: The subject of the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSubject(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getTitle()
+ uid: 'ExcelScript!ExcelScript.DocumentProperties#getTitle:member(1)'
+ package: ExcelScript!
+ fullName: getTitle()
+ summary: The title of the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTitle(): string;'
+ return:
+ type: string
+ description: ''
+ - name: setAuthor(author)
+ uid: 'ExcelScript!ExcelScript.DocumentProperties#setAuthor:member(1)'
+ package: ExcelScript!
+ fullName: setAuthor(author)
+ summary: The author of the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setAuthor(author: string): void;'
+ parameters:
+ - id: author
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setCategory(category)
+ uid: 'ExcelScript!ExcelScript.DocumentProperties#setCategory:member(1)'
+ package: ExcelScript!
+ fullName: setCategory(category)
+ summary: The category of the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setCategory(category: string): void;'
+ parameters:
+ - id: category
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setComments(comments)
+ uid: 'ExcelScript!ExcelScript.DocumentProperties#setComments:member(1)'
+ package: ExcelScript!
+ fullName: setComments(comments)
+ summary: >-
+ The Comments field in the metadata of the workbook. These have no connection to comments by users made in the
+ workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setComments(comments: string): void;'
+ parameters:
+ - id: comments
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setCompany(company)
+ uid: 'ExcelScript!ExcelScript.DocumentProperties#setCompany:member(1)'
+ package: ExcelScript!
+ fullName: setCompany(company)
+ summary: The company of the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setCompany(company: string): void;'
+ parameters:
+ - id: company
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setKeywords(keywords)
+ uid: 'ExcelScript!ExcelScript.DocumentProperties#setKeywords:member(1)'
+ package: ExcelScript!
+ fullName: setKeywords(keywords)
+ summary: The keywords of the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setKeywords(keywords: string): void;'
+ parameters:
+ - id: keywords
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setManager(manager)
+ uid: 'ExcelScript!ExcelScript.DocumentProperties#setManager:member(1)'
+ package: ExcelScript!
+ fullName: setManager(manager)
+ summary: The manager of the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setManager(manager: string): void;'
+ parameters:
+ - id: manager
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setRevisionNumber(revisionNumber)
+ uid: 'ExcelScript!ExcelScript.DocumentProperties#setRevisionNumber:member(1)'
+ package: ExcelScript!
+ fullName: setRevisionNumber(revisionNumber)
+ summary: Gets the revision number of the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setRevisionNumber(revisionNumber: number): void;'
+ parameters:
+ - id: revisionNumber
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setSubject(subject)
+ uid: 'ExcelScript!ExcelScript.DocumentProperties#setSubject:member(1)'
+ package: ExcelScript!
+ fullName: setSubject(subject)
+ summary: The subject of the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSubject(subject: string): void;'
+ parameters:
+ - id: subject
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setTitle(title)
+ uid: 'ExcelScript!ExcelScript.DocumentProperties#setTitle:member(1)'
+ package: ExcelScript!
+ fullName: setTitle(title)
+ summary: The title of the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTitle(title: string): void;'
+ parameters:
+ - id: title
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.documentpropertytype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.documentpropertytype.yml
index 46c99c8e..46a2b750 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.documentpropertytype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.documentpropertytype.yml
@@ -1,58 +1,58 @@
-### YamlMime:TSEnum
-name: ExcelScript.DocumentPropertyType
-uid: 'ExcelScript!ExcelScript.DocumentPropertyType:enum'
-package: ExcelScript!
-fullName: ExcelScript.DocumentPropertyType
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script uses a custom property to set the value and formatting of a cell.
- * If the value of "Routing Number" is not set or is not a number, the cell will be red.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first cell from Sheet1.
- const cell = workbook.getWorksheet("Sheet1").getCell(0,0);
-
- // Get the "Routing Number" property.
- const properties = workbook.getProperties();
- const routingNumber = properties.getCustomProperty("Routing Number");
-
- // If the property is missing or is not a number, change the formatting to indicate a problem.
- if (!routingNumber || routingNumber.getType() != ExcelScript.DocumentPropertyType.number) {
- cell.getFormat().getFill().setColor("red");
- }
-
- // If the property exists, use it to set the value of A1.
- if (routingNumber) {
- cell.setValue(routingNumber.getValue());
- }
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: boolean
- uid: 'ExcelScript!ExcelScript.DocumentPropertyType.boolean:member'
- package: ExcelScript!
- summary: ''
- - name: date
- uid: 'ExcelScript!ExcelScript.DocumentPropertyType.date:member'
- package: ExcelScript!
- summary: ''
- - name: float
- uid: 'ExcelScript!ExcelScript.DocumentPropertyType.float:member'
- package: ExcelScript!
- summary: ''
- - name: number
- uid: 'ExcelScript!ExcelScript.DocumentPropertyType.number:member'
- package: ExcelScript!
- summary: ''
- - name: string
- uid: 'ExcelScript!ExcelScript.DocumentPropertyType.string:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.DocumentPropertyType
+uid: 'ExcelScript!ExcelScript.DocumentPropertyType:enum'
+package: ExcelScript!
+fullName: ExcelScript.DocumentPropertyType
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script uses a custom property to set the value and formatting of a cell.
+ * If the value of "Routing Number" is not set or is not a number, the cell will be red.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first cell from Sheet1.
+ const cell = workbook.getWorksheet("Sheet1").getCell(0,0);
+
+ // Get the "Routing Number" property.
+ const properties = workbook.getProperties();
+ const routingNumber = properties.getCustomProperty("Routing Number");
+
+ // If the property is missing or is not a number, change the formatting to indicate a problem.
+ if (!routingNumber || routingNumber.getType() != ExcelScript.DocumentPropertyType.number) {
+ cell.getFormat().getFill().setColor("red");
+ }
+
+ // If the property exists, use it to set the value of A1.
+ if (routingNumber) {
+ cell.setValue(routingNumber.getValue());
+ }
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: boolean
+ uid: 'ExcelScript!ExcelScript.DocumentPropertyType.boolean:member'
+ package: ExcelScript!
+ summary: ''
+ - name: date
+ uid: 'ExcelScript!ExcelScript.DocumentPropertyType.date:member'
+ package: ExcelScript!
+ summary: ''
+ - name: float
+ uid: 'ExcelScript!ExcelScript.DocumentPropertyType.float:member'
+ package: ExcelScript!
+ summary: ''
+ - name: number
+ uid: 'ExcelScript!ExcelScript.DocumentPropertyType.number:member'
+ package: ExcelScript!
+ summary: ''
+ - name: string
+ uid: 'ExcelScript!ExcelScript.DocumentPropertyType.string:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.dynamicfiltercriteria.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.dynamicfiltercriteria.yml
index 4bd1e7c3..6c60cb3a 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.dynamicfiltercriteria.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.dynamicfiltercriteria.yml
@@ -1,171 +1,171 @@
-### YamlMime:TSEnum
-name: ExcelScript.DynamicFilterCriteria
-uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria:enum'
-package: ExcelScript!
-fullName: ExcelScript.DynamicFilterCriteria
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a filter to a table that filters it
- * to only show rows with dates from the previous month.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the table named "ReportTable".
- const table = workbook.getTable("ReportTable");
-
- // Get the column with the header "Date".
- const dateColumn = table.getColumnByName("Date");
-
- // Apply a dynamic filter to the column.
- // `lastMonth` will only show rows with a date from the previous month.
- dateColumn.getFilter().applyDynamicFilter(ExcelScript.DynamicFilterCriteria.lastMonth);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: aboveAverage
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.aboveAverage:member'
- package: ExcelScript!
- summary: ''
- - name: allDatesInPeriodApril
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodApril:member'
- package: ExcelScript!
- summary: ''
- - name: allDatesInPeriodAugust
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodAugust:member'
- package: ExcelScript!
- summary: ''
- - name: allDatesInPeriodDecember
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodDecember:member'
- package: ExcelScript!
- summary: ''
- - name: allDatesInPeriodFebruary
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodFebruary:member'
- package: ExcelScript!
- summary: ''
- - name: allDatesInPeriodJanuary
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodJanuary:member'
- package: ExcelScript!
- summary: ''
- - name: allDatesInPeriodJuly
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodJuly:member'
- package: ExcelScript!
- summary: ''
- - name: allDatesInPeriodJune
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodJune:member'
- package: ExcelScript!
- summary: ''
- - name: allDatesInPeriodMarch
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodMarch:member'
- package: ExcelScript!
- summary: ''
- - name: allDatesInPeriodMay
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodMay:member'
- package: ExcelScript!
- summary: ''
- - name: allDatesInPeriodNovember
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodNovember:member'
- package: ExcelScript!
- summary: ''
- - name: allDatesInPeriodOctober
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodOctober:member'
- package: ExcelScript!
- summary: ''
- - name: allDatesInPeriodQuarter1
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodQuarter1:member'
- package: ExcelScript!
- summary: ''
- - name: allDatesInPeriodQuarter2
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodQuarter2:member'
- package: ExcelScript!
- summary: ''
- - name: allDatesInPeriodQuarter3
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodQuarter3:member'
- package: ExcelScript!
- summary: ''
- - name: allDatesInPeriodQuarter4
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodQuarter4:member'
- package: ExcelScript!
- summary: ''
- - name: allDatesInPeriodSeptember
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodSeptember:member'
- package: ExcelScript!
- summary: ''
- - name: belowAverage
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.belowAverage:member'
- package: ExcelScript!
- summary: ''
- - name: lastMonth
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.lastMonth:member'
- package: ExcelScript!
- summary: ''
- - name: lastQuarter
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.lastQuarter:member'
- package: ExcelScript!
- summary: ''
- - name: lastWeek
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.lastWeek:member'
- package: ExcelScript!
- summary: ''
- - name: lastYear
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.lastYear:member'
- package: ExcelScript!
- summary: ''
- - name: nextMonth
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.nextMonth:member'
- package: ExcelScript!
- summary: ''
- - name: nextQuarter
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.nextQuarter:member'
- package: ExcelScript!
- summary: ''
- - name: nextWeek
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.nextWeek:member'
- package: ExcelScript!
- summary: ''
- - name: nextYear
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.nextYear:member'
- package: ExcelScript!
- summary: ''
- - name: thisMonth
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.thisMonth:member'
- package: ExcelScript!
- summary: ''
- - name: thisQuarter
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.thisQuarter:member'
- package: ExcelScript!
- summary: ''
- - name: thisWeek
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.thisWeek:member'
- package: ExcelScript!
- summary: ''
- - name: thisYear
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.thisYear:member'
- package: ExcelScript!
- summary: ''
- - name: today
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.today:member'
- package: ExcelScript!
- summary: ''
- - name: tomorrow
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.tomorrow:member'
- package: ExcelScript!
- summary: ''
- - name: unknown
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.unknown:member'
- package: ExcelScript!
- summary: ''
- - name: yearToDate
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.yearToDate:member'
- package: ExcelScript!
- summary: ''
- - name: yesterday
- uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.yesterday:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.DynamicFilterCriteria
+uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria:enum'
+package: ExcelScript!
+fullName: ExcelScript.DynamicFilterCriteria
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a filter to a table that filters it
+ * to only show rows with dates from the previous month.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the table named "ReportTable".
+ const table = workbook.getTable("ReportTable");
+
+ // Get the column with the header "Date".
+ const dateColumn = table.getColumnByName("Date");
+
+ // Apply a dynamic filter to the column.
+ // `lastMonth` will only show rows with a date from the previous month.
+ dateColumn.getFilter().applyDynamicFilter(ExcelScript.DynamicFilterCriteria.lastMonth);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: aboveAverage
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.aboveAverage:member'
+ package: ExcelScript!
+ summary: ''
+ - name: allDatesInPeriodApril
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodApril:member'
+ package: ExcelScript!
+ summary: ''
+ - name: allDatesInPeriodAugust
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodAugust:member'
+ package: ExcelScript!
+ summary: ''
+ - name: allDatesInPeriodDecember
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodDecember:member'
+ package: ExcelScript!
+ summary: ''
+ - name: allDatesInPeriodFebruary
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodFebruary:member'
+ package: ExcelScript!
+ summary: ''
+ - name: allDatesInPeriodJanuary
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodJanuary:member'
+ package: ExcelScript!
+ summary: ''
+ - name: allDatesInPeriodJuly
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodJuly:member'
+ package: ExcelScript!
+ summary: ''
+ - name: allDatesInPeriodJune
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodJune:member'
+ package: ExcelScript!
+ summary: ''
+ - name: allDatesInPeriodMarch
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodMarch:member'
+ package: ExcelScript!
+ summary: ''
+ - name: allDatesInPeriodMay
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodMay:member'
+ package: ExcelScript!
+ summary: ''
+ - name: allDatesInPeriodNovember
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodNovember:member'
+ package: ExcelScript!
+ summary: ''
+ - name: allDatesInPeriodOctober
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodOctober:member'
+ package: ExcelScript!
+ summary: ''
+ - name: allDatesInPeriodQuarter1
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodQuarter1:member'
+ package: ExcelScript!
+ summary: ''
+ - name: allDatesInPeriodQuarter2
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodQuarter2:member'
+ package: ExcelScript!
+ summary: ''
+ - name: allDatesInPeriodQuarter3
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodQuarter3:member'
+ package: ExcelScript!
+ summary: ''
+ - name: allDatesInPeriodQuarter4
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodQuarter4:member'
+ package: ExcelScript!
+ summary: ''
+ - name: allDatesInPeriodSeptember
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.allDatesInPeriodSeptember:member'
+ package: ExcelScript!
+ summary: ''
+ - name: belowAverage
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.belowAverage:member'
+ package: ExcelScript!
+ summary: ''
+ - name: lastMonth
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.lastMonth:member'
+ package: ExcelScript!
+ summary: ''
+ - name: lastQuarter
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.lastQuarter:member'
+ package: ExcelScript!
+ summary: ''
+ - name: lastWeek
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.lastWeek:member'
+ package: ExcelScript!
+ summary: ''
+ - name: lastYear
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.lastYear:member'
+ package: ExcelScript!
+ summary: ''
+ - name: nextMonth
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.nextMonth:member'
+ package: ExcelScript!
+ summary: ''
+ - name: nextQuarter
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.nextQuarter:member'
+ package: ExcelScript!
+ summary: ''
+ - name: nextWeek
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.nextWeek:member'
+ package: ExcelScript!
+ summary: ''
+ - name: nextYear
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.nextYear:member'
+ package: ExcelScript!
+ summary: ''
+ - name: thisMonth
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.thisMonth:member'
+ package: ExcelScript!
+ summary: ''
+ - name: thisQuarter
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.thisQuarter:member'
+ package: ExcelScript!
+ summary: ''
+ - name: thisWeek
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.thisWeek:member'
+ package: ExcelScript!
+ summary: ''
+ - name: thisYear
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.thisYear:member'
+ package: ExcelScript!
+ summary: ''
+ - name: today
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.today:member'
+ package: ExcelScript!
+ summary: ''
+ - name: tomorrow
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.tomorrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: unknown
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.unknown:member'
+ package: ExcelScript!
+ summary: ''
+ - name: yearToDate
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.yearToDate:member'
+ package: ExcelScript!
+ summary: ''
+ - name: yesterday
+ uid: 'ExcelScript!ExcelScript.DynamicFilterCriteria.yesterday:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.emptycellcontrol.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.emptycellcontrol.yml
new file mode 100644
index 00000000..5b5cd73b
--- /dev/null
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.emptycellcontrol.yml
@@ -0,0 +1,23 @@
+### YamlMime:TSType
+name: ExcelScript.EmptyCellControl
+uid: 'ExcelScript!ExcelScript.EmptyCellControl:interface'
+package: ExcelScript!
+fullName: ExcelScript.EmptyCellControl
+summary: Represents an empty cell control. This represents the state where a cell does not have a control.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: type
+ uid: 'ExcelScript!ExcelScript.EmptyCellControl#type:member'
+ package: ExcelScript!
+ fullName: type
+ summary: ''
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'type: CellControlType.empty;'
+ return:
+ type: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.fillpattern.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.fillpattern.yml
index 1790c7ce..6cc4d04f 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.fillpattern.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.fillpattern.yml
@@ -1,108 +1,108 @@
-### YamlMime:TSEnum
-name: ExcelScript.FillPattern
-uid: 'ExcelScript!ExcelScript.FillPattern:enum'
-package: ExcelScript!
-fullName: ExcelScript.FillPattern
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets a black-checkered fill on the selected range.
- */
- function main(workbook: ExcelScript.Workbook) {
- const selected = workbook.getSelectedRange();
- selected.getFormat().getFill().setPattern(ExcelScript.FillPattern.checker);
- selected.getFormat().getFill().setPatternColor("black");
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: checker
- uid: 'ExcelScript!ExcelScript.FillPattern.checker:member'
- package: ExcelScript!
- summary: ''
- - name: crissCross
- uid: 'ExcelScript!ExcelScript.FillPattern.crissCross:member'
- package: ExcelScript!
- summary: ''
- - name: down
- uid: 'ExcelScript!ExcelScript.FillPattern.down:member'
- package: ExcelScript!
- summary: ''
- - name: gray16
- uid: 'ExcelScript!ExcelScript.FillPattern.gray16:member'
- package: ExcelScript!
- summary: ''
- - name: gray25
- uid: 'ExcelScript!ExcelScript.FillPattern.gray25:member'
- package: ExcelScript!
- summary: ''
- - name: gray50
- uid: 'ExcelScript!ExcelScript.FillPattern.gray50:member'
- package: ExcelScript!
- summary: ''
- - name: gray75
- uid: 'ExcelScript!ExcelScript.FillPattern.gray75:member'
- package: ExcelScript!
- summary: ''
- - name: gray8
- uid: 'ExcelScript!ExcelScript.FillPattern.gray8:member'
- package: ExcelScript!
- summary: ''
- - name: grid
- uid: 'ExcelScript!ExcelScript.FillPattern.grid:member'
- package: ExcelScript!
- summary: ''
- - name: horizontal
- uid: 'ExcelScript!ExcelScript.FillPattern.horizontal:member'
- package: ExcelScript!
- summary: ''
- - name: lightDown
- uid: 'ExcelScript!ExcelScript.FillPattern.lightDown:member'
- package: ExcelScript!
- summary: ''
- - name: lightHorizontal
- uid: 'ExcelScript!ExcelScript.FillPattern.lightHorizontal:member'
- package: ExcelScript!
- summary: ''
- - name: lightUp
- uid: 'ExcelScript!ExcelScript.FillPattern.lightUp:member'
- package: ExcelScript!
- summary: ''
- - name: lightVertical
- uid: 'ExcelScript!ExcelScript.FillPattern.lightVertical:member'
- package: ExcelScript!
- summary: ''
- - name: linearGradient
- uid: 'ExcelScript!ExcelScript.FillPattern.linearGradient:member'
- package: ExcelScript!
- summary: ''
- - name: none
- uid: 'ExcelScript!ExcelScript.FillPattern.none:member'
- package: ExcelScript!
- summary: ''
- - name: rectangularGradient
- uid: 'ExcelScript!ExcelScript.FillPattern.rectangularGradient:member'
- package: ExcelScript!
- summary: ''
- - name: semiGray75
- uid: 'ExcelScript!ExcelScript.FillPattern.semiGray75:member'
- package: ExcelScript!
- summary: ''
- - name: solid
- uid: 'ExcelScript!ExcelScript.FillPattern.solid:member'
- package: ExcelScript!
- summary: ''
- - name: up
- uid: 'ExcelScript!ExcelScript.FillPattern.up:member'
- package: ExcelScript!
- summary: ''
- - name: vertical
- uid: 'ExcelScript!ExcelScript.FillPattern.vertical:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.FillPattern
+uid: 'ExcelScript!ExcelScript.FillPattern:enum'
+package: ExcelScript!
+fullName: ExcelScript.FillPattern
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets a black-checkered fill on the selected range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ const selected = workbook.getSelectedRange();
+ selected.getFormat().getFill().setPattern(ExcelScript.FillPattern.checker);
+ selected.getFormat().getFill().setPatternColor("black");
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: checker
+ uid: 'ExcelScript!ExcelScript.FillPattern.checker:member'
+ package: ExcelScript!
+ summary: ''
+ - name: crissCross
+ uid: 'ExcelScript!ExcelScript.FillPattern.crissCross:member'
+ package: ExcelScript!
+ summary: ''
+ - name: down
+ uid: 'ExcelScript!ExcelScript.FillPattern.down:member'
+ package: ExcelScript!
+ summary: ''
+ - name: gray16
+ uid: 'ExcelScript!ExcelScript.FillPattern.gray16:member'
+ package: ExcelScript!
+ summary: ''
+ - name: gray25
+ uid: 'ExcelScript!ExcelScript.FillPattern.gray25:member'
+ package: ExcelScript!
+ summary: ''
+ - name: gray50
+ uid: 'ExcelScript!ExcelScript.FillPattern.gray50:member'
+ package: ExcelScript!
+ summary: ''
+ - name: gray75
+ uid: 'ExcelScript!ExcelScript.FillPattern.gray75:member'
+ package: ExcelScript!
+ summary: ''
+ - name: gray8
+ uid: 'ExcelScript!ExcelScript.FillPattern.gray8:member'
+ package: ExcelScript!
+ summary: ''
+ - name: grid
+ uid: 'ExcelScript!ExcelScript.FillPattern.grid:member'
+ package: ExcelScript!
+ summary: ''
+ - name: horizontal
+ uid: 'ExcelScript!ExcelScript.FillPattern.horizontal:member'
+ package: ExcelScript!
+ summary: ''
+ - name: lightDown
+ uid: 'ExcelScript!ExcelScript.FillPattern.lightDown:member'
+ package: ExcelScript!
+ summary: ''
+ - name: lightHorizontal
+ uid: 'ExcelScript!ExcelScript.FillPattern.lightHorizontal:member'
+ package: ExcelScript!
+ summary: ''
+ - name: lightUp
+ uid: 'ExcelScript!ExcelScript.FillPattern.lightUp:member'
+ package: ExcelScript!
+ summary: ''
+ - name: lightVertical
+ uid: 'ExcelScript!ExcelScript.FillPattern.lightVertical:member'
+ package: ExcelScript!
+ summary: ''
+ - name: linearGradient
+ uid: 'ExcelScript!ExcelScript.FillPattern.linearGradient:member'
+ package: ExcelScript!
+ summary: ''
+ - name: none
+ uid: 'ExcelScript!ExcelScript.FillPattern.none:member'
+ package: ExcelScript!
+ summary: ''
+ - name: rectangularGradient
+ uid: 'ExcelScript!ExcelScript.FillPattern.rectangularGradient:member'
+ package: ExcelScript!
+ summary: ''
+ - name: semiGray75
+ uid: 'ExcelScript!ExcelScript.FillPattern.semiGray75:member'
+ package: ExcelScript!
+ summary: ''
+ - name: solid
+ uid: 'ExcelScript!ExcelScript.FillPattern.solid:member'
+ package: ExcelScript!
+ summary: ''
+ - name: up
+ uid: 'ExcelScript!ExcelScript.FillPattern.up:member'
+ package: ExcelScript!
+ summary: ''
+ - name: vertical
+ uid: 'ExcelScript!ExcelScript.FillPattern.vertical:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.filter.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.filter.yml
index d2bb13fb..2312bf2e 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.filter.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.filter.yml
@@ -1,330 +1,330 @@
-### YamlMime:TSType
-name: ExcelScript.Filter
-uid: 'ExcelScript!ExcelScript.Filter:interface'
-package: ExcelScript!
-fullName: ExcelScript.Filter
-summary: Manages the filtering of a table's column.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a table filter to only show the top 10% of values
- * belonging to a particular column.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table on the current worksheet.
- const table = workbook.getActiveWorksheet().getTables()[0];
-
- // Get the filter for the "PageViews" table column.
- const pageViewFilter : ExcelScript.Filter = table.getColumnByName("PageViews").getFilter();
-
- // Apply a filter to only show the rows with the top 10% of values in this column.
- pageViewFilter.applyTopPercentFilter(10);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: apply(criteria)
- uid: 'ExcelScript!ExcelScript.Filter#apply:member(1)'
- package: ExcelScript!
- fullName: apply(criteria)
- summary: Apply the given filter criteria on the given column.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'apply(criteria: FilterCriteria): void;'
- parameters:
- - id: criteria
- description: The criteria to apply.
- type: ''
- return:
- type: void
- description: ''
- - name: applyBottomItemsFilter(count)
- uid: 'ExcelScript!ExcelScript.Filter#applyBottomItemsFilter:member(1)'
- package: ExcelScript!
- fullName: applyBottomItemsFilter(count)
- summary: Apply a "Bottom Item" filter to the column for the given number of elements.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'applyBottomItemsFilter(count: number): void;'
- parameters:
- - id: count
- description: The number of elements from the bottom to show.
- type: number
- return:
- type: void
- description: ''
- - name: applyBottomPercentFilter(percent)
- uid: 'ExcelScript!ExcelScript.Filter#applyBottomPercentFilter:member(1)'
- package: ExcelScript!
- fullName: applyBottomPercentFilter(percent)
- summary: Apply a "Bottom Percent" filter to the column for the given percentage of elements.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'applyBottomPercentFilter(percent: number): void;'
- parameters:
- - id: percent
- description: The percentage of elements from the bottom to show.
- type: number
- return:
- type: void
- description: ''
- - name: applyCellColorFilter(color)
- uid: 'ExcelScript!ExcelScript.Filter#applyCellColorFilter:member(1)'
- package: ExcelScript!
- fullName: applyCellColorFilter(color)
- summary: Apply a "Cell Color" filter to the column for the given color.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'applyCellColorFilter(color: string): void;'
- parameters:
- - id: color
- description: The background color of the cells to show.
- type: string
- return:
- type: void
- description: ''
- - name: 'applyCustomFilter(criteria1, criteria2, oper)'
- uid: 'ExcelScript!ExcelScript.Filter#applyCustomFilter:member(1)'
- package: ExcelScript!
- fullName: 'applyCustomFilter(criteria1, criteria2, oper)'
- summary: Apply an "Icon" filter to the column for the given criteria strings.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- applyCustomFilter(
- criteria1: string,
- criteria2?: string,
- oper?: FilterOperator
- ): void;
- parameters:
- - id: criteria1
- description: The first criteria string.
- type: string
- - id: criteria2
- description: Optional. The second criteria string.
- type: string
- - id: oper
- description: Optional. The operator that describes how the two criteria are joined.
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * The script filters rows from a table based on numerical values.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table in the current worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const table = currentSheet.getTables()[0];
-
- // Filter to only show rows with values in the "Sales" column that are
- // greater than or equal to 2000.
- table.getColumnByName("Sales").getFilter().applyCustomFilter(">=2000");
- }
- ```
- - name: applyDynamicFilter(criteria)
- uid: 'ExcelScript!ExcelScript.Filter#applyDynamicFilter:member(1)'
- package: ExcelScript!
- fullName: applyDynamicFilter(criteria)
- summary: Apply a "Dynamic" filter to the column.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'applyDynamicFilter(criteria: DynamicFilterCriteria): void;'
- parameters:
- - id: criteria
- description: The dynamic criteria to apply.
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a filter to a table that filters it
- * to only show rows with dates from the previous month.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the table named "ReportTable".
- const table = workbook.getTable("ReportTable");
-
- // Get the column with the header "Date".
- const dateColumn = table.getColumnByName("Date");
-
- // Apply a dynamic filter to the column.
- // `lastMonth` will only show rows with a date from the previous month.
- dateColumn.getFilter().applyDynamicFilter(ExcelScript.DynamicFilterCriteria.lastMonth);
- }
- ```
- - name: applyFontColorFilter(color)
- uid: 'ExcelScript!ExcelScript.Filter#applyFontColorFilter:member(1)'
- package: ExcelScript!
- fullName: applyFontColorFilter(color)
- summary: Apply a "Font Color" filter to the column for the given color.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'applyFontColorFilter(color: string): void;'
- parameters:
- - id: color
- description: The font color of the cells to show.
- type: string
- return:
- type: void
- description: ''
- - name: applyIconFilter(icon)
- uid: 'ExcelScript!ExcelScript.Filter#applyIconFilter:member(1)'
- package: ExcelScript!
- fullName: applyIconFilter(icon)
- summary: Apply an "Icon" filter to the column for the given icon.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'applyIconFilter(icon: Icon): void;'
- parameters:
- - id: icon
- description: The icons of the cells to show.
- type: ''
- return:
- type: void
- description: ''
- - name: applyTopItemsFilter(count)
- uid: 'ExcelScript!ExcelScript.Filter#applyTopItemsFilter:member(1)'
- package: ExcelScript!
- fullName: applyTopItemsFilter(count)
- summary: Apply a "Top Item" filter to the column for the given number of elements.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'applyTopItemsFilter(count: number): void;'
- parameters:
- - id: count
- description: The number of elements from the top to show.
- type: number
- return:
- type: void
- description: ''
- - name: applyTopPercentFilter(percent)
- uid: 'ExcelScript!ExcelScript.Filter#applyTopPercentFilter:member(1)'
- package: ExcelScript!
- fullName: applyTopPercentFilter(percent)
- summary: Apply a "Top Percent" filter to the column for the given percentage of elements.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'applyTopPercentFilter(percent: number): void;'
- parameters:
- - id: percent
- description: The percentage of elements from the top to show.
- type: number
- return:
- type: void
- description: ''
- - name: applyValuesFilter(values)
- uid: 'ExcelScript!ExcelScript.Filter#applyValuesFilter:member(1)'
- package: ExcelScript!
- fullName: applyValuesFilter(values)
- summary: Apply a "Values" filter to the column for the given values.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'applyValuesFilter(values: Array): void;'
- parameters:
- - id: values
- description: >-
- The list of values to show. This must be an array of strings or an array of `ExcelScript.FilterDateTime`
- objects.
- type: 'Array<string | >'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a filter to a table so that it only shows rows with "Needs Review" in the "Type" column.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table in the workbook.
- const table = workbook.getTables()[0];
-
- // Apply the filter to the "Type" column.
- const typeColumn = table.getColumnByName("Type");
- typeColumn.getFilter().applyValuesFilter(["Needs Review"]);
- }
- ```
- - name: clear()
- uid: 'ExcelScript!ExcelScript.Filter#clear:member(1)'
- package: ExcelScript!
- fullName: clear()
- summary: Clear the filter on the given column.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'clear(): void;'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script shows how to clear a filter from a table column.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table in the workbook.
- const table = workbook.getTables()[0];
-
- // Clear the filter for the table column named "Status".
- const statusColumnFilter = table.getColumn("Status").getFilter();
- statusColumnFilter.clear();
- }
- ```
- - name: getCriteria()
- uid: 'ExcelScript!ExcelScript.Filter#getCriteria:member(1)'
- package: ExcelScript!
- fullName: getCriteria()
- summary: The currently applied filter on the given column.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCriteria(): FilterCriteria;'
- return:
- type: ''
- description: ''
+### YamlMime:TSType
+name: ExcelScript.Filter
+uid: 'ExcelScript!ExcelScript.Filter:interface'
+package: ExcelScript!
+fullName: ExcelScript.Filter
+summary: Manages the filtering of a table's column.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a table filter to only show the top 10% of values
+ * belonging to a particular column.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table on the current worksheet.
+ const table = workbook.getActiveWorksheet().getTables()[0];
+
+ // Get the filter for the "PageViews" table column.
+ const pageViewFilter : ExcelScript.Filter = table.getColumnByName("PageViews").getFilter();
+
+ // Apply a filter to only show the rows with the top 10% of values in this column.
+ pageViewFilter.applyTopPercentFilter(10);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: apply(criteria)
+ uid: 'ExcelScript!ExcelScript.Filter#apply:member(1)'
+ package: ExcelScript!
+ fullName: apply(criteria)
+ summary: Apply the given filter criteria on the given column.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'apply(criteria: FilterCriteria): void;'
+ parameters:
+ - id: criteria
+ description: The criteria to apply.
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: applyBottomItemsFilter(count)
+ uid: 'ExcelScript!ExcelScript.Filter#applyBottomItemsFilter:member(1)'
+ package: ExcelScript!
+ fullName: applyBottomItemsFilter(count)
+ summary: Apply a "Bottom Item" filter to the column for the given number of elements.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'applyBottomItemsFilter(count: number): void;'
+ parameters:
+ - id: count
+ description: The number of elements from the bottom to show.
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: applyBottomPercentFilter(percent)
+ uid: 'ExcelScript!ExcelScript.Filter#applyBottomPercentFilter:member(1)'
+ package: ExcelScript!
+ fullName: applyBottomPercentFilter(percent)
+ summary: Apply a "Bottom Percent" filter to the column for the given percentage of elements.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'applyBottomPercentFilter(percent: number): void;'
+ parameters:
+ - id: percent
+ description: The percentage of elements from the bottom to show.
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: applyCellColorFilter(color)
+ uid: 'ExcelScript!ExcelScript.Filter#applyCellColorFilter:member(1)'
+ package: ExcelScript!
+ fullName: applyCellColorFilter(color)
+ summary: Apply a "Cell Color" filter to the column for the given color.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'applyCellColorFilter(color: string): void;'
+ parameters:
+ - id: color
+ description: The background color of the cells to show.
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: 'applyCustomFilter(criteria1, criteria2, oper)'
+ uid: 'ExcelScript!ExcelScript.Filter#applyCustomFilter:member(1)'
+ package: ExcelScript!
+ fullName: 'applyCustomFilter(criteria1, criteria2, oper)'
+ summary: Apply an "Icon" filter to the column for the given criteria strings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ applyCustomFilter(
+ criteria1: string,
+ criteria2?: string,
+ oper?: FilterOperator
+ ): void;
+ parameters:
+ - id: criteria1
+ description: The first criteria string.
+ type: string
+ - id: criteria2
+ description: Optional. The second criteria string.
+ type: string
+ - id: oper
+ description: Optional. The operator that describes how the two criteria are joined.
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * The script filters rows from a table based on numerical values.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table in the current worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const table = currentSheet.getTables()[0];
+
+ // Filter to only show rows with values in the "Sales" column that are
+ // greater than or equal to 2000.
+ table.getColumnByName("Sales").getFilter().applyCustomFilter(">=2000");
+ }
+ ```
+ - name: applyDynamicFilter(criteria)
+ uid: 'ExcelScript!ExcelScript.Filter#applyDynamicFilter:member(1)'
+ package: ExcelScript!
+ fullName: applyDynamicFilter(criteria)
+ summary: Apply a "Dynamic" filter to the column.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'applyDynamicFilter(criteria: DynamicFilterCriteria): void;'
+ parameters:
+ - id: criteria
+ description: The dynamic criteria to apply.
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a filter to a table that filters it
+ * to only show rows with dates from the previous month.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the table named "ReportTable".
+ const table = workbook.getTable("ReportTable");
+
+ // Get the column with the header "Date".
+ const dateColumn = table.getColumnByName("Date");
+
+ // Apply a dynamic filter to the column.
+ // `lastMonth` will only show rows with a date from the previous month.
+ dateColumn.getFilter().applyDynamicFilter(ExcelScript.DynamicFilterCriteria.lastMonth);
+ }
+ ```
+ - name: applyFontColorFilter(color)
+ uid: 'ExcelScript!ExcelScript.Filter#applyFontColorFilter:member(1)'
+ package: ExcelScript!
+ fullName: applyFontColorFilter(color)
+ summary: Apply a "Font Color" filter to the column for the given color.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'applyFontColorFilter(color: string): void;'
+ parameters:
+ - id: color
+ description: The font color of the cells to show.
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: applyIconFilter(icon)
+ uid: 'ExcelScript!ExcelScript.Filter#applyIconFilter:member(1)'
+ package: ExcelScript!
+ fullName: applyIconFilter(icon)
+ summary: Apply an "Icon" filter to the column for the given icon.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'applyIconFilter(icon: Icon): void;'
+ parameters:
+ - id: icon
+ description: The icons of the cells to show.
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: applyTopItemsFilter(count)
+ uid: 'ExcelScript!ExcelScript.Filter#applyTopItemsFilter:member(1)'
+ package: ExcelScript!
+ fullName: applyTopItemsFilter(count)
+ summary: Apply a "Top Item" filter to the column for the given number of elements.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'applyTopItemsFilter(count: number): void;'
+ parameters:
+ - id: count
+ description: The number of elements from the top to show.
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: applyTopPercentFilter(percent)
+ uid: 'ExcelScript!ExcelScript.Filter#applyTopPercentFilter:member(1)'
+ package: ExcelScript!
+ fullName: applyTopPercentFilter(percent)
+ summary: Apply a "Top Percent" filter to the column for the given percentage of elements.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'applyTopPercentFilter(percent: number): void;'
+ parameters:
+ - id: percent
+ description: The percentage of elements from the top to show.
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: applyValuesFilter(values)
+ uid: 'ExcelScript!ExcelScript.Filter#applyValuesFilter:member(1)'
+ package: ExcelScript!
+ fullName: applyValuesFilter(values)
+ summary: Apply a "Values" filter to the column for the given values.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'applyValuesFilter(values: Array): void;'
+ parameters:
+ - id: values
+ description: >-
+ The list of values to show. This must be an array of strings or an array of `ExcelScript.FilterDateTime`
+ objects.
+ type: 'Array<string | >'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a filter to a table so that it only shows rows with "Needs Review" in the "Type" column.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table in the workbook.
+ const table = workbook.getTables()[0];
+
+ // Apply the filter to the "Type" column.
+ const typeColumn = table.getColumnByName("Type");
+ typeColumn.getFilter().applyValuesFilter(["Needs Review"]);
+ }
+ ```
+ - name: clear()
+ uid: 'ExcelScript!ExcelScript.Filter#clear:member(1)'
+ package: ExcelScript!
+ fullName: clear()
+ summary: Clear the filter on the given column.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clear(): void;'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script shows how to clear a filter from a table column.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table in the workbook.
+ const table = workbook.getTables()[0];
+
+ // Clear the filter for the table column named "Status".
+ const statusColumnFilter = table.getColumn("Status").getFilter();
+ statusColumnFilter.clear();
+ }
+ ```
+ - name: getCriteria()
+ uid: 'ExcelScript!ExcelScript.Filter#getCriteria:member(1)'
+ package: ExcelScript!
+ fullName: getCriteria()
+ summary: The currently applied filter on the given column.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCriteria(): FilterCriteria;'
+ return:
+ type: ''
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.filtercriteria.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.filtercriteria.yml
index 1e3af7ed..1cc00234 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.filtercriteria.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.filtercriteria.yml
@@ -1,151 +1,151 @@
-### YamlMime:TSType
-name: ExcelScript.FilterCriteria
-uid: 'ExcelScript!ExcelScript.FilterCriteria:interface'
-package: ExcelScript!
-fullName: ExcelScript.FilterCriteria
-summary: Represents the filtering criteria applied to a column.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: color
- uid: 'ExcelScript!ExcelScript.FilterCriteria#color:member'
- package: ExcelScript!
- fullName: color
- summary: The HTML color string used to filter cells. Used with `cellColor` and `fontColor` filtering.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'color?: string;'
- return:
- type: string
- - name: criterion1
- uid: 'ExcelScript!ExcelScript.FilterCriteria#criterion1:member'
- package: ExcelScript!
- fullName: criterion1
- summary: >-
- The first criterion used to filter data. Used as an operator in the case of `custom` filtering. For example ">50" for numbers greater than 50, or "=*s" for values ending in "s".
-
-
- Used as a number in the case of top/bottom items/percents (e.g., "5" for the top 5 items if `filterOn` is set to
- `topItems`).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'criterion1?: string;'
- return:
- type: string
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates an autoFilter on the worksheet that filters out rows based on column values.
- * The autoFilter filters to only include rows that have a value in column C in the lowest 10 values
- * (of column C values).
- */
- function main(workbook: ExcelScript.Workbook) {
- const currentSheet = workbook.getActiveWorksheet();
- const dataRange = currentSheet.getUsedRange();
-
- // Add a filter that will only show the rows with the lowest 10 values in column C
- // (index 2, assuming the used range spans from at least A:C).
- const filterCriteria: ExcelScript.FilterCriteria = {
- criterion1: "10",
- filterOn: ExcelScript.FilterOn.bottomItems
- };
- currentSheet.getAutoFilter().apply(dataRange, 2, filterCriteria);
- }
- ```
- - name: criterion2
- uid: 'ExcelScript!ExcelScript.FilterCriteria#criterion2:member'
- package: ExcelScript!
- fullName: criterion2
- summary: The second criterion used to filter data. Only used as an operator in the case of `custom` filtering.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'criterion2?: string;'
- return:
- type: string
- - name: dynamicCriteria
- uid: 'ExcelScript!ExcelScript.FilterCriteria#dynamicCriteria:member'
- package: ExcelScript!
- fullName: dynamicCriteria
- summary: >-
- The dynamic criteria from the `ExcelScript.DynamicFilterCriteria` set to apply on this column. Used with `dynamic`
- filtering.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'dynamicCriteria?: DynamicFilterCriteria;'
- return:
- type: ''
- - name: filterOn
- uid: 'ExcelScript!ExcelScript.FilterCriteria#filterOn:member'
- package: ExcelScript!
- fullName: filterOn
- summary: The property used by the filter to determine whether the values should stay visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'filterOn: FilterOn;'
- return:
- type: ''
- - name: icon
- uid: 'ExcelScript!ExcelScript.FilterCriteria#icon:member'
- package: ExcelScript!
- fullName: icon
- summary: The icon used to filter cells. Used with `icon` filtering.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'icon?: Icon;'
- return:
- type: ''
- - name: operator
- uid: 'ExcelScript!ExcelScript.FilterCriteria#operator:member'
- package: ExcelScript!
- fullName: operator
- summary: The operator used to combine criterion 1 and 2 when using `custom` filtering.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'operator?: FilterOperator;'
- return:
- type: ''
- - name: subField
- uid: 'ExcelScript!ExcelScript.FilterCriteria#subField:member'
- package: ExcelScript!
- fullName: subField
- summary: The property used by the filter to do a rich filter on rich values.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'subField?: string;'
- return:
- type: string
- - name: values
- uid: 'ExcelScript!ExcelScript.FilterCriteria#values:member'
- package: ExcelScript!
- fullName: values
- summary: The set of values to be used as part of `values` filtering.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'values?: Array;'
- return:
- type: 'Array<string | >'
+### YamlMime:TSType
+name: ExcelScript.FilterCriteria
+uid: 'ExcelScript!ExcelScript.FilterCriteria:interface'
+package: ExcelScript!
+fullName: ExcelScript.FilterCriteria
+summary: Represents the filtering criteria applied to a column.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: color
+ uid: 'ExcelScript!ExcelScript.FilterCriteria#color:member'
+ package: ExcelScript!
+ fullName: color
+ summary: The HTML color string used to filter cells. Used with `cellColor` and `fontColor` filtering.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'color?: string;'
+ return:
+ type: string
+ - name: criterion1
+ uid: 'ExcelScript!ExcelScript.FilterCriteria#criterion1:member'
+ package: ExcelScript!
+ fullName: criterion1
+ summary: >-
+ The first criterion used to filter data. Used as an operator in the case of `custom` filtering. For example ">50" for numbers greater than 50, or "=*s" for values ending in "s".
+
+
+ Used as a number in the case of top/bottom items/percents (e.g., "5" for the top 5 items if `filterOn` is set to
+ `topItems`).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'criterion1?: string;'
+ return:
+ type: string
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates an autoFilter on the worksheet that filters out rows based on column values.
+ * The autoFilter filters to only include rows that have a value in column C in the lowest 10 values
+ * (of column C values).
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ const currentSheet = workbook.getActiveWorksheet();
+ const dataRange = currentSheet.getUsedRange();
+
+ // Add a filter that will only show the rows with the lowest 10 values in column C
+ // (index 2, assuming the used range spans from at least A:C).
+ const filterCriteria: ExcelScript.FilterCriteria = {
+ criterion1: "10",
+ filterOn: ExcelScript.FilterOn.bottomItems
+ };
+ currentSheet.getAutoFilter().apply(dataRange, 2, filterCriteria);
+ }
+ ```
+ - name: criterion2
+ uid: 'ExcelScript!ExcelScript.FilterCriteria#criterion2:member'
+ package: ExcelScript!
+ fullName: criterion2
+ summary: The second criterion used to filter data. Only used as an operator in the case of `custom` filtering.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'criterion2?: string;'
+ return:
+ type: string
+ - name: dynamicCriteria
+ uid: 'ExcelScript!ExcelScript.FilterCriteria#dynamicCriteria:member'
+ package: ExcelScript!
+ fullName: dynamicCriteria
+ summary: >-
+ The dynamic criteria from the `ExcelScript.DynamicFilterCriteria` set to apply on this column. Used with `dynamic`
+ filtering.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'dynamicCriteria?: DynamicFilterCriteria;'
+ return:
+ type: ''
+ - name: filterOn
+ uid: 'ExcelScript!ExcelScript.FilterCriteria#filterOn:member'
+ package: ExcelScript!
+ fullName: filterOn
+ summary: The property used by the filter to determine whether the values should stay visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'filterOn: FilterOn;'
+ return:
+ type: ''
+ - name: icon
+ uid: 'ExcelScript!ExcelScript.FilterCriteria#icon:member'
+ package: ExcelScript!
+ fullName: icon
+ summary: The icon used to filter cells. Used with `icon` filtering.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'icon?: Icon;'
+ return:
+ type: ''
+ - name: operator
+ uid: 'ExcelScript!ExcelScript.FilterCriteria#operator:member'
+ package: ExcelScript!
+ fullName: operator
+ summary: The operator used to combine criterion 1 and 2 when using `custom` filtering.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'operator?: FilterOperator;'
+ return:
+ type: ''
+ - name: subField
+ uid: 'ExcelScript!ExcelScript.FilterCriteria#subField:member'
+ package: ExcelScript!
+ fullName: subField
+ summary: The property used by the filter to do a rich filter on rich values.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'subField?: string;'
+ return:
+ type: string
+ - name: values
+ uid: 'ExcelScript!ExcelScript.FilterCriteria#values:member'
+ package: ExcelScript!
+ fullName: values
+ summary: The set of values to be used as part of `values` filtering.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'values?: Array;'
+ return:
+ type: 'Array<string | >'
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.filterdatetime.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.filterdatetime.yml
index 7282f1b1..cbd49d82 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.filterdatetime.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.filterdatetime.yml
@@ -1,73 +1,73 @@
-### YamlMime:TSType
-name: ExcelScript.FilterDatetime
-uid: 'ExcelScript!ExcelScript.FilterDatetime:interface'
-package: ExcelScript!
-fullName: ExcelScript.FilterDatetime
-summary: Represents how to filter a date when filtering on values.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a filter to a PivotTable that filters it
- * to only show rows from between June 20th, 2022 and July 10th, 2022.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the "Date Recorded" field to filter.
- // The data in this field must be dates in order for the filter to work.
- const pivot = workbook.getPivotTables()[0];
- const rowHierarchy = pivot.getRowHierarchy("Date Recorded");
- const rowField = rowHierarchy.getFields()[0];
-
- // Create the filter's date boundaries.
- let earliestDate: ExcelScript.FilterDatetime = {
- date: "2022-06-20",
- specificity: ExcelScript.FilterDatetimeSpecificity.day
- };
- let latestDate: ExcelScript.FilterDatetime = {
- date: "2022-07-10",
- specificity: ExcelScript.FilterDatetimeSpecificity.day
- };
-
- // Apply the date filter.
- rowField.applyFilter({
- dateFilter: {
- condition: ExcelScript.DateFilterCondition.between,
- lowerBound: earliestDate,
- upperBound: latestDate
- }
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: date
- uid: 'ExcelScript!ExcelScript.FilterDatetime#date:member'
- package: ExcelScript!
- fullName: date
- summary: The date in ISO8601 format used to filter data.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'date: string;'
- return:
- type: string
- - name: specificity
- uid: 'ExcelScript!ExcelScript.FilterDatetime#specificity:member'
- package: ExcelScript!
- fullName: specificity
- summary: >-
- How specific the date should be used to keep data. For example, if the date is 2005-04-02 and the specificity is
- set to "month", the filter operation will keep all rows with a date in the month of April 2005.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'specificity: FilterDatetimeSpecificity;'
- return:
- type: ''
+### YamlMime:TSType
+name: ExcelScript.FilterDatetime
+uid: 'ExcelScript!ExcelScript.FilterDatetime:interface'
+package: ExcelScript!
+fullName: ExcelScript.FilterDatetime
+summary: Represents how to filter a date when filtering on values.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a filter to a PivotTable that filters it
+ * to only show rows from between June 20th, 2022 and July 10th, 2022.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the "Date Recorded" field to filter.
+ // The data in this field must be dates in order for the filter to work.
+ const pivot = workbook.getPivotTables()[0];
+ const rowHierarchy = pivot.getRowHierarchy("Date Recorded");
+ const rowField = rowHierarchy.getFields()[0];
+
+ // Create the filter's date boundaries.
+ let earliestDate: ExcelScript.FilterDatetime = {
+ date: "2022-06-20",
+ specificity: ExcelScript.FilterDatetimeSpecificity.day
+ };
+ let latestDate: ExcelScript.FilterDatetime = {
+ date: "2022-07-10",
+ specificity: ExcelScript.FilterDatetimeSpecificity.day
+ };
+
+ // Apply the date filter.
+ rowField.applyFilter({
+ dateFilter: {
+ condition: ExcelScript.DateFilterCondition.between,
+ lowerBound: earliestDate,
+ upperBound: latestDate
+ }
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: date
+ uid: 'ExcelScript!ExcelScript.FilterDatetime#date:member'
+ package: ExcelScript!
+ fullName: date
+ summary: The date in ISO8601 format used to filter data.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'date: string;'
+ return:
+ type: string
+ - name: specificity
+ uid: 'ExcelScript!ExcelScript.FilterDatetime#specificity:member'
+ package: ExcelScript!
+ fullName: specificity
+ summary: >-
+ How specific the date should be used to keep data. For example, if the date is 2005-04-02 and the specificity is
+ set to "month", the filter operation will keep all rows with a date in the month of April 2005.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'specificity: FilterDatetimeSpecificity;'
+ return:
+ type: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.filterdatetimespecificity.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.filterdatetimespecificity.yml
index ef32f614..cb91149e 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.filterdatetimespecificity.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.filterdatetimespecificity.yml
@@ -1,70 +1,70 @@
-### YamlMime:TSEnum
-name: ExcelScript.FilterDatetimeSpecificity
-uid: 'ExcelScript!ExcelScript.FilterDatetimeSpecificity:enum'
-package: ExcelScript!
-fullName: ExcelScript.FilterDatetimeSpecificity
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a filter to a PivotTable that filters it
- * to only show rows from between June 20th, 2022 and July 10th, 2022.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the "Date Recorded" field to filter.
- // The data in this field must be dates in order for the filter to work.
- const pivot = workbook.getPivotTables()[0];
- const rowHierarchy = pivot.getRowHierarchy("Date Recorded");
- const rowField = rowHierarchy.getFields()[0];
-
- // Create the filter's date boundaries.
- let earliestDate: ExcelScript.FilterDatetime = {
- date: "2022-06-20",
- specificity: ExcelScript.FilterDatetimeSpecificity.day
- };
- let latestDate: ExcelScript.FilterDatetime = {
- date: "2022-07-10",
- specificity: ExcelScript.FilterDatetimeSpecificity.day
- };
-
- // Apply the date filter.
- rowField.applyFilter({
- dateFilter: {
- condition: ExcelScript.DateFilterCondition.between,
- lowerBound: earliestDate,
- upperBound: latestDate
- }
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: day
- uid: 'ExcelScript!ExcelScript.FilterDatetimeSpecificity.day:member'
- package: ExcelScript!
- summary: ''
- - name: hour
- uid: 'ExcelScript!ExcelScript.FilterDatetimeSpecificity.hour:member'
- package: ExcelScript!
- summary: ''
- - name: minute
- uid: 'ExcelScript!ExcelScript.FilterDatetimeSpecificity.minute:member'
- package: ExcelScript!
- summary: ''
- - name: month
- uid: 'ExcelScript!ExcelScript.FilterDatetimeSpecificity.month:member'
- package: ExcelScript!
- summary: ''
- - name: second
- uid: 'ExcelScript!ExcelScript.FilterDatetimeSpecificity.second:member'
- package: ExcelScript!
- summary: ''
- - name: year
- uid: 'ExcelScript!ExcelScript.FilterDatetimeSpecificity.year:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.FilterDatetimeSpecificity
+uid: 'ExcelScript!ExcelScript.FilterDatetimeSpecificity:enum'
+package: ExcelScript!
+fullName: ExcelScript.FilterDatetimeSpecificity
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a filter to a PivotTable that filters it
+ * to only show rows from between June 20th, 2022 and July 10th, 2022.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the "Date Recorded" field to filter.
+ // The data in this field must be dates in order for the filter to work.
+ const pivot = workbook.getPivotTables()[0];
+ const rowHierarchy = pivot.getRowHierarchy("Date Recorded");
+ const rowField = rowHierarchy.getFields()[0];
+
+ // Create the filter's date boundaries.
+ let earliestDate: ExcelScript.FilterDatetime = {
+ date: "2022-06-20",
+ specificity: ExcelScript.FilterDatetimeSpecificity.day
+ };
+ let latestDate: ExcelScript.FilterDatetime = {
+ date: "2022-07-10",
+ specificity: ExcelScript.FilterDatetimeSpecificity.day
+ };
+
+ // Apply the date filter.
+ rowField.applyFilter({
+ dateFilter: {
+ condition: ExcelScript.DateFilterCondition.between,
+ lowerBound: earliestDate,
+ upperBound: latestDate
+ }
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: day
+ uid: 'ExcelScript!ExcelScript.FilterDatetimeSpecificity.day:member'
+ package: ExcelScript!
+ summary: ''
+ - name: hour
+ uid: 'ExcelScript!ExcelScript.FilterDatetimeSpecificity.hour:member'
+ package: ExcelScript!
+ summary: ''
+ - name: minute
+ uid: 'ExcelScript!ExcelScript.FilterDatetimeSpecificity.minute:member'
+ package: ExcelScript!
+ summary: ''
+ - name: month
+ uid: 'ExcelScript!ExcelScript.FilterDatetimeSpecificity.month:member'
+ package: ExcelScript!
+ summary: ''
+ - name: second
+ uid: 'ExcelScript!ExcelScript.FilterDatetimeSpecificity.second:member'
+ package: ExcelScript!
+ summary: ''
+ - name: year
+ uid: 'ExcelScript!ExcelScript.FilterDatetimeSpecificity.year:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.filteron.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.filteron.yml
index 014f01b7..25472b7f 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.filteron.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.filteron.yml
@@ -1,74 +1,74 @@
-### YamlMime:TSEnum
-name: ExcelScript.FilterOn
-uid: 'ExcelScript!ExcelScript.FilterOn:enum'
-package: ExcelScript!
-fullName: ExcelScript.FilterOn
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a filter to a table so that
- * only rows with values in column 1 that start with "L" are shown.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the autoFilter of the first table in the current worksheet.
- const table = workbook.getActiveWorksheet().getTables()[0];
- const autoFilter = table.getAutoFilter();
-
- // Filter to only include values that start with "L".
- const filterCriteria: ExcelScript.FilterCriteria = {
- filterOn: ExcelScript.FilterOn.custom,
- criterion1: "L*"
- };
-
- // Apply the filter to column 1 (zero-based).
- autoFilter.apply(table.getRange(), 1, filterCriteria);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: bottomItems
- uid: 'ExcelScript!ExcelScript.FilterOn.bottomItems:member'
- package: ExcelScript!
- summary: ''
- - name: bottomPercent
- uid: 'ExcelScript!ExcelScript.FilterOn.bottomPercent:member'
- package: ExcelScript!
- summary: ''
- - name: cellColor
- uid: 'ExcelScript!ExcelScript.FilterOn.cellColor:member'
- package: ExcelScript!
- summary: ''
- - name: custom
- uid: 'ExcelScript!ExcelScript.FilterOn.custom:member'
- package: ExcelScript!
- summary: ''
- - name: dynamic
- uid: 'ExcelScript!ExcelScript.FilterOn.dynamic:member'
- package: ExcelScript!
- summary: ''
- - name: fontColor
- uid: 'ExcelScript!ExcelScript.FilterOn.fontColor:member'
- package: ExcelScript!
- summary: ''
- - name: icon
- uid: 'ExcelScript!ExcelScript.FilterOn.icon:member'
- package: ExcelScript!
- summary: ''
- - name: topItems
- uid: 'ExcelScript!ExcelScript.FilterOn.topItems:member'
- package: ExcelScript!
- summary: ''
- - name: topPercent
- uid: 'ExcelScript!ExcelScript.FilterOn.topPercent:member'
- package: ExcelScript!
- summary: ''
- - name: values
- uid: 'ExcelScript!ExcelScript.FilterOn.values:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.FilterOn
+uid: 'ExcelScript!ExcelScript.FilterOn:enum'
+package: ExcelScript!
+fullName: ExcelScript.FilterOn
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a filter to a table so that
+ * only rows with values in column 1 that start with "L" are shown.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the autoFilter of the first table in the current worksheet.
+ const table = workbook.getActiveWorksheet().getTables()[0];
+ const autoFilter = table.getAutoFilter();
+
+ // Filter to only include values that start with "L".
+ const filterCriteria: ExcelScript.FilterCriteria = {
+ filterOn: ExcelScript.FilterOn.custom,
+ criterion1: "L*"
+ };
+
+ // Apply the filter to column 1 (zero-based).
+ autoFilter.apply(table.getRange(), 1, filterCriteria);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: bottomItems
+ uid: 'ExcelScript!ExcelScript.FilterOn.bottomItems:member'
+ package: ExcelScript!
+ summary: ''
+ - name: bottomPercent
+ uid: 'ExcelScript!ExcelScript.FilterOn.bottomPercent:member'
+ package: ExcelScript!
+ summary: ''
+ - name: cellColor
+ uid: 'ExcelScript!ExcelScript.FilterOn.cellColor:member'
+ package: ExcelScript!
+ summary: ''
+ - name: custom
+ uid: 'ExcelScript!ExcelScript.FilterOn.custom:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dynamic
+ uid: 'ExcelScript!ExcelScript.FilterOn.dynamic:member'
+ package: ExcelScript!
+ summary: ''
+ - name: fontColor
+ uid: 'ExcelScript!ExcelScript.FilterOn.fontColor:member'
+ package: ExcelScript!
+ summary: ''
+ - name: icon
+ uid: 'ExcelScript!ExcelScript.FilterOn.icon:member'
+ package: ExcelScript!
+ summary: ''
+ - name: topItems
+ uid: 'ExcelScript!ExcelScript.FilterOn.topItems:member'
+ package: ExcelScript!
+ summary: ''
+ - name: topPercent
+ uid: 'ExcelScript!ExcelScript.FilterOn.topPercent:member'
+ package: ExcelScript!
+ summary: ''
+ - name: values
+ uid: 'ExcelScript!ExcelScript.FilterOn.values:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.filteroperator.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.filteroperator.yml
index 5fb8e37f..72eaeaa0 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.filteroperator.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.filteroperator.yml
@@ -1,36 +1,36 @@
-### YamlMime:TSEnum
-name: ExcelScript.FilterOperator
-uid: 'ExcelScript!ExcelScript.FilterOperator:enum'
-package: ExcelScript!
-fullName: ExcelScript.FilterOperator
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * The script filters rows from a table based on a numerical range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table in the current worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const table = currentSheet.getTables()[0];
-
- // Filter to only show rows with a value in the "Exam Score" column that is
- // greater than 0 and less than or equal to 60.
- table.getColumnByName("Exam Score").getFilter().applyCustomFilter(">0", "<=60", ExcelScript.FilterOperator.and);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: and
- uid: 'ExcelScript!ExcelScript.FilterOperator.and:member'
- package: ExcelScript!
- summary: ''
- - name: or
- uid: 'ExcelScript!ExcelScript.FilterOperator.or:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.FilterOperator
+uid: 'ExcelScript!ExcelScript.FilterOperator:enum'
+package: ExcelScript!
+fullName: ExcelScript.FilterOperator
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * The script filters rows from a table based on a numerical range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table in the current worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const table = currentSheet.getTables()[0];
+
+ // Filter to only show rows with a value in the "Exam Score" column that is
+ // greater than 0 and less than or equal to 60.
+ table.getColumnByName("Exam Score").getFilter().applyCustomFilter(">0", "<=60", ExcelScript.FilterOperator.and);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: and
+ uid: 'ExcelScript!ExcelScript.FilterOperator.and:member'
+ package: ExcelScript!
+ summary: ''
+ - name: or
+ uid: 'ExcelScript!ExcelScript.FilterOperator.or:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.filterpivothierarchy.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.filterpivothierarchy.yml
index a14138c4..1baa6387 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.filterpivothierarchy.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.filterpivothierarchy.yml
@@ -1,201 +1,201 @@
-### YamlMime:TSType
-name: ExcelScript.FilterPivotHierarchy
-uid: 'ExcelScript!ExcelScript.FilterPivotHierarchy:interface'
-package: ExcelScript!
-fullName: ExcelScript.FilterPivotHierarchy
-summary: Represents the Excel FilterPivotHierarchy.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a PivotTable with a filter.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the two worksheets to use in PivotTable creation.
- const dataSheet = workbook.getWorksheet("Data");
- const pivotSheet = workbook.getWorksheet("Pivot");
-
- // Create a new PivotTable.
- const newPivot = pivotSheet.addPivotTable(
- "My PivotTable",
- dataSheet.getUsedRange(),
- pivotSheet.getRange("A1"));
-
- // Add a filter with the Quarter field.
- const filter: ExcelScript.FilterPivotHierarchy =
- newPivot.addFilterHierarchy(newPivot.getHierarchy("Quarter"));
-
- // Add other hierarchies...
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getEnableMultipleFilterItems()
- uid: 'ExcelScript!ExcelScript.FilterPivotHierarchy#getEnableMultipleFilterItems:member(1)'
- package: ExcelScript!
- fullName: getEnableMultipleFilterItems()
- summary: Determines whether to allow multiple filter items.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getEnableMultipleFilterItems(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getFields()
- uid: 'ExcelScript!ExcelScript.FilterPivotHierarchy#getFields:member(1)'
- package: ExcelScript!
- fullName: getFields()
- summary: Returns the PivotFields associated with the FilterPivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFields(): PivotField[];'
- return:
- type: '[]'
- description: ''
- - name: getId()
- uid: 'ExcelScript!ExcelScript.FilterPivotHierarchy#getId:member(1)'
- package: ExcelScript!
- fullName: getId()
- summary: ID of the FilterPivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getId(): string;'
- return:
- type: string
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.FilterPivotHierarchy#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: Name of the FilterPivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script logs the names of all the filter hierarchies in a PivotTable.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first PivotTable in the workbook.
- const pivotTable = workbook.getPivotTables()[0];
-
- // For each pivot filter, log its name.
- pivotTable.getFilterHierarchies().forEach((filter: ExcelScript.FilterPivotHierarchy) => {
- console.log(filter.getName());
- });
- }
- ```
- - name: getPivotField(name)
- uid: 'ExcelScript!ExcelScript.FilterPivotHierarchy#getPivotField:member(1)'
- package: ExcelScript!
- fullName: getPivotField(name)
- summary: 'Gets a PivotField by name. If the PivotField does not exist, then this method returns `undefined`.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPivotField(name: string): PivotField | undefined;'
- parameters:
- - id: name
- description: Name of the PivotField to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getPosition()
- uid: 'ExcelScript!ExcelScript.FilterPivotHierarchy#getPosition:member(1)'
- package: ExcelScript!
- fullName: getPosition()
- summary: Position of the FilterPivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPosition(): number;'
- return:
- type: number
- description: ''
- - name: setEnableMultipleFilterItems(enableMultipleFilterItems)
- uid: 'ExcelScript!ExcelScript.FilterPivotHierarchy#setEnableMultipleFilterItems:member(1)'
- package: ExcelScript!
- fullName: setEnableMultipleFilterItems(enableMultipleFilterItems)
- summary: Determines whether to allow multiple filter items.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setEnableMultipleFilterItems(enableMultipleFilterItems: boolean): void;'
- parameters:
- - id: enableMultipleFilterItems
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setName(name)
- uid: 'ExcelScript!ExcelScript.FilterPivotHierarchy#setName:member(1)'
- package: ExcelScript!
- fullName: setName(name)
- summary: Name of the FilterPivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setName(name: string): void;'
- parameters:
- - id: name
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setPosition(position)
- uid: 'ExcelScript!ExcelScript.FilterPivotHierarchy#setPosition:member(1)'
- package: ExcelScript!
- fullName: setPosition(position)
- summary: Position of the FilterPivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPosition(position: number): void;'
- parameters:
- - id: position
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setToDefault()
- uid: 'ExcelScript!ExcelScript.FilterPivotHierarchy#setToDefault:member(1)'
- package: ExcelScript!
- fullName: setToDefault()
- summary: Reset the FilterPivotHierarchy back to its default values.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setToDefault(): void;'
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.FilterPivotHierarchy
+uid: 'ExcelScript!ExcelScript.FilterPivotHierarchy:interface'
+package: ExcelScript!
+fullName: ExcelScript.FilterPivotHierarchy
+summary: Represents the Excel FilterPivotHierarchy.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a PivotTable with a filter.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the two worksheets to use in PivotTable creation.
+ const dataSheet = workbook.getWorksheet("Data");
+ const pivotSheet = workbook.getWorksheet("Pivot");
+
+ // Create a new PivotTable.
+ const newPivot = pivotSheet.addPivotTable(
+ "My PivotTable",
+ dataSheet.getUsedRange(),
+ pivotSheet.getRange("A1"));
+
+ // Add a filter with the Quarter field.
+ const filter: ExcelScript.FilterPivotHierarchy =
+ newPivot.addFilterHierarchy(newPivot.getHierarchy("Quarter"));
+
+ // Add other hierarchies...
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getEnableMultipleFilterItems()
+ uid: 'ExcelScript!ExcelScript.FilterPivotHierarchy#getEnableMultipleFilterItems:member(1)'
+ package: ExcelScript!
+ fullName: getEnableMultipleFilterItems()
+ summary: Determines whether to allow multiple filter items.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getEnableMultipleFilterItems(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getFields()
+ uid: 'ExcelScript!ExcelScript.FilterPivotHierarchy#getFields:member(1)'
+ package: ExcelScript!
+ fullName: getFields()
+ summary: Returns the PivotFields associated with the FilterPivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFields(): PivotField[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getId()
+ uid: 'ExcelScript!ExcelScript.FilterPivotHierarchy#getId:member(1)'
+ package: ExcelScript!
+ fullName: getId()
+ summary: ID of the FilterPivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getId(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.FilterPivotHierarchy#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: Name of the FilterPivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script logs the names of all the filter hierarchies in a PivotTable.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first PivotTable in the workbook.
+ const pivotTable = workbook.getPivotTables()[0];
+
+ // For each pivot filter, log its name.
+ pivotTable.getFilterHierarchies().forEach((filter: ExcelScript.FilterPivotHierarchy) => {
+ console.log(filter.getName());
+ });
+ }
+ ```
+ - name: getPivotField(name)
+ uid: 'ExcelScript!ExcelScript.FilterPivotHierarchy#getPivotField:member(1)'
+ package: ExcelScript!
+ fullName: getPivotField(name)
+ summary: 'Gets a PivotField by name. If the PivotField does not exist, then this method returns `undefined`.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPivotField(name: string): PivotField | undefined;'
+ parameters:
+ - id: name
+ description: Name of the PivotField to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getPosition()
+ uid: 'ExcelScript!ExcelScript.FilterPivotHierarchy#getPosition:member(1)'
+ package: ExcelScript!
+ fullName: getPosition()
+ summary: Position of the FilterPivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPosition(): number;'
+ return:
+ type: number
+ description: ''
+ - name: setEnableMultipleFilterItems(enableMultipleFilterItems)
+ uid: 'ExcelScript!ExcelScript.FilterPivotHierarchy#setEnableMultipleFilterItems:member(1)'
+ package: ExcelScript!
+ fullName: setEnableMultipleFilterItems(enableMultipleFilterItems)
+ summary: Determines whether to allow multiple filter items.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setEnableMultipleFilterItems(enableMultipleFilterItems: boolean): void;'
+ parameters:
+ - id: enableMultipleFilterItems
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setName(name)
+ uid: 'ExcelScript!ExcelScript.FilterPivotHierarchy#setName:member(1)'
+ package: ExcelScript!
+ fullName: setName(name)
+ summary: Name of the FilterPivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setName(name: string): void;'
+ parameters:
+ - id: name
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setPosition(position)
+ uid: 'ExcelScript!ExcelScript.FilterPivotHierarchy#setPosition:member(1)'
+ package: ExcelScript!
+ fullName: setPosition(position)
+ summary: Position of the FilterPivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPosition(position: number): void;'
+ parameters:
+ - id: position
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setToDefault()
+ uid: 'ExcelScript!ExcelScript.FilterPivotHierarchy#setToDefault:member(1)'
+ package: ExcelScript!
+ fullName: setToDefault()
+ summary: Reset the FilterPivotHierarchy back to its default values.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setToDefault(): void;'
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.formatprotection.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.formatprotection.yml
index 60e82af2..0eee0b23 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.formatprotection.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.formatprotection.yml
@@ -1,79 +1,79 @@
-### YamlMime:TSType
-name: ExcelScript.FormatProtection
-uid: 'ExcelScript!ExcelScript.FormatProtection:interface'
-package: ExcelScript!
-fullName: ExcelScript.FormatProtection
-summary: Represents the format protection of a range object.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getFormulaHidden()
- uid: 'ExcelScript!ExcelScript.FormatProtection#getFormulaHidden:member(1)'
- package: ExcelScript!
- fullName: getFormulaHidden()
- summary: >-
- Specifies if Excel hides the formula for the cells in the range. A `null` value indicates that the entire range
- doesn't have a uniform formula hidden setting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormulaHidden(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getLocked()
- uid: 'ExcelScript!ExcelScript.FormatProtection#getLocked:member(1)'
- package: ExcelScript!
- fullName: getLocked()
- summary: >-
- Specifies if Excel locks the cells in the object. A `null` value indicates that the entire range doesn't have a
- uniform lock setting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLocked(): boolean;'
- return:
- type: boolean
- description: ''
- - name: setFormulaHidden(formulaHidden)
- uid: 'ExcelScript!ExcelScript.FormatProtection#setFormulaHidden:member(1)'
- package: ExcelScript!
- fullName: setFormulaHidden(formulaHidden)
- summary: >-
- Specifies if Excel hides the formula for the cells in the range. A `null` value indicates that the entire range
- doesn't have a uniform formula hidden setting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFormulaHidden(formulaHidden: boolean): void;'
- parameters:
- - id: formulaHidden
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setLocked(locked)
- uid: 'ExcelScript!ExcelScript.FormatProtection#setLocked:member(1)'
- package: ExcelScript!
- fullName: setLocked(locked)
- summary: >-
- Specifies if Excel locks the cells in the object. A `null` value indicates that the entire range doesn't have a
- uniform lock setting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLocked(locked: boolean): void;'
- parameters:
- - id: locked
- description: ''
- type: boolean
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.FormatProtection
+uid: 'ExcelScript!ExcelScript.FormatProtection:interface'
+package: ExcelScript!
+fullName: ExcelScript.FormatProtection
+summary: Represents the format protection of a range object.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getFormulaHidden()
+ uid: 'ExcelScript!ExcelScript.FormatProtection#getFormulaHidden:member(1)'
+ package: ExcelScript!
+ fullName: getFormulaHidden()
+ summary: >-
+ Specifies if Excel hides the formula for the cells in the range. A `null` value indicates that the entire range
+ doesn't have a uniform formula hidden setting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormulaHidden(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getLocked()
+ uid: 'ExcelScript!ExcelScript.FormatProtection#getLocked:member(1)'
+ package: ExcelScript!
+ fullName: getLocked()
+ summary: >-
+ Specifies if Excel locks the cells in the object. A `null` value indicates that the entire range doesn't have a
+ uniform lock setting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLocked(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: setFormulaHidden(formulaHidden)
+ uid: 'ExcelScript!ExcelScript.FormatProtection#setFormulaHidden:member(1)'
+ package: ExcelScript!
+ fullName: setFormulaHidden(formulaHidden)
+ summary: >-
+ Specifies if Excel hides the formula for the cells in the range. A `null` value indicates that the entire range
+ doesn't have a uniform formula hidden setting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFormulaHidden(formulaHidden: boolean): void;'
+ parameters:
+ - id: formulaHidden
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setLocked(locked)
+ uid: 'ExcelScript!ExcelScript.FormatProtection#setLocked:member(1)'
+ package: ExcelScript!
+ fullName: setLocked(locked)
+ summary: >-
+ Specifies if Excel locks the cells in the object. A `null` value indicates that the entire range doesn't have a
+ uniform lock setting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLocked(locked: boolean): void;'
+ parameters:
+ - id: locked
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.geometricshape.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.geometricshape.yml
index 1c902d72..a28187c2 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.geometricshape.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.geometricshape.yml
@@ -1,26 +1,26 @@
-### YamlMime:TSType
-name: ExcelScript.GeometricShape
-uid: 'ExcelScript!ExcelScript.GeometricShape:interface'
-package: ExcelScript!
-fullName: ExcelScript.GeometricShape
-summary: >-
- 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.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getId()
- uid: 'ExcelScript!ExcelScript.GeometricShape#getId:member(1)'
- package: ExcelScript!
- fullName: getId()
- summary: Returns the shape identifier.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getId(): string;'
- return:
- type: string
- description: ''
+### YamlMime:TSType
+name: ExcelScript.GeometricShape
+uid: 'ExcelScript!ExcelScript.GeometricShape:interface'
+package: ExcelScript!
+fullName: ExcelScript.GeometricShape
+summary: >-
+ 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.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getId()
+ uid: 'ExcelScript!ExcelScript.GeometricShape#getId:member(1)'
+ package: ExcelScript!
+ fullName: getId()
+ summary: Returns the shape identifier.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getId(): string;'
+ return:
+ type: string
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.geometricshapetype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.geometricshapetype.yml
index b8d9ac77..4fd0b772 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.geometricshapetype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.geometricshapetype.yml
@@ -1,740 +1,740 @@
-### YamlMime:TSEnum
-name: ExcelScript.GeometricShapeType
-uid: 'ExcelScript!ExcelScript.GeometricShapeType:enum'
-package: ExcelScript!
-fullName: ExcelScript.GeometricShapeType
-summary: Specifies the shape type for a `GeometricShape` object.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a hexagon shape on the current worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- const currentSheet = workbook.getActiveWorksheet();
- const hexagon: ExcelScript.Shape =
- currentSheet.addGeometricShape(ExcelScript.GeometricShapeType.hexagon);
-
- // Set the hexagon size to 40x40 pixels.
- hexagon.setHeight(40);
- hexagon.setWidth(40);
-
- // Position the hexagon at [100,100] pixels.
- hexagon.setLeft(100);
- hexagon.setTop(100);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: accentBorderCallout1
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.accentBorderCallout1:member'
- package: ExcelScript!
- summary: ''
- - name: accentBorderCallout2
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.accentBorderCallout2:member'
- package: ExcelScript!
- summary: ''
- - name: accentBorderCallout3
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.accentBorderCallout3:member'
- package: ExcelScript!
- summary: ''
- - name: accentCallout1
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.accentCallout1:member'
- package: ExcelScript!
- summary: ''
- - name: accentCallout2
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.accentCallout2:member'
- package: ExcelScript!
- summary: ''
- - name: accentCallout3
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.accentCallout3:member'
- package: ExcelScript!
- summary: ''
- - name: actionButtonBackPrevious
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.actionButtonBackPrevious:member'
- package: ExcelScript!
- summary: ''
- - name: actionButtonBeginning
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.actionButtonBeginning:member'
- package: ExcelScript!
- summary: ''
- - name: actionButtonBlank
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.actionButtonBlank:member'
- package: ExcelScript!
- summary: ''
- - name: actionButtonDocument
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.actionButtonDocument:member'
- package: ExcelScript!
- summary: ''
- - name: actionButtonEnd
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.actionButtonEnd:member'
- package: ExcelScript!
- summary: ''
- - name: actionButtonForwardNext
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.actionButtonForwardNext:member'
- package: ExcelScript!
- summary: ''
- - name: actionButtonHelp
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.actionButtonHelp:member'
- package: ExcelScript!
- summary: ''
- - name: actionButtonHome
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.actionButtonHome:member'
- package: ExcelScript!
- summary: ''
- - name: actionButtonInformation
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.actionButtonInformation:member'
- package: ExcelScript!
- summary: ''
- - name: actionButtonMovie
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.actionButtonMovie:member'
- package: ExcelScript!
- summary: ''
- - name: actionButtonReturn
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.actionButtonReturn:member'
- package: ExcelScript!
- summary: ''
- - name: actionButtonSound
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.actionButtonSound:member'
- package: ExcelScript!
- summary: ''
- - name: arc
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.arc:member'
- package: ExcelScript!
- summary: ''
- - name: bentArrow
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.bentArrow:member'
- package: ExcelScript!
- summary: ''
- - name: bentUpArrow
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.bentUpArrow:member'
- package: ExcelScript!
- summary: ''
- - name: bevel
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.bevel:member'
- package: ExcelScript!
- summary: ''
- - name: blockArc
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.blockArc:member'
- package: ExcelScript!
- summary: ''
- - name: borderCallout1
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.borderCallout1:member'
- package: ExcelScript!
- summary: ''
- - name: borderCallout2
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.borderCallout2:member'
- package: ExcelScript!
- summary: ''
- - name: borderCallout3
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.borderCallout3:member'
- package: ExcelScript!
- summary: ''
- - name: bracePair
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.bracePair:member'
- package: ExcelScript!
- summary: ''
- - name: bracketPair
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.bracketPair:member'
- package: ExcelScript!
- summary: ''
- - name: callout1
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.callout1:member'
- package: ExcelScript!
- summary: ''
- - name: callout2
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.callout2:member'
- package: ExcelScript!
- summary: ''
- - name: callout3
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.callout3:member'
- package: ExcelScript!
- summary: ''
- - name: can
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.can:member'
- package: ExcelScript!
- summary: ''
- - name: chartPlus
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.chartPlus:member'
- package: ExcelScript!
- summary: ''
- - name: chartStar
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.chartStar:member'
- package: ExcelScript!
- summary: ''
- - name: chartX
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.chartX:member'
- package: ExcelScript!
- summary: ''
- - name: chevron
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.chevron:member'
- package: ExcelScript!
- summary: ''
- - name: chord
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.chord:member'
- package: ExcelScript!
- summary: ''
- - name: circularArrow
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.circularArrow:member'
- package: ExcelScript!
- summary: ''
- - name: cloud
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.cloud:member'
- package: ExcelScript!
- summary: ''
- - name: cloudCallout
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.cloudCallout:member'
- package: ExcelScript!
- summary: ''
- - name: corner
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.corner:member'
- package: ExcelScript!
- summary: ''
- - name: cornerTabs
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.cornerTabs:member'
- package: ExcelScript!
- summary: ''
- - name: cube
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.cube:member'
- package: ExcelScript!
- summary: ''
- - name: curvedDownArrow
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.curvedDownArrow:member'
- package: ExcelScript!
- summary: ''
- - name: curvedLeftArrow
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.curvedLeftArrow:member'
- package: ExcelScript!
- summary: ''
- - name: curvedRightArrow
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.curvedRightArrow:member'
- package: ExcelScript!
- summary: ''
- - name: curvedUpArrow
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.curvedUpArrow:member'
- package: ExcelScript!
- summary: ''
- - name: decagon
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.decagon:member'
- package: ExcelScript!
- summary: ''
- - name: diagonalStripe
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.diagonalStripe:member'
- package: ExcelScript!
- summary: ''
- - name: diamond
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.diamond:member'
- package: ExcelScript!
- summary: ''
- - name: dodecagon
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.dodecagon:member'
- package: ExcelScript!
- summary: ''
- - name: donut
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.donut:member'
- package: ExcelScript!
- summary: ''
- - name: doubleWave
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.doubleWave:member'
- package: ExcelScript!
- summary: ''
- - name: downArrow
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.downArrow:member'
- package: ExcelScript!
- summary: ''
- - name: downArrowCallout
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.downArrowCallout:member'
- package: ExcelScript!
- summary: ''
- - name: ellipse
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.ellipse:member'
- package: ExcelScript!
- summary: ''
- - name: ellipseRibbon
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.ellipseRibbon:member'
- package: ExcelScript!
- summary: ''
- - name: ellipseRibbon2
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.ellipseRibbon2:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartAlternateProcess
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartAlternateProcess:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartCollate
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartCollate:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartConnector
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartConnector:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartDecision
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartDecision:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartDelay
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartDelay:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartDisplay
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartDisplay:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartDocument
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartDocument:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartExtract
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartExtract:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartInputOutput
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartInputOutput:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartInternalStorage
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartInternalStorage:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartMagneticDisk
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartMagneticDisk:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartMagneticDrum
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartMagneticDrum:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartMagneticTape
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartMagneticTape:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartManualInput
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartManualInput:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartManualOperation
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartManualOperation:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartMerge
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartMerge:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartMultidocument
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartMultidocument:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartOfflineStorage
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartOfflineStorage:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartOffpageConnector
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartOffpageConnector:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartOnlineStorage
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartOnlineStorage:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartOr
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartOr:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartPredefinedProcess
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartPredefinedProcess:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartPreparation
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartPreparation:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartProcess
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartProcess:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartPunchedCard
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartPunchedCard:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartPunchedTape
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartPunchedTape:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartSort
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartSort:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartSummingJunction
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartSummingJunction:member'
- package: ExcelScript!
- summary: ''
- - name: flowChartTerminator
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartTerminator:member'
- package: ExcelScript!
- summary: ''
- - name: foldedCorner
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.foldedCorner:member'
- package: ExcelScript!
- summary: ''
- - name: frame
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.frame:member'
- package: ExcelScript!
- summary: ''
- - name: funnel
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.funnel:member'
- package: ExcelScript!
- summary: ''
- - name: gear6
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.gear6:member'
- package: ExcelScript!
- summary: ''
- - name: gear9
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.gear9:member'
- package: ExcelScript!
- summary: ''
- - name: halfFrame
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.halfFrame:member'
- package: ExcelScript!
- summary: ''
- - name: heart
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.heart:member'
- package: ExcelScript!
- summary: ''
- - name: heptagon
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.heptagon:member'
- package: ExcelScript!
- summary: ''
- - name: hexagon
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.hexagon:member'
- package: ExcelScript!
- summary: ''
- - name: homePlate
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.homePlate:member'
- package: ExcelScript!
- summary: ''
- - name: horizontalScroll
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.horizontalScroll:member'
- package: ExcelScript!
- summary: ''
- - name: irregularSeal1
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.irregularSeal1:member'
- package: ExcelScript!
- summary: ''
- - name: irregularSeal2
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.irregularSeal2:member'
- package: ExcelScript!
- summary: ''
- - name: leftArrow
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.leftArrow:member'
- package: ExcelScript!
- summary: ''
- - name: leftArrowCallout
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.leftArrowCallout:member'
- package: ExcelScript!
- summary: ''
- - name: leftBrace
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.leftBrace:member'
- package: ExcelScript!
- summary: ''
- - name: leftBracket
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.leftBracket:member'
- package: ExcelScript!
- summary: ''
- - name: leftCircularArrow
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.leftCircularArrow:member'
- package: ExcelScript!
- summary: ''
- - name: leftRightArrow
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.leftRightArrow:member'
- package: ExcelScript!
- summary: ''
- - name: leftRightArrowCallout
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.leftRightArrowCallout:member'
- package: ExcelScript!
- summary: ''
- - name: leftRightCircularArrow
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.leftRightCircularArrow:member'
- package: ExcelScript!
- summary: ''
- - name: leftRightRibbon
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.leftRightRibbon:member'
- package: ExcelScript!
- summary: ''
- - name: leftRightUpArrow
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.leftRightUpArrow:member'
- package: ExcelScript!
- summary: ''
- - name: leftUpArrow
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.leftUpArrow:member'
- package: ExcelScript!
- summary: ''
- - name: lightningBolt
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.lightningBolt:member'
- package: ExcelScript!
- summary: ''
- - name: lineInverse
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.lineInverse:member'
- package: ExcelScript!
- summary: ''
- - name: mathDivide
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.mathDivide:member'
- package: ExcelScript!
- summary: ''
- - name: mathEqual
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.mathEqual:member'
- package: ExcelScript!
- summary: ''
- - name: mathMinus
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.mathMinus:member'
- package: ExcelScript!
- summary: ''
- - name: mathMultiply
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.mathMultiply:member'
- package: ExcelScript!
- summary: ''
- - name: mathNotEqual
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.mathNotEqual:member'
- package: ExcelScript!
- summary: ''
- - name: mathPlus
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.mathPlus:member'
- package: ExcelScript!
- summary: ''
- - name: moon
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.moon:member'
- package: ExcelScript!
- summary: ''
- - name: nonIsoscelesTrapezoid
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.nonIsoscelesTrapezoid:member'
- package: ExcelScript!
- summary: ''
- - name: noSmoking
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.noSmoking:member'
- package: ExcelScript!
- summary: ''
- - name: notchedRightArrow
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.notchedRightArrow:member'
- package: ExcelScript!
- summary: ''
- - name: octagon
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.octagon:member'
- package: ExcelScript!
- summary: ''
- - name: parallelogram
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.parallelogram:member'
- package: ExcelScript!
- summary: ''
- - name: pentagon
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.pentagon:member'
- package: ExcelScript!
- summary: ''
- - name: pie
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.pie:member'
- package: ExcelScript!
- summary: ''
- - name: pieWedge
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.pieWedge:member'
- package: ExcelScript!
- summary: ''
- - name: plaque
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.plaque:member'
- package: ExcelScript!
- summary: ''
- - name: plaqueTabs
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.plaqueTabs:member'
- package: ExcelScript!
- summary: ''
- - name: plus
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.plus:member'
- package: ExcelScript!
- summary: ''
- - name: quadArrow
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.quadArrow:member'
- package: ExcelScript!
- summary: ''
- - name: quadArrowCallout
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.quadArrowCallout:member'
- package: ExcelScript!
- summary: ''
- - name: rectangle
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.rectangle:member'
- package: ExcelScript!
- summary: ''
- - name: ribbon
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.ribbon:member'
- package: ExcelScript!
- summary: ''
- - name: ribbon2
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.ribbon2:member'
- package: ExcelScript!
- summary: ''
- - name: rightArrow
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.rightArrow:member'
- package: ExcelScript!
- summary: ''
- - name: rightArrowCallout
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.rightArrowCallout:member'
- package: ExcelScript!
- summary: ''
- - name: rightBrace
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.rightBrace:member'
- package: ExcelScript!
- summary: ''
- - name: rightBracket
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.rightBracket:member'
- package: ExcelScript!
- summary: ''
- - name: rightTriangle
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.rightTriangle:member'
- package: ExcelScript!
- summary: ''
- - name: round1Rectangle
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.round1Rectangle:member'
- package: ExcelScript!
- summary: ''
- - name: round2DiagonalRectangle
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.round2DiagonalRectangle:member'
- package: ExcelScript!
- summary: ''
- - name: round2SameRectangle
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.round2SameRectangle:member'
- package: ExcelScript!
- summary: ''
- - name: roundRectangle
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.roundRectangle:member'
- package: ExcelScript!
- summary: ''
- - name: smileyFace
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.smileyFace:member'
- package: ExcelScript!
- summary: ''
- - name: snip1Rectangle
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.snip1Rectangle:member'
- package: ExcelScript!
- summary: ''
- - name: snip2DiagonalRectangle
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.snip2DiagonalRectangle:member'
- package: ExcelScript!
- summary: ''
- - name: snip2SameRectangle
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.snip2SameRectangle:member'
- package: ExcelScript!
- summary: ''
- - name: snipRoundRectangle
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.snipRoundRectangle:member'
- package: ExcelScript!
- summary: ''
- - name: squareTabs
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.squareTabs:member'
- package: ExcelScript!
- summary: ''
- - name: star10
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.star10:member'
- package: ExcelScript!
- summary: ''
- - name: star12
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.star12:member'
- package: ExcelScript!
- summary: ''
- - name: star16
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.star16:member'
- package: ExcelScript!
- summary: ''
- - name: star24
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.star24:member'
- package: ExcelScript!
- summary: ''
- - name: star32
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.star32:member'
- package: ExcelScript!
- summary: ''
- - name: star4
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.star4:member'
- package: ExcelScript!
- summary: ''
- - name: star5
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.star5:member'
- package: ExcelScript!
- summary: ''
- - name: star6
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.star6:member'
- package: ExcelScript!
- summary: ''
- - name: star7
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.star7:member'
- package: ExcelScript!
- summary: ''
- - name: star8
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.star8:member'
- package: ExcelScript!
- summary: ''
- - name: stripedRightArrow
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.stripedRightArrow:member'
- package: ExcelScript!
- summary: ''
- - name: sun
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.sun:member'
- package: ExcelScript!
- summary: ''
- - name: swooshArrow
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.swooshArrow:member'
- package: ExcelScript!
- summary: ''
- - name: teardrop
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.teardrop:member'
- package: ExcelScript!
- summary: ''
- - name: trapezoid
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.trapezoid:member'
- package: ExcelScript!
- summary: ''
- - name: triangle
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.triangle:member'
- package: ExcelScript!
- summary: ''
- - name: upArrow
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.upArrow:member'
- package: ExcelScript!
- summary: ''
- - name: upArrowCallout
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.upArrowCallout:member'
- package: ExcelScript!
- summary: ''
- - name: upDownArrow
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.upDownArrow:member'
- package: ExcelScript!
- summary: ''
- - name: upDownArrowCallout
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.upDownArrowCallout:member'
- package: ExcelScript!
- summary: ''
- - name: uturnArrow
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.uturnArrow:member'
- package: ExcelScript!
- summary: ''
- - name: verticalScroll
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.verticalScroll:member'
- package: ExcelScript!
- summary: ''
- - name: wave
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.wave:member'
- package: ExcelScript!
- summary: ''
- - name: wedgeEllipseCallout
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.wedgeEllipseCallout:member'
- package: ExcelScript!
- summary: ''
- - name: wedgeRectCallout
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.wedgeRectCallout:member'
- package: ExcelScript!
- summary: ''
- - name: wedgeRRectCallout
- uid: 'ExcelScript!ExcelScript.GeometricShapeType.wedgeRRectCallout:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.GeometricShapeType
+uid: 'ExcelScript!ExcelScript.GeometricShapeType:enum'
+package: ExcelScript!
+fullName: ExcelScript.GeometricShapeType
+summary: Specifies the shape type for a `GeometricShape` object.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a hexagon shape on the current worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ const currentSheet = workbook.getActiveWorksheet();
+ const hexagon: ExcelScript.Shape =
+ currentSheet.addGeometricShape(ExcelScript.GeometricShapeType.hexagon);
+
+ // Set the hexagon size to 40x40 pixels.
+ hexagon.setHeight(40);
+ hexagon.setWidth(40);
+
+ // Position the hexagon at [100,100] pixels.
+ hexagon.setLeft(100);
+ hexagon.setTop(100);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: accentBorderCallout1
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.accentBorderCallout1:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accentBorderCallout2
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.accentBorderCallout2:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accentBorderCallout3
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.accentBorderCallout3:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accentCallout1
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.accentCallout1:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accentCallout2
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.accentCallout2:member'
+ package: ExcelScript!
+ summary: ''
+ - name: accentCallout3
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.accentCallout3:member'
+ package: ExcelScript!
+ summary: ''
+ - name: actionButtonBackPrevious
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.actionButtonBackPrevious:member'
+ package: ExcelScript!
+ summary: ''
+ - name: actionButtonBeginning
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.actionButtonBeginning:member'
+ package: ExcelScript!
+ summary: ''
+ - name: actionButtonBlank
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.actionButtonBlank:member'
+ package: ExcelScript!
+ summary: ''
+ - name: actionButtonDocument
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.actionButtonDocument:member'
+ package: ExcelScript!
+ summary: ''
+ - name: actionButtonEnd
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.actionButtonEnd:member'
+ package: ExcelScript!
+ summary: ''
+ - name: actionButtonForwardNext
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.actionButtonForwardNext:member'
+ package: ExcelScript!
+ summary: ''
+ - name: actionButtonHelp
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.actionButtonHelp:member'
+ package: ExcelScript!
+ summary: ''
+ - name: actionButtonHome
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.actionButtonHome:member'
+ package: ExcelScript!
+ summary: ''
+ - name: actionButtonInformation
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.actionButtonInformation:member'
+ package: ExcelScript!
+ summary: ''
+ - name: actionButtonMovie
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.actionButtonMovie:member'
+ package: ExcelScript!
+ summary: ''
+ - name: actionButtonReturn
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.actionButtonReturn:member'
+ package: ExcelScript!
+ summary: ''
+ - name: actionButtonSound
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.actionButtonSound:member'
+ package: ExcelScript!
+ summary: ''
+ - name: arc
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.arc:member'
+ package: ExcelScript!
+ summary: ''
+ - name: bentArrow
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.bentArrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: bentUpArrow
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.bentUpArrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: bevel
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.bevel:member'
+ package: ExcelScript!
+ summary: ''
+ - name: blockArc
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.blockArc:member'
+ package: ExcelScript!
+ summary: ''
+ - name: borderCallout1
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.borderCallout1:member'
+ package: ExcelScript!
+ summary: ''
+ - name: borderCallout2
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.borderCallout2:member'
+ package: ExcelScript!
+ summary: ''
+ - name: borderCallout3
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.borderCallout3:member'
+ package: ExcelScript!
+ summary: ''
+ - name: bracePair
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.bracePair:member'
+ package: ExcelScript!
+ summary: ''
+ - name: bracketPair
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.bracketPair:member'
+ package: ExcelScript!
+ summary: ''
+ - name: callout1
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.callout1:member'
+ package: ExcelScript!
+ summary: ''
+ - name: callout2
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.callout2:member'
+ package: ExcelScript!
+ summary: ''
+ - name: callout3
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.callout3:member'
+ package: ExcelScript!
+ summary: ''
+ - name: can
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.can:member'
+ package: ExcelScript!
+ summary: ''
+ - name: chartPlus
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.chartPlus:member'
+ package: ExcelScript!
+ summary: ''
+ - name: chartStar
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.chartStar:member'
+ package: ExcelScript!
+ summary: ''
+ - name: chartX
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.chartX:member'
+ package: ExcelScript!
+ summary: ''
+ - name: chevron
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.chevron:member'
+ package: ExcelScript!
+ summary: ''
+ - name: chord
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.chord:member'
+ package: ExcelScript!
+ summary: ''
+ - name: circularArrow
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.circularArrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: cloud
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.cloud:member'
+ package: ExcelScript!
+ summary: ''
+ - name: cloudCallout
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.cloudCallout:member'
+ package: ExcelScript!
+ summary: ''
+ - name: corner
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.corner:member'
+ package: ExcelScript!
+ summary: ''
+ - name: cornerTabs
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.cornerTabs:member'
+ package: ExcelScript!
+ summary: ''
+ - name: cube
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.cube:member'
+ package: ExcelScript!
+ summary: ''
+ - name: curvedDownArrow
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.curvedDownArrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: curvedLeftArrow
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.curvedLeftArrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: curvedRightArrow
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.curvedRightArrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: curvedUpArrow
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.curvedUpArrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: decagon
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.decagon:member'
+ package: ExcelScript!
+ summary: ''
+ - name: diagonalStripe
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.diagonalStripe:member'
+ package: ExcelScript!
+ summary: ''
+ - name: diamond
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.diamond:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dodecagon
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.dodecagon:member'
+ package: ExcelScript!
+ summary: ''
+ - name: donut
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.donut:member'
+ package: ExcelScript!
+ summary: ''
+ - name: doubleWave
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.doubleWave:member'
+ package: ExcelScript!
+ summary: ''
+ - name: downArrow
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.downArrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: downArrowCallout
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.downArrowCallout:member'
+ package: ExcelScript!
+ summary: ''
+ - name: ellipse
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.ellipse:member'
+ package: ExcelScript!
+ summary: ''
+ - name: ellipseRibbon
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.ellipseRibbon:member'
+ package: ExcelScript!
+ summary: ''
+ - name: ellipseRibbon2
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.ellipseRibbon2:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartAlternateProcess
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartAlternateProcess:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartCollate
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartCollate:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartConnector
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartConnector:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartDecision
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartDecision:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartDelay
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartDelay:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartDisplay
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartDisplay:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartDocument
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartDocument:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartExtract
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartExtract:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartInputOutput
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartInputOutput:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartInternalStorage
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartInternalStorage:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartMagneticDisk
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartMagneticDisk:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartMagneticDrum
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartMagneticDrum:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartMagneticTape
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartMagneticTape:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartManualInput
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartManualInput:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartManualOperation
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartManualOperation:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartMerge
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartMerge:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartMultidocument
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartMultidocument:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartOfflineStorage
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartOfflineStorage:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartOffpageConnector
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartOffpageConnector:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartOnlineStorage
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartOnlineStorage:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartOr
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartOr:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartPredefinedProcess
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartPredefinedProcess:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartPreparation
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartPreparation:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartProcess
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartProcess:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartPunchedCard
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartPunchedCard:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartPunchedTape
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartPunchedTape:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartSort
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartSort:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartSummingJunction
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartSummingJunction:member'
+ package: ExcelScript!
+ summary: ''
+ - name: flowChartTerminator
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.flowChartTerminator:member'
+ package: ExcelScript!
+ summary: ''
+ - name: foldedCorner
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.foldedCorner:member'
+ package: ExcelScript!
+ summary: ''
+ - name: frame
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.frame:member'
+ package: ExcelScript!
+ summary: ''
+ - name: funnel
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.funnel:member'
+ package: ExcelScript!
+ summary: ''
+ - name: gear6
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.gear6:member'
+ package: ExcelScript!
+ summary: ''
+ - name: gear9
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.gear9:member'
+ package: ExcelScript!
+ summary: ''
+ - name: halfFrame
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.halfFrame:member'
+ package: ExcelScript!
+ summary: ''
+ - name: heart
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.heart:member'
+ package: ExcelScript!
+ summary: ''
+ - name: heptagon
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.heptagon:member'
+ package: ExcelScript!
+ summary: ''
+ - name: hexagon
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.hexagon:member'
+ package: ExcelScript!
+ summary: ''
+ - name: homePlate
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.homePlate:member'
+ package: ExcelScript!
+ summary: ''
+ - name: horizontalScroll
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.horizontalScroll:member'
+ package: ExcelScript!
+ summary: ''
+ - name: irregularSeal1
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.irregularSeal1:member'
+ package: ExcelScript!
+ summary: ''
+ - name: irregularSeal2
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.irregularSeal2:member'
+ package: ExcelScript!
+ summary: ''
+ - name: leftArrow
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.leftArrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: leftArrowCallout
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.leftArrowCallout:member'
+ package: ExcelScript!
+ summary: ''
+ - name: leftBrace
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.leftBrace:member'
+ package: ExcelScript!
+ summary: ''
+ - name: leftBracket
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.leftBracket:member'
+ package: ExcelScript!
+ summary: ''
+ - name: leftCircularArrow
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.leftCircularArrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: leftRightArrow
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.leftRightArrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: leftRightArrowCallout
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.leftRightArrowCallout:member'
+ package: ExcelScript!
+ summary: ''
+ - name: leftRightCircularArrow
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.leftRightCircularArrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: leftRightRibbon
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.leftRightRibbon:member'
+ package: ExcelScript!
+ summary: ''
+ - name: leftRightUpArrow
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.leftRightUpArrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: leftUpArrow
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.leftUpArrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: lightningBolt
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.lightningBolt:member'
+ package: ExcelScript!
+ summary: ''
+ - name: lineInverse
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.lineInverse:member'
+ package: ExcelScript!
+ summary: ''
+ - name: mathDivide
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.mathDivide:member'
+ package: ExcelScript!
+ summary: ''
+ - name: mathEqual
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.mathEqual:member'
+ package: ExcelScript!
+ summary: ''
+ - name: mathMinus
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.mathMinus:member'
+ package: ExcelScript!
+ summary: ''
+ - name: mathMultiply
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.mathMultiply:member'
+ package: ExcelScript!
+ summary: ''
+ - name: mathNotEqual
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.mathNotEqual:member'
+ package: ExcelScript!
+ summary: ''
+ - name: mathPlus
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.mathPlus:member'
+ package: ExcelScript!
+ summary: ''
+ - name: moon
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.moon:member'
+ package: ExcelScript!
+ summary: ''
+ - name: nonIsoscelesTrapezoid
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.nonIsoscelesTrapezoid:member'
+ package: ExcelScript!
+ summary: ''
+ - name: noSmoking
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.noSmoking:member'
+ package: ExcelScript!
+ summary: ''
+ - name: notchedRightArrow
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.notchedRightArrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: octagon
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.octagon:member'
+ package: ExcelScript!
+ summary: ''
+ - name: parallelogram
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.parallelogram:member'
+ package: ExcelScript!
+ summary: ''
+ - name: pentagon
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.pentagon:member'
+ package: ExcelScript!
+ summary: ''
+ - name: pie
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.pie:member'
+ package: ExcelScript!
+ summary: ''
+ - name: pieWedge
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.pieWedge:member'
+ package: ExcelScript!
+ summary: ''
+ - name: plaque
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.plaque:member'
+ package: ExcelScript!
+ summary: ''
+ - name: plaqueTabs
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.plaqueTabs:member'
+ package: ExcelScript!
+ summary: ''
+ - name: plus
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.plus:member'
+ package: ExcelScript!
+ summary: ''
+ - name: quadArrow
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.quadArrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: quadArrowCallout
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.quadArrowCallout:member'
+ package: ExcelScript!
+ summary: ''
+ - name: rectangle
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.rectangle:member'
+ package: ExcelScript!
+ summary: ''
+ - name: ribbon
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.ribbon:member'
+ package: ExcelScript!
+ summary: ''
+ - name: ribbon2
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.ribbon2:member'
+ package: ExcelScript!
+ summary: ''
+ - name: rightArrow
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.rightArrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: rightArrowCallout
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.rightArrowCallout:member'
+ package: ExcelScript!
+ summary: ''
+ - name: rightBrace
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.rightBrace:member'
+ package: ExcelScript!
+ summary: ''
+ - name: rightBracket
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.rightBracket:member'
+ package: ExcelScript!
+ summary: ''
+ - name: rightTriangle
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.rightTriangle:member'
+ package: ExcelScript!
+ summary: ''
+ - name: round1Rectangle
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.round1Rectangle:member'
+ package: ExcelScript!
+ summary: ''
+ - name: round2DiagonalRectangle
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.round2DiagonalRectangle:member'
+ package: ExcelScript!
+ summary: ''
+ - name: round2SameRectangle
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.round2SameRectangle:member'
+ package: ExcelScript!
+ summary: ''
+ - name: roundRectangle
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.roundRectangle:member'
+ package: ExcelScript!
+ summary: ''
+ - name: smileyFace
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.smileyFace:member'
+ package: ExcelScript!
+ summary: ''
+ - name: snip1Rectangle
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.snip1Rectangle:member'
+ package: ExcelScript!
+ summary: ''
+ - name: snip2DiagonalRectangle
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.snip2DiagonalRectangle:member'
+ package: ExcelScript!
+ summary: ''
+ - name: snip2SameRectangle
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.snip2SameRectangle:member'
+ package: ExcelScript!
+ summary: ''
+ - name: snipRoundRectangle
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.snipRoundRectangle:member'
+ package: ExcelScript!
+ summary: ''
+ - name: squareTabs
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.squareTabs:member'
+ package: ExcelScript!
+ summary: ''
+ - name: star10
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.star10:member'
+ package: ExcelScript!
+ summary: ''
+ - name: star12
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.star12:member'
+ package: ExcelScript!
+ summary: ''
+ - name: star16
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.star16:member'
+ package: ExcelScript!
+ summary: ''
+ - name: star24
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.star24:member'
+ package: ExcelScript!
+ summary: ''
+ - name: star32
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.star32:member'
+ package: ExcelScript!
+ summary: ''
+ - name: star4
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.star4:member'
+ package: ExcelScript!
+ summary: ''
+ - name: star5
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.star5:member'
+ package: ExcelScript!
+ summary: ''
+ - name: star6
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.star6:member'
+ package: ExcelScript!
+ summary: ''
+ - name: star7
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.star7:member'
+ package: ExcelScript!
+ summary: ''
+ - name: star8
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.star8:member'
+ package: ExcelScript!
+ summary: ''
+ - name: stripedRightArrow
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.stripedRightArrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: sun
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.sun:member'
+ package: ExcelScript!
+ summary: ''
+ - name: swooshArrow
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.swooshArrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: teardrop
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.teardrop:member'
+ package: ExcelScript!
+ summary: ''
+ - name: trapezoid
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.trapezoid:member'
+ package: ExcelScript!
+ summary: ''
+ - name: triangle
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.triangle:member'
+ package: ExcelScript!
+ summary: ''
+ - name: upArrow
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.upArrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: upArrowCallout
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.upArrowCallout:member'
+ package: ExcelScript!
+ summary: ''
+ - name: upDownArrow
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.upDownArrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: upDownArrowCallout
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.upDownArrowCallout:member'
+ package: ExcelScript!
+ summary: ''
+ - name: uturnArrow
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.uturnArrow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: verticalScroll
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.verticalScroll:member'
+ package: ExcelScript!
+ summary: ''
+ - name: wave
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.wave:member'
+ package: ExcelScript!
+ summary: ''
+ - name: wedgeEllipseCallout
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.wedgeEllipseCallout:member'
+ package: ExcelScript!
+ summary: ''
+ - name: wedgeRectCallout
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.wedgeRectCallout:member'
+ package: ExcelScript!
+ summary: ''
+ - name: wedgeRRectCallout
+ uid: 'ExcelScript!ExcelScript.GeometricShapeType.wedgeRRectCallout:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.groupoption.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.groupoption.yml
index 89aaa68f..a227e75f 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.groupoption.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.groupoption.yml
@@ -1,37 +1,37 @@
-### YamlMime:TSEnum
-name: ExcelScript.GroupOption
-uid: 'ExcelScript!ExcelScript.GroupOption:enum'
-package: ExcelScript!
-fullName: ExcelScript.GroupOption
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a two-level column-based outline on Sheet1.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Group columns A-F in the worksheet named Sheet1.
- const sheet = workbook.getWorksheet("Sheet1");
- const firstLevel = sheet.getRange("A:F");
- firstLevel.group(ExcelScript.GroupOption.byColumns);
-
- // Create a second level to the outline by grouping subsections.
- sheet.getRange("A:B").group(ExcelScript.GroupOption.byColumns);
- sheet.getRange("D:E").group(ExcelScript.GroupOption.byColumns);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: byColumns
- uid: 'ExcelScript!ExcelScript.GroupOption.byColumns:member'
- package: ExcelScript!
- summary: Group by columns.
- - name: byRows
- uid: 'ExcelScript!ExcelScript.GroupOption.byRows:member'
- package: ExcelScript!
- summary: Group by rows.
+### YamlMime:TSEnum
+name: ExcelScript.GroupOption
+uid: 'ExcelScript!ExcelScript.GroupOption:enum'
+package: ExcelScript!
+fullName: ExcelScript.GroupOption
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a two-level column-based outline on Sheet1.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Group columns A-F in the worksheet named Sheet1.
+ const sheet = workbook.getWorksheet("Sheet1");
+ const firstLevel = sheet.getRange("A:F");
+ firstLevel.group(ExcelScript.GroupOption.byColumns);
+
+ // Create a second level to the outline by grouping subsections.
+ sheet.getRange("A:B").group(ExcelScript.GroupOption.byColumns);
+ sheet.getRange("D:E").group(ExcelScript.GroupOption.byColumns);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: byColumns
+ uid: 'ExcelScript!ExcelScript.GroupOption.byColumns:member'
+ package: ExcelScript!
+ summary: Group by columns.
+ - name: byRows
+ uid: 'ExcelScript!ExcelScript.GroupOption.byRows:member'
+ package: ExcelScript!
+ summary: Group by rows.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.headerfooter.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.headerfooter.yml
index 72b77022..ab4667f3 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.headerfooter.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.headerfooter.yml
@@ -1,215 +1,215 @@
-### YamlMime:TSType
-name: ExcelScript.HeaderFooter
-uid: 'ExcelScript!ExcelScript.HeaderFooter:interface'
-package: ExcelScript!
-fullName: ExcelScript.HeaderFooter
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getCenterFooter()
- uid: 'ExcelScript!ExcelScript.HeaderFooter#getCenterFooter:member(1)'
- package: ExcelScript!
- fullName: getCenterFooter()
- summary: >-
- The center footer of the worksheet. To apply font formatting or insert a variable value, use format codes
- specified here: https://msdn.microsoft.com/library/bb225426.aspx.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCenterFooter(): string;'
- return:
- type: string
- description: ''
- - name: getCenterHeader()
- uid: 'ExcelScript!ExcelScript.HeaderFooter#getCenterHeader:member(1)'
- package: ExcelScript!
- fullName: getCenterHeader()
- summary: >-
- The center header of the worksheet. To apply font formatting or insert a variable value, use format codes
- specified here: https://msdn.microsoft.com/library/bb225426.aspx.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCenterHeader(): string;'
- return:
- type: string
- description: ''
- - name: getLeftFooter()
- uid: 'ExcelScript!ExcelScript.HeaderFooter#getLeftFooter:member(1)'
- package: ExcelScript!
- fullName: getLeftFooter()
- summary: >-
- The left footer of the worksheet. To apply font formatting or insert a variable value, use format codes specified
- here: https://msdn.microsoft.com/library/bb225426.aspx.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLeftFooter(): string;'
- return:
- type: string
- description: ''
- - name: getLeftHeader()
- uid: 'ExcelScript!ExcelScript.HeaderFooter#getLeftHeader:member(1)'
- package: ExcelScript!
- fullName: getLeftHeader()
- summary: >-
- The left header of the worksheet. To apply font formatting or insert a variable value, use format codes specified
- here: https://msdn.microsoft.com/library/bb225426.aspx.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLeftHeader(): string;'
- return:
- type: string
- description: ''
- - name: getRightFooter()
- uid: 'ExcelScript!ExcelScript.HeaderFooter#getRightFooter:member(1)'
- package: ExcelScript!
- fullName: getRightFooter()
- summary: >-
- The right footer of the worksheet. To apply font formatting or insert a variable value, use format codes specified
- here: https://msdn.microsoft.com/library/bb225426.aspx.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRightFooter(): string;'
- return:
- type: string
- description: ''
- - name: getRightHeader()
- uid: 'ExcelScript!ExcelScript.HeaderFooter#getRightHeader:member(1)'
- package: ExcelScript!
- fullName: getRightHeader()
- summary: >-
- The right header of the worksheet. To apply font formatting or insert a variable value, use format codes specified
- here: https://msdn.microsoft.com/library/bb225426.aspx.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRightHeader(): string;'
- return:
- type: string
- description: ''
- - name: setCenterFooter(centerFooter)
- uid: 'ExcelScript!ExcelScript.HeaderFooter#setCenterFooter:member(1)'
- package: ExcelScript!
- fullName: setCenterFooter(centerFooter)
- summary: >-
- The center footer of the worksheet. To apply font formatting or insert a variable value, use format codes
- specified here: https://msdn.microsoft.com/library/bb225426.aspx.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setCenterFooter(centerFooter: string): void;'
- parameters:
- - id: centerFooter
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setCenterHeader(centerHeader)
- uid: 'ExcelScript!ExcelScript.HeaderFooter#setCenterHeader:member(1)'
- package: ExcelScript!
- fullName: setCenterHeader(centerHeader)
- summary: >-
- The center header of the worksheet. To apply font formatting or insert a variable value, use format codes
- specified here: https://msdn.microsoft.com/library/bb225426.aspx.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setCenterHeader(centerHeader: string): void;'
- parameters:
- - id: centerHeader
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setLeftFooter(leftFooter)
- uid: 'ExcelScript!ExcelScript.HeaderFooter#setLeftFooter:member(1)'
- package: ExcelScript!
- fullName: setLeftFooter(leftFooter)
- summary: >-
- The left footer of the worksheet. To apply font formatting or insert a variable value, use format codes specified
- here: https://msdn.microsoft.com/library/bb225426.aspx.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLeftFooter(leftFooter: string): void;'
- parameters:
- - id: leftFooter
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setLeftHeader(leftHeader)
- uid: 'ExcelScript!ExcelScript.HeaderFooter#setLeftHeader:member(1)'
- package: ExcelScript!
- fullName: setLeftHeader(leftHeader)
- summary: >-
- The left header of the worksheet. To apply font formatting or insert a variable value, use format codes specified
- here: https://msdn.microsoft.com/library/bb225426.aspx.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLeftHeader(leftHeader: string): void;'
- parameters:
- - id: leftHeader
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setRightFooter(rightFooter)
- uid: 'ExcelScript!ExcelScript.HeaderFooter#setRightFooter:member(1)'
- package: ExcelScript!
- fullName: setRightFooter(rightFooter)
- summary: >-
- The right footer of the worksheet. To apply font formatting or insert a variable value, use format codes specified
- here: https://msdn.microsoft.com/library/bb225426.aspx.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setRightFooter(rightFooter: string): void;'
- parameters:
- - id: rightFooter
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setRightHeader(rightHeader)
- uid: 'ExcelScript!ExcelScript.HeaderFooter#setRightHeader:member(1)'
- package: ExcelScript!
- fullName: setRightHeader(rightHeader)
- summary: >-
- The right header of the worksheet. To apply font formatting or insert a variable value, use format codes specified
- here: https://msdn.microsoft.com/library/bb225426.aspx.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setRightHeader(rightHeader: string): void;'
- parameters:
- - id: rightHeader
- description: ''
- type: string
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.HeaderFooter
+uid: 'ExcelScript!ExcelScript.HeaderFooter:interface'
+package: ExcelScript!
+fullName: ExcelScript.HeaderFooter
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getCenterFooter()
+ uid: 'ExcelScript!ExcelScript.HeaderFooter#getCenterFooter:member(1)'
+ package: ExcelScript!
+ fullName: getCenterFooter()
+ summary: >-
+ The center footer of the worksheet. To apply font formatting or insert a variable value, use format codes
+ specified here: https://msdn.microsoft.com/library/bb225426.aspx.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCenterFooter(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getCenterHeader()
+ uid: 'ExcelScript!ExcelScript.HeaderFooter#getCenterHeader:member(1)'
+ package: ExcelScript!
+ fullName: getCenterHeader()
+ summary: >-
+ The center header of the worksheet. To apply font formatting or insert a variable value, use format codes
+ specified here: https://msdn.microsoft.com/library/bb225426.aspx.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCenterHeader(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getLeftFooter()
+ uid: 'ExcelScript!ExcelScript.HeaderFooter#getLeftFooter:member(1)'
+ package: ExcelScript!
+ fullName: getLeftFooter()
+ summary: >-
+ The left footer of the worksheet. To apply font formatting or insert a variable value, use format codes specified
+ here: https://msdn.microsoft.com/library/bb225426.aspx.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLeftFooter(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getLeftHeader()
+ uid: 'ExcelScript!ExcelScript.HeaderFooter#getLeftHeader:member(1)'
+ package: ExcelScript!
+ fullName: getLeftHeader()
+ summary: >-
+ The left header of the worksheet. To apply font formatting or insert a variable value, use format codes specified
+ here: https://msdn.microsoft.com/library/bb225426.aspx.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLeftHeader(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getRightFooter()
+ uid: 'ExcelScript!ExcelScript.HeaderFooter#getRightFooter:member(1)'
+ package: ExcelScript!
+ fullName: getRightFooter()
+ summary: >-
+ The right footer of the worksheet. To apply font formatting or insert a variable value, use format codes specified
+ here: https://msdn.microsoft.com/library/bb225426.aspx.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRightFooter(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getRightHeader()
+ uid: 'ExcelScript!ExcelScript.HeaderFooter#getRightHeader:member(1)'
+ package: ExcelScript!
+ fullName: getRightHeader()
+ summary: >-
+ The right header of the worksheet. To apply font formatting or insert a variable value, use format codes specified
+ here: https://msdn.microsoft.com/library/bb225426.aspx.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRightHeader(): string;'
+ return:
+ type: string
+ description: ''
+ - name: setCenterFooter(centerFooter)
+ uid: 'ExcelScript!ExcelScript.HeaderFooter#setCenterFooter:member(1)'
+ package: ExcelScript!
+ fullName: setCenterFooter(centerFooter)
+ summary: >-
+ The center footer of the worksheet. To apply font formatting or insert a variable value, use format codes
+ specified here: https://msdn.microsoft.com/library/bb225426.aspx.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setCenterFooter(centerFooter: string): void;'
+ parameters:
+ - id: centerFooter
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setCenterHeader(centerHeader)
+ uid: 'ExcelScript!ExcelScript.HeaderFooter#setCenterHeader:member(1)'
+ package: ExcelScript!
+ fullName: setCenterHeader(centerHeader)
+ summary: >-
+ The center header of the worksheet. To apply font formatting or insert a variable value, use format codes
+ specified here: https://msdn.microsoft.com/library/bb225426.aspx.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setCenterHeader(centerHeader: string): void;'
+ parameters:
+ - id: centerHeader
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setLeftFooter(leftFooter)
+ uid: 'ExcelScript!ExcelScript.HeaderFooter#setLeftFooter:member(1)'
+ package: ExcelScript!
+ fullName: setLeftFooter(leftFooter)
+ summary: >-
+ The left footer of the worksheet. To apply font formatting or insert a variable value, use format codes specified
+ here: https://msdn.microsoft.com/library/bb225426.aspx.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLeftFooter(leftFooter: string): void;'
+ parameters:
+ - id: leftFooter
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setLeftHeader(leftHeader)
+ uid: 'ExcelScript!ExcelScript.HeaderFooter#setLeftHeader:member(1)'
+ package: ExcelScript!
+ fullName: setLeftHeader(leftHeader)
+ summary: >-
+ The left header of the worksheet. To apply font formatting or insert a variable value, use format codes specified
+ here: https://msdn.microsoft.com/library/bb225426.aspx.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLeftHeader(leftHeader: string): void;'
+ parameters:
+ - id: leftHeader
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setRightFooter(rightFooter)
+ uid: 'ExcelScript!ExcelScript.HeaderFooter#setRightFooter:member(1)'
+ package: ExcelScript!
+ fullName: setRightFooter(rightFooter)
+ summary: >-
+ The right footer of the worksheet. To apply font formatting or insert a variable value, use format codes specified
+ here: https://msdn.microsoft.com/library/bb225426.aspx.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setRightFooter(rightFooter: string): void;'
+ parameters:
+ - id: rightFooter
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setRightHeader(rightHeader)
+ uid: 'ExcelScript!ExcelScript.HeaderFooter#setRightHeader:member(1)'
+ package: ExcelScript!
+ fullName: setRightHeader(rightHeader)
+ summary: >-
+ The right header of the worksheet. To apply font formatting or insert a variable value, use format codes specified
+ here: https://msdn.microsoft.com/library/bb225426.aspx.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setRightHeader(rightHeader: string): void;'
+ parameters:
+ - id: rightHeader
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.headerfootergroup.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.headerfootergroup.yml
index 3f16352e..4ff30d8c 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.headerfootergroup.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.headerfootergroup.yml
@@ -1,161 +1,161 @@
-### YamlMime:TSType
-name: ExcelScript.HeaderFooterGroup
-uid: 'ExcelScript!ExcelScript.HeaderFooterGroup:interface'
-package: ExcelScript!
-fullName: ExcelScript.HeaderFooterGroup
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getDefaultForAllPages()
- uid: 'ExcelScript!ExcelScript.HeaderFooterGroup#getDefaultForAllPages:member(1)'
- package: ExcelScript!
- fullName: getDefaultForAllPages()
- summary: 'The general header/footer, used for all pages unless even/odd or first page is specified.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDefaultForAllPages(): HeaderFooter;'
- return:
- type: ''
- description: ''
- - name: getEvenPages()
- uid: 'ExcelScript!ExcelScript.HeaderFooterGroup#getEvenPages:member(1)'
- package: ExcelScript!
- fullName: getEvenPages()
- summary: 'The header/footer to use for even pages, odd header/footer needs to be specified for odd pages.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getEvenPages(): HeaderFooter;'
- return:
- type: ''
- description: ''
- - name: getFirstPage()
- uid: 'ExcelScript!ExcelScript.HeaderFooterGroup#getFirstPage:member(1)'
- package: ExcelScript!
- fullName: getFirstPage()
- summary: 'The first page header/footer, for all other pages general or even/odd is used.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFirstPage(): HeaderFooter;'
- return:
- type: ''
- description: ''
- - name: getOddPages()
- uid: 'ExcelScript!ExcelScript.HeaderFooterGroup#getOddPages:member(1)'
- package: ExcelScript!
- fullName: getOddPages()
- summary: 'The header/footer to use for odd pages, even header/footer needs to be specified for even pages.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getOddPages(): HeaderFooter;'
- return:
- type: ''
- description: ''
- - name: getState()
- uid: 'ExcelScript!ExcelScript.HeaderFooterGroup#getState:member(1)'
- package: ExcelScript!
- fullName: getState()
- summary: The state by which headers/footers are set. See `ExcelScript.HeaderFooterState` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getState(): HeaderFooterState;'
- return:
- type: ''
- description: ''
- - name: getUseSheetMargins()
- uid: 'ExcelScript!ExcelScript.HeaderFooterGroup#getUseSheetMargins:member(1)'
- package: ExcelScript!
- fullName: getUseSheetMargins()
- summary: >-
- Gets or sets a flag indicating if headers/footers are aligned with the page margins set in the page layout options
- for the worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getUseSheetMargins(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getUseSheetScale()
- uid: 'ExcelScript!ExcelScript.HeaderFooterGroup#getUseSheetScale:member(1)'
- package: ExcelScript!
- fullName: getUseSheetScale()
- summary: >-
- Gets or sets a flag indicating if headers/footers should be scaled by the page percentage scale set in the page
- layout options for the worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getUseSheetScale(): boolean;'
- return:
- type: boolean
- description: ''
- - name: setState(state)
- uid: 'ExcelScript!ExcelScript.HeaderFooterGroup#setState:member(1)'
- package: ExcelScript!
- fullName: setState(state)
- summary: The state by which headers/footers are set. See `ExcelScript.HeaderFooterState` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setState(state: HeaderFooterState): void;'
- parameters:
- - id: state
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setUseSheetMargins(useSheetMargins)
- uid: 'ExcelScript!ExcelScript.HeaderFooterGroup#setUseSheetMargins:member(1)'
- package: ExcelScript!
- fullName: setUseSheetMargins(useSheetMargins)
- summary: >-
- Gets or sets a flag indicating if headers/footers are aligned with the page margins set in the page layout options
- for the worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setUseSheetMargins(useSheetMargins: boolean): void;'
- parameters:
- - id: useSheetMargins
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setUseSheetScale(useSheetScale)
- uid: 'ExcelScript!ExcelScript.HeaderFooterGroup#setUseSheetScale:member(1)'
- package: ExcelScript!
- fullName: setUseSheetScale(useSheetScale)
- summary: >-
- Gets or sets a flag indicating if headers/footers should be scaled by the page percentage scale set in the page
- layout options for the worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setUseSheetScale(useSheetScale: boolean): void;'
- parameters:
- - id: useSheetScale
- description: ''
- type: boolean
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.HeaderFooterGroup
+uid: 'ExcelScript!ExcelScript.HeaderFooterGroup:interface'
+package: ExcelScript!
+fullName: ExcelScript.HeaderFooterGroup
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getDefaultForAllPages()
+ uid: 'ExcelScript!ExcelScript.HeaderFooterGroup#getDefaultForAllPages:member(1)'
+ package: ExcelScript!
+ fullName: getDefaultForAllPages()
+ summary: 'The general header/footer, used for all pages unless even/odd or first page is specified.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDefaultForAllPages(): HeaderFooter;'
+ return:
+ type: ''
+ description: ''
+ - name: getEvenPages()
+ uid: 'ExcelScript!ExcelScript.HeaderFooterGroup#getEvenPages:member(1)'
+ package: ExcelScript!
+ fullName: getEvenPages()
+ summary: 'The header/footer to use for even pages, odd header/footer needs to be specified for odd pages.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getEvenPages(): HeaderFooter;'
+ return:
+ type: ''
+ description: ''
+ - name: getFirstPage()
+ uid: 'ExcelScript!ExcelScript.HeaderFooterGroup#getFirstPage:member(1)'
+ package: ExcelScript!
+ fullName: getFirstPage()
+ summary: 'The first page header/footer, for all other pages general or even/odd is used.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFirstPage(): HeaderFooter;'
+ return:
+ type: ''
+ description: ''
+ - name: getOddPages()
+ uid: 'ExcelScript!ExcelScript.HeaderFooterGroup#getOddPages:member(1)'
+ package: ExcelScript!
+ fullName: getOddPages()
+ summary: 'The header/footer to use for odd pages, even header/footer needs to be specified for even pages.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getOddPages(): HeaderFooter;'
+ return:
+ type: ''
+ description: ''
+ - name: getState()
+ uid: 'ExcelScript!ExcelScript.HeaderFooterGroup#getState:member(1)'
+ package: ExcelScript!
+ fullName: getState()
+ summary: The state by which headers/footers are set. See `ExcelScript.HeaderFooterState` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getState(): HeaderFooterState;'
+ return:
+ type: ''
+ description: ''
+ - name: getUseSheetMargins()
+ uid: 'ExcelScript!ExcelScript.HeaderFooterGroup#getUseSheetMargins:member(1)'
+ package: ExcelScript!
+ fullName: getUseSheetMargins()
+ summary: >-
+ Specifies a flag indicating if headers/footers are aligned with the page margins set in the page layout options
+ for the worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getUseSheetMargins(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getUseSheetScale()
+ uid: 'ExcelScript!ExcelScript.HeaderFooterGroup#getUseSheetScale:member(1)'
+ package: ExcelScript!
+ fullName: getUseSheetScale()
+ summary: >-
+ Specifies a flag indicating if headers/footers should be scaled by the page percentage scale set in the page
+ layout options for the worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getUseSheetScale(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: setState(state)
+ uid: 'ExcelScript!ExcelScript.HeaderFooterGroup#setState:member(1)'
+ package: ExcelScript!
+ fullName: setState(state)
+ summary: The state by which headers/footers are set. See `ExcelScript.HeaderFooterState` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setState(state: HeaderFooterState): void;'
+ parameters:
+ - id: state
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setUseSheetMargins(useSheetMargins)
+ uid: 'ExcelScript!ExcelScript.HeaderFooterGroup#setUseSheetMargins:member(1)'
+ package: ExcelScript!
+ fullName: setUseSheetMargins(useSheetMargins)
+ summary: >-
+ Specifies a flag indicating if headers/footers are aligned with the page margins set in the page layout options
+ for the worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setUseSheetMargins(useSheetMargins: boolean): void;'
+ parameters:
+ - id: useSheetMargins
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setUseSheetScale(useSheetScale)
+ uid: 'ExcelScript!ExcelScript.HeaderFooterGroup#setUseSheetScale:member(1)'
+ package: ExcelScript!
+ fullName: setUseSheetScale(useSheetScale)
+ summary: >-
+ Specifies a flag indicating if headers/footers should be scaled by the page percentage scale set in the page
+ layout options for the worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setUseSheetScale(useSheetScale: boolean): void;'
+ parameters:
+ - id: useSheetScale
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.headerfooterstate.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.headerfooterstate.yml
index a7d96b1f..cfea29d6 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.headerfooterstate.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.headerfooterstate.yml
@@ -1,26 +1,26 @@
-### YamlMime:TSEnum
-name: ExcelScript.HeaderFooterState
-uid: 'ExcelScript!ExcelScript.HeaderFooterState:enum'
-package: ExcelScript!
-fullName: ExcelScript.HeaderFooterState
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: default
- uid: 'ExcelScript!ExcelScript.HeaderFooterState.default:member'
- package: ExcelScript!
- summary: Only one general header/footer is used for all pages printed.
- - name: firstAndDefault
- uid: 'ExcelScript!ExcelScript.HeaderFooterState.firstAndDefault:member'
- package: ExcelScript!
- summary: 'There is a separate first page header/footer, and a general header/footer used for all other pages.'
- - name: firstOddAndEven
- uid: 'ExcelScript!ExcelScript.HeaderFooterState.firstOddAndEven:member'
- package: ExcelScript!
- summary: 'There is a separate first page header/footer, then there is a separate header/footer for odd and even pages.'
- - name: oddAndEven
- uid: 'ExcelScript!ExcelScript.HeaderFooterState.oddAndEven:member'
- package: ExcelScript!
- summary: There is a different header/footer for odd and even pages.
+### YamlMime:TSEnum
+name: ExcelScript.HeaderFooterState
+uid: 'ExcelScript!ExcelScript.HeaderFooterState:enum'
+package: ExcelScript!
+fullName: ExcelScript.HeaderFooterState
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: default
+ uid: 'ExcelScript!ExcelScript.HeaderFooterState.default:member'
+ package: ExcelScript!
+ summary: Only one general header/footer is used for all pages printed.
+ - name: firstAndDefault
+ uid: 'ExcelScript!ExcelScript.HeaderFooterState.firstAndDefault:member'
+ package: ExcelScript!
+ summary: 'There is a separate first page header/footer, and a general header/footer used for all other pages.'
+ - name: firstOddAndEven
+ uid: 'ExcelScript!ExcelScript.HeaderFooterState.firstOddAndEven:member'
+ package: ExcelScript!
+ summary: 'There is a separate first page header/footer, then there is a separate header/footer for odd and even pages.'
+ - name: oddAndEven
+ uid: 'ExcelScript!ExcelScript.HeaderFooterState.oddAndEven:member'
+ package: ExcelScript!
+ summary: There is a different header/footer for odd and even pages.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.horizontalalignment.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.horizontalalignment.yml
index 735d4792..0d93dc36 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.horizontalalignment.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.horizontalalignment.yml
@@ -1,62 +1,62 @@
-### YamlMime:TSEnum
-name: ExcelScript.HorizontalAlignment
-uid: 'ExcelScript!ExcelScript.HorizontalAlignment:enum'
-package: ExcelScript!
-fullName: ExcelScript.HorizontalAlignment
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script centers the text in a table's header row cells.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table on the current worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const table = currentSheet.getTables()[0];
-
- // Get the header range.
- const headerRange = table.getHeaderRowRange();
-
- // Set the horizontal text alignment to `center`.
- headerRange.getFormat().setHorizontalAlignment(ExcelScript.HorizontalAlignment.center);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: center
- uid: 'ExcelScript!ExcelScript.HorizontalAlignment.center:member'
- package: ExcelScript!
- summary: ''
- - name: centerAcrossSelection
- uid: 'ExcelScript!ExcelScript.HorizontalAlignment.centerAcrossSelection:member'
- package: ExcelScript!
- summary: ''
- - name: distributed
- uid: 'ExcelScript!ExcelScript.HorizontalAlignment.distributed:member'
- package: ExcelScript!
- summary: ''
- - name: fill
- uid: 'ExcelScript!ExcelScript.HorizontalAlignment.fill:member'
- package: ExcelScript!
- summary: ''
- - name: general
- uid: 'ExcelScript!ExcelScript.HorizontalAlignment.general:member'
- package: ExcelScript!
- summary: ''
- - name: justify
- uid: 'ExcelScript!ExcelScript.HorizontalAlignment.justify:member'
- package: ExcelScript!
- summary: ''
- - name: left
- uid: 'ExcelScript!ExcelScript.HorizontalAlignment.left:member'
- package: ExcelScript!
- summary: ''
- - name: right
- uid: 'ExcelScript!ExcelScript.HorizontalAlignment.right:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.HorizontalAlignment
+uid: 'ExcelScript!ExcelScript.HorizontalAlignment:enum'
+package: ExcelScript!
+fullName: ExcelScript.HorizontalAlignment
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script centers the text in a table's header row cells.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table on the current worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const table = currentSheet.getTables()[0];
+
+ // Get the header range.
+ const headerRange = table.getHeaderRowRange();
+
+ // Set the horizontal text alignment to `center`.
+ headerRange.getFormat().setHorizontalAlignment(ExcelScript.HorizontalAlignment.center);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: center
+ uid: 'ExcelScript!ExcelScript.HorizontalAlignment.center:member'
+ package: ExcelScript!
+ summary: ''
+ - name: centerAcrossSelection
+ uid: 'ExcelScript!ExcelScript.HorizontalAlignment.centerAcrossSelection:member'
+ package: ExcelScript!
+ summary: ''
+ - name: distributed
+ uid: 'ExcelScript!ExcelScript.HorizontalAlignment.distributed:member'
+ package: ExcelScript!
+ summary: ''
+ - name: fill
+ uid: 'ExcelScript!ExcelScript.HorizontalAlignment.fill:member'
+ package: ExcelScript!
+ summary: ''
+ - name: general
+ uid: 'ExcelScript!ExcelScript.HorizontalAlignment.general:member'
+ package: ExcelScript!
+ summary: ''
+ - name: justify
+ uid: 'ExcelScript!ExcelScript.HorizontalAlignment.justify:member'
+ package: ExcelScript!
+ summary: ''
+ - name: left
+ uid: 'ExcelScript!ExcelScript.HorizontalAlignment.left:member'
+ package: ExcelScript!
+ summary: ''
+ - name: right
+ uid: 'ExcelScript!ExcelScript.HorizontalAlignment.right:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.icon.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.icon.yml
index 66ad0bcd..829a422b 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.icon.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.icon.yml
@@ -1,35 +1,35 @@
-### YamlMime:TSType
-name: ExcelScript.Icon
-uid: 'ExcelScript!ExcelScript.Icon:interface'
-package: ExcelScript!
-fullName: ExcelScript.Icon
-summary: Represents a cell icon.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: index
- uid: 'ExcelScript!ExcelScript.Icon#index:member'
- package: ExcelScript!
- fullName: index
- summary: Specifies the index of the icon in the given set.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'index: number;'
- return:
- type: number
- - name: set
- uid: 'ExcelScript!ExcelScript.Icon#set:member'
- package: ExcelScript!
- fullName: set
- summary: Specifies the set that the icon is part of.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'set: IconSet;'
- return:
- type: ''
+### YamlMime:TSType
+name: ExcelScript.Icon
+uid: 'ExcelScript!ExcelScript.Icon:interface'
+package: ExcelScript!
+fullName: ExcelScript.Icon
+summary: Represents a cell icon.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: index
+ uid: 'ExcelScript!ExcelScript.Icon#index:member'
+ package: ExcelScript!
+ fullName: index
+ summary: Specifies the index of the icon in the given set.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'index: number;'
+ return:
+ type: number
+ - name: set
+ uid: 'ExcelScript!ExcelScript.Icon#set:member'
+ package: ExcelScript!
+ fullName: set
+ summary: Specifies the set that the icon is part of.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'set: IconSet;'
+ return:
+ type: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.iconset.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.iconset.yml
index 24379d19..38678a46 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.iconset.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.iconset.yml
@@ -1,128 +1,128 @@
-### YamlMime:TSEnum
-name: ExcelScript.IconSet
-uid: 'ExcelScript!ExcelScript.IconSet:enum'
-package: ExcelScript!
-fullName: ExcelScript.IconSet
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies icon set conditional formatting to a range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range "A1:A5" on the current worksheet.
- const sheet = workbook.getActiveWorksheet();
- const range = sheet.getRange("A1:A5");
-
- // Create icon set conditional formatting on the range.
- const conditionalFormatting = range.addConditionalFormat(ExcelScript.ConditionalFormatType.iconSet);
-
- // Use the "3 Traffic Lights (Unrimmed)" set.
- conditionalFormatting.getIconSet().setStyle(ExcelScript.IconSet.threeTrafficLights1);
-
- // Set the criteria to use a different icon for the bottom, middle, and top thirds of the values in the range.
- conditionalFormatting.getIconSet().setCriteria([
- {
- formula:'=0',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
- type:ExcelScript.ConditionalFormatIconRuleType.percent
- },
- {
- formula:'=33',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
- type:ExcelScript.ConditionalFormatIconRuleType.percent},
- {
- formula:'=67',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
- type:ExcelScript.ConditionalFormatIconRuleType.percent
- }]);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: fiveArrows
- uid: 'ExcelScript!ExcelScript.IconSet.fiveArrows:member'
- package: ExcelScript!
- summary: ''
- - name: fiveArrowsGray
- uid: 'ExcelScript!ExcelScript.IconSet.fiveArrowsGray:member'
- package: ExcelScript!
- summary: ''
- - name: fiveBoxes
- uid: 'ExcelScript!ExcelScript.IconSet.fiveBoxes:member'
- package: ExcelScript!
- summary: ''
- - name: fiveQuarters
- uid: 'ExcelScript!ExcelScript.IconSet.fiveQuarters:member'
- package: ExcelScript!
- summary: ''
- - name: fiveRating
- uid: 'ExcelScript!ExcelScript.IconSet.fiveRating:member'
- package: ExcelScript!
- summary: ''
- - name: fourArrows
- uid: 'ExcelScript!ExcelScript.IconSet.fourArrows:member'
- package: ExcelScript!
- summary: ''
- - name: fourArrowsGray
- uid: 'ExcelScript!ExcelScript.IconSet.fourArrowsGray:member'
- package: ExcelScript!
- summary: ''
- - name: fourRating
- uid: 'ExcelScript!ExcelScript.IconSet.fourRating:member'
- package: ExcelScript!
- summary: ''
- - name: fourRedToBlack
- uid: 'ExcelScript!ExcelScript.IconSet.fourRedToBlack:member'
- package: ExcelScript!
- summary: ''
- - name: fourTrafficLights
- uid: 'ExcelScript!ExcelScript.IconSet.fourTrafficLights:member'
- package: ExcelScript!
- summary: ''
- - name: invalid
- uid: 'ExcelScript!ExcelScript.IconSet.invalid:member'
- package: ExcelScript!
- summary: ''
- - name: threeArrows
- uid: 'ExcelScript!ExcelScript.IconSet.threeArrows:member'
- package: ExcelScript!
- summary: ''
- - name: threeArrowsGray
- uid: 'ExcelScript!ExcelScript.IconSet.threeArrowsGray:member'
- package: ExcelScript!
- summary: ''
- - name: threeFlags
- uid: 'ExcelScript!ExcelScript.IconSet.threeFlags:member'
- package: ExcelScript!
- summary: ''
- - name: threeSigns
- uid: 'ExcelScript!ExcelScript.IconSet.threeSigns:member'
- package: ExcelScript!
- summary: ''
- - name: threeStars
- uid: 'ExcelScript!ExcelScript.IconSet.threeStars:member'
- package: ExcelScript!
- summary: ''
- - name: threeSymbols
- uid: 'ExcelScript!ExcelScript.IconSet.threeSymbols:member'
- package: ExcelScript!
- summary: ''
- - name: threeSymbols2
- uid: 'ExcelScript!ExcelScript.IconSet.threeSymbols2:member'
- package: ExcelScript!
- summary: ''
- - name: threeTrafficLights1
- uid: 'ExcelScript!ExcelScript.IconSet.threeTrafficLights1:member'
- package: ExcelScript!
- summary: ''
- - name: threeTrafficLights2
- uid: 'ExcelScript!ExcelScript.IconSet.threeTrafficLights2:member'
- package: ExcelScript!
- summary: ''
- - name: threeTriangles
- uid: 'ExcelScript!ExcelScript.IconSet.threeTriangles:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.IconSet
+uid: 'ExcelScript!ExcelScript.IconSet:enum'
+package: ExcelScript!
+fullName: ExcelScript.IconSet
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies icon set conditional formatting to a range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range "A1:A5" on the current worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const range = sheet.getRange("A1:A5");
+
+ // Create icon set conditional formatting on the range.
+ const conditionalFormatting = range.addConditionalFormat(ExcelScript.ConditionalFormatType.iconSet);
+
+ // Use the "3 Traffic Lights (Unrimmed)" set.
+ conditionalFormatting.getIconSet().setStyle(ExcelScript.IconSet.threeTrafficLights1);
+
+ // Set the criteria to use a different icon for the bottom, middle, and top thirds of the values in the range.
+ conditionalFormatting.getIconSet().setCriteria([
+ {
+ formula:'=0',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
+ type:ExcelScript.ConditionalFormatIconRuleType.percent
+ },
+ {
+ formula:'=33',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
+ type:ExcelScript.ConditionalFormatIconRuleType.percent},
+ {
+ formula:'=67',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
+ type:ExcelScript.ConditionalFormatIconRuleType.percent
+ }]);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: fiveArrows
+ uid: 'ExcelScript!ExcelScript.IconSet.fiveArrows:member'
+ package: ExcelScript!
+ summary: ''
+ - name: fiveArrowsGray
+ uid: 'ExcelScript!ExcelScript.IconSet.fiveArrowsGray:member'
+ package: ExcelScript!
+ summary: ''
+ - name: fiveBoxes
+ uid: 'ExcelScript!ExcelScript.IconSet.fiveBoxes:member'
+ package: ExcelScript!
+ summary: ''
+ - name: fiveQuarters
+ uid: 'ExcelScript!ExcelScript.IconSet.fiveQuarters:member'
+ package: ExcelScript!
+ summary: ''
+ - name: fiveRating
+ uid: 'ExcelScript!ExcelScript.IconSet.fiveRating:member'
+ package: ExcelScript!
+ summary: ''
+ - name: fourArrows
+ uid: 'ExcelScript!ExcelScript.IconSet.fourArrows:member'
+ package: ExcelScript!
+ summary: ''
+ - name: fourArrowsGray
+ uid: 'ExcelScript!ExcelScript.IconSet.fourArrowsGray:member'
+ package: ExcelScript!
+ summary: ''
+ - name: fourRating
+ uid: 'ExcelScript!ExcelScript.IconSet.fourRating:member'
+ package: ExcelScript!
+ summary: ''
+ - name: fourRedToBlack
+ uid: 'ExcelScript!ExcelScript.IconSet.fourRedToBlack:member'
+ package: ExcelScript!
+ summary: ''
+ - name: fourTrafficLights
+ uid: 'ExcelScript!ExcelScript.IconSet.fourTrafficLights:member'
+ package: ExcelScript!
+ summary: ''
+ - name: invalid
+ uid: 'ExcelScript!ExcelScript.IconSet.invalid:member'
+ package: ExcelScript!
+ summary: ''
+ - name: threeArrows
+ uid: 'ExcelScript!ExcelScript.IconSet.threeArrows:member'
+ package: ExcelScript!
+ summary: ''
+ - name: threeArrowsGray
+ uid: 'ExcelScript!ExcelScript.IconSet.threeArrowsGray:member'
+ package: ExcelScript!
+ summary: ''
+ - name: threeFlags
+ uid: 'ExcelScript!ExcelScript.IconSet.threeFlags:member'
+ package: ExcelScript!
+ summary: ''
+ - name: threeSigns
+ uid: 'ExcelScript!ExcelScript.IconSet.threeSigns:member'
+ package: ExcelScript!
+ summary: ''
+ - name: threeStars
+ uid: 'ExcelScript!ExcelScript.IconSet.threeStars:member'
+ package: ExcelScript!
+ summary: ''
+ - name: threeSymbols
+ uid: 'ExcelScript!ExcelScript.IconSet.threeSymbols:member'
+ package: ExcelScript!
+ summary: ''
+ - name: threeSymbols2
+ uid: 'ExcelScript!ExcelScript.IconSet.threeSymbols2:member'
+ package: ExcelScript!
+ summary: ''
+ - name: threeTrafficLights1
+ uid: 'ExcelScript!ExcelScript.IconSet.threeTrafficLights1:member'
+ package: ExcelScript!
+ summary: ''
+ - name: threeTrafficLights2
+ uid: 'ExcelScript!ExcelScript.IconSet.threeTrafficLights2:member'
+ package: ExcelScript!
+ summary: ''
+ - name: threeTriangles
+ uid: 'ExcelScript!ExcelScript.IconSet.threeTriangles:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.iconsetconditionalformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.iconsetconditionalformat.yml
index be216f25..795cf064 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.iconsetconditionalformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.iconsetconditionalformat.yml
@@ -1,175 +1,175 @@
-### YamlMime:TSType
-name: ExcelScript.IconSetConditionalFormat
-uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.IconSetConditionalFormat
-summary: Represents an icon set criteria for conditional formatting.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies icon set conditional formatting to a range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range "A1:A5" on the current worksheet.
- const sheet = workbook.getActiveWorksheet();
- const range = sheet.getRange("A1:A5");
-
- // Create icon set conditional formatting on the range.
- const conditionalFormatting = range.addConditionalFormat(ExcelScript.ConditionalFormatType.iconSet);
- const iconSetFormat: ExcelScript.IconSetConditionalFormat = conditionalFormatting.getIconSet();
- // Use the "3 Traffic Lights (Unrimmed)" set.
- iconSetFormat.setStyle(ExcelScript.IconSet.threeTrafficLights1);
-
- // Set the criteria to use a different icon for the bottom, middle, and top thirds of the values in the range.
- iconSetFormat.setCriteria([
- {
- formula:'=0',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
- type:ExcelScript.ConditionalFormatIconRuleType.percent
- },
- {
- formula:'=33',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
- type:ExcelScript.ConditionalFormatIconRuleType.percent},
- {
- formula:'=67',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
- type:ExcelScript.ConditionalFormatIconRuleType.percent
- }]);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getCriteria()
- uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat#getCriteria:member(1)'
- package: ExcelScript!
- fullName: getCriteria()
- summary: >-
- An array of criteria and icon sets for the rules and potential custom icons for conditional icons. Note that for
- the first criterion only the custom icon can be modified, while type, formula, and operator will be ignored when
- set.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCriteria(): ConditionalIconCriterion[];'
- return:
- type: '[]'
- description: ''
- - name: getReverseIconOrder()
- uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat#getReverseIconOrder:member(1)'
- package: ExcelScript!
- fullName: getReverseIconOrder()
- summary: >-
- If `true`, reverses the icon orders for the icon set. Note that this cannot be set if custom icons are
- used.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getReverseIconOrder(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowIconOnly()
- uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat#getShowIconOnly:member(1)'
- package: ExcelScript!
- fullName: getShowIconOnly()
- summary: 'If `true`, hides the values and only shows icons.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowIconOnly(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getStyle()
- uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat#getStyle:member(1)'
- package: ExcelScript!
- fullName: getStyle()
- summary: 'If set, displays the icon set option for the conditional format.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getStyle(): IconSet;'
- return:
- type: ''
- description: ''
- - name: setCriteria(criteria)
- uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat#setCriteria:member(1)'
- package: ExcelScript!
- fullName: setCriteria(criteria)
- summary: >-
- An array of criteria and icon sets for the rules and potential custom icons for conditional icons. Note that for
- the first criterion only the custom icon can be modified, while type, formula, and operator will be ignored when
- set.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setCriteria(criteria: ConditionalIconCriterion[]): void;'
- parameters:
- - id: criteria
- description: ''
- type: '[]'
- return:
- type: void
- description: ''
- - name: setReverseIconOrder(reverseIconOrder)
- uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat#setReverseIconOrder:member(1)'
- package: ExcelScript!
- fullName: setReverseIconOrder(reverseIconOrder)
- summary: >-
- If `true`, reverses the icon orders for the icon set. Note that this cannot be set if custom icons are
- used.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setReverseIconOrder(reverseIconOrder: boolean): void;'
- parameters:
- - id: reverseIconOrder
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowIconOnly(showIconOnly)
- uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat#setShowIconOnly:member(1)'
- package: ExcelScript!
- fullName: setShowIconOnly(showIconOnly)
- summary: 'If `true`, hides the values and only shows icons.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowIconOnly(showIconOnly: boolean): void;'
- parameters:
- - id: showIconOnly
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setStyle(style)
- uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat#setStyle:member(1)'
- package: ExcelScript!
- fullName: setStyle(style)
- summary: 'If set, displays the icon set option for the conditional format.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setStyle(style: IconSet): void;'
- parameters:
- - id: style
- description: ''
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.IconSetConditionalFormat
+uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.IconSetConditionalFormat
+summary: Represents an icon set criteria for conditional formatting.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies icon set conditional formatting to a range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range "A1:A5" on the current worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const range = sheet.getRange("A1:A5");
+
+ // Create icon set conditional formatting on the range.
+ const conditionalFormatting = range.addConditionalFormat(ExcelScript.ConditionalFormatType.iconSet);
+ const iconSetFormat: ExcelScript.IconSetConditionalFormat = conditionalFormatting.getIconSet();
+ // Use the "3 Traffic Lights (Unrimmed)" set.
+ iconSetFormat.setStyle(ExcelScript.IconSet.threeTrafficLights1);
+
+ // Set the criteria to use a different icon for the bottom, middle, and top thirds of the values in the range.
+ iconSetFormat.setCriteria([
+ {
+ formula:'=0',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
+ type:ExcelScript.ConditionalFormatIconRuleType.percent
+ },
+ {
+ formula:'=33',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
+ type:ExcelScript.ConditionalFormatIconRuleType.percent},
+ {
+ formula:'=67',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
+ type:ExcelScript.ConditionalFormatIconRuleType.percent
+ }]);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getCriteria()
+ uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat#getCriteria:member(1)'
+ package: ExcelScript!
+ fullName: getCriteria()
+ summary: >-
+ An array of criteria and icon sets for the rules and potential custom icons for conditional icons. Note that for
+ the first criterion only the custom icon can be modified, while type, formula, and operator will be ignored when
+ set.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCriteria(): ConditionalIconCriterion[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getReverseIconOrder()
+ uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat#getReverseIconOrder:member(1)'
+ package: ExcelScript!
+ fullName: getReverseIconOrder()
+ summary: >-
+ If `true`, reverses the icon orders for the icon set. Note that this cannot be set if custom icons are
+ used.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getReverseIconOrder(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowIconOnly()
+ uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat#getShowIconOnly:member(1)'
+ package: ExcelScript!
+ fullName: getShowIconOnly()
+ summary: 'If `true`, hides the values and only shows icons.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowIconOnly(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getStyle()
+ uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat#getStyle:member(1)'
+ package: ExcelScript!
+ fullName: getStyle()
+ summary: 'If set, displays the icon set option for the conditional format.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getStyle(): IconSet;'
+ return:
+ type: ''
+ description: ''
+ - name: setCriteria(criteria)
+ uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat#setCriteria:member(1)'
+ package: ExcelScript!
+ fullName: setCriteria(criteria)
+ summary: >-
+ An array of criteria and icon sets for the rules and potential custom icons for conditional icons. Note that for
+ the first criterion only the custom icon can be modified, while type, formula, and operator will be ignored when
+ set.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setCriteria(criteria: ConditionalIconCriterion[]): void;'
+ parameters:
+ - id: criteria
+ description: ''
+ type: '[]'
+ return:
+ type: void
+ description: ''
+ - name: setReverseIconOrder(reverseIconOrder)
+ uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat#setReverseIconOrder:member(1)'
+ package: ExcelScript!
+ fullName: setReverseIconOrder(reverseIconOrder)
+ summary: >-
+ If `true`, reverses the icon orders for the icon set. Note that this cannot be set if custom icons are
+ used.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setReverseIconOrder(reverseIconOrder: boolean): void;'
+ parameters:
+ - id: reverseIconOrder
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowIconOnly(showIconOnly)
+ uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat#setShowIconOnly:member(1)'
+ package: ExcelScript!
+ fullName: setShowIconOnly(showIconOnly)
+ summary: 'If `true`, hides the values and only shows icons.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowIconOnly(showIconOnly: boolean): void;'
+ parameters:
+ - id: showIconOnly
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setStyle(style)
+ uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat#setStyle:member(1)'
+ package: ExcelScript!
+ fullName: setStyle(style)
+ summary: 'If set, displays the icon set option for the conditional format.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setStyle(style: IconSet): void;'
+ parameters:
+ - id: style
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.image.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.image.yml
index d6e8b19a..7412ae85 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.image.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.image.yml
@@ -1,76 +1,76 @@
-### YamlMime:TSType
-name: ExcelScript.Image
-uid: 'ExcelScript!ExcelScript.Image:interface'
-package: ExcelScript!
-fullName: ExcelScript.Image
-summary: 'Represents an image in the worksheet. To get the corresponding `Shape` object, use `Image.getShape`.'
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script transfers an image from one worksheet to another.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the worksheet with the image on it.
- const firstWorksheet = workbook.getWorksheet("FirstSheet");
-
- // Get the first image from the worksheet.
- // If a script added the image, you could add a name to make it easier to find.
- let image: ExcelScript.Image;
- firstWorksheet.getShapes().forEach((shape, index) => {
- if (shape.getType() === ExcelScript.ShapeType.image) {
- image = shape.getImage();
- return;
- }
- });
-
- // Copy the image to another worksheet.
- image.getShape().copyTo("SecondSheet");
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getFormat()
- uid: 'ExcelScript!ExcelScript.Image#getFormat:member(1)'
- package: ExcelScript!
- fullName: getFormat()
- summary: Returns the format of the image.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormat(): PictureFormat;'
- return:
- type: ''
- description: ''
- - name: getId()
- uid: 'ExcelScript!ExcelScript.Image#getId:member(1)'
- package: ExcelScript!
- fullName: getId()
- summary: Specifies the shape identifier for the image object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getId(): string;'
- return:
- type: string
- description: ''
- - name: getShape()
- uid: 'ExcelScript!ExcelScript.Image#getShape:member(1)'
- package: ExcelScript!
- fullName: getShape()
- summary: Returns the `Shape` object associated with the image.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShape(): Shape;'
- return:
- type: ''
- description: ''
+### YamlMime:TSType
+name: ExcelScript.Image
+uid: 'ExcelScript!ExcelScript.Image:interface'
+package: ExcelScript!
+fullName: ExcelScript.Image
+summary: 'Represents an image in the worksheet. To get the corresponding `Shape` object, use `Image.getShape`.'
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script transfers an image from one worksheet to another.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the worksheet with the image on it.
+ const firstWorksheet = workbook.getWorksheet("FirstSheet");
+
+ // Get the first image from the worksheet.
+ // If a script added the image, you could add a name to make it easier to find.
+ let image: ExcelScript.Image;
+ firstWorksheet.getShapes().forEach((shape, index) => {
+ if (shape.getType() === ExcelScript.ShapeType.image) {
+ image = shape.getImage();
+ return;
+ }
+ });
+
+ // Copy the image to another worksheet.
+ image.getShape().copyTo("SecondSheet");
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getFormat()
+ uid: 'ExcelScript!ExcelScript.Image#getFormat:member(1)'
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: Returns the format of the image.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): PictureFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getId()
+ uid: 'ExcelScript!ExcelScript.Image#getId:member(1)'
+ package: ExcelScript!
+ fullName: getId()
+ summary: Specifies the shape identifier for the image object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getId(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getShape()
+ uid: 'ExcelScript!ExcelScript.Image#getShape:member(1)'
+ package: ExcelScript!
+ fullName: getShape()
+ summary: Returns the `Shape` object associated with the image.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShape(): Shape;'
+ return:
+ type: ''
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.imagefittingmode.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.imagefittingmode.yml
index 917f23cb..623dc940 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.imagefittingmode.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.imagefittingmode.yml
@@ -1,48 +1,48 @@
-### YamlMime:TSEnum
-name: ExcelScript.ImageFittingMode
-uid: 'ExcelScript!ExcelScript.ImageFittingMode:enum'
-package: ExcelScript!
-fullName: ExcelScript.ImageFittingMode
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script returns an image of the first chart in the first worksheet.
- * That image is 600x400 pixels and the chart will be
- * stretched to fill those dimensions.
- * The returned image can be used in a Power Automate flow.
- */
- function main(workbook: ExcelScript.Workbook): string {
- // Get the first chart in the first worksheet.
- const firstSheet = workbook.getFirstWorksheet();
- const firstChart = firstSheet.getCharts()[0];
-
- // Get an image of the chart as a base64-encoded string.
- const base64String = firstChart.getImage(
- 600, /* Width */
- 400, /* Height */
- ExcelScript.ImageFittingMode.fill /* Fill to match the dimensions. */
- );
-
- return base64String;
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: fill
- uid: 'ExcelScript!ExcelScript.ImageFittingMode.fill:member'
- package: ExcelScript!
- summary: ''
- - name: fit
- uid: 'ExcelScript!ExcelScript.ImageFittingMode.fit:member'
- package: ExcelScript!
- summary: ''
- - name: fitAndCenter
- uid: 'ExcelScript!ExcelScript.ImageFittingMode.fitAndCenter:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ImageFittingMode
+uid: 'ExcelScript!ExcelScript.ImageFittingMode:enum'
+package: ExcelScript!
+fullName: ExcelScript.ImageFittingMode
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script returns an image of the first chart in the first worksheet.
+ * That image is 600x400 pixels and the chart will be
+ * stretched to fill those dimensions.
+ * The returned image can be used in a Power Automate flow.
+ */
+ function main(workbook: ExcelScript.Workbook): string {
+ // Get the first chart in the first worksheet.
+ const firstSheet = workbook.getFirstWorksheet();
+ const firstChart = firstSheet.getCharts()[0];
+
+ // Get an image of the chart as a base64-encoded string.
+ const base64String = firstChart.getImage(
+ 600, /* Width */
+ 400, /* Height */
+ ExcelScript.ImageFittingMode.fill /* Fill to match the dimensions. */
+ );
+
+ return base64String;
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: fill
+ uid: 'ExcelScript!ExcelScript.ImageFittingMode.fill:member'
+ package: ExcelScript!
+ summary: ''
+ - name: fit
+ uid: 'ExcelScript!ExcelScript.ImageFittingMode.fit:member'
+ package: ExcelScript!
+ summary: ''
+ - name: fitAndCenter
+ uid: 'ExcelScript!ExcelScript.ImageFittingMode.fitAndCenter:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.insertshiftdirection.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.insertshiftdirection.yml
index be1bc4e1..85f7b868 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.insertshiftdirection.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.insertshiftdirection.yml
@@ -1,41 +1,41 @@
-### YamlMime:TSEnum
-name: ExcelScript.InsertShiftDirection
-uid: 'ExcelScript!ExcelScript.InsertShiftDirection:enum'
-package: ExcelScript!
-fullName: ExcelScript.InsertShiftDirection
-summary: Determines the direction in which existing cells will be shifted to accommodate what is being inserted.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script inserts headers at the top of the worksheet.
- */
- function main(workbook: ExcelScript.Workbook)
- {
- let currentSheet = workbook.getActiveWorksheet();
-
- // Create headers for 3 columns.
- let myHeaders = [["NAME", "ID", "ROLE"]];
-
- // Add a blank first row and push existing data down a row.
- let firstRow = currentSheet.getRange("1:1");
- firstRow.insert(ExcelScript.InsertShiftDirection.down);
-
- // Add the headers.
- currentSheet.getRange("A1:C1").setValues(myHeaders);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: down
- uid: 'ExcelScript!ExcelScript.InsertShiftDirection.down:member'
- package: ExcelScript!
- summary: ''
- - name: right
- uid: 'ExcelScript!ExcelScript.InsertShiftDirection.right:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.InsertShiftDirection
+uid: 'ExcelScript!ExcelScript.InsertShiftDirection:enum'
+package: ExcelScript!
+fullName: ExcelScript.InsertShiftDirection
+summary: Determines the direction in which existing cells will be shifted to accommodate what is being inserted.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script inserts headers at the top of the worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook)
+ {
+ let currentSheet = workbook.getActiveWorksheet();
+
+ // Create headers for 3 columns.
+ let myHeaders = [["NAME", "ID", "ROLE"]];
+
+ // Add a blank first row and push existing data down a row.
+ let firstRow = currentSheet.getRange("1:1");
+ firstRow.insert(ExcelScript.InsertShiftDirection.down);
+
+ // Add the headers.
+ currentSheet.getRange("A1:C1").setValues(myHeaders);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: down
+ uid: 'ExcelScript!ExcelScript.InsertShiftDirection.down:member'
+ package: ExcelScript!
+ summary: ''
+ - name: right
+ uid: 'ExcelScript!ExcelScript.InsertShiftDirection.right:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.iterativecalculation.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.iterativecalculation.yml
index e20ae9b9..84841eb6 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.iterativecalculation.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.iterativecalculation.yml
@@ -1,101 +1,101 @@
-### YamlMime:TSType
-name: ExcelScript.IterativeCalculation
-uid: 'ExcelScript!ExcelScript.IterativeCalculation:interface'
-package: ExcelScript!
-fullName: ExcelScript.IterativeCalculation
-summary: Represents the iterative calculation settings.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getEnabled()
- uid: 'ExcelScript!ExcelScript.IterativeCalculation#getEnabled:member(1)'
- package: ExcelScript!
- fullName: getEnabled()
- summary: True if Excel will use iteration to resolve circular references.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getEnabled(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getMaxChange()
- uid: 'ExcelScript!ExcelScript.IterativeCalculation#getMaxChange:member(1)'
- package: ExcelScript!
- fullName: getMaxChange()
- summary: Specifies the maximum amount of change between each iteration as Excel resolves circular references.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMaxChange(): number;'
- return:
- type: number
- description: ''
- - name: getMaxIteration()
- uid: 'ExcelScript!ExcelScript.IterativeCalculation#getMaxIteration:member(1)'
- package: ExcelScript!
- fullName: getMaxIteration()
- summary: Specifies the maximum number of iterations that Excel can use to resolve a circular reference.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMaxIteration(): number;'
- return:
- type: number
- description: ''
- - name: setEnabled(enabled)
- uid: 'ExcelScript!ExcelScript.IterativeCalculation#setEnabled:member(1)'
- package: ExcelScript!
- fullName: setEnabled(enabled)
- summary: True if Excel will use iteration to resolve circular references.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setEnabled(enabled: boolean): void;'
- parameters:
- - id: enabled
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setMaxChange(maxChange)
- uid: 'ExcelScript!ExcelScript.IterativeCalculation#setMaxChange:member(1)'
- package: ExcelScript!
- fullName: setMaxChange(maxChange)
- summary: Specifies the maximum amount of change between each iteration as Excel resolves circular references.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMaxChange(maxChange: number): void;'
- parameters:
- - id: maxChange
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setMaxIteration(maxIteration)
- uid: 'ExcelScript!ExcelScript.IterativeCalculation#setMaxIteration:member(1)'
- package: ExcelScript!
- fullName: setMaxIteration(maxIteration)
- summary: Specifies the maximum number of iterations that Excel can use to resolve a circular reference.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMaxIteration(maxIteration: number): void;'
- parameters:
- - id: maxIteration
- description: ''
- type: number
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.IterativeCalculation
+uid: 'ExcelScript!ExcelScript.IterativeCalculation:interface'
+package: ExcelScript!
+fullName: ExcelScript.IterativeCalculation
+summary: Represents the iterative calculation settings.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getEnabled()
+ uid: 'ExcelScript!ExcelScript.IterativeCalculation#getEnabled:member(1)'
+ package: ExcelScript!
+ fullName: getEnabled()
+ summary: True if Excel will use iteration to resolve circular references.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getEnabled(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getMaxChange()
+ uid: 'ExcelScript!ExcelScript.IterativeCalculation#getMaxChange:member(1)'
+ package: ExcelScript!
+ fullName: getMaxChange()
+ summary: Specifies the maximum amount of change between each iteration as Excel resolves circular references.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMaxChange(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getMaxIteration()
+ uid: 'ExcelScript!ExcelScript.IterativeCalculation#getMaxIteration:member(1)'
+ package: ExcelScript!
+ fullName: getMaxIteration()
+ summary: Specifies the maximum number of iterations that Excel can use to resolve a circular reference.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMaxIteration(): number;'
+ return:
+ type: number
+ description: ''
+ - name: setEnabled(enabled)
+ uid: 'ExcelScript!ExcelScript.IterativeCalculation#setEnabled:member(1)'
+ package: ExcelScript!
+ fullName: setEnabled(enabled)
+ summary: True if Excel will use iteration to resolve circular references.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setEnabled(enabled: boolean): void;'
+ parameters:
+ - id: enabled
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setMaxChange(maxChange)
+ uid: 'ExcelScript!ExcelScript.IterativeCalculation#setMaxChange:member(1)'
+ package: ExcelScript!
+ fullName: setMaxChange(maxChange)
+ summary: Specifies the maximum amount of change between each iteration as Excel resolves circular references.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMaxChange(maxChange: number): void;'
+ parameters:
+ - id: maxChange
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setMaxIteration(maxIteration)
+ uid: 'ExcelScript!ExcelScript.IterativeCalculation#setMaxIteration:member(1)'
+ package: ExcelScript!
+ fullName: setMaxIteration(maxIteration)
+ summary: Specifies the maximum number of iterations that Excel can use to resolve a circular reference.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMaxIteration(maxIteration: number): void;'
+ parameters:
+ - id: maxIteration
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.keyboarddirection.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.keyboarddirection.yml
index 9a754bd4..23101eb8 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.keyboarddirection.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.keyboarddirection.yml
@@ -1,49 +1,49 @@
-### YamlMime:TSEnum
-name: ExcelScript.KeyboardDirection
-uid: 'ExcelScript!ExcelScript.KeyboardDirection:enum'
-package: ExcelScript!
-fullName: ExcelScript.KeyboardDirection
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script makes the font bold on all the contiguous cells between
- * A1 and the bottom of the used range of the first column.
- */
- function main(workbook: ExcelScript.Workbook)
- {
- // Get the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Get every cell that's used between A1 and the end of the column.
- // This recreates the Ctrl+Shift+Down arrow key behavior.
- let firstCell = selectedSheet.getRange("A1");
- let firstColumn = firstCell.getExtendedRange(ExcelScript.KeyboardDirection.down);
-
- // Set the font to bold in that range.
- firstColumn.getFormat().getFont().setBold(true);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: down
- uid: 'ExcelScript!ExcelScript.KeyboardDirection.down:member'
- package: ExcelScript!
- summary: ''
- - name: left
- uid: 'ExcelScript!ExcelScript.KeyboardDirection.left:member'
- package: ExcelScript!
- summary: ''
- - name: right
- uid: 'ExcelScript!ExcelScript.KeyboardDirection.right:member'
- package: ExcelScript!
- summary: ''
- - name: up
- uid: 'ExcelScript!ExcelScript.KeyboardDirection.up:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.KeyboardDirection
+uid: 'ExcelScript!ExcelScript.KeyboardDirection:enum'
+package: ExcelScript!
+fullName: ExcelScript.KeyboardDirection
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script makes the font bold on all the contiguous cells between
+ * A1 and the bottom of the used range of the first column.
+ */
+ function main(workbook: ExcelScript.Workbook)
+ {
+ // Get the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Get every cell that's used between A1 and the end of the column.
+ // This recreates the Ctrl+Shift+Down arrow key behavior.
+ let firstCell = selectedSheet.getRange("A1");
+ let firstColumn = firstCell.getExtendedRange(ExcelScript.KeyboardDirection.down);
+
+ // Set the font to bold in that range.
+ firstColumn.getFormat().getFont().setBold(true);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: down
+ uid: 'ExcelScript!ExcelScript.KeyboardDirection.down:member'
+ package: ExcelScript!
+ summary: ''
+ - name: left
+ uid: 'ExcelScript!ExcelScript.KeyboardDirection.left:member'
+ package: ExcelScript!
+ summary: ''
+ - name: right
+ uid: 'ExcelScript!ExcelScript.KeyboardDirection.right:member'
+ package: ExcelScript!
+ summary: ''
+ - name: up
+ uid: 'ExcelScript!ExcelScript.KeyboardDirection.up:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.labelfiltercondition.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.labelfiltercondition.yml
index 20474f9a..db73885e 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.labelfiltercondition.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.labelfiltercondition.yml
@@ -1,109 +1,109 @@
-### YamlMime:TSEnum
-name: ExcelScript.LabelFilterCondition
-uid: 'ExcelScript!ExcelScript.LabelFilterCondition:enum'
-package: ExcelScript!
-fullName: ExcelScript.LabelFilterCondition
-summary: >-
- 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.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script filters items that start with "L" from the "Type" field
- * of the "Farm Sales" PivotTable.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the PivotTable.
- const pivotTable = workbook.getActiveWorksheet().getPivotTable("Farm Sales");
-
- // Get the "Type" field.
- const field = pivotTable.getHierarchy("Type").getPivotField("Type");
-
- // Filter out any types that start with "L" (such as "Lemons" and "Limes").
- const filter: ExcelScript.PivotLabelFilter = {
- condition: ExcelScript.LabelFilterCondition.beginsWith,
- substring: "L",
- exclusive: true
- };
-
- // Apply the label filter to the field.
- field.applyFilter({ labelFilter: filter });
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: beginsWith
- uid: 'ExcelScript!ExcelScript.LabelFilterCondition.beginsWith:member'
- package: ExcelScript!
- summary: |-
- Label begins with substring criterion.
-
- Required Criteria: {`substring`}. Optional Criteria: {`exclusive`}.
- - name: between
- uid: 'ExcelScript!ExcelScript.LabelFilterCondition.between:member'
- package: ExcelScript!
- summary: >-
- Between `lowerBound` and `upperBound` criteria.
-
-
- Required Criteria: {`lowerBound`, `upperBound`}. Optional Criteria: {`exclusive`}.
- - name: contains
- uid: 'ExcelScript!ExcelScript.LabelFilterCondition.contains:member'
- package: ExcelScript!
- summary: |-
- Label contains substring criterion.
-
- Required Criteria: {`substring`}. Optional Criteria: {`exclusive`}.
- - name: endsWith
- uid: 'ExcelScript!ExcelScript.LabelFilterCondition.endsWith:member'
- package: ExcelScript!
- summary: |-
- Label ends with substring criterion.
-
- Required Criteria: {`substring`}. Optional Criteria: {`exclusive`}.
- - name: equals
- uid: 'ExcelScript!ExcelScript.LabelFilterCondition.equals:member'
- package: ExcelScript!
- summary: |-
- Equals comparator criterion.
-
- Required Criteria: {`comparator`}. Optional Criteria: {`exclusive`}.
- - name: greaterThan
- uid: 'ExcelScript!ExcelScript.LabelFilterCondition.greaterThan:member'
- package: ExcelScript!
- summary: |-
- Greater than comparator criterion.
-
- Required Criteria: {`comparator`}.
- - name: greaterThanOrEqualTo
- uid: 'ExcelScript!ExcelScript.LabelFilterCondition.greaterThanOrEqualTo:member'
- package: ExcelScript!
- summary: |-
- Greater than or equal to comparator criterion.
-
- Required Criteria: {`comparator`}.
- - name: lessThan
- uid: 'ExcelScript!ExcelScript.LabelFilterCondition.lessThan:member'
- package: ExcelScript!
- summary: |-
- Less than comparator criterion.
-
- Required Criteria: {`comparator`}.
- - name: lessThanOrEqualTo
- uid: 'ExcelScript!ExcelScript.LabelFilterCondition.lessThanOrEqualTo:member'
- package: ExcelScript!
- summary: |-
- Less than or equal to comparator criterion.
-
- Required Criteria: {`comparator`}.
- - name: unknown
- uid: 'ExcelScript!ExcelScript.LabelFilterCondition.unknown:member'
- package: ExcelScript!
- summary: '`LabelFilterCondition` is unknown or unsupported.'
+### YamlMime:TSEnum
+name: ExcelScript.LabelFilterCondition
+uid: 'ExcelScript!ExcelScript.LabelFilterCondition:enum'
+package: ExcelScript!
+fullName: ExcelScript.LabelFilterCondition
+summary: >-
+ 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.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script filters items that start with "L" from the "Type" field
+ * of the "Farm Sales" PivotTable.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the PivotTable.
+ const pivotTable = workbook.getActiveWorksheet().getPivotTable("Farm Sales");
+
+ // Get the "Type" field.
+ const field = pivotTable.getHierarchy("Type").getPivotField("Type");
+
+ // Filter out any types that start with "L" (such as "Lemons" and "Limes").
+ const filter: ExcelScript.PivotLabelFilter = {
+ condition: ExcelScript.LabelFilterCondition.beginsWith,
+ substring: "L",
+ exclusive: true
+ };
+
+ // Apply the label filter to the field.
+ field.applyFilter({ labelFilter: filter });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: beginsWith
+ uid: 'ExcelScript!ExcelScript.LabelFilterCondition.beginsWith:member'
+ package: ExcelScript!
+ summary: |-
+ Label begins with substring criterion.
+
+ Required Criteria: {`substring`}. Optional Criteria: {`exclusive`}.
+ - name: between
+ uid: 'ExcelScript!ExcelScript.LabelFilterCondition.between:member'
+ package: ExcelScript!
+ summary: >-
+ Between `lowerBound` and `upperBound` criteria.
+
+
+ Required Criteria: {`lowerBound`, `upperBound`}. Optional Criteria: {`exclusive`}.
+ - name: contains
+ uid: 'ExcelScript!ExcelScript.LabelFilterCondition.contains:member'
+ package: ExcelScript!
+ summary: |-
+ Label contains substring criterion.
+
+ Required Criteria: {`substring`}. Optional Criteria: {`exclusive`}.
+ - name: endsWith
+ uid: 'ExcelScript!ExcelScript.LabelFilterCondition.endsWith:member'
+ package: ExcelScript!
+ summary: |-
+ Label ends with substring criterion.
+
+ Required Criteria: {`substring`}. Optional Criteria: {`exclusive`}.
+ - name: equals
+ uid: 'ExcelScript!ExcelScript.LabelFilterCondition.equals:member'
+ package: ExcelScript!
+ summary: |-
+ Equals comparator criterion.
+
+ Required Criteria: {`comparator`}. Optional Criteria: {`exclusive`}.
+ - name: greaterThan
+ uid: 'ExcelScript!ExcelScript.LabelFilterCondition.greaterThan:member'
+ package: ExcelScript!
+ summary: |-
+ Greater than comparator criterion.
+
+ Required Criteria: {`comparator`}.
+ - name: greaterThanOrEqualTo
+ uid: 'ExcelScript!ExcelScript.LabelFilterCondition.greaterThanOrEqualTo:member'
+ package: ExcelScript!
+ summary: |-
+ Greater than or equal to comparator criterion.
+
+ Required Criteria: {`comparator`}.
+ - name: lessThan
+ uid: 'ExcelScript!ExcelScript.LabelFilterCondition.lessThan:member'
+ package: ExcelScript!
+ summary: |-
+ Less than comparator criterion.
+
+ Required Criteria: {`comparator`}.
+ - name: lessThanOrEqualTo
+ uid: 'ExcelScript!ExcelScript.LabelFilterCondition.lessThanOrEqualTo:member'
+ package: ExcelScript!
+ summary: |-
+ Less than or equal to comparator criterion.
+
+ Required Criteria: {`comparator`}.
+ - name: unknown
+ uid: 'ExcelScript!ExcelScript.LabelFilterCondition.unknown:member'
+ package: ExcelScript!
+ summary: '`LabelFilterCondition` is unknown or unsupported.'
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.line.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.line.yml
index 6bfbec80..a3206508 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.line.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.line.yml
@@ -1,399 +1,399 @@
-### YamlMime:TSType
-name: ExcelScript.Line
-uid: 'ExcelScript!ExcelScript.Line:interface'
-package: ExcelScript!
-fullName: ExcelScript.Line
-summary: 'Represents a line inside a worksheet. To get the corresponding `Shape` object, use `Line.shape`.'
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: 'connectBeginShape(shape, connectionSite)'
- uid: 'ExcelScript!ExcelScript.Line#connectBeginShape:member(1)'
- package: ExcelScript!
- fullName: 'connectBeginShape(shape, connectionSite)'
- summary: Attaches the beginning of the specified connector to a specified shape.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'connectBeginShape(shape: Shape, connectionSite: number): void;'
- parameters:
- - id: shape
- description: The shape to connect.
- type: ''
- - id: connectionSite
- description: >-
- The connection site on the shape to which the beginning of the connector is attached. Must be an integer
- between 0 (inclusive) and the connection-site count of the specified shape (exclusive).
- type: number
- return:
- type: void
- description: ''
- - name: 'connectEndShape(shape, connectionSite)'
- uid: 'ExcelScript!ExcelScript.Line#connectEndShape:member(1)'
- package: ExcelScript!
- fullName: 'connectEndShape(shape, connectionSite)'
- summary: Attaches the end of the specified connector to a specified shape.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'connectEndShape(shape: Shape, connectionSite: number): void;'
- parameters:
- - id: shape
- description: The shape to connect.
- type: ''
- - id: connectionSite
- description: >-
- The connection site on the shape to which the end of the connector is attached. Must be an integer between 0
- (inclusive) and the connection-site count of the specified shape (exclusive).
- type: number
- return:
- type: void
- description: ''
- - name: disconnectBeginShape()
- uid: 'ExcelScript!ExcelScript.Line#disconnectBeginShape:member(1)'
- package: ExcelScript!
- fullName: disconnectBeginShape()
- summary: Detaches the beginning of the specified connector from a shape.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'disconnectBeginShape(): void;'
- return:
- type: void
- description: ''
- - name: disconnectEndShape()
- uid: 'ExcelScript!ExcelScript.Line#disconnectEndShape:member(1)'
- package: ExcelScript!
- fullName: disconnectEndShape()
- summary: Detaches the end of the specified connector from a shape.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'disconnectEndShape(): void;'
- return:
- type: void
- description: ''
- - name: getBeginArrowheadLength()
- uid: 'ExcelScript!ExcelScript.Line#getBeginArrowheadLength:member(1)'
- package: ExcelScript!
- fullName: getBeginArrowheadLength()
- summary: Represents the length of the arrowhead at the beginning of the specified line.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBeginArrowheadLength(): ArrowheadLength;'
- return:
- type: ''
- description: ''
- - name: getBeginArrowheadStyle()
- uid: 'ExcelScript!ExcelScript.Line#getBeginArrowheadStyle:member(1)'
- package: ExcelScript!
- fullName: getBeginArrowheadStyle()
- summary: Represents the style of the arrowhead at the beginning of the specified line.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBeginArrowheadStyle(): ArrowheadStyle;'
- return:
- type: ''
- description: ''
- - name: getBeginArrowheadWidth()
- uid: 'ExcelScript!ExcelScript.Line#getBeginArrowheadWidth:member(1)'
- package: ExcelScript!
- fullName: getBeginArrowheadWidth()
- summary: Represents the width of the arrowhead at the beginning of the specified line.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBeginArrowheadWidth(): ArrowheadWidth;'
- return:
- type: ''
- description: ''
- - name: getBeginConnectedShape()
- uid: 'ExcelScript!ExcelScript.Line#getBeginConnectedShape:member(1)'
- package: ExcelScript!
- fullName: getBeginConnectedShape()
- summary: Represents the shape to which the beginning of the specified line is attached.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBeginConnectedShape(): Shape;'
- return:
- type: ''
- description: ''
- - name: getBeginConnectedSite()
- uid: 'ExcelScript!ExcelScript.Line#getBeginConnectedSite:member(1)'
- package: ExcelScript!
- fullName: getBeginConnectedSite()
- summary: >-
- Represents the connection site to which the beginning of a connector is connected. Returns `null` when the
- beginning of the line is not attached to any shape.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBeginConnectedSite(): number;'
- return:
- type: number
- description: ''
- - name: getConnectorType()
- uid: 'ExcelScript!ExcelScript.Line#getConnectorType:member(1)'
- package: ExcelScript!
- fullName: getConnectorType()
- summary: Represents the connector type for the line.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getConnectorType(): ConnectorType;'
- return:
- type: ''
- description: ''
- - name: getEndArrowheadLength()
- uid: 'ExcelScript!ExcelScript.Line#getEndArrowheadLength:member(1)'
- package: ExcelScript!
- fullName: getEndArrowheadLength()
- summary: Represents the length of the arrowhead at the end of the specified line.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getEndArrowheadLength(): ArrowheadLength;'
- return:
- type: ''
- description: ''
- - name: getEndArrowheadStyle()
- uid: 'ExcelScript!ExcelScript.Line#getEndArrowheadStyle:member(1)'
- package: ExcelScript!
- fullName: getEndArrowheadStyle()
- summary: Represents the style of the arrowhead at the end of the specified line.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getEndArrowheadStyle(): ArrowheadStyle;'
- return:
- type: ''
- description: ''
- - name: getEndArrowheadWidth()
- uid: 'ExcelScript!ExcelScript.Line#getEndArrowheadWidth:member(1)'
- package: ExcelScript!
- fullName: getEndArrowheadWidth()
- summary: Represents the width of the arrowhead at the end of the specified line.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getEndArrowheadWidth(): ArrowheadWidth;'
- return:
- type: ''
- description: ''
- - name: getEndConnectedShape()
- uid: 'ExcelScript!ExcelScript.Line#getEndConnectedShape:member(1)'
- package: ExcelScript!
- fullName: getEndConnectedShape()
- summary: Represents the shape to which the end of the specified line is attached.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getEndConnectedShape(): Shape;'
- return:
- type: ''
- description: ''
- - name: getEndConnectedSite()
- uid: 'ExcelScript!ExcelScript.Line#getEndConnectedSite:member(1)'
- package: ExcelScript!
- fullName: getEndConnectedSite()
- summary: >-
- Represents the connection site to which the end of a connector is connected. Returns `null` when the end of the
- line is not attached to any shape.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getEndConnectedSite(): number;'
- return:
- type: number
- description: ''
- - name: getId()
- uid: 'ExcelScript!ExcelScript.Line#getId:member(1)'
- package: ExcelScript!
- fullName: getId()
- summary: Specifies the shape identifier.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getId(): string;'
- return:
- type: string
- description: ''
- - name: getIsBeginConnected()
- uid: 'ExcelScript!ExcelScript.Line#getIsBeginConnected:member(1)'
- package: ExcelScript!
- fullName: getIsBeginConnected()
- summary: Specifies if the beginning of the specified line is connected to a shape.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIsBeginConnected(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getIsEndConnected()
- uid: 'ExcelScript!ExcelScript.Line#getIsEndConnected:member(1)'
- package: ExcelScript!
- fullName: getIsEndConnected()
- summary: Specifies if the end of the specified line is connected to a shape.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIsEndConnected(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShape()
- uid: 'ExcelScript!ExcelScript.Line#getShape:member(1)'
- package: ExcelScript!
- fullName: getShape()
- summary: Returns the `Shape` object associated with the line.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShape(): Shape;'
- return:
- type: ''
- description: ''
- - name: setBeginArrowheadLength(beginArrowheadLength)
- uid: 'ExcelScript!ExcelScript.Line#setBeginArrowheadLength:member(1)'
- package: ExcelScript!
- fullName: setBeginArrowheadLength(beginArrowheadLength)
- summary: Represents the length of the arrowhead at the beginning of the specified line.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setBeginArrowheadLength(beginArrowheadLength: ArrowheadLength): void;'
- parameters:
- - id: beginArrowheadLength
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setBeginArrowheadStyle(beginArrowheadStyle)
- uid: 'ExcelScript!ExcelScript.Line#setBeginArrowheadStyle:member(1)'
- package: ExcelScript!
- fullName: setBeginArrowheadStyle(beginArrowheadStyle)
- summary: Represents the style of the arrowhead at the beginning of the specified line.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setBeginArrowheadStyle(beginArrowheadStyle: ArrowheadStyle): void;'
- parameters:
- - id: beginArrowheadStyle
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setBeginArrowheadWidth(beginArrowheadWidth)
- uid: 'ExcelScript!ExcelScript.Line#setBeginArrowheadWidth:member(1)'
- package: ExcelScript!
- fullName: setBeginArrowheadWidth(beginArrowheadWidth)
- summary: Represents the width of the arrowhead at the beginning of the specified line.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setBeginArrowheadWidth(beginArrowheadWidth: ArrowheadWidth): void;'
- parameters:
- - id: beginArrowheadWidth
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setConnectorType(connectorType)
- uid: 'ExcelScript!ExcelScript.Line#setConnectorType:member(1)'
- package: ExcelScript!
- fullName: setConnectorType(connectorType)
- summary: Represents the connector type for the line.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setConnectorType(connectorType: ConnectorType): void;'
- parameters:
- - id: connectorType
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setEndArrowheadLength(endArrowheadLength)
- uid: 'ExcelScript!ExcelScript.Line#setEndArrowheadLength:member(1)'
- package: ExcelScript!
- fullName: setEndArrowheadLength(endArrowheadLength)
- summary: Represents the length of the arrowhead at the end of the specified line.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setEndArrowheadLength(endArrowheadLength: ArrowheadLength): void;'
- parameters:
- - id: endArrowheadLength
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setEndArrowheadStyle(endArrowheadStyle)
- uid: 'ExcelScript!ExcelScript.Line#setEndArrowheadStyle:member(1)'
- package: ExcelScript!
- fullName: setEndArrowheadStyle(endArrowheadStyle)
- summary: Represents the style of the arrowhead at the end of the specified line.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setEndArrowheadStyle(endArrowheadStyle: ArrowheadStyle): void;'
- parameters:
- - id: endArrowheadStyle
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setEndArrowheadWidth(endArrowheadWidth)
- uid: 'ExcelScript!ExcelScript.Line#setEndArrowheadWidth:member(1)'
- package: ExcelScript!
- fullName: setEndArrowheadWidth(endArrowheadWidth)
- summary: Represents the width of the arrowhead at the end of the specified line.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setEndArrowheadWidth(endArrowheadWidth: ArrowheadWidth): void;'
- parameters:
- - id: endArrowheadWidth
- description: ''
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.Line
+uid: 'ExcelScript!ExcelScript.Line:interface'
+package: ExcelScript!
+fullName: ExcelScript.Line
+summary: 'Represents a line inside a worksheet. To get the corresponding `Shape` object, use `Line.shape`.'
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: 'connectBeginShape(shape, connectionSite)'
+ uid: 'ExcelScript!ExcelScript.Line#connectBeginShape:member(1)'
+ package: ExcelScript!
+ fullName: 'connectBeginShape(shape, connectionSite)'
+ summary: Attaches the beginning of the specified connector to a specified shape.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'connectBeginShape(shape: Shape, connectionSite: number): void;'
+ parameters:
+ - id: shape
+ description: The shape to connect.
+ type: ''
+ - id: connectionSite
+ description: >-
+ The connection site on the shape to which the beginning of the connector is attached. Must be an integer
+ between 0 (inclusive) and the connection-site count of the specified shape (exclusive).
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: 'connectEndShape(shape, connectionSite)'
+ uid: 'ExcelScript!ExcelScript.Line#connectEndShape:member(1)'
+ package: ExcelScript!
+ fullName: 'connectEndShape(shape, connectionSite)'
+ summary: Attaches the end of the specified connector to a specified shape.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'connectEndShape(shape: Shape, connectionSite: number): void;'
+ parameters:
+ - id: shape
+ description: The shape to connect.
+ type: ''
+ - id: connectionSite
+ description: >-
+ The connection site on the shape to which the end of the connector is attached. Must be an integer between 0
+ (inclusive) and the connection-site count of the specified shape (exclusive).
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: disconnectBeginShape()
+ uid: 'ExcelScript!ExcelScript.Line#disconnectBeginShape:member(1)'
+ package: ExcelScript!
+ fullName: disconnectBeginShape()
+ summary: Detaches the beginning of the specified connector from a shape.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'disconnectBeginShape(): void;'
+ return:
+ type: void
+ description: ''
+ - name: disconnectEndShape()
+ uid: 'ExcelScript!ExcelScript.Line#disconnectEndShape:member(1)'
+ package: ExcelScript!
+ fullName: disconnectEndShape()
+ summary: Detaches the end of the specified connector from a shape.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'disconnectEndShape(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getBeginArrowheadLength()
+ uid: 'ExcelScript!ExcelScript.Line#getBeginArrowheadLength:member(1)'
+ package: ExcelScript!
+ fullName: getBeginArrowheadLength()
+ summary: Represents the length of the arrowhead at the beginning of the specified line.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBeginArrowheadLength(): ArrowheadLength;'
+ return:
+ type: ''
+ description: ''
+ - name: getBeginArrowheadStyle()
+ uid: 'ExcelScript!ExcelScript.Line#getBeginArrowheadStyle:member(1)'
+ package: ExcelScript!
+ fullName: getBeginArrowheadStyle()
+ summary: Represents the style of the arrowhead at the beginning of the specified line.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBeginArrowheadStyle(): ArrowheadStyle;'
+ return:
+ type: ''
+ description: ''
+ - name: getBeginArrowheadWidth()
+ uid: 'ExcelScript!ExcelScript.Line#getBeginArrowheadWidth:member(1)'
+ package: ExcelScript!
+ fullName: getBeginArrowheadWidth()
+ summary: Represents the width of the arrowhead at the beginning of the specified line.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBeginArrowheadWidth(): ArrowheadWidth;'
+ return:
+ type: ''
+ description: ''
+ - name: getBeginConnectedShape()
+ uid: 'ExcelScript!ExcelScript.Line#getBeginConnectedShape:member(1)'
+ package: ExcelScript!
+ fullName: getBeginConnectedShape()
+ summary: Represents the shape to which the beginning of the specified line is attached.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBeginConnectedShape(): Shape;'
+ return:
+ type: ''
+ description: ''
+ - name: getBeginConnectedSite()
+ uid: 'ExcelScript!ExcelScript.Line#getBeginConnectedSite:member(1)'
+ package: ExcelScript!
+ fullName: getBeginConnectedSite()
+ summary: >-
+ Represents the connection site to which the beginning of a connector is connected. Returns `null` when the
+ beginning of the line is not attached to any shape.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBeginConnectedSite(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getConnectorType()
+ uid: 'ExcelScript!ExcelScript.Line#getConnectorType:member(1)'
+ package: ExcelScript!
+ fullName: getConnectorType()
+ summary: Represents the connector type for the line.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getConnectorType(): ConnectorType;'
+ return:
+ type: ''
+ description: ''
+ - name: getEndArrowheadLength()
+ uid: 'ExcelScript!ExcelScript.Line#getEndArrowheadLength:member(1)'
+ package: ExcelScript!
+ fullName: getEndArrowheadLength()
+ summary: Represents the length of the arrowhead at the end of the specified line.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getEndArrowheadLength(): ArrowheadLength;'
+ return:
+ type: ''
+ description: ''
+ - name: getEndArrowheadStyle()
+ uid: 'ExcelScript!ExcelScript.Line#getEndArrowheadStyle:member(1)'
+ package: ExcelScript!
+ fullName: getEndArrowheadStyle()
+ summary: Represents the style of the arrowhead at the end of the specified line.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getEndArrowheadStyle(): ArrowheadStyle;'
+ return:
+ type: ''
+ description: ''
+ - name: getEndArrowheadWidth()
+ uid: 'ExcelScript!ExcelScript.Line#getEndArrowheadWidth:member(1)'
+ package: ExcelScript!
+ fullName: getEndArrowheadWidth()
+ summary: Represents the width of the arrowhead at the end of the specified line.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getEndArrowheadWidth(): ArrowheadWidth;'
+ return:
+ type: ''
+ description: ''
+ - name: getEndConnectedShape()
+ uid: 'ExcelScript!ExcelScript.Line#getEndConnectedShape:member(1)'
+ package: ExcelScript!
+ fullName: getEndConnectedShape()
+ summary: Represents the shape to which the end of the specified line is attached.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getEndConnectedShape(): Shape;'
+ return:
+ type: ''
+ description: ''
+ - name: getEndConnectedSite()
+ uid: 'ExcelScript!ExcelScript.Line#getEndConnectedSite:member(1)'
+ package: ExcelScript!
+ fullName: getEndConnectedSite()
+ summary: >-
+ Represents the connection site to which the end of a connector is connected. Returns `null` when the end of the
+ line is not attached to any shape.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getEndConnectedSite(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getId()
+ uid: 'ExcelScript!ExcelScript.Line#getId:member(1)'
+ package: ExcelScript!
+ fullName: getId()
+ summary: Specifies the shape identifier.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getId(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getIsBeginConnected()
+ uid: 'ExcelScript!ExcelScript.Line#getIsBeginConnected:member(1)'
+ package: ExcelScript!
+ fullName: getIsBeginConnected()
+ summary: Specifies if the beginning of the specified line is connected to a shape.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIsBeginConnected(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getIsEndConnected()
+ uid: 'ExcelScript!ExcelScript.Line#getIsEndConnected:member(1)'
+ package: ExcelScript!
+ fullName: getIsEndConnected()
+ summary: Specifies if the end of the specified line is connected to a shape.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIsEndConnected(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShape()
+ uid: 'ExcelScript!ExcelScript.Line#getShape:member(1)'
+ package: ExcelScript!
+ fullName: getShape()
+ summary: Returns the `Shape` object associated with the line.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShape(): Shape;'
+ return:
+ type: ''
+ description: ''
+ - name: setBeginArrowheadLength(beginArrowheadLength)
+ uid: 'ExcelScript!ExcelScript.Line#setBeginArrowheadLength:member(1)'
+ package: ExcelScript!
+ fullName: setBeginArrowheadLength(beginArrowheadLength)
+ summary: Represents the length of the arrowhead at the beginning of the specified line.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setBeginArrowheadLength(beginArrowheadLength: ArrowheadLength): void;'
+ parameters:
+ - id: beginArrowheadLength
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setBeginArrowheadStyle(beginArrowheadStyle)
+ uid: 'ExcelScript!ExcelScript.Line#setBeginArrowheadStyle:member(1)'
+ package: ExcelScript!
+ fullName: setBeginArrowheadStyle(beginArrowheadStyle)
+ summary: Represents the style of the arrowhead at the beginning of the specified line.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setBeginArrowheadStyle(beginArrowheadStyle: ArrowheadStyle): void;'
+ parameters:
+ - id: beginArrowheadStyle
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setBeginArrowheadWidth(beginArrowheadWidth)
+ uid: 'ExcelScript!ExcelScript.Line#setBeginArrowheadWidth:member(1)'
+ package: ExcelScript!
+ fullName: setBeginArrowheadWidth(beginArrowheadWidth)
+ summary: Represents the width of the arrowhead at the beginning of the specified line.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setBeginArrowheadWidth(beginArrowheadWidth: ArrowheadWidth): void;'
+ parameters:
+ - id: beginArrowheadWidth
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setConnectorType(connectorType)
+ uid: 'ExcelScript!ExcelScript.Line#setConnectorType:member(1)'
+ package: ExcelScript!
+ fullName: setConnectorType(connectorType)
+ summary: Represents the connector type for the line.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setConnectorType(connectorType: ConnectorType): void;'
+ parameters:
+ - id: connectorType
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setEndArrowheadLength(endArrowheadLength)
+ uid: 'ExcelScript!ExcelScript.Line#setEndArrowheadLength:member(1)'
+ package: ExcelScript!
+ fullName: setEndArrowheadLength(endArrowheadLength)
+ summary: Represents the length of the arrowhead at the end of the specified line.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setEndArrowheadLength(endArrowheadLength: ArrowheadLength): void;'
+ parameters:
+ - id: endArrowheadLength
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setEndArrowheadStyle(endArrowheadStyle)
+ uid: 'ExcelScript!ExcelScript.Line#setEndArrowheadStyle:member(1)'
+ package: ExcelScript!
+ fullName: setEndArrowheadStyle(endArrowheadStyle)
+ summary: Represents the style of the arrowhead at the end of the specified line.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setEndArrowheadStyle(endArrowheadStyle: ArrowheadStyle): void;'
+ parameters:
+ - id: endArrowheadStyle
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setEndArrowheadWidth(endArrowheadWidth)
+ uid: 'ExcelScript!ExcelScript.Line#setEndArrowheadWidth:member(1)'
+ package: ExcelScript!
+ fullName: setEndArrowheadWidth(endArrowheadWidth)
+ summary: Represents the width of the arrowhead at the end of the specified line.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setEndArrowheadWidth(endArrowheadWidth: ArrowheadWidth): void;'
+ parameters:
+ - id: endArrowheadWidth
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.linkeddatatypestate.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.linkeddatatypestate.yml
index 1361e754..f1133cb3 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.linkeddatatypestate.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.linkeddatatypestate.yml
@@ -1,30 +1,30 @@
-### YamlMime:TSEnum
-name: ExcelScript.LinkedDataTypeState
-uid: 'ExcelScript!ExcelScript.LinkedDataTypeState:enum'
-package: ExcelScript!
-fullName: ExcelScript.LinkedDataTypeState
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: brokenLinkedData
- uid: 'ExcelScript!ExcelScript.LinkedDataTypeState.brokenLinkedData:member'
- package: ExcelScript!
- summary: ''
- - name: disambiguationNeeded
- uid: 'ExcelScript!ExcelScript.LinkedDataTypeState.disambiguationNeeded:member'
- package: ExcelScript!
- summary: ''
- - name: fetchingData
- uid: 'ExcelScript!ExcelScript.LinkedDataTypeState.fetchingData:member'
- package: ExcelScript!
- summary: ''
- - name: none
- uid: 'ExcelScript!ExcelScript.LinkedDataTypeState.none:member'
- package: ExcelScript!
- summary: ''
- - name: validLinkedData
- uid: 'ExcelScript!ExcelScript.LinkedDataTypeState.validLinkedData:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.LinkedDataTypeState
+uid: 'ExcelScript!ExcelScript.LinkedDataTypeState:enum'
+package: ExcelScript!
+fullName: ExcelScript.LinkedDataTypeState
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: brokenLinkedData
+ uid: 'ExcelScript!ExcelScript.LinkedDataTypeState.brokenLinkedData:member'
+ package: ExcelScript!
+ summary: ''
+ - name: disambiguationNeeded
+ uid: 'ExcelScript!ExcelScript.LinkedDataTypeState.disambiguationNeeded:member'
+ package: ExcelScript!
+ summary: ''
+ - name: fetchingData
+ uid: 'ExcelScript!ExcelScript.LinkedDataTypeState.fetchingData:member'
+ package: ExcelScript!
+ summary: ''
+ - name: none
+ uid: 'ExcelScript!ExcelScript.LinkedDataTypeState.none:member'
+ package: ExcelScript!
+ summary: ''
+ - name: validLinkedData
+ uid: 'ExcelScript!ExcelScript.LinkedDataTypeState.validLinkedData:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.linkedworkbook.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.linkedworkbook.yml
index 9dbdc23b..ebf7f8a2 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.linkedworkbook.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.linkedworkbook.yml
@@ -1,62 +1,75 @@
-### YamlMime:TSType
-name: ExcelScript.LinkedWorkbook
-uid: 'ExcelScript!ExcelScript.LinkedWorkbook:interface'
-package: ExcelScript!
-fullName: ExcelScript.LinkedWorkbook
-summary: >-
- 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".
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: breakLinks()
- uid: 'ExcelScript!ExcelScript.LinkedWorkbook#breakLinks:member(1)'
- package: ExcelScript!
- fullName: breakLinks()
- summary: >-
- Makes a request to break the links pointing to the linked workbook. Links in formulas are replaced with the latest
- fetched data. The current `LinkedWorkbook` object is invalidated and removed from `LinkedWorkbookCollection`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'breakLinks(): void;'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script removes all links to other workbooks.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get all the linked workbook references.
- const externalWorkbooks: ExcelScript.LinkedWorkbook[] = workbook.getLinkedWorkbooks();
- console.log(`There are ${externalWorkbooks.length} other workbooks linked to from this workbook.`);
-
- // Remove all the links to those workbooks.
- // This changes the value of cells with workbook links to "#CONNECT!".
- externalWorkbooks.forEach((workbookLink) => {
- workbookLink.breakLinks();
- });
- }
- ```
- - name: refreshLinks()
- uid: 'ExcelScript!ExcelScript.LinkedWorkbook#refreshLinks:member(1)'
- package: ExcelScript!
- fullName: refreshLinks()
- summary: Makes a request to refresh the data retrieved from the linked workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'refreshLinks(): void;'
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.LinkedWorkbook
+uid: 'ExcelScript!ExcelScript.LinkedWorkbook:interface'
+package: ExcelScript!
+fullName: ExcelScript.LinkedWorkbook
+summary: >-
+ 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".
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: breakLinks()
+ uid: 'ExcelScript!ExcelScript.LinkedWorkbook#breakLinks:member(1)'
+ package: ExcelScript!
+ fullName: breakLinks()
+ summary: >-
+ Makes a request to break the links pointing to the linked workbook. Links in formulas are replaced with the latest
+ fetched data. The current `LinkedWorkbook` object is invalidated and removed from `LinkedWorkbookCollection`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'breakLinks(): void;'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script removes all links to other workbooks.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get all the linked workbook references.
+ const externalWorkbooks: ExcelScript.LinkedWorkbook[] = workbook.getLinkedWorkbooks();
+ console.log(`There are ${externalWorkbooks.length} other workbooks linked to from this workbook.`);
+
+ // Remove all the links to those workbooks.
+ // This changes the value of cells with workbook links to "#CONNECT!".
+ externalWorkbooks.forEach((workbookLink) => {
+ workbookLink.breakLinks();
+ });
+ }
+ ```
+ - name: getId()
+ uid: 'ExcelScript!ExcelScript.LinkedWorkbook#getId:member(1)'
+ package: ExcelScript!
+ fullName: getId()
+ summary: The original URL pointing to the linked workbook. It is unique across all linked workbooks in the collection.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getId(): string;'
+ return:
+ type: string
+ description: ''
+ - name: refreshLinks()
+ uid: 'ExcelScript!ExcelScript.LinkedWorkbook#refreshLinks:member(1)'
+ package: ExcelScript!
+ fullName: refreshLinks()
+ summary: Makes a request to refresh the data retrieved from the linked workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'refreshLinks(): void;'
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.listdatavalidation.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.listdatavalidation.yml
index 501abe7e..098c3a63 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.listdatavalidation.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.listdatavalidation.yml
@@ -1,77 +1,77 @@
-### YamlMime:TSType
-name: ExcelScript.ListDataValidation
-uid: 'ExcelScript!ExcelScript.ListDataValidation:interface'
-package: ExcelScript!
-fullName: ExcelScript.ListDataValidation
-summary: Represents the List data validation criteria.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a dropdown selection list for a cell.
- * It uses the existing values of the selected range as the choices for the list.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the values for data validation.
- const selectedRange = workbook.getSelectedRange();
- const rangeValues = selectedRange.getValues();
-
- // Convert the values into a comma-delimited string.
- let dataValidationListString = "";
- rangeValues.forEach((rangeValueRow) => {
- rangeValueRow.forEach((value) => {
- dataValidationListString += value + ",";
- });
- });
-
- // Clear the old range.
- selectedRange.clear(ExcelScript.ClearApplyTo.contents);
-
- // Apply the data validation to the first cell in the selected range.
- const targetCell = selectedRange.getCell(0, 0);
- const dataValidation = targetCell.getDataValidation();
-
- // Set the content of the dropdown list.
- let validationCriteria : ExcelScript.ListDataValidation = {
- inCellDropDown: true,
- source: dataValidationListString
- };
- let validationRule: ExcelScript.DataValidationRule = {
- list: validationCriteria
- };
- dataValidation.setRule(validationRule);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: inCellDropDown
- uid: 'ExcelScript!ExcelScript.ListDataValidation#inCellDropDown:member'
- package: ExcelScript!
- fullName: inCellDropDown
- summary: Specifies whether to display the list in a cell drop-down. The default is `true`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'inCellDropDown: boolean;'
- return:
- type: boolean
- - name: source
- uid: 'ExcelScript!ExcelScript.ListDataValidation#source:member'
- package: ExcelScript!
- fullName: source
- summary: >-
- Source of the list for data validation When setting the value, it can be passed in as a `Range` object, or a
- string that contains a comma-separated number, boolean, or date.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'source: string | Range;'
- return:
- type: 'string | '
+### YamlMime:TSType
+name: ExcelScript.ListDataValidation
+uid: 'ExcelScript!ExcelScript.ListDataValidation:interface'
+package: ExcelScript!
+fullName: ExcelScript.ListDataValidation
+summary: Represents the List data validation criteria.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a dropdown selection list for a cell.
+ * It uses the existing values of the selected range as the choices for the list.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the values for data validation.
+ const selectedRange = workbook.getSelectedRange();
+ const rangeValues = selectedRange.getValues();
+
+ // Convert the values into a comma-delimited string.
+ let dataValidationListString = "";
+ rangeValues.forEach((rangeValueRow) => {
+ rangeValueRow.forEach((value) => {
+ dataValidationListString += value + ",";
+ });
+ });
+
+ // Clear the old range.
+ selectedRange.clear(ExcelScript.ClearApplyTo.contents);
+
+ // Apply the data validation to the first cell in the selected range.
+ const targetCell = selectedRange.getCell(0, 0);
+ const dataValidation = targetCell.getDataValidation();
+
+ // Set the content of the dropdown list.
+ let validationCriteria : ExcelScript.ListDataValidation = {
+ inCellDropDown: true,
+ source: dataValidationListString
+ };
+ let validationRule: ExcelScript.DataValidationRule = {
+ list: validationCriteria
+ };
+ dataValidation.setRule(validationRule);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: inCellDropDown
+ uid: 'ExcelScript!ExcelScript.ListDataValidation#inCellDropDown:member'
+ package: ExcelScript!
+ fullName: inCellDropDown
+ summary: Specifies whether to display the list in a cell drop-down. The default is `true`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'inCellDropDown: boolean;'
+ return:
+ type: boolean
+ - name: source
+ uid: 'ExcelScript!ExcelScript.ListDataValidation#source:member'
+ package: ExcelScript!
+ fullName: source
+ summary: >-
+ Source of the list for data validation When setting the value, it can be passed in as a `Range` object, or a
+ string that contains a comma-separated number, boolean, or date.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'source: string | Range;'
+ return:
+ type: 'string | '
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.loadtotype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.loadtotype.yml
index 7e747663..a41e5e68 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.loadtotype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.loadtotype.yml
@@ -1,26 +1,26 @@
-### YamlMime:TSEnum
-name: ExcelScript.LoadToType
-uid: 'ExcelScript!ExcelScript.LoadToType:enum'
-package: ExcelScript!
-fullName: ExcelScript.LoadToType
-summary: An enum that specifies the query load to destination.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: connectionOnly
- uid: 'ExcelScript!ExcelScript.LoadToType.connectionOnly:member'
- package: ExcelScript!
- summary: Load to connection only.
- - name: pivotChart
- uid: 'ExcelScript!ExcelScript.LoadToType.pivotChart:member'
- package: ExcelScript!
- summary: Load to PivotChart.
- - name: pivotTable
- uid: 'ExcelScript!ExcelScript.LoadToType.pivotTable:member'
- package: ExcelScript!
- summary: Load to PivotTable.
- - name: table
- uid: 'ExcelScript!ExcelScript.LoadToType.table:member'
- package: ExcelScript!
- summary: Load to a table.
+### YamlMime:TSEnum
+name: ExcelScript.LoadToType
+uid: 'ExcelScript!ExcelScript.LoadToType:enum'
+package: ExcelScript!
+fullName: ExcelScript.LoadToType
+summary: An enum that specifies the query load to destination.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: connectionOnly
+ uid: 'ExcelScript!ExcelScript.LoadToType.connectionOnly:member'
+ package: ExcelScript!
+ summary: Load to connection only.
+ - name: pivotChart
+ uid: 'ExcelScript!ExcelScript.LoadToType.pivotChart:member'
+ package: ExcelScript!
+ summary: Load to PivotChart.
+ - name: pivotTable
+ uid: 'ExcelScript!ExcelScript.LoadToType.pivotTable:member'
+ package: ExcelScript!
+ summary: Load to PivotTable.
+ - name: table
+ uid: 'ExcelScript!ExcelScript.LoadToType.table:member'
+ package: ExcelScript!
+ summary: Load to a table.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.mixedcellcontrol.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.mixedcellcontrol.yml
new file mode 100644
index 00000000..711233e9
--- /dev/null
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.mixedcellcontrol.yml
@@ -0,0 +1,25 @@
+### YamlMime:TSType
+name: ExcelScript.MixedCellControl
+uid: 'ExcelScript!ExcelScript.MixedCellControl:interface'
+package: ExcelScript!
+fullName: ExcelScript.MixedCellControl
+summary: >-
+ Represents the result of a query that resulted in multiple cell controls. If the result has multiple controls, then
+ they can't be represented as a single result.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: type
+ uid: 'ExcelScript!ExcelScript.MixedCellControl#type:member'
+ package: ExcelScript!
+ fullName: type
+ summary: ''
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'type: CellControlType.mixed;'
+ return:
+ type: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.nameditem.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.nameditem.yml
index 5e6810d0..7ced2181 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.nameditem.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.nameditem.yml
@@ -1,264 +1,264 @@
-### YamlMime:TSType
-name: ExcelScript.NamedItem
-uid: 'ExcelScript!ExcelScript.NamedItem:interface'
-package: ExcelScript!
-fullName: ExcelScript.NamedItem
-summary: >-
- 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.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a named formula and uses it in another part of the workbook.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Create a named item for a formula.
- // This formula is the sum of the cells F2:F21 on Sheet1.
- const namedItem: ExcelScript.NamedItem = workbook.addNamedItem(
- "GrandTotal",
- "=SUM(Sheet1!$F$2:$F$21)",
- "The sum of table sums."
- );
-
- // Add this named formula to a new sheet in the workbook.
- const otherSheet = workbook.addWorksheet();
- otherSheet.getRange("A1").setFormula(namedItem.getFormula());
-
- // Switch to the new worksheet.
- otherSheet.activate();
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: delete()
- uid: 'ExcelScript!ExcelScript.NamedItem#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: Deletes the given name.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: ''
- - name: getArrayValues()
- uid: 'ExcelScript!ExcelScript.NamedItem#getArrayValues:member(1)'
- package: ExcelScript!
- fullName: getArrayValues()
- summary: Returns an object containing values and types of the named item.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getArrayValues(): NamedItemArrayValues;'
- return:
- type: ''
- description: ''
- - name: getComment()
- uid: 'ExcelScript!ExcelScript.NamedItem#getComment:member(1)'
- package: ExcelScript!
- fullName: getComment()
- summary: Specifies the comment associated with this name.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getComment(): string;'
- return:
- type: string
- description: ''
- - name: getFormula()
- uid: 'ExcelScript!ExcelScript.NamedItem#getFormula:member(1)'
- package: ExcelScript!
- fullName: getFormula()
- summary: The formula of the named item. Formulas always start with an equal sign ("=").
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormula(): string;'
- return:
- type: string
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.NamedItem#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: The name of the object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: getRange()
- uid: 'ExcelScript!ExcelScript.NamedItem#getRange:member(1)'
- package: ExcelScript!
- fullName: getRange()
- summary: >-
- Returns the range object that is associated with the name. If the named item's type is not a range, then this
- method returns `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRange(): Range;'
- return:
- type: ''
- description: ''
- - name: getScope()
- uid: 'ExcelScript!ExcelScript.NamedItem#getScope:member(1)'
- package: ExcelScript!
- fullName: getScope()
- summary: >-
- Specifies if the name is scoped to the workbook or to a specific worksheet. Possible values are: Worksheet,
- Workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getScope(): NamedItemScope;'
- return:
- type: ''
- description: ''
- - name: getType()
- uid: 'ExcelScript!ExcelScript.NamedItem#getType:member(1)'
- package: ExcelScript!
- fullName: getType()
- summary: Specifies the type of the value returned by the name's formula. See `ExcelScript.NamedItemType` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getType(): NamedItemType;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script looks for every named range with "Review" in the name
- * and marks the range with a yellow fill.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Look at every named item in the workbook.
- workbook.getNames().forEach((namedItem) => {
- // Find names containing "Review".
- if (namedItem.getName().includes("Review")) {
- // Only change the fill color if the named item is a range (not a formula).
- let itemType: ExcelScript.NamedItemType = namedItem.getType();
- if (itemType === ExcelScript.NamedItemType.range) {
- // Set the range's fill color to yellow.
- namedItem.getRange().getFormat().getFill().setColor("yellow");
- }
- }
- });
- }
- ```
- - name: getValue()
- uid: 'ExcelScript!ExcelScript.NamedItem#getValue:member(1)'
- package: ExcelScript!
- fullName: getValue()
- summary: >-
- Represents the value computed by the name's formula. For a named range, it will return the range address. This API
- returns the \#VALUE! error in the Excel UI if it refers to a user-defined function.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getValue(): string | number;'
- return:
- type: string | number
- description: ''
- - name: getVisible()
- uid: 'ExcelScript!ExcelScript.NamedItem#getVisible:member(1)'
- package: ExcelScript!
- fullName: getVisible()
- summary: Specifies if the object is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVisible(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getWorksheet()
- uid: 'ExcelScript!ExcelScript.NamedItem#getWorksheet:member(1)'
- package: ExcelScript!
- fullName: getWorksheet()
- summary: >-
- Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this
- method returns `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWorksheet(): Worksheet | undefined;'
- return:
- type: ' | undefined'
- description: ''
- - name: setComment(comment)
- uid: 'ExcelScript!ExcelScript.NamedItem#setComment:member(1)'
- package: ExcelScript!
- fullName: setComment(comment)
- summary: Specifies the comment associated with this name.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setComment(comment: string): void;'
- parameters:
- - id: comment
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setFormula(formula)
- uid: 'ExcelScript!ExcelScript.NamedItem#setFormula:member(1)'
- package: ExcelScript!
- fullName: setFormula(formula)
- summary: The formula of the named item. Formulas always start with an equal sign ("=").
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFormula(formula: string): void;'
- parameters:
- - id: formula
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setVisible(visible)
- uid: 'ExcelScript!ExcelScript.NamedItem#setVisible:member(1)'
- package: ExcelScript!
- fullName: setVisible(visible)
- summary: Specifies if the object is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setVisible(visible: boolean): void;'
- parameters:
- - id: visible
- description: ''
- type: boolean
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.NamedItem
+uid: 'ExcelScript!ExcelScript.NamedItem:interface'
+package: ExcelScript!
+fullName: ExcelScript.NamedItem
+summary: >-
+ 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.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a named formula and uses it in another part of the workbook.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Create a named item for a formula.
+ // This formula is the sum of the cells F2:F21 on Sheet1.
+ const namedItem: ExcelScript.NamedItem = workbook.addNamedItem(
+ "GrandTotal",
+ "=SUM(Sheet1!$F$2:$F$21)",
+ "The sum of table sums."
+ );
+
+ // Add this named formula to a new sheet in the workbook.
+ const otherSheet = workbook.addWorksheet();
+ otherSheet.getRange("A1").setFormula(namedItem.getFormula());
+
+ // Switch to the new worksheet.
+ otherSheet.activate();
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.NamedItem#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: Deletes the given name.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getArrayValues()
+ uid: 'ExcelScript!ExcelScript.NamedItem#getArrayValues:member(1)'
+ package: ExcelScript!
+ fullName: getArrayValues()
+ summary: Returns an object containing values and types of the named item.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getArrayValues(): NamedItemArrayValues;'
+ return:
+ type: ''
+ description: ''
+ - name: getComment()
+ uid: 'ExcelScript!ExcelScript.NamedItem#getComment:member(1)'
+ package: ExcelScript!
+ fullName: getComment()
+ summary: Specifies the comment associated with this name.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getComment(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getFormula()
+ uid: 'ExcelScript!ExcelScript.NamedItem#getFormula:member(1)'
+ package: ExcelScript!
+ fullName: getFormula()
+ summary: The formula of the named item. Formulas always start with an equal sign ("=").
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormula(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.NamedItem#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: The name of the object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getRange()
+ uid: 'ExcelScript!ExcelScript.NamedItem#getRange:member(1)'
+ package: ExcelScript!
+ fullName: getRange()
+ summary: >-
+ Returns the range object that is associated with the name. If the named item's type is not a range, then this
+ method returns `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRange(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getScope()
+ uid: 'ExcelScript!ExcelScript.NamedItem#getScope:member(1)'
+ package: ExcelScript!
+ fullName: getScope()
+ summary: >-
+ Specifies if the name is scoped to the workbook or to a specific worksheet. Possible values are: Worksheet,
+ Workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getScope(): NamedItemScope;'
+ return:
+ type: ''
+ description: ''
+ - name: getType()
+ uid: 'ExcelScript!ExcelScript.NamedItem#getType:member(1)'
+ package: ExcelScript!
+ fullName: getType()
+ summary: Specifies the type of the value returned by the name's formula. See `ExcelScript.NamedItemType` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getType(): NamedItemType;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script looks for every named range with "Review" in the name
+ * and marks the range with a yellow fill.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Look at every named item in the workbook.
+ workbook.getNames().forEach((namedItem) => {
+ // Find names containing "Review".
+ if (namedItem.getName().includes("Review")) {
+ // Only change the fill color if the named item is a range (not a formula).
+ let itemType: ExcelScript.NamedItemType = namedItem.getType();
+ if (itemType === ExcelScript.NamedItemType.range) {
+ // Set the range's fill color to yellow.
+ namedItem.getRange().getFormat().getFill().setColor("yellow");
+ }
+ }
+ });
+ }
+ ```
+ - name: getValue()
+ uid: 'ExcelScript!ExcelScript.NamedItem#getValue:member(1)'
+ package: ExcelScript!
+ fullName: getValue()
+ summary: >-
+ Represents the value computed by the name's formula. For a named range, it will return the range address. This API
+ returns the \#VALUE! error in the Excel UI if it refers to a user-defined function.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getValue(): string | number;'
+ return:
+ type: string | number
+ description: ''
+ - name: getVisible()
+ uid: 'ExcelScript!ExcelScript.NamedItem#getVisible:member(1)'
+ package: ExcelScript!
+ fullName: getVisible()
+ summary: Specifies if the object is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVisible(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getWorksheet()
+ uid: 'ExcelScript!ExcelScript.NamedItem#getWorksheet:member(1)'
+ package: ExcelScript!
+ fullName: getWorksheet()
+ summary: >-
+ Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this
+ method returns `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWorksheet(): Worksheet | undefined;'
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: setComment(comment)
+ uid: 'ExcelScript!ExcelScript.NamedItem#setComment:member(1)'
+ package: ExcelScript!
+ fullName: setComment(comment)
+ summary: Specifies the comment associated with this name.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setComment(comment: string): void;'
+ parameters:
+ - id: comment
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setFormula(formula)
+ uid: 'ExcelScript!ExcelScript.NamedItem#setFormula:member(1)'
+ package: ExcelScript!
+ fullName: setFormula(formula)
+ summary: The formula of the named item. Formulas always start with an equal sign ("=").
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFormula(formula: string): void;'
+ parameters:
+ - id: formula
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setVisible(visible)
+ uid: 'ExcelScript!ExcelScript.NamedItem#setVisible:member(1)'
+ package: ExcelScript!
+ fullName: setVisible(visible)
+ summary: Specifies if the object is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setVisible(visible: boolean): void;'
+ parameters:
+ - id: visible
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.nameditemarrayvalues.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.nameditemarrayvalues.yml
index 180aedc0..77c27d88 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.nameditemarrayvalues.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.nameditemarrayvalues.yml
@@ -1,37 +1,37 @@
-### YamlMime:TSType
-name: ExcelScript.NamedItemArrayValues
-uid: 'ExcelScript!ExcelScript.NamedItemArrayValues:interface'
-package: ExcelScript!
-fullName: ExcelScript.NamedItemArrayValues
-summary: Represents an object containing values and types of a named item.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getTypes()
- uid: 'ExcelScript!ExcelScript.NamedItemArrayValues#getTypes:member(1)'
- package: ExcelScript!
- fullName: getTypes()
- summary: Represents the types for each item in the named item array
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTypes(): RangeValueType[][];'
- return:
- type: '[][]'
- description: ''
- - name: getValues()
- uid: 'ExcelScript!ExcelScript.NamedItemArrayValues#getValues:member(1)'
- package: ExcelScript!
- fullName: getValues()
- summary: Represents the values of each item in the named item array.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getValues(): (string | number | boolean)[][];'
- return:
- type: '(string | number | boolean)[][]'
- description: ''
+### YamlMime:TSType
+name: ExcelScript.NamedItemArrayValues
+uid: 'ExcelScript!ExcelScript.NamedItemArrayValues:interface'
+package: ExcelScript!
+fullName: ExcelScript.NamedItemArrayValues
+summary: Represents an object containing values and types of a named item.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getTypes()
+ uid: 'ExcelScript!ExcelScript.NamedItemArrayValues#getTypes:member(1)'
+ package: ExcelScript!
+ fullName: getTypes()
+ summary: Represents the types for each item in the named item array
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTypes(): RangeValueType[][];'
+ return:
+ type: '[][]'
+ description: ''
+ - name: getValues()
+ uid: 'ExcelScript!ExcelScript.NamedItemArrayValues#getValues:member(1)'
+ package: ExcelScript!
+ fullName: getValues()
+ summary: Represents the values of each item in the named item array.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getValues(): (string | number | boolean)[][];'
+ return:
+ type: '(string | number | boolean)[][]'
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.nameditemscope.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.nameditemscope.yml
index 3eaef3c2..ea697b44 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.nameditemscope.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.nameditemscope.yml
@@ -1,18 +1,18 @@
-### YamlMime:TSEnum
-name: ExcelScript.NamedItemScope
-uid: 'ExcelScript!ExcelScript.NamedItemScope:enum'
-package: ExcelScript!
-fullName: ExcelScript.NamedItemScope
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: workbook
- uid: 'ExcelScript!ExcelScript.NamedItemScope.workbook:member'
- package: ExcelScript!
- summary: ''
- - name: worksheet
- uid: 'ExcelScript!ExcelScript.NamedItemScope.worksheet:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.NamedItemScope
+uid: 'ExcelScript!ExcelScript.NamedItemScope:enum'
+package: ExcelScript!
+fullName: ExcelScript.NamedItemScope
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: workbook
+ uid: 'ExcelScript!ExcelScript.NamedItemScope.workbook:member'
+ package: ExcelScript!
+ summary: ''
+ - name: worksheet
+ uid: 'ExcelScript!ExcelScript.NamedItemScope.worksheet:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.nameditemtype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.nameditemtype.yml
index dfa3069c..44e7a588 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.nameditemtype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.nameditemtype.yml
@@ -1,62 +1,62 @@
-### YamlMime:TSEnum
-name: ExcelScript.NamedItemType
-uid: 'ExcelScript!ExcelScript.NamedItemType:enum'
-package: ExcelScript!
-fullName: ExcelScript.NamedItemType
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script looks for every named range with "Review" in the name
- * and marks the range with a yellow fill.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Look at every named item in the workbook.
- workbook.getNames().forEach((namedItem) => {
- // Find names containing "Review".
- if (namedItem.getName().includes("Review")) {
- // Only change the fill color if the named item is a range (not a formula).
- let itemType: ExcelScript.NamedItemType = namedItem.getType();
- if (itemType === ExcelScript.NamedItemType.range) {
- // Set the range's fill color to yellow.
- namedItem.getRange().getFormat().getFill().setColor("yellow");
- }
- }
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: array
- uid: 'ExcelScript!ExcelScript.NamedItemType.array:member'
- package: ExcelScript!
- summary: ''
- - name: boolean
- uid: 'ExcelScript!ExcelScript.NamedItemType.boolean:member'
- package: ExcelScript!
- summary: ''
- - name: double
- uid: 'ExcelScript!ExcelScript.NamedItemType.double:member'
- package: ExcelScript!
- summary: ''
- - name: error
- uid: 'ExcelScript!ExcelScript.NamedItemType.error:member'
- package: ExcelScript!
- summary: ''
- - name: integer
- uid: 'ExcelScript!ExcelScript.NamedItemType.integer:member'
- package: ExcelScript!
- summary: ''
- - name: range
- uid: 'ExcelScript!ExcelScript.NamedItemType.range:member'
- package: ExcelScript!
- summary: ''
- - name: string
- uid: 'ExcelScript!ExcelScript.NamedItemType.string:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.NamedItemType
+uid: 'ExcelScript!ExcelScript.NamedItemType:enum'
+package: ExcelScript!
+fullName: ExcelScript.NamedItemType
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script looks for every named range with "Review" in the name
+ * and marks the range with a yellow fill.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Look at every named item in the workbook.
+ workbook.getNames().forEach((namedItem) => {
+ // Find names containing "Review".
+ if (namedItem.getName().includes("Review")) {
+ // Only change the fill color if the named item is a range (not a formula).
+ let itemType: ExcelScript.NamedItemType = namedItem.getType();
+ if (itemType === ExcelScript.NamedItemType.range) {
+ // Set the range's fill color to yellow.
+ namedItem.getRange().getFormat().getFill().setColor("yellow");
+ }
+ }
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: array
+ uid: 'ExcelScript!ExcelScript.NamedItemType.array:member'
+ package: ExcelScript!
+ summary: ''
+ - name: boolean
+ uid: 'ExcelScript!ExcelScript.NamedItemType.boolean:member'
+ package: ExcelScript!
+ summary: ''
+ - name: double
+ uid: 'ExcelScript!ExcelScript.NamedItemType.double:member'
+ package: ExcelScript!
+ summary: ''
+ - name: error
+ uid: 'ExcelScript!ExcelScript.NamedItemType.error:member'
+ package: ExcelScript!
+ summary: ''
+ - name: integer
+ uid: 'ExcelScript!ExcelScript.NamedItemType.integer:member'
+ package: ExcelScript!
+ summary: ''
+ - name: range
+ uid: 'ExcelScript!ExcelScript.NamedItemType.range:member'
+ package: ExcelScript!
+ summary: ''
+ - name: string
+ uid: 'ExcelScript!ExcelScript.NamedItemType.string:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.namedsheetview.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.namedsheetview.yml
index 5ab6cd23..a2636487 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.namedsheetview.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.namedsheetview.yml
@@ -1,91 +1,91 @@
-### YamlMime:TSType
-name: ExcelScript.NamedSheetView
-uid: 'ExcelScript!ExcelScript.NamedSheetView:interface'
-package: ExcelScript!
-fullName: ExcelScript.NamedSheetView
-summary: >-
- 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.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: activate()
- uid: 'ExcelScript!ExcelScript.NamedSheetView#activate:member(1)'
- package: ExcelScript!
- fullName: activate()
- summary: Activates this sheet view. This is equivalent to using "Switch To" in the Excel UI.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'activate(): void;'
- return:
- type: void
- description: ''
- - name: delete()
- uid: 'ExcelScript!ExcelScript.NamedSheetView#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: Removes the sheet view from the worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: ''
- - name: duplicate(name)
- uid: 'ExcelScript!ExcelScript.NamedSheetView#duplicate:member(1)'
- package: ExcelScript!
- fullName: duplicate(name)
- summary: Creates a copy of this sheet view.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'duplicate(name?: string): NamedSheetView;'
- parameters:
- - id: name
- description: 'The name of the duplicated sheet view. If no name is provided, one will be generated.'
- type: string
- return:
- type: ''
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.NamedSheetView#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: >-
- Gets or sets the name of the sheet view. The temporary sheet view name is the empty string (""). Naming the view
- by using the name property causes the sheet view to be saved.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: setName(name)
- uid: 'ExcelScript!ExcelScript.NamedSheetView#setName:member(1)'
- package: ExcelScript!
- fullName: setName(name)
- summary: >-
- Gets or sets the name of the sheet view. The temporary sheet view name is the empty string (""). Naming the view
- by using the name property causes the sheet view to be saved.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setName(name: string): void;'
- parameters:
- - id: name
- description: ''
- type: string
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.NamedSheetView
+uid: 'ExcelScript!ExcelScript.NamedSheetView:interface'
+package: ExcelScript!
+fullName: ExcelScript.NamedSheetView
+summary: >-
+ 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.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: activate()
+ uid: 'ExcelScript!ExcelScript.NamedSheetView#activate:member(1)'
+ package: ExcelScript!
+ fullName: activate()
+ summary: Activates this sheet view. This is equivalent to using "Switch To" in the Excel UI.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'activate(): void;'
+ return:
+ type: void
+ description: ''
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.NamedSheetView#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: Removes the sheet view from the worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: duplicate(name)
+ uid: 'ExcelScript!ExcelScript.NamedSheetView#duplicate:member(1)'
+ package: ExcelScript!
+ fullName: duplicate(name)
+ summary: Creates a copy of this sheet view.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'duplicate(name?: string): NamedSheetView;'
+ parameters:
+ - id: name
+ description: 'The name of the duplicated sheet view. If no name is provided, one will be generated.'
+ type: string
+ return:
+ type: ''
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.NamedSheetView#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: >-
+ Specifies the name of the sheet view. The temporary sheet view name is the empty string (""). Naming the view by
+ using the name property causes the sheet view to be saved.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: setName(name)
+ uid: 'ExcelScript!ExcelScript.NamedSheetView#setName:member(1)'
+ package: ExcelScript!
+ fullName: setName(name)
+ summary: >-
+ Specifies the name of the sheet view. The temporary sheet view name is the empty string (""). Naming the view by
+ using the name property causes the sheet view to be saved.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setName(name: string): void;'
+ parameters:
+ - id: name
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.numberformatcategory.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.numberformatcategory.yml
index 3962cf5f..47e3d608 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.numberformatcategory.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.numberformatcategory.yml
@@ -1,94 +1,94 @@
-### YamlMime:TSEnum
-name: ExcelScript.NumberFormatCategory
-uid: 'ExcelScript!ExcelScript.NumberFormatCategory:enum'
-package: ExcelScript!
-fullName: ExcelScript.NumberFormatCategory
-summary: Represents a category of number formats.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script finds cells in a table column that are not formatted as currency
- * and sets the fill color to red.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the "Cost" column from the "Expenses" table.
- const table = workbook.getTable("Expenses");
- const costColumn = table.getColumnByName("Cost");
- const costColumnRange = costColumn.getRangeBetweenHeaderAndTotal();
-
- // Get the number format categories for the column's range.
- const numberFormatCategories = costColumnRange.getNumberFormatCategories();
-
- // If any cell in the column doesn't have a currency format, make the cell red.
- numberFormatCategories.forEach((category, index) =>{
- if (category[0] != ExcelScript.NumberFormatCategory.currency) {
- costColumnRange.getCell(index, 0).getFormat().getFill().setColor("red");
- }
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: accounting
- uid: 'ExcelScript!ExcelScript.NumberFormatCategory.accounting:member'
- package: ExcelScript!
- summary: Accounting formats line up the currency symbols and decimal points in a column.
- - name: currency
- uid: 'ExcelScript!ExcelScript.NumberFormatCategory.currency:member'
- package: ExcelScript!
- summary: Currency formats are used for general monetary values. Use Accounting formats to align decimal points in a column.
- - name: custom
- uid: 'ExcelScript!ExcelScript.NumberFormatCategory.custom:member'
- package: ExcelScript!
- summary: A custom format that is not a part of any category.
- - name: date
- uid: 'ExcelScript!ExcelScript.NumberFormatCategory.date:member'
- package: ExcelScript!
- summary: >-
- Date formats display date and time serial numbers as date values. Date formats that begin with an asterisk (*)
- respond to changes in regional date and time settings that are specified for the operating system. Formats without
- an asterisk are not affected by operating system settings.
- - name: fraction
- uid: 'ExcelScript!ExcelScript.NumberFormatCategory.fraction:member'
- package: ExcelScript!
- summary: >-
- Fraction formats display the cell value as a whole number with the remainder rounded to the nearest fraction
- value.
- - name: general
- uid: 'ExcelScript!ExcelScript.NumberFormatCategory.general:member'
- package: ExcelScript!
- summary: General format cells have no specific number format.
- - name: number
- uid: 'ExcelScript!ExcelScript.NumberFormatCategory.number:member'
- package: ExcelScript!
- summary: >-
- Number is used for general display of numbers. Currency and Accounting offer specialized formatting for monetary
- value.
- - name: percentage
- uid: 'ExcelScript!ExcelScript.NumberFormatCategory.percentage:member'
- package: ExcelScript!
- summary: Percentage formats multiply the cell value by 100 and displays the result with a percent symbol.
- - name: scientific
- uid: 'ExcelScript!ExcelScript.NumberFormatCategory.scientific:member'
- package: ExcelScript!
- summary: Scientific formats display the cell value as a number between 1 and 10 multiplied by a power of 10.
- - name: special
- uid: 'ExcelScript!ExcelScript.NumberFormatCategory.special:member'
- package: ExcelScript!
- summary: Special formats are useful for tracking list and database values.
- - name: text
- uid: 'ExcelScript!ExcelScript.NumberFormatCategory.text:member'
- package: ExcelScript!
- summary: Text format cells are treated as text even when a number is in the cell. The cell is displayed exactly as entered.
- - name: time
- uid: 'ExcelScript!ExcelScript.NumberFormatCategory.time:member'
- package: ExcelScript!
- summary: >-
- Time formats display date and time serial numbers as date values. Time formats that begin with an asterisk (*)
- respond to changes in regional date and time settings that are specified for the operating system. Formats without
- an asterisk are not affected by operating system settings.
+### YamlMime:TSEnum
+name: ExcelScript.NumberFormatCategory
+uid: 'ExcelScript!ExcelScript.NumberFormatCategory:enum'
+package: ExcelScript!
+fullName: ExcelScript.NumberFormatCategory
+summary: Represents a category of number formats.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script finds cells in a table column that are not formatted as currency
+ * and sets the fill color to red.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the "Cost" column from the "Expenses" table.
+ const table = workbook.getTable("Expenses");
+ const costColumn = table.getColumnByName("Cost");
+ const costColumnRange = costColumn.getRangeBetweenHeaderAndTotal();
+
+ // Get the number format categories for the column's range.
+ const numberFormatCategories = costColumnRange.getNumberFormatCategories();
+
+ // If any cell in the column doesn't have a currency format, make the cell red.
+ numberFormatCategories.forEach((category, index) =>{
+ if (category[0] != ExcelScript.NumberFormatCategory.currency) {
+ costColumnRange.getCell(index, 0).getFormat().getFill().setColor("red");
+ }
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: accounting
+ uid: 'ExcelScript!ExcelScript.NumberFormatCategory.accounting:member'
+ package: ExcelScript!
+ summary: Accounting formats line up the currency symbols and decimal points in a column.
+ - name: currency
+ uid: 'ExcelScript!ExcelScript.NumberFormatCategory.currency:member'
+ package: ExcelScript!
+ summary: Currency formats are used for general monetary values. Use Accounting formats to align decimal points in a column.
+ - name: custom
+ uid: 'ExcelScript!ExcelScript.NumberFormatCategory.custom:member'
+ package: ExcelScript!
+ summary: A custom format that is not a part of any category.
+ - name: date
+ uid: 'ExcelScript!ExcelScript.NumberFormatCategory.date:member'
+ package: ExcelScript!
+ summary: >-
+ Date formats display date and time serial numbers as date values. Date formats that begin with an asterisk (*)
+ respond to changes in regional date and time settings that are specified for the operating system. Formats without
+ an asterisk are not affected by operating system settings.
+ - name: fraction
+ uid: 'ExcelScript!ExcelScript.NumberFormatCategory.fraction:member'
+ package: ExcelScript!
+ summary: >-
+ Fraction formats display the cell value as a whole number with the remainder rounded to the nearest fraction
+ value.
+ - name: general
+ uid: 'ExcelScript!ExcelScript.NumberFormatCategory.general:member'
+ package: ExcelScript!
+ summary: General format cells have no specific number format.
+ - name: number
+ uid: 'ExcelScript!ExcelScript.NumberFormatCategory.number:member'
+ package: ExcelScript!
+ summary: >-
+ Number is used for general display of numbers. Currency and Accounting offer specialized formatting for monetary
+ value.
+ - name: percentage
+ uid: 'ExcelScript!ExcelScript.NumberFormatCategory.percentage:member'
+ package: ExcelScript!
+ summary: Percentage formats multiply the cell value by 100 and displays the result with a percent symbol.
+ - name: scientific
+ uid: 'ExcelScript!ExcelScript.NumberFormatCategory.scientific:member'
+ package: ExcelScript!
+ summary: Scientific formats display the cell value as a number between 1 and 10 multiplied by a power of 10.
+ - name: special
+ uid: 'ExcelScript!ExcelScript.NumberFormatCategory.special:member'
+ package: ExcelScript!
+ summary: Special formats are useful for tracking list and database values.
+ - name: text
+ uid: 'ExcelScript!ExcelScript.NumberFormatCategory.text:member'
+ package: ExcelScript!
+ summary: Text format cells are treated as text even when a number is in the cell. The cell is displayed exactly as entered.
+ - name: time
+ uid: 'ExcelScript!ExcelScript.NumberFormatCategory.time:member'
+ package: ExcelScript!
+ summary: >-
+ Time formats display date and time serial numbers as date values. Time formats that begin with an asterisk (*)
+ respond to changes in regional date and time settings that are specified for the operating system. Formats without
+ an asterisk are not affected by operating system settings.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.numberformatinfo.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.numberformatinfo.yml
index d716d17b..76935bec 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.numberformatinfo.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.numberformatinfo.yml
@@ -1,39 +1,52 @@
-### YamlMime:TSType
-name: ExcelScript.NumberFormatInfo
-uid: 'ExcelScript!ExcelScript.NumberFormatInfo:interface'
-package: ExcelScript!
-fullName: ExcelScript.NumberFormatInfo
-summary: Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getNumberDecimalSeparator()
- uid: 'ExcelScript!ExcelScript.NumberFormatInfo#getNumberDecimalSeparator:member(1)'
- package: ExcelScript!
- fullName: getNumberDecimalSeparator()
- summary: Gets the string used as the decimal separator for numeric values. This is based on current system settings.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNumberDecimalSeparator(): string;'
- return:
- type: string
- description: ''
- - name: getNumberGroupSeparator()
- uid: 'ExcelScript!ExcelScript.NumberFormatInfo#getNumberGroupSeparator:member(1)'
- package: ExcelScript!
- fullName: getNumberGroupSeparator()
- summary: >-
- Gets the string used to separate groups of digits to the left of the decimal for numeric values. This is based on
- current system settings.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNumberGroupSeparator(): string;'
- return:
- type: string
- description: ''
+### YamlMime:TSType
+name: ExcelScript.NumberFormatInfo
+uid: 'ExcelScript!ExcelScript.NumberFormatInfo:interface'
+package: ExcelScript!
+fullName: ExcelScript.NumberFormatInfo
+summary: Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getCurrencySymbol()
+ uid: 'ExcelScript!ExcelScript.NumberFormatInfo#getCurrencySymbol:member(1)'
+ package: ExcelScript!
+ fullName: getCurrencySymbol()
+ summary: Gets the currency symbol for currency values. This is based on current system settings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCurrencySymbol(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getNumberDecimalSeparator()
+ uid: 'ExcelScript!ExcelScript.NumberFormatInfo#getNumberDecimalSeparator:member(1)'
+ package: ExcelScript!
+ fullName: getNumberDecimalSeparator()
+ summary: Gets the string used as the decimal separator for numeric values. This is based on current system settings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNumberDecimalSeparator(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getNumberGroupSeparator()
+ uid: 'ExcelScript!ExcelScript.NumberFormatInfo#getNumberGroupSeparator:member(1)'
+ package: ExcelScript!
+ fullName: getNumberGroupSeparator()
+ summary: >-
+ Gets the string used to separate groups of digits to the left of the decimal for numeric values. This is based on
+ current system settings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNumberGroupSeparator(): string;'
+ return:
+ type: string
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.pagebreak.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.pagebreak.yml
index 3f76f9c4..4712a306 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.pagebreak.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.pagebreak.yml
@@ -1,50 +1,63 @@
-### YamlMime:TSType
-name: ExcelScript.PageBreak
-uid: 'ExcelScript!ExcelScript.PageBreak:interface'
-package: ExcelScript!
-fullName: ExcelScript.PageBreak
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: delete()
- uid: 'ExcelScript!ExcelScript.PageBreak#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: Deletes a page break object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: ''
- - name: getCellAfterBreak()
- uid: 'ExcelScript!ExcelScript.PageBreak#getCellAfterBreak:member(1)'
- package: ExcelScript!
- fullName: getCellAfterBreak()
- summary: Gets the first cell after the page break.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCellAfterBreak(): Range;'
- return:
- type: ''
- description: ''
- - name: getColumnIndex()
- uid: 'ExcelScript!ExcelScript.PageBreak#getColumnIndex:member(1)'
- package: ExcelScript!
- fullName: getColumnIndex()
- summary: Specifies the column index for the page break.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColumnIndex(): number;'
- return:
- type: number
- description: ''
+### YamlMime:TSType
+name: ExcelScript.PageBreak
+uid: 'ExcelScript!ExcelScript.PageBreak:interface'
+package: ExcelScript!
+fullName: ExcelScript.PageBreak
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.PageBreak#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: Deletes a page break object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getCellAfterBreak()
+ uid: 'ExcelScript!ExcelScript.PageBreak#getCellAfterBreak:member(1)'
+ package: ExcelScript!
+ fullName: getCellAfterBreak()
+ summary: Gets the first cell after the page break.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCellAfterBreak(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getColumnIndex()
+ uid: 'ExcelScript!ExcelScript.PageBreak#getColumnIndex:member(1)'
+ package: ExcelScript!
+ fullName: getColumnIndex()
+ summary: Specifies the column index for the page break.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColumnIndex(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getRowIndex()
+ uid: 'ExcelScript!ExcelScript.PageBreak#getRowIndex:member(1)'
+ package: ExcelScript!
+ fullName: getRowIndex()
+ summary: Specifies the row index for the page break.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRowIndex(): number;'
+ return:
+ type: number
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.pagelayout.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.pagelayout.yml
index b345be13..918ea7cc 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.pagelayout.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.pagelayout.yml
@@ -1,864 +1,864 @@
-### YamlMime:TSType
-name: ExcelScript.PageLayout
-uid: 'ExcelScript!ExcelScript.PageLayout:interface'
-package: ExcelScript!
-fullName: ExcelScript.PageLayout
-summary: >-
- 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.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets some basic page layout settings for printing.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Go to each worksheet so the print settings are consistent.
- workbook.getWorksheets().forEach((sheet) => {
- const pageLayout : ExcelScript.PageLayout = sheet.getPageLayout();
-
- // Turn off draft mode so images are printed.
- pageLayout.setDraftMode(false);
-
- // Print on 8.5"x11" paper.
- pageLayout.setPaperSize(ExcelScript.PaperType.letter);
-
- // Print every page with a landscape orientation.
- pageLayout.setOrientation(ExcelScript.PageOrientation.landscape);
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getBlackAndWhite()
- uid: 'ExcelScript!ExcelScript.PageLayout#getBlackAndWhite:member(1)'
- package: ExcelScript!
- fullName: getBlackAndWhite()
- summary: The worksheet's black and white print option.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBlackAndWhite(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getBottomMargin()
- uid: 'ExcelScript!ExcelScript.PageLayout#getBottomMargin:member(1)'
- package: ExcelScript!
- fullName: getBottomMargin()
- summary: The worksheet's bottom page margin to use for printing in points.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBottomMargin(): number;'
- return:
- type: number
- description: ''
- - name: getCenterHorizontally()
- uid: 'ExcelScript!ExcelScript.PageLayout#getCenterHorizontally:member(1)'
- package: ExcelScript!
- fullName: getCenterHorizontally()
- summary: >-
- The worksheet's center horizontally flag. This flag determines whether the worksheet will be centered horizontally
- when it's printed.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCenterHorizontally(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getCenterVertically()
- uid: 'ExcelScript!ExcelScript.PageLayout#getCenterVertically:member(1)'
- package: ExcelScript!
- fullName: getCenterVertically()
- summary: >-
- The worksheet's center vertically flag. This flag determines whether the worksheet will be centered vertically
- when it's printed.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCenterVertically(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getDraftMode()
- uid: 'ExcelScript!ExcelScript.PageLayout#getDraftMode:member(1)'
- package: ExcelScript!
- fullName: getDraftMode()
- summary: 'The worksheet''s draft mode option. If `true`, the sheet will be printed without graphics.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDraftMode(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getFirstPageNumber()
- uid: 'ExcelScript!ExcelScript.PageLayout#getFirstPageNumber:member(1)'
- package: ExcelScript!
- fullName: getFirstPageNumber()
- summary: The worksheet's first page number to print. A `null` value represents "auto" page numbering.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFirstPageNumber(): number | "";'
- return:
- type: number | ""
- description: ''
- - name: getFooterMargin()
- uid: 'ExcelScript!ExcelScript.PageLayout#getFooterMargin:member(1)'
- package: ExcelScript!
- fullName: getFooterMargin()
- summary: 'The worksheet''s footer margin, in points, for use when printing.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFooterMargin(): number;'
- return:
- type: number
- description: ''
- - name: getHeaderMargin()
- uid: 'ExcelScript!ExcelScript.PageLayout#getHeaderMargin:member(1)'
- package: ExcelScript!
- fullName: getHeaderMargin()
- summary: 'The worksheet''s header margin, in points, for use when printing.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHeaderMargin(): number;'
- return:
- type: number
- description: ''
- - name: getHeadersFooters()
- uid: 'ExcelScript!ExcelScript.PageLayout#getHeadersFooters:member(1)'
- package: ExcelScript!
- fullName: getHeadersFooters()
- summary: Header and footer configuration for the worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHeadersFooters(): HeaderFooterGroup;'
- return:
- type: ''
- description: ''
- - name: getLeftMargin()
- uid: 'ExcelScript!ExcelScript.PageLayout#getLeftMargin:member(1)'
- package: ExcelScript!
- fullName: getLeftMargin()
- summary: 'The worksheet''s left margin, in points, for use when printing.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLeftMargin(): number;'
- return:
- type: number
- description: ''
- - name: getOrientation()
- uid: 'ExcelScript!ExcelScript.PageLayout#getOrientation:member(1)'
- package: ExcelScript!
- fullName: getOrientation()
- summary: The worksheet's orientation of the page.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getOrientation(): PageOrientation;'
- return:
- type: ''
- description: ''
- - name: getPaperSize()
- uid: 'ExcelScript!ExcelScript.PageLayout#getPaperSize:member(1)'
- package: ExcelScript!
- fullName: getPaperSize()
- summary: The worksheet's paper size of the page.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPaperSize(): PaperType;'
- return:
- type: ''
- description: ''
- - name: getPrintArea()
- uid: 'ExcelScript!ExcelScript.PageLayout#getPrintArea:member(1)'
- package: ExcelScript!
- fullName: getPrintArea()
- summary: >-
- Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents the print area for the
- worksheet. If there is no print area, then this method returns `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPrintArea(): RangeAreas;'
- return:
- type: ''
- description: ''
- - name: getPrintComments()
- uid: 'ExcelScript!ExcelScript.PageLayout#getPrintComments:member(1)'
- package: ExcelScript!
- fullName: getPrintComments()
- summary: Specifies if the worksheet's comments should be displayed when printing.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPrintComments(): PrintComments;'
- return:
- type: ''
- description: ''
- - name: getPrintErrors()
- uid: 'ExcelScript!ExcelScript.PageLayout#getPrintErrors:member(1)'
- package: ExcelScript!
- fullName: getPrintErrors()
- summary: The worksheet's print errors option.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPrintErrors(): PrintErrorType;'
- return:
- type: ''
- description: ''
- - name: getPrintGridlines()
- uid: 'ExcelScript!ExcelScript.PageLayout#getPrintGridlines:member(1)'
- package: ExcelScript!
- fullName: getPrintGridlines()
- summary: Specifies if the worksheet's gridlines will be printed.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPrintGridlines(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getPrintHeadings()
- uid: 'ExcelScript!ExcelScript.PageLayout#getPrintHeadings:member(1)'
- package: ExcelScript!
- fullName: getPrintHeadings()
- summary: Specifies if the worksheet's headings will be printed.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPrintHeadings(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getPrintOrder()
- uid: 'ExcelScript!ExcelScript.PageLayout#getPrintOrder:member(1)'
- package: ExcelScript!
- fullName: getPrintOrder()
- summary: The worksheet's page print order option. This specifies the order to use for processing the page number printed.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPrintOrder(): PrintOrder;'
- return:
- type: ''
- description: ''
- - name: getPrintTitleColumns()
- uid: 'ExcelScript!ExcelScript.PageLayout#getPrintTitleColumns:member(1)'
- package: ExcelScript!
- fullName: getPrintTitleColumns()
- summary: 'Gets the range object representing the title columns. If not set, then this method returns `undefined`.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPrintTitleColumns(): Range;'
- return:
- type: ''
- description: ''
- - name: getPrintTitleRows()
- uid: 'ExcelScript!ExcelScript.PageLayout#getPrintTitleRows:member(1)'
- package: ExcelScript!
- fullName: getPrintTitleRows()
- summary: 'Gets the range object representing the title rows. If not set, then this method returns `undefined`.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPrintTitleRows(): Range;'
- return:
- type: ''
- description: ''
- - name: getRightMargin()
- uid: 'ExcelScript!ExcelScript.PageLayout#getRightMargin:member(1)'
- package: ExcelScript!
- fullName: getRightMargin()
- summary: 'The worksheet''s right margin, in points, for use when printing.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRightMargin(): number;'
- return:
- type: number
- description: ''
- - name: getTopMargin()
- uid: 'ExcelScript!ExcelScript.PageLayout#getTopMargin:member(1)'
- package: ExcelScript!
- fullName: getTopMargin()
- summary: 'The worksheet''s top margin, in points, for use when printing.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTopMargin(): number;'
- return:
- type: number
- description: ''
- - name: getZoom()
- uid: 'ExcelScript!ExcelScript.PageLayout#getZoom:member(1)'
- package: ExcelScript!
- fullName: getZoom()
- summary: >-
- The worksheet's print zoom options. The `PageLayoutZoomOptions` object must be set as a JSON object (use `x.zoom =
- {...}` instead of `x.zoom.scale = ...`).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getZoom(): PageLayoutZoomOptions;'
- return:
- type: ''
- description: ''
- - name: setBlackAndWhite(blackAndWhite)
- uid: 'ExcelScript!ExcelScript.PageLayout#setBlackAndWhite:member(1)'
- package: ExcelScript!
- fullName: setBlackAndWhite(blackAndWhite)
- summary: The worksheet's black and white print option.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setBlackAndWhite(blackAndWhite: boolean): void;'
- parameters:
- - id: blackAndWhite
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setBottomMargin(bottomMargin)
- uid: 'ExcelScript!ExcelScript.PageLayout#setBottomMargin:member(1)'
- package: ExcelScript!
- fullName: setBottomMargin(bottomMargin)
- summary: The worksheet's bottom page margin to use for printing in points.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setBottomMargin(bottomMargin: number): void;'
- parameters:
- - id: bottomMargin
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setCenterHorizontally(centerHorizontally)
- uid: 'ExcelScript!ExcelScript.PageLayout#setCenterHorizontally:member(1)'
- package: ExcelScript!
- fullName: setCenterHorizontally(centerHorizontally)
- summary: >-
- The worksheet's center horizontally flag. This flag determines whether the worksheet will be centered horizontally
- when it's printed.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setCenterHorizontally(centerHorizontally: boolean): void;'
- parameters:
- - id: centerHorizontally
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setCenterVertically(centerVertically)
- uid: 'ExcelScript!ExcelScript.PageLayout#setCenterVertically:member(1)'
- package: ExcelScript!
- fullName: setCenterVertically(centerVertically)
- summary: >-
- The worksheet's center vertically flag. This flag determines whether the worksheet will be centered vertically
- when it's printed.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setCenterVertically(centerVertically: boolean): void;'
- parameters:
- - id: centerVertically
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setDraftMode(draftMode)
- uid: 'ExcelScript!ExcelScript.PageLayout#setDraftMode:member(1)'
- package: ExcelScript!
- fullName: setDraftMode(draftMode)
- summary: 'The worksheet''s draft mode option. If `true`, the sheet will be printed without graphics.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setDraftMode(draftMode: boolean): void;'
- parameters:
- - id: draftMode
- description: ''
- type: boolean
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script turns off the print setting for draft mode.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Go to each worksheet so the print settings are consistent.
- workbook.getWorksheets().forEach((sheet) => {
- const pageLayout = sheet.getPageLayout();
-
- // Turn off draft mode so images are printed.
- pageLayout.setDraftMode(false);
- });
- }
- ```
- - name: setFirstPageNumber(firstPageNumber)
- uid: 'ExcelScript!ExcelScript.PageLayout#setFirstPageNumber:member(1)'
- package: ExcelScript!
- fullName: setFirstPageNumber(firstPageNumber)
- summary: The worksheet's first page number to print. A `null` value represents "auto" page numbering.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFirstPageNumber(firstPageNumber: number | ""): void;'
- parameters:
- - id: firstPageNumber
- description: ''
- type: number | ""
- return:
- type: void
- description: ''
- - name: setFooterMargin(footerMargin)
- uid: 'ExcelScript!ExcelScript.PageLayout#setFooterMargin:member(1)'
- package: ExcelScript!
- fullName: setFooterMargin(footerMargin)
- summary: 'The worksheet''s footer margin, in points, for use when printing.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFooterMargin(footerMargin: number): void;'
- parameters:
- - id: footerMargin
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setHeaderMargin(headerMargin)
- uid: 'ExcelScript!ExcelScript.PageLayout#setHeaderMargin:member(1)'
- package: ExcelScript!
- fullName: setHeaderMargin(headerMargin)
- summary: 'The worksheet''s header margin, in points, for use when printing.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setHeaderMargin(headerMargin: number): void;'
- parameters:
- - id: headerMargin
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setLeftMargin(leftMargin)
- uid: 'ExcelScript!ExcelScript.PageLayout#setLeftMargin:member(1)'
- package: ExcelScript!
- fullName: setLeftMargin(leftMargin)
- summary: 'The worksheet''s left margin, in points, for use when printing.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLeftMargin(leftMargin: number): void;'
- parameters:
- - id: leftMargin
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setOrientation(orientation)
- uid: 'ExcelScript!ExcelScript.PageLayout#setOrientation:member(1)'
- package: ExcelScript!
- fullName: setOrientation(orientation)
- summary: The worksheet's orientation of the page.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setOrientation(orientation: PageOrientation): void;'
- parameters:
- - id: orientation
- description: ''
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the printing orientation for the entire workbook.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Go to each worksheet so the print settings are consistent.
- workbook.getWorksheets().forEach((sheet) => {
- const pageLayout = sheet.getPageLayout();
-
- // Print every page with a landscape orientation.
- pageLayout.setOrientation(ExcelScript.PageOrientation.landscape);
- });
- }
- ```
- - name: setPaperSize(paperSize)
- uid: 'ExcelScript!ExcelScript.PageLayout#setPaperSize:member(1)'
- package: ExcelScript!
- fullName: setPaperSize(paperSize)
- summary: The worksheet's paper size of the page.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPaperSize(paperSize: PaperType): void;'
- parameters:
- - id: paperSize
- description: ''
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the page size for printing.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Go to each worksheet so the print settings are consistent.
- workbook.getWorksheets().forEach((sheet) => {
- const pageLayout = sheet.getPageLayout();
- // Print on 8.5"x11" paper.
- pageLayout.setPaperSize(ExcelScript.PaperType.letter);
- });
- }
- ```
- - name: setPrintArea(printArea)
- uid: 'ExcelScript!ExcelScript.PageLayout#setPrintArea:member(1)'
- package: ExcelScript!
- fullName: setPrintArea(printArea)
- summary: Sets the worksheet's print area.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPrintArea(printArea: Range | RangeAreas | string): void;'
- parameters:
- - id: printArea
- description: The range or ranges of the content to print.
- type: >-
- | | string
- return:
- type: void
- description: ''
- - name: setPrintComments(printComments)
- uid: 'ExcelScript!ExcelScript.PageLayout#setPrintComments:member(1)'
- package: ExcelScript!
- fullName: setPrintComments(printComments)
- summary: Specifies if the worksheet's comments should be displayed when printing.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPrintComments(printComments: PrintComments): void;'
- parameters:
- - id: printComments
- description: ''
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script makes the comments print at the end of the worksheet
- * when the workbook is printed.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Access every worksheet in the workbook.
- workbook.getWorksheets().forEach(worksheet => {
- // Get the page layout for each sheet.
- const layout = worksheet.getPageLayout();
-
- // Change the comment printing settings to print them at the end of the sheet.
- layout.setPrintComments(ExcelScript.PrintComments.endSheet);
- });
- }
- ```
- - name: setPrintErrors(printErrors)
- uid: 'ExcelScript!ExcelScript.PageLayout#setPrintErrors:member(1)'
- package: ExcelScript!
- fullName: setPrintErrors(printErrors)
- summary: The worksheet's print errors option.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPrintErrors(printErrors: PrintErrorType): void;'
- parameters:
- - id: printErrors
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setPrintGridlines(printGridlines)
- uid: 'ExcelScript!ExcelScript.PageLayout#setPrintGridlines:member(1)'
- package: ExcelScript!
- fullName: setPrintGridlines(printGridlines)
- summary: Specifies if the worksheet's gridlines will be printed.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPrintGridlines(printGridlines: boolean): void;'
- parameters:
- - id: printGridlines
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setPrintHeadings(printHeadings)
- uid: 'ExcelScript!ExcelScript.PageLayout#setPrintHeadings:member(1)'
- package: ExcelScript!
- fullName: setPrintHeadings(printHeadings)
- summary: Specifies if the worksheet's headings will be printed.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPrintHeadings(printHeadings: boolean): void;'
- parameters:
- - id: printHeadings
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: 'setPrintMargins(unit, marginOptions)'
- uid: 'ExcelScript!ExcelScript.PageLayout#setPrintMargins:member(1)'
- package: ExcelScript!
- fullName: 'setPrintMargins(unit, marginOptions)'
- summary: Sets the worksheet's page margins with units.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setPrintMargins(
- unit: PrintMarginUnit,
- marginOptions: PageLayoutMarginOptions
- ): void;
- parameters:
- - id: unit
- description: Measurement unit for the margins provided.
- type: ''
- - id: marginOptions
- description: Margin values to set. Margins not provided remain unchanged.
- type: ''
- return:
- type: void
- description: ''
- - name: setPrintOrder(printOrder)
- uid: 'ExcelScript!ExcelScript.PageLayout#setPrintOrder:member(1)'
- package: ExcelScript!
- fullName: setPrintOrder(printOrder)
- summary: The worksheet's page print order option. This specifies the order to use for processing the page number printed.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPrintOrder(printOrder: PrintOrder): void;'
- parameters:
- - id: printOrder
- description: ''
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the print order for every worksheet in the workbook.
- * The order of printed content will go over (e.g., left-to-right)
- * then down (i.e., top-to-bottom).
- */
- function main(workbook: ExcelScript.Workbook) {
- // Access every worksheet in the workbook.
- workbook.getWorksheets().forEach(worksheet => {
- // Get the page layout for each sheet.
- const layout: ExcelScript.PageLayout = worksheet.getPageLayout();
-
- // Set the print order to over-then-down.
- layout.setPrintOrder(ExcelScript.PrintOrder.overThenDown);
- });
- }
- ```
- - name: setPrintTitleColumns(printTitleColumns)
- uid: 'ExcelScript!ExcelScript.PageLayout#setPrintTitleColumns:member(1)'
- package: ExcelScript!
- fullName: setPrintTitleColumns(printTitleColumns)
- summary: Sets the columns that contain the cells to be repeated at the left of each page of the worksheet for printing.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPrintTitleColumns(printTitleColumns: Range | string): void;'
- parameters:
- - id: printTitleColumns
- description: The columns to be repeated to the left of each page. The range must span the entire column to be valid.
- type: ' | string'
- return:
- type: void
- description: ''
- - name: setPrintTitleRows(printTitleRows)
- uid: 'ExcelScript!ExcelScript.PageLayout#setPrintTitleRows:member(1)'
- package: ExcelScript!
- fullName: setPrintTitleRows(printTitleRows)
- summary: Sets the rows that contain the cells to be repeated at the top of each page of the worksheet for printing.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPrintTitleRows(printTitleRows: Range | string): void;'
- parameters:
- - id: printTitleRows
- description: The rows to be repeated at the top of each page. The range must span the entire row to be valid.
- type: ' | string'
- return:
- type: void
- description: ''
- - name: setRightMargin(rightMargin)
- uid: 'ExcelScript!ExcelScript.PageLayout#setRightMargin:member(1)'
- package: ExcelScript!
- fullName: setRightMargin(rightMargin)
- summary: 'The worksheet''s right margin, in points, for use when printing.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setRightMargin(rightMargin: number): void;'
- parameters:
- - id: rightMargin
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setTopMargin(topMargin)
- uid: 'ExcelScript!ExcelScript.PageLayout#setTopMargin:member(1)'
- package: ExcelScript!
- fullName: setTopMargin(topMargin)
- summary: 'The worksheet''s top margin, in points, for use when printing.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTopMargin(topMargin: number): void;'
- parameters:
- - id: topMargin
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setZoom(zoom)
- uid: 'ExcelScript!ExcelScript.PageLayout#setZoom:member(1)'
- package: ExcelScript!
- fullName: setZoom(zoom)
- summary: >-
- The worksheet's print zoom options. The `PageLayoutZoomOptions` object must be set as a JSON object (use `x.zoom =
- {...}` instead of `x.zoom.scale = ...`).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setZoom(zoom: PageLayoutZoomOptions): void;'
- parameters:
- - id: zoom
- description: ''
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script changes the scale-to-fit of the page layout.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- const sheet = workbook.getActiveWorksheet();
-
- // Scale the layout to half size for printing.
- const layout = sheet.getPageLayout();
- const zoomOptions: ExcelScript.PageLayoutZoomOptions = {
- scale: 50
- }
- layout.setZoom(zoomOptions)
- }
- ```
+### YamlMime:TSType
+name: ExcelScript.PageLayout
+uid: 'ExcelScript!ExcelScript.PageLayout:interface'
+package: ExcelScript!
+fullName: ExcelScript.PageLayout
+summary: >-
+ 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.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets some basic page layout settings for printing.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Go to each worksheet so the print settings are consistent.
+ workbook.getWorksheets().forEach((sheet) => {
+ const pageLayout : ExcelScript.PageLayout = sheet.getPageLayout();
+
+ // Turn off draft mode so images are printed.
+ pageLayout.setDraftMode(false);
+
+ // Print on 8.5"x11" paper.
+ pageLayout.setPaperSize(ExcelScript.PaperType.letter);
+
+ // Print every page with a landscape orientation.
+ pageLayout.setOrientation(ExcelScript.PageOrientation.landscape);
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getBlackAndWhite()
+ uid: 'ExcelScript!ExcelScript.PageLayout#getBlackAndWhite:member(1)'
+ package: ExcelScript!
+ fullName: getBlackAndWhite()
+ summary: The worksheet's black and white print option.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBlackAndWhite(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getBottomMargin()
+ uid: 'ExcelScript!ExcelScript.PageLayout#getBottomMargin:member(1)'
+ package: ExcelScript!
+ fullName: getBottomMargin()
+ summary: The worksheet's bottom page margin to use for printing in points.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBottomMargin(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getCenterHorizontally()
+ uid: 'ExcelScript!ExcelScript.PageLayout#getCenterHorizontally:member(1)'
+ package: ExcelScript!
+ fullName: getCenterHorizontally()
+ summary: >-
+ The worksheet's center horizontally flag. This flag determines whether the worksheet will be centered horizontally
+ when it's printed.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCenterHorizontally(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getCenterVertically()
+ uid: 'ExcelScript!ExcelScript.PageLayout#getCenterVertically:member(1)'
+ package: ExcelScript!
+ fullName: getCenterVertically()
+ summary: >-
+ The worksheet's center vertically flag. This flag determines whether the worksheet will be centered vertically
+ when it's printed.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCenterVertically(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getDraftMode()
+ uid: 'ExcelScript!ExcelScript.PageLayout#getDraftMode:member(1)'
+ package: ExcelScript!
+ fullName: getDraftMode()
+ summary: 'The worksheet''s draft mode option. If `true`, the sheet will be printed without graphics.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDraftMode(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getFirstPageNumber()
+ uid: 'ExcelScript!ExcelScript.PageLayout#getFirstPageNumber:member(1)'
+ package: ExcelScript!
+ fullName: getFirstPageNumber()
+ summary: The worksheet's first page number to print. A `null` value represents "auto" page numbering.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFirstPageNumber(): number | "";'
+ return:
+ type: number | ""
+ description: ''
+ - name: getFooterMargin()
+ uid: 'ExcelScript!ExcelScript.PageLayout#getFooterMargin:member(1)'
+ package: ExcelScript!
+ fullName: getFooterMargin()
+ summary: 'The worksheet''s footer margin, in points, for use when printing.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFooterMargin(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getHeaderMargin()
+ uid: 'ExcelScript!ExcelScript.PageLayout#getHeaderMargin:member(1)'
+ package: ExcelScript!
+ fullName: getHeaderMargin()
+ summary: 'The worksheet''s header margin, in points, for use when printing.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHeaderMargin(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getHeadersFooters()
+ uid: 'ExcelScript!ExcelScript.PageLayout#getHeadersFooters:member(1)'
+ package: ExcelScript!
+ fullName: getHeadersFooters()
+ summary: Header and footer configuration for the worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHeadersFooters(): HeaderFooterGroup;'
+ return:
+ type: ''
+ description: ''
+ - name: getLeftMargin()
+ uid: 'ExcelScript!ExcelScript.PageLayout#getLeftMargin:member(1)'
+ package: ExcelScript!
+ fullName: getLeftMargin()
+ summary: 'The worksheet''s left margin, in points, for use when printing.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLeftMargin(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getOrientation()
+ uid: 'ExcelScript!ExcelScript.PageLayout#getOrientation:member(1)'
+ package: ExcelScript!
+ fullName: getOrientation()
+ summary: The worksheet's orientation of the page.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getOrientation(): PageOrientation;'
+ return:
+ type: ''
+ description: ''
+ - name: getPaperSize()
+ uid: 'ExcelScript!ExcelScript.PageLayout#getPaperSize:member(1)'
+ package: ExcelScript!
+ fullName: getPaperSize()
+ summary: The worksheet's paper size of the page.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPaperSize(): PaperType;'
+ return:
+ type: ''
+ description: ''
+ - name: getPrintArea()
+ uid: 'ExcelScript!ExcelScript.PageLayout#getPrintArea:member(1)'
+ package: ExcelScript!
+ fullName: getPrintArea()
+ summary: >-
+ Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents the print area for the
+ worksheet. If there is no print area, then this method returns `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPrintArea(): RangeAreas;'
+ return:
+ type: ''
+ description: ''
+ - name: getPrintComments()
+ uid: 'ExcelScript!ExcelScript.PageLayout#getPrintComments:member(1)'
+ package: ExcelScript!
+ fullName: getPrintComments()
+ summary: Specifies if the worksheet's comments should be displayed when printing.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPrintComments(): PrintComments;'
+ return:
+ type: ''
+ description: ''
+ - name: getPrintErrors()
+ uid: 'ExcelScript!ExcelScript.PageLayout#getPrintErrors:member(1)'
+ package: ExcelScript!
+ fullName: getPrintErrors()
+ summary: The worksheet's print errors option.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPrintErrors(): PrintErrorType;'
+ return:
+ type: ''
+ description: ''
+ - name: getPrintGridlines()
+ uid: 'ExcelScript!ExcelScript.PageLayout#getPrintGridlines:member(1)'
+ package: ExcelScript!
+ fullName: getPrintGridlines()
+ summary: Specifies if the worksheet's gridlines will be printed.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPrintGridlines(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getPrintHeadings()
+ uid: 'ExcelScript!ExcelScript.PageLayout#getPrintHeadings:member(1)'
+ package: ExcelScript!
+ fullName: getPrintHeadings()
+ summary: Specifies if the worksheet's headings will be printed.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPrintHeadings(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getPrintOrder()
+ uid: 'ExcelScript!ExcelScript.PageLayout#getPrintOrder:member(1)'
+ package: ExcelScript!
+ fullName: getPrintOrder()
+ summary: The worksheet's page print order option. This specifies the order to use for processing the page number printed.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPrintOrder(): PrintOrder;'
+ return:
+ type: ''
+ description: ''
+ - name: getPrintTitleColumns()
+ uid: 'ExcelScript!ExcelScript.PageLayout#getPrintTitleColumns:member(1)'
+ package: ExcelScript!
+ fullName: getPrintTitleColumns()
+ summary: 'Gets the range object representing the title columns. If not set, then this method returns `undefined`.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPrintTitleColumns(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getPrintTitleRows()
+ uid: 'ExcelScript!ExcelScript.PageLayout#getPrintTitleRows:member(1)'
+ package: ExcelScript!
+ fullName: getPrintTitleRows()
+ summary: 'Gets the range object representing the title rows. If not set, then this method returns `undefined`.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPrintTitleRows(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getRightMargin()
+ uid: 'ExcelScript!ExcelScript.PageLayout#getRightMargin:member(1)'
+ package: ExcelScript!
+ fullName: getRightMargin()
+ summary: 'The worksheet''s right margin, in points, for use when printing.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRightMargin(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getTopMargin()
+ uid: 'ExcelScript!ExcelScript.PageLayout#getTopMargin:member(1)'
+ package: ExcelScript!
+ fullName: getTopMargin()
+ summary: 'The worksheet''s top margin, in points, for use when printing.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTopMargin(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getZoom()
+ uid: 'ExcelScript!ExcelScript.PageLayout#getZoom:member(1)'
+ package: ExcelScript!
+ fullName: getZoom()
+ summary: >-
+ The worksheet's print zoom options. The `PageLayoutZoomOptions` object must be set as a JSON object (use `x.zoom =
+ {...}` instead of `x.zoom.scale = ...`).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getZoom(): PageLayoutZoomOptions;'
+ return:
+ type: ''
+ description: ''
+ - name: setBlackAndWhite(blackAndWhite)
+ uid: 'ExcelScript!ExcelScript.PageLayout#setBlackAndWhite:member(1)'
+ package: ExcelScript!
+ fullName: setBlackAndWhite(blackAndWhite)
+ summary: The worksheet's black and white print option.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setBlackAndWhite(blackAndWhite: boolean): void;'
+ parameters:
+ - id: blackAndWhite
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setBottomMargin(bottomMargin)
+ uid: 'ExcelScript!ExcelScript.PageLayout#setBottomMargin:member(1)'
+ package: ExcelScript!
+ fullName: setBottomMargin(bottomMargin)
+ summary: The worksheet's bottom page margin to use for printing in points.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setBottomMargin(bottomMargin: number): void;'
+ parameters:
+ - id: bottomMargin
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setCenterHorizontally(centerHorizontally)
+ uid: 'ExcelScript!ExcelScript.PageLayout#setCenterHorizontally:member(1)'
+ package: ExcelScript!
+ fullName: setCenterHorizontally(centerHorizontally)
+ summary: >-
+ The worksheet's center horizontally flag. This flag determines whether the worksheet will be centered horizontally
+ when it's printed.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setCenterHorizontally(centerHorizontally: boolean): void;'
+ parameters:
+ - id: centerHorizontally
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setCenterVertically(centerVertically)
+ uid: 'ExcelScript!ExcelScript.PageLayout#setCenterVertically:member(1)'
+ package: ExcelScript!
+ fullName: setCenterVertically(centerVertically)
+ summary: >-
+ The worksheet's center vertically flag. This flag determines whether the worksheet will be centered vertically
+ when it's printed.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setCenterVertically(centerVertically: boolean): void;'
+ parameters:
+ - id: centerVertically
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setDraftMode(draftMode)
+ uid: 'ExcelScript!ExcelScript.PageLayout#setDraftMode:member(1)'
+ package: ExcelScript!
+ fullName: setDraftMode(draftMode)
+ summary: 'The worksheet''s draft mode option. If `true`, the sheet will be printed without graphics.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setDraftMode(draftMode: boolean): void;'
+ parameters:
+ - id: draftMode
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script turns off the print setting for draft mode.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Go to each worksheet so the print settings are consistent.
+ workbook.getWorksheets().forEach((sheet) => {
+ const pageLayout = sheet.getPageLayout();
+
+ // Turn off draft mode so images are printed.
+ pageLayout.setDraftMode(false);
+ });
+ }
+ ```
+ - name: setFirstPageNumber(firstPageNumber)
+ uid: 'ExcelScript!ExcelScript.PageLayout#setFirstPageNumber:member(1)'
+ package: ExcelScript!
+ fullName: setFirstPageNumber(firstPageNumber)
+ summary: The worksheet's first page number to print. A `null` value represents "auto" page numbering.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFirstPageNumber(firstPageNumber: number | ""): void;'
+ parameters:
+ - id: firstPageNumber
+ description: ''
+ type: number | ""
+ return:
+ type: void
+ description: ''
+ - name: setFooterMargin(footerMargin)
+ uid: 'ExcelScript!ExcelScript.PageLayout#setFooterMargin:member(1)'
+ package: ExcelScript!
+ fullName: setFooterMargin(footerMargin)
+ summary: 'The worksheet''s footer margin, in points, for use when printing.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFooterMargin(footerMargin: number): void;'
+ parameters:
+ - id: footerMargin
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setHeaderMargin(headerMargin)
+ uid: 'ExcelScript!ExcelScript.PageLayout#setHeaderMargin:member(1)'
+ package: ExcelScript!
+ fullName: setHeaderMargin(headerMargin)
+ summary: 'The worksheet''s header margin, in points, for use when printing.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setHeaderMargin(headerMargin: number): void;'
+ parameters:
+ - id: headerMargin
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setLeftMargin(leftMargin)
+ uid: 'ExcelScript!ExcelScript.PageLayout#setLeftMargin:member(1)'
+ package: ExcelScript!
+ fullName: setLeftMargin(leftMargin)
+ summary: 'The worksheet''s left margin, in points, for use when printing.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLeftMargin(leftMargin: number): void;'
+ parameters:
+ - id: leftMargin
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setOrientation(orientation)
+ uid: 'ExcelScript!ExcelScript.PageLayout#setOrientation:member(1)'
+ package: ExcelScript!
+ fullName: setOrientation(orientation)
+ summary: The worksheet's orientation of the page.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setOrientation(orientation: PageOrientation): void;'
+ parameters:
+ - id: orientation
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the printing orientation for the entire workbook.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Go to each worksheet so the print settings are consistent.
+ workbook.getWorksheets().forEach((sheet) => {
+ const pageLayout = sheet.getPageLayout();
+
+ // Print every page with a landscape orientation.
+ pageLayout.setOrientation(ExcelScript.PageOrientation.landscape);
+ });
+ }
+ ```
+ - name: setPaperSize(paperSize)
+ uid: 'ExcelScript!ExcelScript.PageLayout#setPaperSize:member(1)'
+ package: ExcelScript!
+ fullName: setPaperSize(paperSize)
+ summary: The worksheet's paper size of the page.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPaperSize(paperSize: PaperType): void;'
+ parameters:
+ - id: paperSize
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the page size for printing.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Go to each worksheet so the print settings are consistent.
+ workbook.getWorksheets().forEach((sheet) => {
+ const pageLayout = sheet.getPageLayout();
+ // Print on 8.5"x11" paper.
+ pageLayout.setPaperSize(ExcelScript.PaperType.letter);
+ });
+ }
+ ```
+ - name: setPrintArea(printArea)
+ uid: 'ExcelScript!ExcelScript.PageLayout#setPrintArea:member(1)'
+ package: ExcelScript!
+ fullName: setPrintArea(printArea)
+ summary: Sets the worksheet's print area.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPrintArea(printArea: Range | RangeAreas | string): void;'
+ parameters:
+ - id: printArea
+ description: The range or ranges of the content to print.
+ type: >-
+ | | string
+ return:
+ type: void
+ description: ''
+ - name: setPrintComments(printComments)
+ uid: 'ExcelScript!ExcelScript.PageLayout#setPrintComments:member(1)'
+ package: ExcelScript!
+ fullName: setPrintComments(printComments)
+ summary: Specifies if the worksheet's comments should be displayed when printing.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPrintComments(printComments: PrintComments): void;'
+ parameters:
+ - id: printComments
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script makes the comments print at the end of the worksheet
+ * when the workbook is printed.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Access every worksheet in the workbook.
+ workbook.getWorksheets().forEach(worksheet => {
+ // Get the page layout for each sheet.
+ const layout = worksheet.getPageLayout();
+
+ // Change the comment printing settings to print them at the end of the sheet.
+ layout.setPrintComments(ExcelScript.PrintComments.endSheet);
+ });
+ }
+ ```
+ - name: setPrintErrors(printErrors)
+ uid: 'ExcelScript!ExcelScript.PageLayout#setPrintErrors:member(1)'
+ package: ExcelScript!
+ fullName: setPrintErrors(printErrors)
+ summary: The worksheet's print errors option.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPrintErrors(printErrors: PrintErrorType): void;'
+ parameters:
+ - id: printErrors
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setPrintGridlines(printGridlines)
+ uid: 'ExcelScript!ExcelScript.PageLayout#setPrintGridlines:member(1)'
+ package: ExcelScript!
+ fullName: setPrintGridlines(printGridlines)
+ summary: Specifies if the worksheet's gridlines will be printed.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPrintGridlines(printGridlines: boolean): void;'
+ parameters:
+ - id: printGridlines
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setPrintHeadings(printHeadings)
+ uid: 'ExcelScript!ExcelScript.PageLayout#setPrintHeadings:member(1)'
+ package: ExcelScript!
+ fullName: setPrintHeadings(printHeadings)
+ summary: Specifies if the worksheet's headings will be printed.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPrintHeadings(printHeadings: boolean): void;'
+ parameters:
+ - id: printHeadings
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: 'setPrintMargins(unit, marginOptions)'
+ uid: 'ExcelScript!ExcelScript.PageLayout#setPrintMargins:member(1)'
+ package: ExcelScript!
+ fullName: 'setPrintMargins(unit, marginOptions)'
+ summary: Sets the worksheet's page margins with units.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setPrintMargins(
+ unit: PrintMarginUnit,
+ marginOptions: PageLayoutMarginOptions
+ ): void;
+ parameters:
+ - id: unit
+ description: Measurement unit for the margins provided.
+ type: ''
+ - id: marginOptions
+ description: Margin values to set. Margins not provided remain unchanged.
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setPrintOrder(printOrder)
+ uid: 'ExcelScript!ExcelScript.PageLayout#setPrintOrder:member(1)'
+ package: ExcelScript!
+ fullName: setPrintOrder(printOrder)
+ summary: The worksheet's page print order option. This specifies the order to use for processing the page number printed.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPrintOrder(printOrder: PrintOrder): void;'
+ parameters:
+ - id: printOrder
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the print order for every worksheet in the workbook.
+ * The order of printed content will go over (e.g., left-to-right)
+ * then down (i.e., top-to-bottom).
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Access every worksheet in the workbook.
+ workbook.getWorksheets().forEach(worksheet => {
+ // Get the page layout for each sheet.
+ const layout: ExcelScript.PageLayout = worksheet.getPageLayout();
+
+ // Set the print order to over-then-down.
+ layout.setPrintOrder(ExcelScript.PrintOrder.overThenDown);
+ });
+ }
+ ```
+ - name: setPrintTitleColumns(printTitleColumns)
+ uid: 'ExcelScript!ExcelScript.PageLayout#setPrintTitleColumns:member(1)'
+ package: ExcelScript!
+ fullName: setPrintTitleColumns(printTitleColumns)
+ summary: Sets the columns that contain the cells to be repeated at the left of each page of the worksheet for printing.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPrintTitleColumns(printTitleColumns: Range | string): void;'
+ parameters:
+ - id: printTitleColumns
+ description: The columns to be repeated to the left of each page. The range must span the entire column to be valid.
+ type: ' | string'
+ return:
+ type: void
+ description: ''
+ - name: setPrintTitleRows(printTitleRows)
+ uid: 'ExcelScript!ExcelScript.PageLayout#setPrintTitleRows:member(1)'
+ package: ExcelScript!
+ fullName: setPrintTitleRows(printTitleRows)
+ summary: Sets the rows that contain the cells to be repeated at the top of each page of the worksheet for printing.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPrintTitleRows(printTitleRows: Range | string): void;'
+ parameters:
+ - id: printTitleRows
+ description: The rows to be repeated at the top of each page. The range must span the entire row to be valid.
+ type: ' | string'
+ return:
+ type: void
+ description: ''
+ - name: setRightMargin(rightMargin)
+ uid: 'ExcelScript!ExcelScript.PageLayout#setRightMargin:member(1)'
+ package: ExcelScript!
+ fullName: setRightMargin(rightMargin)
+ summary: 'The worksheet''s right margin, in points, for use when printing.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setRightMargin(rightMargin: number): void;'
+ parameters:
+ - id: rightMargin
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setTopMargin(topMargin)
+ uid: 'ExcelScript!ExcelScript.PageLayout#setTopMargin:member(1)'
+ package: ExcelScript!
+ fullName: setTopMargin(topMargin)
+ summary: 'The worksheet''s top margin, in points, for use when printing.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTopMargin(topMargin: number): void;'
+ parameters:
+ - id: topMargin
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setZoom(zoom)
+ uid: 'ExcelScript!ExcelScript.PageLayout#setZoom:member(1)'
+ package: ExcelScript!
+ fullName: setZoom(zoom)
+ summary: >-
+ The worksheet's print zoom options. The `PageLayoutZoomOptions` object must be set as a JSON object (use `x.zoom =
+ {...}` instead of `x.zoom.scale = ...`).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setZoom(zoom: PageLayoutZoomOptions): void;'
+ parameters:
+ - id: zoom
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script changes the scale-to-fit of the page layout.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ const sheet = workbook.getActiveWorksheet();
+
+ // Scale the layout to half size for printing.
+ const layout = sheet.getPageLayout();
+ const zoomOptions: ExcelScript.PageLayoutZoomOptions = {
+ scale: 50
+ }
+ layout.setZoom(zoomOptions)
+ }
+ ```
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.pagelayoutmarginoptions.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.pagelayoutmarginoptions.yml
index 387382b3..d5c672af 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.pagelayoutmarginoptions.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.pagelayoutmarginoptions.yml
@@ -1,83 +1,83 @@
-### YamlMime:TSType
-name: ExcelScript.PageLayoutMarginOptions
-uid: 'ExcelScript!ExcelScript.PageLayoutMarginOptions:interface'
-package: ExcelScript!
-fullName: ExcelScript.PageLayoutMarginOptions
-summary: Represents the options in page layout margins.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: bottom
- uid: 'ExcelScript!ExcelScript.PageLayoutMarginOptions#bottom:member'
- package: ExcelScript!
- fullName: bottom
- summary: Specifies the page layout bottom margin in the unit specified to use for printing.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'bottom?: number;'
- return:
- type: number
- - name: footer
- uid: 'ExcelScript!ExcelScript.PageLayoutMarginOptions#footer:member'
- package: ExcelScript!
- fullName: footer
- summary: Specifies the page layout footer margin in the unit specified to use for printing.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'footer?: number;'
- return:
- type: number
- - name: header
- uid: 'ExcelScript!ExcelScript.PageLayoutMarginOptions#header:member'
- package: ExcelScript!
- fullName: header
- summary: Specifies the page layout header margin in the unit specified to use for printing.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'header?: number;'
- return:
- type: number
- - name: left
- uid: 'ExcelScript!ExcelScript.PageLayoutMarginOptions#left:member'
- package: ExcelScript!
- fullName: left
- summary: Specifies the page layout left margin in the unit specified to use for printing.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'left?: number;'
- return:
- type: number
- - name: right
- uid: 'ExcelScript!ExcelScript.PageLayoutMarginOptions#right:member'
- package: ExcelScript!
- fullName: right
- summary: Specifies the page layout right margin in the unit specified to use for printing.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'right?: number;'
- return:
- type: number
- - name: top
- uid: 'ExcelScript!ExcelScript.PageLayoutMarginOptions#top:member'
- package: ExcelScript!
- fullName: top
- summary: Specifies the page layout top margin in the unit specified to use for printing.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'top?: number;'
- return:
- type: number
+### YamlMime:TSType
+name: ExcelScript.PageLayoutMarginOptions
+uid: 'ExcelScript!ExcelScript.PageLayoutMarginOptions:interface'
+package: ExcelScript!
+fullName: ExcelScript.PageLayoutMarginOptions
+summary: Represents the options in page layout margins.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: bottom
+ uid: 'ExcelScript!ExcelScript.PageLayoutMarginOptions#bottom:member'
+ package: ExcelScript!
+ fullName: bottom
+ summary: Specifies the page layout bottom margin in the unit specified to use for printing.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'bottom?: number;'
+ return:
+ type: number
+ - name: footer
+ uid: 'ExcelScript!ExcelScript.PageLayoutMarginOptions#footer:member'
+ package: ExcelScript!
+ fullName: footer
+ summary: Specifies the page layout footer margin in the unit specified to use for printing.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'footer?: number;'
+ return:
+ type: number
+ - name: header
+ uid: 'ExcelScript!ExcelScript.PageLayoutMarginOptions#header:member'
+ package: ExcelScript!
+ fullName: header
+ summary: Specifies the page layout header margin in the unit specified to use for printing.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'header?: number;'
+ return:
+ type: number
+ - name: left
+ uid: 'ExcelScript!ExcelScript.PageLayoutMarginOptions#left:member'
+ package: ExcelScript!
+ fullName: left
+ summary: Specifies the page layout left margin in the unit specified to use for printing.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'left?: number;'
+ return:
+ type: number
+ - name: right
+ uid: 'ExcelScript!ExcelScript.PageLayoutMarginOptions#right:member'
+ package: ExcelScript!
+ fullName: right
+ summary: Specifies the page layout right margin in the unit specified to use for printing.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'right?: number;'
+ return:
+ type: number
+ - name: top
+ uid: 'ExcelScript!ExcelScript.PageLayoutMarginOptions#top:member'
+ package: ExcelScript!
+ fullName: top
+ summary: Specifies the page layout top margin in the unit specified to use for printing.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'top?: number;'
+ return:
+ type: number
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.pagelayoutzoomoptions.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.pagelayoutzoomoptions.yml
index 345a6b47..a6294fae 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.pagelayoutzoomoptions.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.pagelayoutzoomoptions.yml
@@ -1,69 +1,69 @@
-### YamlMime:TSType
-name: ExcelScript.PageLayoutZoomOptions
-uid: 'ExcelScript!ExcelScript.PageLayoutZoomOptions:interface'
-package: ExcelScript!
-fullName: ExcelScript.PageLayoutZoomOptions
-summary: Represents page zoom properties.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script changes the scale-to-fit of the page layout.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- const sheet = workbook.getActiveWorksheet();
-
- // Scale the layout to half size for printing.
- const layout = sheet.getPageLayout();
- const zoomOptions: ExcelScript.PageLayoutZoomOptions = {
- scale: 50
- }
- layout.setZoom(zoomOptions)
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: horizontalFitToPages
- uid: 'ExcelScript!ExcelScript.PageLayoutZoomOptions#horizontalFitToPages:member'
- package: ExcelScript!
- fullName: horizontalFitToPages
- summary: Number of pages to fit horizontally. This value can be `null` if percentage scale is used.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'horizontalFitToPages?: number;'
- return:
- type: number
- - name: scale
- uid: 'ExcelScript!ExcelScript.PageLayoutZoomOptions#scale:member'
- package: ExcelScript!
- fullName: scale
- summary: >-
- Print page scale value can be between 10 and 400. This value can be `null` if fit to page tall or wide is
- specified.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'scale?: number;'
- return:
- type: number
- - name: verticalFitToPages
- uid: 'ExcelScript!ExcelScript.PageLayoutZoomOptions#verticalFitToPages:member'
- package: ExcelScript!
- fullName: verticalFitToPages
- summary: Number of pages to fit vertically. This value can be `null` if percentage scale is used.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'verticalFitToPages?: number;'
- return:
- type: number
+### YamlMime:TSType
+name: ExcelScript.PageLayoutZoomOptions
+uid: 'ExcelScript!ExcelScript.PageLayoutZoomOptions:interface'
+package: ExcelScript!
+fullName: ExcelScript.PageLayoutZoomOptions
+summary: Represents page zoom properties.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script changes the scale-to-fit of the page layout.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ const sheet = workbook.getActiveWorksheet();
+
+ // Scale the layout to half size for printing.
+ const layout = sheet.getPageLayout();
+ const zoomOptions: ExcelScript.PageLayoutZoomOptions = {
+ scale: 50
+ }
+ layout.setZoom(zoomOptions)
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: horizontalFitToPages
+ uid: 'ExcelScript!ExcelScript.PageLayoutZoomOptions#horizontalFitToPages:member'
+ package: ExcelScript!
+ fullName: horizontalFitToPages
+ summary: Number of pages to fit horizontally. This value can be `null` if percentage scale is used.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'horizontalFitToPages?: number;'
+ return:
+ type: number
+ - name: scale
+ uid: 'ExcelScript!ExcelScript.PageLayoutZoomOptions#scale:member'
+ package: ExcelScript!
+ fullName: scale
+ summary: >-
+ Print page scale value can be between 10 and 400. This value can be `null` if fit to page tall or wide is
+ specified.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'scale?: number;'
+ return:
+ type: number
+ - name: verticalFitToPages
+ uid: 'ExcelScript!ExcelScript.PageLayoutZoomOptions#verticalFitToPages:member'
+ package: ExcelScript!
+ fullName: verticalFitToPages
+ summary: Number of pages to fit vertically. This value can be `null` if percentage scale is used.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'verticalFitToPages?: number;'
+ return:
+ type: number
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.pageorientation.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.pageorientation.yml
index ec42cf83..e9fd26e2 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.pageorientation.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.pageorientation.yml
@@ -1,36 +1,36 @@
-### YamlMime:TSEnum
-name: ExcelScript.PageOrientation
-uid: 'ExcelScript!ExcelScript.PageOrientation:enum'
-package: ExcelScript!
-fullName: ExcelScript.PageOrientation
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the printing orientation for the entire workbook.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Go to each worksheet so the print settings are consistent.
- workbook.getWorksheets().forEach((sheet) => {
- const pageLayout = sheet.getPageLayout();
-
- // Print every page with a landscape orientation.
- pageLayout.setOrientation(ExcelScript.PageOrientation.landscape);
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: landscape
- uid: 'ExcelScript!ExcelScript.PageOrientation.landscape:member'
- package: ExcelScript!
- summary: ''
- - name: portrait
- uid: 'ExcelScript!ExcelScript.PageOrientation.portrait:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.PageOrientation
+uid: 'ExcelScript!ExcelScript.PageOrientation:enum'
+package: ExcelScript!
+fullName: ExcelScript.PageOrientation
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the printing orientation for the entire workbook.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Go to each worksheet so the print settings are consistent.
+ workbook.getWorksheets().forEach((sheet) => {
+ const pageLayout = sheet.getPageLayout();
+
+ // Print every page with a landscape orientation.
+ pageLayout.setOrientation(ExcelScript.PageOrientation.landscape);
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: landscape
+ uid: 'ExcelScript!ExcelScript.PageOrientation.landscape:member'
+ package: ExcelScript!
+ summary: ''
+ - name: portrait
+ uid: 'ExcelScript!ExcelScript.PageOrientation.portrait:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.papertype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.papertype.yml
index 145d9bc9..792a3ccb 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.papertype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.papertype.yml
@@ -1,191 +1,191 @@
-### YamlMime:TSEnum
-name: ExcelScript.PaperType
-uid: 'ExcelScript!ExcelScript.PaperType:enum'
-package: ExcelScript!
-fullName: ExcelScript.PaperType
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the page size for printing.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Go to each worksheet so the print settings are consistent.
- workbook.getWorksheets().forEach((sheet) => {
- const pageLayout = sheet.getPageLayout();
- // Print on 8.5"x11" paper.
- pageLayout.setPaperSize(ExcelScript.PaperType.letter);
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: a3
- uid: 'ExcelScript!ExcelScript.PaperType.a3:member'
- package: ExcelScript!
- summary: ''
- - name: a4
- uid: 'ExcelScript!ExcelScript.PaperType.a4:member'
- package: ExcelScript!
- summary: ''
- - name: a4Small
- uid: 'ExcelScript!ExcelScript.PaperType.a4Small:member'
- package: ExcelScript!
- summary: ''
- - name: a5
- uid: 'ExcelScript!ExcelScript.PaperType.a5:member'
- package: ExcelScript!
- summary: ''
- - name: b4
- uid: 'ExcelScript!ExcelScript.PaperType.b4:member'
- package: ExcelScript!
- summary: ''
- - name: b5
- uid: 'ExcelScript!ExcelScript.PaperType.b5:member'
- package: ExcelScript!
- summary: ''
- - name: csheet
- uid: 'ExcelScript!ExcelScript.PaperType.csheet:member'
- package: ExcelScript!
- summary: ''
- - name: dsheet
- uid: 'ExcelScript!ExcelScript.PaperType.dsheet:member'
- package: ExcelScript!
- summary: ''
- - name: envelope10
- uid: 'ExcelScript!ExcelScript.PaperType.envelope10:member'
- package: ExcelScript!
- summary: ''
- - name: envelope11
- uid: 'ExcelScript!ExcelScript.PaperType.envelope11:member'
- package: ExcelScript!
- summary: ''
- - name: envelope12
- uid: 'ExcelScript!ExcelScript.PaperType.envelope12:member'
- package: ExcelScript!
- summary: ''
- - name: envelope14
- uid: 'ExcelScript!ExcelScript.PaperType.envelope14:member'
- package: ExcelScript!
- summary: ''
- - name: envelope9
- uid: 'ExcelScript!ExcelScript.PaperType.envelope9:member'
- package: ExcelScript!
- summary: ''
- - name: envelopeB4
- uid: 'ExcelScript!ExcelScript.PaperType.envelopeB4:member'
- package: ExcelScript!
- summary: ''
- - name: envelopeB5
- uid: 'ExcelScript!ExcelScript.PaperType.envelopeB5:member'
- package: ExcelScript!
- summary: ''
- - name: envelopeB6
- uid: 'ExcelScript!ExcelScript.PaperType.envelopeB6:member'
- package: ExcelScript!
- summary: ''
- - name: envelopeC3
- uid: 'ExcelScript!ExcelScript.PaperType.envelopeC3:member'
- package: ExcelScript!
- summary: ''
- - name: envelopeC4
- uid: 'ExcelScript!ExcelScript.PaperType.envelopeC4:member'
- package: ExcelScript!
- summary: ''
- - name: envelopeC5
- uid: 'ExcelScript!ExcelScript.PaperType.envelopeC5:member'
- package: ExcelScript!
- summary: ''
- - name: envelopeC6
- uid: 'ExcelScript!ExcelScript.PaperType.envelopeC6:member'
- package: ExcelScript!
- summary: ''
- - name: envelopeC65
- uid: 'ExcelScript!ExcelScript.PaperType.envelopeC65:member'
- package: ExcelScript!
- summary: ''
- - name: envelopeDL
- uid: 'ExcelScript!ExcelScript.PaperType.envelopeDL:member'
- package: ExcelScript!
- summary: ''
- - name: envelopeItaly
- uid: 'ExcelScript!ExcelScript.PaperType.envelopeItaly:member'
- package: ExcelScript!
- summary: ''
- - name: envelopeMonarch
- uid: 'ExcelScript!ExcelScript.PaperType.envelopeMonarch:member'
- package: ExcelScript!
- summary: ''
- - name: envelopePersonal
- uid: 'ExcelScript!ExcelScript.PaperType.envelopePersonal:member'
- package: ExcelScript!
- summary: ''
- - name: esheet
- uid: 'ExcelScript!ExcelScript.PaperType.esheet:member'
- package: ExcelScript!
- summary: ''
- - name: executive
- uid: 'ExcelScript!ExcelScript.PaperType.executive:member'
- package: ExcelScript!
- summary: ''
- - name: fanfoldLegalGerman
- uid: 'ExcelScript!ExcelScript.PaperType.fanfoldLegalGerman:member'
- package: ExcelScript!
- summary: ''
- - name: fanfoldStdGerman
- uid: 'ExcelScript!ExcelScript.PaperType.fanfoldStdGerman:member'
- package: ExcelScript!
- summary: ''
- - name: fanfoldUS
- uid: 'ExcelScript!ExcelScript.PaperType.fanfoldUS:member'
- package: ExcelScript!
- summary: ''
- - name: folio
- uid: 'ExcelScript!ExcelScript.PaperType.folio:member'
- package: ExcelScript!
- summary: ''
- - name: ledger
- uid: 'ExcelScript!ExcelScript.PaperType.ledger:member'
- package: ExcelScript!
- summary: ''
- - name: legal
- uid: 'ExcelScript!ExcelScript.PaperType.legal:member'
- package: ExcelScript!
- summary: ''
- - name: letter
- uid: 'ExcelScript!ExcelScript.PaperType.letter:member'
- package: ExcelScript!
- summary: ''
- - name: letterSmall
- uid: 'ExcelScript!ExcelScript.PaperType.letterSmall:member'
- package: ExcelScript!
- summary: ''
- - name: note
- uid: 'ExcelScript!ExcelScript.PaperType.note:member'
- package: ExcelScript!
- summary: ''
- - name: paper10x14
- uid: 'ExcelScript!ExcelScript.PaperType.paper10x14:member'
- package: ExcelScript!
- summary: ''
- - name: paper11x17
- uid: 'ExcelScript!ExcelScript.PaperType.paper11x17:member'
- package: ExcelScript!
- summary: ''
- - name: quatro
- uid: 'ExcelScript!ExcelScript.PaperType.quatro:member'
- package: ExcelScript!
- summary: ''
- - name: statement
- uid: 'ExcelScript!ExcelScript.PaperType.statement:member'
- package: ExcelScript!
- summary: ''
- - name: tabloid
- uid: 'ExcelScript!ExcelScript.PaperType.tabloid:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.PaperType
+uid: 'ExcelScript!ExcelScript.PaperType:enum'
+package: ExcelScript!
+fullName: ExcelScript.PaperType
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the page size for printing.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Go to each worksheet so the print settings are consistent.
+ workbook.getWorksheets().forEach((sheet) => {
+ const pageLayout = sheet.getPageLayout();
+ // Print on 8.5"x11" paper.
+ pageLayout.setPaperSize(ExcelScript.PaperType.letter);
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: a3
+ uid: 'ExcelScript!ExcelScript.PaperType.a3:member'
+ package: ExcelScript!
+ summary: ''
+ - name: a4
+ uid: 'ExcelScript!ExcelScript.PaperType.a4:member'
+ package: ExcelScript!
+ summary: ''
+ - name: a4Small
+ uid: 'ExcelScript!ExcelScript.PaperType.a4Small:member'
+ package: ExcelScript!
+ summary: ''
+ - name: a5
+ uid: 'ExcelScript!ExcelScript.PaperType.a5:member'
+ package: ExcelScript!
+ summary: ''
+ - name: b4
+ uid: 'ExcelScript!ExcelScript.PaperType.b4:member'
+ package: ExcelScript!
+ summary: ''
+ - name: b5
+ uid: 'ExcelScript!ExcelScript.PaperType.b5:member'
+ package: ExcelScript!
+ summary: ''
+ - name: csheet
+ uid: 'ExcelScript!ExcelScript.PaperType.csheet:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dsheet
+ uid: 'ExcelScript!ExcelScript.PaperType.dsheet:member'
+ package: ExcelScript!
+ summary: ''
+ - name: envelope10
+ uid: 'ExcelScript!ExcelScript.PaperType.envelope10:member'
+ package: ExcelScript!
+ summary: ''
+ - name: envelope11
+ uid: 'ExcelScript!ExcelScript.PaperType.envelope11:member'
+ package: ExcelScript!
+ summary: ''
+ - name: envelope12
+ uid: 'ExcelScript!ExcelScript.PaperType.envelope12:member'
+ package: ExcelScript!
+ summary: ''
+ - name: envelope14
+ uid: 'ExcelScript!ExcelScript.PaperType.envelope14:member'
+ package: ExcelScript!
+ summary: ''
+ - name: envelope9
+ uid: 'ExcelScript!ExcelScript.PaperType.envelope9:member'
+ package: ExcelScript!
+ summary: ''
+ - name: envelopeB4
+ uid: 'ExcelScript!ExcelScript.PaperType.envelopeB4:member'
+ package: ExcelScript!
+ summary: ''
+ - name: envelopeB5
+ uid: 'ExcelScript!ExcelScript.PaperType.envelopeB5:member'
+ package: ExcelScript!
+ summary: ''
+ - name: envelopeB6
+ uid: 'ExcelScript!ExcelScript.PaperType.envelopeB6:member'
+ package: ExcelScript!
+ summary: ''
+ - name: envelopeC3
+ uid: 'ExcelScript!ExcelScript.PaperType.envelopeC3:member'
+ package: ExcelScript!
+ summary: ''
+ - name: envelopeC4
+ uid: 'ExcelScript!ExcelScript.PaperType.envelopeC4:member'
+ package: ExcelScript!
+ summary: ''
+ - name: envelopeC5
+ uid: 'ExcelScript!ExcelScript.PaperType.envelopeC5:member'
+ package: ExcelScript!
+ summary: ''
+ - name: envelopeC6
+ uid: 'ExcelScript!ExcelScript.PaperType.envelopeC6:member'
+ package: ExcelScript!
+ summary: ''
+ - name: envelopeC65
+ uid: 'ExcelScript!ExcelScript.PaperType.envelopeC65:member'
+ package: ExcelScript!
+ summary: ''
+ - name: envelopeDL
+ uid: 'ExcelScript!ExcelScript.PaperType.envelopeDL:member'
+ package: ExcelScript!
+ summary: ''
+ - name: envelopeItaly
+ uid: 'ExcelScript!ExcelScript.PaperType.envelopeItaly:member'
+ package: ExcelScript!
+ summary: ''
+ - name: envelopeMonarch
+ uid: 'ExcelScript!ExcelScript.PaperType.envelopeMonarch:member'
+ package: ExcelScript!
+ summary: ''
+ - name: envelopePersonal
+ uid: 'ExcelScript!ExcelScript.PaperType.envelopePersonal:member'
+ package: ExcelScript!
+ summary: ''
+ - name: esheet
+ uid: 'ExcelScript!ExcelScript.PaperType.esheet:member'
+ package: ExcelScript!
+ summary: ''
+ - name: executive
+ uid: 'ExcelScript!ExcelScript.PaperType.executive:member'
+ package: ExcelScript!
+ summary: ''
+ - name: fanfoldLegalGerman
+ uid: 'ExcelScript!ExcelScript.PaperType.fanfoldLegalGerman:member'
+ package: ExcelScript!
+ summary: ''
+ - name: fanfoldStdGerman
+ uid: 'ExcelScript!ExcelScript.PaperType.fanfoldStdGerman:member'
+ package: ExcelScript!
+ summary: ''
+ - name: fanfoldUS
+ uid: 'ExcelScript!ExcelScript.PaperType.fanfoldUS:member'
+ package: ExcelScript!
+ summary: ''
+ - name: folio
+ uid: 'ExcelScript!ExcelScript.PaperType.folio:member'
+ package: ExcelScript!
+ summary: ''
+ - name: ledger
+ uid: 'ExcelScript!ExcelScript.PaperType.ledger:member'
+ package: ExcelScript!
+ summary: ''
+ - name: legal
+ uid: 'ExcelScript!ExcelScript.PaperType.legal:member'
+ package: ExcelScript!
+ summary: ''
+ - name: letter
+ uid: 'ExcelScript!ExcelScript.PaperType.letter:member'
+ package: ExcelScript!
+ summary: ''
+ - name: letterSmall
+ uid: 'ExcelScript!ExcelScript.PaperType.letterSmall:member'
+ package: ExcelScript!
+ summary: ''
+ - name: note
+ uid: 'ExcelScript!ExcelScript.PaperType.note:member'
+ package: ExcelScript!
+ summary: ''
+ - name: paper10x14
+ uid: 'ExcelScript!ExcelScript.PaperType.paper10x14:member'
+ package: ExcelScript!
+ summary: ''
+ - name: paper11x17
+ uid: 'ExcelScript!ExcelScript.PaperType.paper11x17:member'
+ package: ExcelScript!
+ summary: ''
+ - name: quatro
+ uid: 'ExcelScript!ExcelScript.PaperType.quatro:member'
+ package: ExcelScript!
+ summary: ''
+ - name: statement
+ uid: 'ExcelScript!ExcelScript.PaperType.statement:member'
+ package: ExcelScript!
+ summary: ''
+ - name: tabloid
+ uid: 'ExcelScript!ExcelScript.PaperType.tabloid:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.pictureformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.pictureformat.yml
index bc0a71ee..b9c09b03 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.pictureformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.pictureformat.yml
@@ -1,61 +1,61 @@
-### YamlMime:TSEnum
-name: ExcelScript.PictureFormat
-uid: 'ExcelScript!ExcelScript.PictureFormat:enum'
-package: ExcelScript!
-fullName: ExcelScript.PictureFormat
-summary: The format of the image.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a star shape with the value from cell A1.
- * It then returns the image as a base64-encoded string.
- * This string would be used as part of a Power Automate flow to add the image elsewhere.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the value of A1 from the worksheet named Sheet1.
- const sheet = workbook.getWorksheet("Sheet1");
- const value = sheet.getRange("A1").getValue();
-
- // Create a Shape object that looks like a 5-pointed star.
- const star = sheet.addGeometricShape(ExcelScript.GeometricShapeType.star5);
-
- // Set the text of star and make sure the shape fits the text.
- const textFrame = star.getTextFrame();
- textFrame.getTextRange().setText(value.toString());
- textFrame.setAutoSizeSetting(ExcelScript.ShapeAutoSize.autoSizeShapeToFitText);
-
- // Return the shape as a PNG image represented by a base64-encoded string.
- return star.getAsImage(ExcelScript.PictureFormat.png);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: bmp
- uid: 'ExcelScript!ExcelScript.PictureFormat.bmp:member'
- package: ExcelScript!
- summary: Bitmap image.
- - name: gif
- uid: 'ExcelScript!ExcelScript.PictureFormat.gif:member'
- package: ExcelScript!
- summary: Graphics Interchange Format.
- - name: jpeg
- uid: 'ExcelScript!ExcelScript.PictureFormat.jpeg:member'
- package: ExcelScript!
- summary: Joint Photographic Experts Group.
- - name: png
- uid: 'ExcelScript!ExcelScript.PictureFormat.png:member'
- package: ExcelScript!
- summary: Portable Network Graphics.
- - name: svg
- uid: 'ExcelScript!ExcelScript.PictureFormat.svg:member'
- package: ExcelScript!
- summary: Scalable Vector Graphic.
- - name: unknown
- uid: 'ExcelScript!ExcelScript.PictureFormat.unknown:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.PictureFormat
+uid: 'ExcelScript!ExcelScript.PictureFormat:enum'
+package: ExcelScript!
+fullName: ExcelScript.PictureFormat
+summary: The format of the image.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a star shape with the value from cell A1.
+ * It then returns the image as a base64-encoded string.
+ * This string would be used as part of a Power Automate flow to add the image elsewhere.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the value of A1 from the worksheet named Sheet1.
+ const sheet = workbook.getWorksheet("Sheet1");
+ const value = sheet.getRange("A1").getValue();
+
+ // Create a Shape object that looks like a 5-pointed star.
+ const star = sheet.addGeometricShape(ExcelScript.GeometricShapeType.star5);
+
+ // Set the text of star and make sure the shape fits the text.
+ const textFrame = star.getTextFrame();
+ textFrame.getTextRange().setText(value.toString());
+ textFrame.setAutoSizeSetting(ExcelScript.ShapeAutoSize.autoSizeShapeToFitText);
+
+ // Return the shape as a PNG image represented by a base64-encoded string.
+ return star.getAsImage(ExcelScript.PictureFormat.png);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: bmp
+ uid: 'ExcelScript!ExcelScript.PictureFormat.bmp:member'
+ package: ExcelScript!
+ summary: Bitmap image.
+ - name: gif
+ uid: 'ExcelScript!ExcelScript.PictureFormat.gif:member'
+ package: ExcelScript!
+ summary: Graphics Interchange Format.
+ - name: jpeg
+ uid: 'ExcelScript!ExcelScript.PictureFormat.jpeg:member'
+ package: ExcelScript!
+ summary: Joint Photographic Experts Group.
+ - name: png
+ uid: 'ExcelScript!ExcelScript.PictureFormat.png:member'
+ package: ExcelScript!
+ summary: Portable Network Graphics.
+ - name: svg
+ uid: 'ExcelScript!ExcelScript.PictureFormat.svg:member'
+ package: ExcelScript!
+ summary: Scalable Vector Graphic.
+ - name: unknown
+ uid: 'ExcelScript!ExcelScript.PictureFormat.unknown:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotaxis.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotaxis.yml
index b5221f97..68f5ebbe 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotaxis.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotaxis.yml
@@ -1,30 +1,30 @@
-### YamlMime:TSEnum
-name: ExcelScript.PivotAxis
-uid: 'ExcelScript!ExcelScript.PivotAxis:enum'
-package: ExcelScript!
-fullName: ExcelScript.PivotAxis
-summary: Represents the axis from which to get the PivotItems.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: column
- uid: 'ExcelScript!ExcelScript.PivotAxis.column:member'
- package: ExcelScript!
- summary: The column axis.
- - name: data
- uid: 'ExcelScript!ExcelScript.PivotAxis.data:member'
- package: ExcelScript!
- summary: The data axis.
- - name: filter
- uid: 'ExcelScript!ExcelScript.PivotAxis.filter:member'
- package: ExcelScript!
- summary: The filter axis.
- - name: row
- uid: 'ExcelScript!ExcelScript.PivotAxis.row:member'
- package: ExcelScript!
- summary: The row axis.
- - name: unknown
- uid: 'ExcelScript!ExcelScript.PivotAxis.unknown:member'
- package: ExcelScript!
- summary: The axis or region is unknown or unsupported.
+### YamlMime:TSEnum
+name: ExcelScript.PivotAxis
+uid: 'ExcelScript!ExcelScript.PivotAxis:enum'
+package: ExcelScript!
+fullName: ExcelScript.PivotAxis
+summary: Represents the axis from which to get the PivotItems.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: column
+ uid: 'ExcelScript!ExcelScript.PivotAxis.column:member'
+ package: ExcelScript!
+ summary: The column axis.
+ - name: data
+ uid: 'ExcelScript!ExcelScript.PivotAxis.data:member'
+ package: ExcelScript!
+ summary: The data axis.
+ - name: filter
+ uid: 'ExcelScript!ExcelScript.PivotAxis.filter:member'
+ package: ExcelScript!
+ summary: The filter axis.
+ - name: row
+ uid: 'ExcelScript!ExcelScript.PivotAxis.row:member'
+ package: ExcelScript!
+ summary: The row axis.
+ - name: unknown
+ uid: 'ExcelScript!ExcelScript.PivotAxis.unknown:member'
+ package: ExcelScript!
+ summary: The axis or region is unknown or unsupported.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotdatefilter.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotdatefilter.yml
index bf5c54d6..91cd9118 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotdatefilter.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotdatefilter.yml
@@ -1,155 +1,155 @@
-### YamlMime:TSType
-name: ExcelScript.PivotDateFilter
-uid: 'ExcelScript!ExcelScript.PivotDateFilter:interface'
-package: ExcelScript!
-fullName: ExcelScript.PivotDateFilter
-summary: >-
- 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.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: comparator
- uid: 'ExcelScript!ExcelScript.PivotDateFilter#comparator:member'
- package: ExcelScript!
- fullName: comparator
- summary: >-
- The comparator is the static value to which other values are compared. The type of comparison is defined by the
- condition.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'comparator?: FilterDatetime;'
- return:
- type: ''
- - name: condition
- uid: 'ExcelScript!ExcelScript.PivotDateFilter#condition:member'
- package: ExcelScript!
- fullName: condition
- summary: 'Specifies the condition for the filter, which defines the necessary filtering criteria.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'condition: DateFilterCondition;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a filter to a PivotTable that filters out rows
- * that aren't from this month.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the "Date Recorded" field to filter.
- // The data in this field must be dates in order for the filter to work.
- const pivot = workbook.getPivotTables()[0];
- const rowHierarchy = pivot.getRowHierarchy("Date Recorded");
- const rowField = rowHierarchy.getFields()[0];
-
- // Apply the date filter.
- rowField.applyFilter({
- dateFilter: {
- // Setting the condition to `thisMonth` means items that are before or
- // after this month will not be displayed.
- condition: ExcelScript.DateFilterCondition.thisMonth
- }
- });
- }
- ```
- - name: exclusive
- uid: 'ExcelScript!ExcelScript.PivotDateFilter#exclusive:member'
- package: ExcelScript!
- fullName: exclusive
- summary: >-
- If `true`, filter *excludes* items that meet criteria. The default is `false` (filter to include items
- that meet criteria).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'exclusive?: boolean;'
- return:
- type: boolean
- - name: lowerBound
- uid: 'ExcelScript!ExcelScript.PivotDateFilter#lowerBound:member'
- package: ExcelScript!
- fullName: lowerBound
- summary: The lower-bound of the range for the `between` filter condition.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'lowerBound?: FilterDatetime;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a filter to a PivotTable that filters it
- * to only show rows from between June 20th, 2022 and July 10th, 2022.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the "Date Recorded" field to filter.
- // The data in this field must be dates in order for the filter to work.
- const pivot = workbook.getPivotTables()[0];
- const rowHierarchy = pivot.getRowHierarchy("Date Recorded");
- const rowField = rowHierarchy.getFields()[0];
-
- // Create the filter's date boundaries.
- let earliestDate: ExcelScript.FilterDatetime = {
- date: "2022-06-20",
- specificity: ExcelScript.FilterDatetimeSpecificity.day
- };
- let latestDate: ExcelScript.FilterDatetime = {
- date: "2022-07-10",
- specificity: ExcelScript.FilterDatetimeSpecificity.day
- };
-
- // Apply the date filter.
- rowField.applyFilter({
- dateFilter: {
- condition: ExcelScript.DateFilterCondition.between,
- lowerBound: earliestDate,
- upperBound: latestDate
- }
- });
- }
- ```
- - name: upperBound
- uid: 'ExcelScript!ExcelScript.PivotDateFilter#upperBound:member'
- package: ExcelScript!
- fullName: upperBound
- summary: The upper-bound of the range for the `between` filter condition.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'upperBound?: FilterDatetime;'
- return:
- type: ''
- - name: wholeDays
- uid: 'ExcelScript!ExcelScript.PivotDateFilter#wholeDays:member'
- package: ExcelScript!
- fullName: wholeDays
- summary: >-
- For `equals`, `before`, `after`, and `between` filter conditions, indicates if comparisons
- should be made as whole days.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'wholeDays?: boolean;'
- return:
- type: boolean
+### YamlMime:TSType
+name: ExcelScript.PivotDateFilter
+uid: 'ExcelScript!ExcelScript.PivotDateFilter:interface'
+package: ExcelScript!
+fullName: ExcelScript.PivotDateFilter
+summary: >-
+ 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.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: comparator
+ uid: 'ExcelScript!ExcelScript.PivotDateFilter#comparator:member'
+ package: ExcelScript!
+ fullName: comparator
+ summary: >-
+ The comparator is the static value to which other values are compared. The type of comparison is defined by the
+ condition.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'comparator?: FilterDatetime;'
+ return:
+ type: ''
+ - name: condition
+ uid: 'ExcelScript!ExcelScript.PivotDateFilter#condition:member'
+ package: ExcelScript!
+ fullName: condition
+ summary: 'Specifies the condition for the filter, which defines the necessary filtering criteria.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'condition: DateFilterCondition;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a filter to a PivotTable that filters out rows
+ * that aren't from this month.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the "Date Recorded" field to filter.
+ // The data in this field must be dates in order for the filter to work.
+ const pivot = workbook.getPivotTables()[0];
+ const rowHierarchy = pivot.getRowHierarchy("Date Recorded");
+ const rowField = rowHierarchy.getFields()[0];
+
+ // Apply the date filter.
+ rowField.applyFilter({
+ dateFilter: {
+ // Setting the condition to `thisMonth` means items that are before or
+ // after this month will not be displayed.
+ condition: ExcelScript.DateFilterCondition.thisMonth
+ }
+ });
+ }
+ ```
+ - name: exclusive
+ uid: 'ExcelScript!ExcelScript.PivotDateFilter#exclusive:member'
+ package: ExcelScript!
+ fullName: exclusive
+ summary: >-
+ If `true`, filter *excludes* items that meet criteria. The default is `false` (filter to include items
+ that meet criteria).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'exclusive?: boolean;'
+ return:
+ type: boolean
+ - name: lowerBound
+ uid: 'ExcelScript!ExcelScript.PivotDateFilter#lowerBound:member'
+ package: ExcelScript!
+ fullName: lowerBound
+ summary: The lower-bound of the range for the `between` filter condition.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'lowerBound?: FilterDatetime;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a filter to a PivotTable that filters it
+ * to only show rows from between June 20th, 2022 and July 10th, 2022.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the "Date Recorded" field to filter.
+ // The data in this field must be dates in order for the filter to work.
+ const pivot = workbook.getPivotTables()[0];
+ const rowHierarchy = pivot.getRowHierarchy("Date Recorded");
+ const rowField = rowHierarchy.getFields()[0];
+
+ // Create the filter's date boundaries.
+ let earliestDate: ExcelScript.FilterDatetime = {
+ date: "2022-06-20",
+ specificity: ExcelScript.FilterDatetimeSpecificity.day
+ };
+ let latestDate: ExcelScript.FilterDatetime = {
+ date: "2022-07-10",
+ specificity: ExcelScript.FilterDatetimeSpecificity.day
+ };
+
+ // Apply the date filter.
+ rowField.applyFilter({
+ dateFilter: {
+ condition: ExcelScript.DateFilterCondition.between,
+ lowerBound: earliestDate,
+ upperBound: latestDate
+ }
+ });
+ }
+ ```
+ - name: upperBound
+ uid: 'ExcelScript!ExcelScript.PivotDateFilter#upperBound:member'
+ package: ExcelScript!
+ fullName: upperBound
+ summary: The upper-bound of the range for the `between` filter condition.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'upperBound?: FilterDatetime;'
+ return:
+ type: ''
+ - name: wholeDays
+ uid: 'ExcelScript!ExcelScript.PivotDateFilter#wholeDays:member'
+ package: ExcelScript!
+ fullName: wholeDays
+ summary: >-
+ For `equals`, `before`, `after`, and `between` filter conditions, indicates if comparisons
+ should be made as whole days.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'wholeDays?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotfield.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotfield.yml
index 33ddb5f3..fbaab61e 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotfield.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotfield.yml
@@ -1,350 +1,350 @@
-### YamlMime:TSType
-name: ExcelScript.PivotField
-uid: 'ExcelScript!ExcelScript.PivotField:interface'
-package: ExcelScript!
-fullName: ExcelScript.PivotField
-summary: Represents the Excel PivotField.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: applyFilter(filter)
- uid: 'ExcelScript!ExcelScript.PivotField#applyFilter:member(1)'
- package: ExcelScript!
- fullName: applyFilter(filter)
- summary: >-
- Sets one or more of the field's current PivotFilters and applies them to the field. If the provided filters are
- invalid or cannot be applied, an exception is thrown.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'applyFilter(filter: PivotFilters): void;'
- parameters:
- - id: filter
- description: 'A configured specific PivotFilter, or a PivotFilters interface containing multiple configured filters.'
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a PivotValueFilter to the first row hierarchy in the PivotTable.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the PivotTable on the current worksheet.
- let sheet = workbook.getActiveWorksheet();
- let pivotTable = sheet.getPivotTables()[0];
-
- // Get the first row hierarchy to use as the field which gets filtered.
- let rowHierarchy = pivotTable.getRowHierarchies()[0];
-
- // Get the first data hierarchy to use as the values for filtering the rows.
- let dataHierarchy = pivotTable.getDataHierarchies()[0];
-
- // Create a filter that excludes values greater than 500.
- let filter: ExcelScript.PivotValueFilter = {
- condition: ExcelScript.ValueFilterCondition.greaterThan,
- comparator: 500,
- value: dataHierarchy.getName()
- };
-
- // Apply the filter.
- rowHierarchy.getPivotField(rowHierarchy.getName()).applyFilter({
- valueFilter: filter
- });
- }
- ```
- - name: clearAllFilters()
- uid: 'ExcelScript!ExcelScript.PivotField#clearAllFilters:member(1)'
- package: ExcelScript!
- fullName: clearAllFilters()
- summary: Clears all criteria from all of the field's filters. This removes any active filtering on the field.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'clearAllFilters(): void;'
- return:
- type: void
- description: ''
- - name: clearFilter(filterType)
- uid: 'ExcelScript!ExcelScript.PivotField#clearFilter:member(1)'
- package: ExcelScript!
- fullName: clearFilter(filterType)
- summary: Clears all existing criteria from the field's filter of the given type (if one is currently applied).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'clearFilter(filterType: PivotFilterType): void;'
- parameters:
- - id: filterType
- description: The type of filter on the field of which to clear all criteria.
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script gets the "Type" field from the "Farms Sales" PivotTable
- * and clears the value filter from it.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the PivotTable named "Farm Sales".
- const pivot = workbook.getPivotTable("Farm Sales");
-
- // Get the "Type" field.
- const typeField = pivot.getHierarchy("Type").getPivotField("Type");
-
- // Clear the value filter (if there is one) from the field.
- typeField.clearFilter(ExcelScript.PivotFilterType.value);
- }
- ```
- - name: getFilters()
- uid: 'ExcelScript!ExcelScript.PivotField#getFilters:member(1)'
- package: ExcelScript!
- fullName: getFilters()
- summary: Gets all filters currently applied on the field.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFilters(): PivotFilters;'
- return:
- type: ''
- description: ''
- - name: getId()
- uid: 'ExcelScript!ExcelScript.PivotField#getId:member(1)'
- package: ExcelScript!
- fullName: getId()
- summary: ID of the PivotField.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getId(): string;'
- return:
- type: string
- description: ''
- - name: getItems()
- uid: 'ExcelScript!ExcelScript.PivotField#getItems:member(1)'
- package: ExcelScript!
- fullName: getItems()
- summary: Returns the PivotItems associated with the PivotField.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getItems(): PivotItem[];'
- return:
- type: '[]'
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.PivotField#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: Name of the PivotField.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: getPivotItem(name)
- uid: 'ExcelScript!ExcelScript.PivotField#getPivotItem:member(1)'
- package: ExcelScript!
- fullName: getPivotItem(name)
- summary: 'Gets a PivotItem by name. If the PivotItem does not exist, then this method returns `undefined`.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPivotItem(name: string): PivotItem | undefined;'
- parameters:
- - id: name
- description: Name of the PivotItem to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getShowAllItems()
- uid: 'ExcelScript!ExcelScript.PivotField#getShowAllItems:member(1)'
- package: ExcelScript!
- fullName: getShowAllItems()
- summary: Determines whether to show all items of the PivotField.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowAllItems(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getSubtotals()
- uid: 'ExcelScript!ExcelScript.PivotField#getSubtotals:member(1)'
- package: ExcelScript!
- fullName: getSubtotals()
- summary: Subtotals of the PivotField.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSubtotals(): Subtotals;'
- return:
- type: ''
- description: ''
- - name: isFiltered(filterType)
- uid: 'ExcelScript!ExcelScript.PivotField#isFiltered:member(1)'
- package: ExcelScript!
- fullName: isFiltered(filterType)
- summary: Checks if there are any applied filters on the field.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'isFiltered(filterType?: PivotFilterType): boolean;'
- parameters:
- - id: filterType
- description: 'The filter type to check. If no type is provided, this method will check if any filter is applied.'
- type: ''
- return:
- type: boolean
- description: ''
- - name: setName(name)
- uid: 'ExcelScript!ExcelScript.PivotField#setName:member(1)'
- package: ExcelScript!
- fullName: setName(name)
- summary: Name of the PivotField.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setName(name: string): void;'
- parameters:
- - id: name
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setShowAllItems(showAllItems)
- uid: 'ExcelScript!ExcelScript.PivotField#setShowAllItems:member(1)'
- package: ExcelScript!
- fullName: setShowAllItems(showAllItems)
- summary: Determines whether to show all items of the PivotField.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowAllItems(showAllItems: boolean): void;'
- parameters:
- - id: showAllItems
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setSubtotals(subtotals)
- uid: 'ExcelScript!ExcelScript.PivotField#setSubtotals:member(1)'
- package: ExcelScript!
- fullName: setSubtotals(subtotals)
- summary: Subtotals of the PivotField.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setSubtotals(subtotals: Subtotals): void;'
- parameters:
- - id: subtotals
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: sortByLabels(sortBy)
- uid: 'ExcelScript!ExcelScript.PivotField#sortByLabels:member(1)'
- package: ExcelScript!
- fullName: sortByLabels(sortBy)
- summary: >-
- Sorts the PivotField. If a DataPivotHierarchy is specified, then sort will be applied based on it, if not sort
- will be based on the PivotField itself.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'sortByLabels(sortBy: SortBy): void;'
- parameters:
- - id: sortBy
- description: Specifies if the sorting is done in ascending or descending order.
- type: ''
- return:
- type: void
- description: ''
- - name: 'sortByValues(sortBy, valuesHierarchy, pivotItemScope)'
- uid: 'ExcelScript!ExcelScript.PivotField#sortByValues:member(1)'
- package: ExcelScript!
- fullName: 'sortByValues(sortBy, valuesHierarchy, pivotItemScope)'
- summary: >-
- Sorts the PivotField by specified values in a given scope. The scope defines which specific values will be used to
- sort when there are multiple values from the same DataPivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- sortByValues(
- sortBy: SortBy,
- valuesHierarchy: DataPivotHierarchy,
- pivotItemScope?: Array
- ): void;
- parameters:
- - id: sortBy
- description: Specifies if the sorting is done in ascending or descending order.
- type: ''
- - id: valuesHierarchy
- description: Specifies the values hierarchy on the data axis to be used for sorting.
- type: ''
- - id: pivotItemScope
- description: >-
- The items that should be used for the scope of the sorting. These will be the items that make up the row or
- column that you want to sort on. If a string is used instead of a PivotItem, the string represents the ID of
- the PivotItem. If there are no items other than data hierarchy on the axis you want to sort on, this can be
- empty.
- type: 'Array< | string>'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample sorts the rows of a PivotTable.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get an existing PivotTable.
- const pivotTable = workbook.getPivotTable("Farm Sales");
-
- // Get the data hierarchy to use as the basis of the sort.
- const valueFieldToSortOn = pivotTable.getDataHierarchy("Sum of Crates Sold Wholesale");
-
- // Get the row to sort.
- const rowToSort = pivotTable.getRowHierarchy("Farm");
-
- // Sort the "Farm" row's only field by the values in "Sum of Crates Sold Wholesale".
- rowToSort.getFields()[0].sortByValues(ExcelScript.SortBy.descending, valueFieldToSortOn);
- }
- ```
+### YamlMime:TSType
+name: ExcelScript.PivotField
+uid: 'ExcelScript!ExcelScript.PivotField:interface'
+package: ExcelScript!
+fullName: ExcelScript.PivotField
+summary: Represents the Excel PivotField.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: applyFilter(filter)
+ uid: 'ExcelScript!ExcelScript.PivotField#applyFilter:member(1)'
+ package: ExcelScript!
+ fullName: applyFilter(filter)
+ summary: >-
+ Sets one or more of the field's current PivotFilters and applies them to the field. If the provided filters are
+ invalid or cannot be applied, an exception is thrown.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'applyFilter(filter: PivotFilters): void;'
+ parameters:
+ - id: filter
+ description: 'A configured specific PivotFilter, or a PivotFilters interface containing multiple configured filters.'
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a PivotValueFilter to the first row hierarchy in the PivotTable.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the PivotTable on the current worksheet.
+ let sheet = workbook.getActiveWorksheet();
+ let pivotTable = sheet.getPivotTables()[0];
+
+ // Get the first row hierarchy to use as the field which gets filtered.
+ let rowHierarchy = pivotTable.getRowHierarchies()[0];
+
+ // Get the first data hierarchy to use as the values for filtering the rows.
+ let dataHierarchy = pivotTable.getDataHierarchies()[0];
+
+ // Create a filter that excludes values greater than 500.
+ let filter: ExcelScript.PivotValueFilter = {
+ condition: ExcelScript.ValueFilterCondition.greaterThan,
+ comparator: 500,
+ value: dataHierarchy.getName()
+ };
+
+ // Apply the filter.
+ rowHierarchy.getPivotField(rowHierarchy.getName()).applyFilter({
+ valueFilter: filter
+ });
+ }
+ ```
+ - name: clearAllFilters()
+ uid: 'ExcelScript!ExcelScript.PivotField#clearAllFilters:member(1)'
+ package: ExcelScript!
+ fullName: clearAllFilters()
+ summary: Clears all criteria from all of the field's filters. This removes any active filtering on the field.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clearAllFilters(): void;'
+ return:
+ type: void
+ description: ''
+ - name: clearFilter(filterType)
+ uid: 'ExcelScript!ExcelScript.PivotField#clearFilter:member(1)'
+ package: ExcelScript!
+ fullName: clearFilter(filterType)
+ summary: Clears all existing criteria from the field's filter of the given type (if one is currently applied).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clearFilter(filterType: PivotFilterType): void;'
+ parameters:
+ - id: filterType
+ description: The type of filter on the field of which to clear all criteria.
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script gets the "Type" field from the "Farms Sales" PivotTable
+ * and clears the value filter from it.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the PivotTable named "Farm Sales".
+ const pivot = workbook.getPivotTable("Farm Sales");
+
+ // Get the "Type" field.
+ const typeField = pivot.getHierarchy("Type").getPivotField("Type");
+
+ // Clear the value filter (if there is one) from the field.
+ typeField.clearFilter(ExcelScript.PivotFilterType.value);
+ }
+ ```
+ - name: getFilters()
+ uid: 'ExcelScript!ExcelScript.PivotField#getFilters:member(1)'
+ package: ExcelScript!
+ fullName: getFilters()
+ summary: Gets all filters currently applied on the field.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFilters(): PivotFilters;'
+ return:
+ type: ''
+ description: ''
+ - name: getId()
+ uid: 'ExcelScript!ExcelScript.PivotField#getId:member(1)'
+ package: ExcelScript!
+ fullName: getId()
+ summary: ID of the PivotField.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getId(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getItems()
+ uid: 'ExcelScript!ExcelScript.PivotField#getItems:member(1)'
+ package: ExcelScript!
+ fullName: getItems()
+ summary: Returns the PivotItems associated with the PivotField.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItems(): PivotItem[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.PivotField#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: Name of the PivotField.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getPivotItem(name)
+ uid: 'ExcelScript!ExcelScript.PivotField#getPivotItem:member(1)'
+ package: ExcelScript!
+ fullName: getPivotItem(name)
+ summary: 'Gets a PivotItem by name. If the PivotItem does not exist, then this method returns `undefined`.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPivotItem(name: string): PivotItem | undefined;'
+ parameters:
+ - id: name
+ description: Name of the PivotItem to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getShowAllItems()
+ uid: 'ExcelScript!ExcelScript.PivotField#getShowAllItems:member(1)'
+ package: ExcelScript!
+ fullName: getShowAllItems()
+ summary: Determines whether to show all items of the PivotField.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowAllItems(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getSubtotals()
+ uid: 'ExcelScript!ExcelScript.PivotField#getSubtotals:member(1)'
+ package: ExcelScript!
+ fullName: getSubtotals()
+ summary: Subtotals of the PivotField.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSubtotals(): Subtotals;'
+ return:
+ type: ''
+ description: ''
+ - name: isFiltered(filterType)
+ uid: 'ExcelScript!ExcelScript.PivotField#isFiltered:member(1)'
+ package: ExcelScript!
+ fullName: isFiltered(filterType)
+ summary: Checks if there are any applied filters on the field.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isFiltered(filterType?: PivotFilterType): boolean;'
+ parameters:
+ - id: filterType
+ description: 'The filter type to check. If no type is provided, this method will check if any filter is applied.'
+ type: ''
+ return:
+ type: boolean
+ description: ''
+ - name: setName(name)
+ uid: 'ExcelScript!ExcelScript.PivotField#setName:member(1)'
+ package: ExcelScript!
+ fullName: setName(name)
+ summary: Name of the PivotField.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setName(name: string): void;'
+ parameters:
+ - id: name
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setShowAllItems(showAllItems)
+ uid: 'ExcelScript!ExcelScript.PivotField#setShowAllItems:member(1)'
+ package: ExcelScript!
+ fullName: setShowAllItems(showAllItems)
+ summary: Determines whether to show all items of the PivotField.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowAllItems(showAllItems: boolean): void;'
+ parameters:
+ - id: showAllItems
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setSubtotals(subtotals)
+ uid: 'ExcelScript!ExcelScript.PivotField#setSubtotals:member(1)'
+ package: ExcelScript!
+ fullName: setSubtotals(subtotals)
+ summary: Subtotals of the PivotField.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSubtotals(subtotals: Subtotals): void;'
+ parameters:
+ - id: subtotals
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: sortByLabels(sortBy)
+ uid: 'ExcelScript!ExcelScript.PivotField#sortByLabels:member(1)'
+ package: ExcelScript!
+ fullName: sortByLabels(sortBy)
+ summary: >-
+ Sorts the PivotField. If a DataPivotHierarchy is specified, then sort will be applied based on it, if not sort
+ will be based on the PivotField itself.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'sortByLabels(sortBy: SortBy): void;'
+ parameters:
+ - id: sortBy
+ description: Specifies if the sorting is done in ascending or descending order.
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: 'sortByValues(sortBy, valuesHierarchy, pivotItemScope)'
+ uid: 'ExcelScript!ExcelScript.PivotField#sortByValues:member(1)'
+ package: ExcelScript!
+ fullName: 'sortByValues(sortBy, valuesHierarchy, pivotItemScope)'
+ summary: >-
+ Sorts the PivotField by specified values in a given scope. The scope defines which specific values will be used to
+ sort when there are multiple values from the same DataPivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ sortByValues(
+ sortBy: SortBy,
+ valuesHierarchy: DataPivotHierarchy,
+ pivotItemScope?: Array
+ ): void;
+ parameters:
+ - id: sortBy
+ description: Specifies if the sorting is done in ascending or descending order.
+ type: ''
+ - id: valuesHierarchy
+ description: Specifies the values hierarchy on the data axis to be used for sorting.
+ type: ''
+ - id: pivotItemScope
+ description: >-
+ The items that should be used for the scope of the sorting. These will be the items that make up the row or
+ column that you want to sort on. If a string is used instead of a PivotItem, the string represents the ID of
+ the PivotItem. If there are no items other than data hierarchy on the axis you want to sort on, this can be
+ empty.
+ type: 'Array< | string>'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample sorts the rows of a PivotTable.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get an existing PivotTable.
+ const pivotTable = workbook.getPivotTable("Farm Sales");
+
+ // Get the data hierarchy to use as the basis of the sort.
+ const valueFieldToSortOn = pivotTable.getDataHierarchy("Sum of Crates Sold Wholesale");
+
+ // Get the row to sort.
+ const rowToSort = pivotTable.getRowHierarchy("Farm");
+
+ // Sort the "Farm" row's only field by the values in "Sum of Crates Sold Wholesale".
+ rowToSort.getFields()[0].sortByValues(ExcelScript.SortBy.descending, valueFieldToSortOn);
+ }
+ ```
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotfilters.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotfilters.yml
index 998ca5fb..9f36aa24 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotfilters.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotfilters.yml
@@ -1,177 +1,177 @@
-### YamlMime:TSType
-name: ExcelScript.PivotFilters
-uid: 'ExcelScript!ExcelScript.PivotFilters:interface'
-package: ExcelScript!
-fullName: ExcelScript.PivotFilters
-summary: An interface representing all PivotFilters currently applied to a given PivotField.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: dateFilter
- uid: 'ExcelScript!ExcelScript.PivotFilters#dateFilter:member'
- package: ExcelScript!
- fullName: dateFilter
- summary: The PivotField's currently applied date filter. This property is `null` if no value filter is applied.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'dateFilter?: PivotDateFilter;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a filter to a PivotTable that filters out rows
- * that aren't from this month.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the "Date Recorded" field to filter.
- // The data in this field must be dates in order for the filter to work.
- const pivot = workbook.getPivotTables()[0];
- const rowHierarchy = pivot.getRowHierarchy("Date Recorded");
- const rowField = rowHierarchy.getFields()[0];
-
- // Apply the date filter.
- rowField.applyFilter({
- dateFilter: {
- // Setting the condition to `thisMonth` means items that are before or
- // after this month will not be displayed.
- condition: ExcelScript.DateFilterCondition.thisMonth
- }
- });
- }
- ```
- - name: labelFilter
- uid: 'ExcelScript!ExcelScript.PivotFilters#labelFilter:member'
- package: ExcelScript!
- fullName: labelFilter
- summary: The PivotField's currently applied label filter. This property is `null` if no value filter is applied.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'labelFilter?: PivotLabelFilter;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script filters items that start with "L" from the "Type" field
- * of the "Farm Sales" PivotTable.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the PivotTable.
- const pivotTable = workbook.getActiveWorksheet().getPivotTable("Farm Sales");
-
- // Get the "Type" field.
- const field = pivotTable.getHierarchy("Type").getPivotField("Type");
-
- // Filter out any types that start with "L" (such as "Lemons" and "Limes").
- const filter: ExcelScript.PivotLabelFilter = {
- condition: ExcelScript.LabelFilterCondition.beginsWith,
- substring: "L",
- exclusive: true
- };
-
- // Apply the label filter to the field.
- field.applyFilter({ labelFilter: filter });
- }
- ```
- - name: manualFilter
- uid: 'ExcelScript!ExcelScript.PivotFilters#manualFilter:member'
- package: ExcelScript!
- fullName: manualFilter
- summary: The PivotField's currently applied manual filter. This property is `null` if no value filter is applied.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'manualFilter?: PivotManualFilter;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a manual filter to a PivotTable.
- */
- function main(workbook: ExcelScript.Workbook)
- {
- // Get the first PivotTable in the workbook.
- const pivot = workbook.getPivotTables()[0];
-
- // Get the hierarchy to use as the filter.
- const location = pivot.getHierarchy("Location");
-
- // Use "Location" as the FilterHierarchy.
- pivot.addFilterHierarchy(location);
-
- // Select items for the filter.
- // Note that hierarchies and fields have a 1:1 relationship in Excel,
- // so `getFields()[0]` always gets the correct field.
- location.getFields()[0].applyFilter({
- manualFilter: {
- selectedItems: ["Seattle", "Chicago"]
- }
- });
- }
- ```
- - name: valueFilter
- uid: 'ExcelScript!ExcelScript.PivotFilters#valueFilter:member'
- package: ExcelScript!
- fullName: valueFilter
- summary: The PivotField's currently applied value filter. This property is `null` if no value filter is applied.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'valueFilter?: PivotValueFilter;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a PivotValueFilter to the first row hierarchy in the PivotTable.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the PivotTable on the current worksheet.
- let sheet = workbook.getActiveWorksheet();
- let pivotTable = sheet.getPivotTables()[0];
-
- // Get the first row hierarchy to use as the field which gets filtered.
- let rowHierarchy = pivotTable.getRowHierarchies()[0];
-
- // Get the first data hierarchy to use as the values for filtering the rows.
- let dataHierarchy = pivotTable.getDataHierarchies()[0];
-
- // Create a filter that excludes values greater than 500.
- let filter: ExcelScript.PivotValueFilter = {
- condition: ExcelScript.ValueFilterCondition.greaterThan,
- comparator: 500,
- value: dataHierarchy.getName()
- };
-
- // Apply the filter.
- rowHierarchy.getPivotField(rowHierarchy.getName()).applyFilter({
- valueFilter: filter
- });
- }
- ```
+### YamlMime:TSType
+name: ExcelScript.PivotFilters
+uid: 'ExcelScript!ExcelScript.PivotFilters:interface'
+package: ExcelScript!
+fullName: ExcelScript.PivotFilters
+summary: An interface representing all PivotFilters currently applied to a given PivotField.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: dateFilter
+ uid: 'ExcelScript!ExcelScript.PivotFilters#dateFilter:member'
+ package: ExcelScript!
+ fullName: dateFilter
+ summary: The PivotField's currently applied date filter. This property is `null` if no value filter is applied.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'dateFilter?: PivotDateFilter;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a filter to a PivotTable that filters out rows
+ * that aren't from this month.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the "Date Recorded" field to filter.
+ // The data in this field must be dates in order for the filter to work.
+ const pivot = workbook.getPivotTables()[0];
+ const rowHierarchy = pivot.getRowHierarchy("Date Recorded");
+ const rowField = rowHierarchy.getFields()[0];
+
+ // Apply the date filter.
+ rowField.applyFilter({
+ dateFilter: {
+ // Setting the condition to `thisMonth` means items that are before or
+ // after this month will not be displayed.
+ condition: ExcelScript.DateFilterCondition.thisMonth
+ }
+ });
+ }
+ ```
+ - name: labelFilter
+ uid: 'ExcelScript!ExcelScript.PivotFilters#labelFilter:member'
+ package: ExcelScript!
+ fullName: labelFilter
+ summary: The PivotField's currently applied label filter. This property is `null` if no value filter is applied.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'labelFilter?: PivotLabelFilter;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script filters items that start with "L" from the "Type" field
+ * of the "Farm Sales" PivotTable.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the PivotTable.
+ const pivotTable = workbook.getActiveWorksheet().getPivotTable("Farm Sales");
+
+ // Get the "Type" field.
+ const field = pivotTable.getHierarchy("Type").getPivotField("Type");
+
+ // Filter out any types that start with "L" (such as "Lemons" and "Limes").
+ const filter: ExcelScript.PivotLabelFilter = {
+ condition: ExcelScript.LabelFilterCondition.beginsWith,
+ substring: "L",
+ exclusive: true
+ };
+
+ // Apply the label filter to the field.
+ field.applyFilter({ labelFilter: filter });
+ }
+ ```
+ - name: manualFilter
+ uid: 'ExcelScript!ExcelScript.PivotFilters#manualFilter:member'
+ package: ExcelScript!
+ fullName: manualFilter
+ summary: The PivotField's currently applied manual filter. This property is `null` if no value filter is applied.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'manualFilter?: PivotManualFilter;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a manual filter to a PivotTable.
+ */
+ function main(workbook: ExcelScript.Workbook)
+ {
+ // Get the first PivotTable in the workbook.
+ const pivot = workbook.getPivotTables()[0];
+
+ // Get the hierarchy to use as the filter.
+ const location = pivot.getHierarchy("Location");
+
+ // Use "Location" as the FilterHierarchy.
+ pivot.addFilterHierarchy(location);
+
+ // Select items for the filter.
+ // Note that hierarchies and fields have a 1:1 relationship in Excel,
+ // so `getFields()[0]` always gets the correct field.
+ location.getFields()[0].applyFilter({
+ manualFilter: {
+ selectedItems: ["Seattle", "Chicago"]
+ }
+ });
+ }
+ ```
+ - name: valueFilter
+ uid: 'ExcelScript!ExcelScript.PivotFilters#valueFilter:member'
+ package: ExcelScript!
+ fullName: valueFilter
+ summary: The PivotField's currently applied value filter. This property is `null` if no value filter is applied.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'valueFilter?: PivotValueFilter;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a PivotValueFilter to the first row hierarchy in the PivotTable.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the PivotTable on the current worksheet.
+ let sheet = workbook.getActiveWorksheet();
+ let pivotTable = sheet.getPivotTables()[0];
+
+ // Get the first row hierarchy to use as the field which gets filtered.
+ let rowHierarchy = pivotTable.getRowHierarchies()[0];
+
+ // Get the first data hierarchy to use as the values for filtering the rows.
+ let dataHierarchy = pivotTable.getDataHierarchies()[0];
+
+ // Create a filter that excludes values greater than 500.
+ let filter: ExcelScript.PivotValueFilter = {
+ condition: ExcelScript.ValueFilterCondition.greaterThan,
+ comparator: 500,
+ value: dataHierarchy.getName()
+ };
+
+ // Apply the filter.
+ rowHierarchy.getPivotField(rowHierarchy.getName()).applyFilter({
+ valueFilter: filter
+ });
+ }
+ ```
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotfiltertopbottomcriterion.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotfiltertopbottomcriterion.yml
index 9e937a78..2096fc8c 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotfiltertopbottomcriterion.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotfiltertopbottomcriterion.yml
@@ -1,38 +1,38 @@
-### YamlMime:TSEnum
-name: ExcelScript.PivotFilterTopBottomCriterion
-uid: 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion:enum'
-package: ExcelScript!
-fullName: ExcelScript.PivotFilterTopBottomCriterion
-summary: Represents the criteria for the top/bottom values filter.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: bottomItems
- uid: 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion.bottomItems:member'
- package: ExcelScript!
- summary: ''
- - name: bottomPercent
- uid: 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion.bottomPercent:member'
- package: ExcelScript!
- summary: ''
- - name: bottomSum
- uid: 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion.bottomSum:member'
- package: ExcelScript!
- summary: ''
- - name: invalid
- uid: 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion.invalid:member'
- package: ExcelScript!
- summary: ''
- - name: topItems
- uid: 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion.topItems:member'
- package: ExcelScript!
- summary: ''
- - name: topPercent
- uid: 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion.topPercent:member'
- package: ExcelScript!
- summary: ''
- - name: topSum
- uid: 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion.topSum:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.PivotFilterTopBottomCriterion
+uid: 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion:enum'
+package: ExcelScript!
+fullName: ExcelScript.PivotFilterTopBottomCriterion
+summary: Represents the criteria for the top/bottom values filter.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: bottomItems
+ uid: 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion.bottomItems:member'
+ package: ExcelScript!
+ summary: ''
+ - name: bottomPercent
+ uid: 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion.bottomPercent:member'
+ package: ExcelScript!
+ summary: ''
+ - name: bottomSum
+ uid: 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion.bottomSum:member'
+ package: ExcelScript!
+ summary: ''
+ - name: invalid
+ uid: 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion.invalid:member'
+ package: ExcelScript!
+ summary: ''
+ - name: topItems
+ uid: 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion.topItems:member'
+ package: ExcelScript!
+ summary: ''
+ - name: topPercent
+ uid: 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion.topPercent:member'
+ package: ExcelScript!
+ summary: ''
+ - name: topSum
+ uid: 'ExcelScript!ExcelScript.PivotFilterTopBottomCriterion.topSum:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotfiltertype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotfiltertype.yml
index 3d170c34..bbde0047 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotfiltertype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotfiltertype.yml
@@ -1,54 +1,54 @@
-### YamlMime:TSEnum
-name: ExcelScript.PivotFilterType
-uid: 'ExcelScript!ExcelScript.PivotFilterType:enum'
-package: ExcelScript!
-fullName: ExcelScript.PivotFilterType
-summary: A simple enum that represents a type of filter for a PivotField.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script gets the "Type" field from the "Farms Sales" PivotTable
- * and clears the value filter from it.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the PivotTable named "Farm Sales".
- const pivot = workbook.getPivotTable("Farm Sales");
-
- // Get the "Type" field.
- const typeField = pivot.getHierarchy("Type").getPivotField("Type");
-
- // Clear the value filter (if there is one) from the field.
- typeField.clearFilter(ExcelScript.PivotFilterType.value);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: date
- uid: 'ExcelScript!ExcelScript.PivotFilterType.date:member'
- package: ExcelScript!
- summary: >-
- Filters PivotItems with a date in place of a label. Note: A PivotField cannot simultaneously have a label filter
- and a date filter applied.
- - name: label
- uid: 'ExcelScript!ExcelScript.PivotFilterType.label:member'
- package: ExcelScript!
- summary: >-
- Filters PivotItems based on their labels. Note: A PivotField cannot simultaneously have a label filter and a date
- filter applied.
- - name: manual
- uid: 'ExcelScript!ExcelScript.PivotFilterType.manual:member'
- package: ExcelScript!
- summary: Filters specific manually selected PivotItems from the PivotTable.
- - name: unknown
- uid: 'ExcelScript!ExcelScript.PivotFilterType.unknown:member'
- package: ExcelScript!
- summary: '`PivotFilterType` is unknown or unsupported.'
- - name: value
- uid: 'ExcelScript!ExcelScript.PivotFilterType.value:member'
- package: ExcelScript!
- summary: Filters based on the value of a PivotItem with respect to a `DataPivotHierarchy`.
+### YamlMime:TSEnum
+name: ExcelScript.PivotFilterType
+uid: 'ExcelScript!ExcelScript.PivotFilterType:enum'
+package: ExcelScript!
+fullName: ExcelScript.PivotFilterType
+summary: A simple enum that represents a type of filter for a PivotField.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script gets the "Type" field from the "Farms Sales" PivotTable
+ * and clears the value filter from it.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the PivotTable named "Farm Sales".
+ const pivot = workbook.getPivotTable("Farm Sales");
+
+ // Get the "Type" field.
+ const typeField = pivot.getHierarchy("Type").getPivotField("Type");
+
+ // Clear the value filter (if there is one) from the field.
+ typeField.clearFilter(ExcelScript.PivotFilterType.value);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: date
+ uid: 'ExcelScript!ExcelScript.PivotFilterType.date:member'
+ package: ExcelScript!
+ summary: >-
+ Filters PivotItems with a date in place of a label. Note: A PivotField cannot simultaneously have a label filter
+ and a date filter applied.
+ - name: label
+ uid: 'ExcelScript!ExcelScript.PivotFilterType.label:member'
+ package: ExcelScript!
+ summary: >-
+ Filters PivotItems based on their labels. Note: A PivotField cannot simultaneously have a label filter and a date
+ filter applied.
+ - name: manual
+ uid: 'ExcelScript!ExcelScript.PivotFilterType.manual:member'
+ package: ExcelScript!
+ summary: Filters specific manually selected PivotItems from the PivotTable.
+ - name: unknown
+ uid: 'ExcelScript!ExcelScript.PivotFilterType.unknown:member'
+ package: ExcelScript!
+ summary: '`PivotFilterType` is unknown or unsupported.'
+ - name: value
+ uid: 'ExcelScript!ExcelScript.PivotFilterType.value:member'
+ package: ExcelScript!
+ summary: Filters based on the value of a PivotItem with respect to a `DataPivotHierarchy`.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivothierarchy.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivothierarchy.yml
index b9d97f3e..4c84959f 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivothierarchy.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivothierarchy.yml
@@ -1,107 +1,107 @@
-### YamlMime:TSType
-name: ExcelScript.PivotHierarchy
-uid: 'ExcelScript!ExcelScript.PivotHierarchy:interface'
-package: ExcelScript!
-fullName: ExcelScript.PivotHierarchy
-summary: Represents the Excel PivotHierarchy.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a PivotTable from an existing table and adds it to a new worksheet.
- * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
- */
- function main(workbook: ExcelScript.Workbook) {
- // Create a PivotTable based on a table in the current worksheet.
- let sheet = workbook.getActiveWorksheet();
- let table = sheet.getTables()[0];
-
- // Add the PivotTable to a new worksheet.
- let newSheet = workbook.addWorksheet("Pivot");
- let pivotTable = newSheet.addPivotTable("My Pivot", table, "A1");
-
- // Add fields to the PivotTable to show "Sales" per "Type".
- pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
- pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getFields()
- uid: 'ExcelScript!ExcelScript.PivotHierarchy#getFields:member(1)'
- package: ExcelScript!
- fullName: getFields()
- summary: Returns the PivotFields associated with the PivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFields(): PivotField[];'
- return:
- type: '[]'
- description: ''
- - name: getId()
- uid: 'ExcelScript!ExcelScript.PivotHierarchy#getId:member(1)'
- package: ExcelScript!
- fullName: getId()
- summary: ID of the PivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getId(): string;'
- return:
- type: string
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.PivotHierarchy#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: Name of the PivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: getPivotField(name)
- uid: 'ExcelScript!ExcelScript.PivotHierarchy#getPivotField:member(1)'
- package: ExcelScript!
- fullName: getPivotField(name)
- summary: 'Gets a PivotField by name. If the PivotField does not exist, then this method returns `undefined`.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPivotField(name: string): PivotField | undefined;'
- parameters:
- - id: name
- description: Name of the PivotField to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: setName(name)
- uid: 'ExcelScript!ExcelScript.PivotHierarchy#setName:member(1)'
- package: ExcelScript!
- fullName: setName(name)
- summary: Name of the PivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setName(name: string): void;'
- parameters:
- - id: name
- description: ''
- type: string
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.PivotHierarchy
+uid: 'ExcelScript!ExcelScript.PivotHierarchy:interface'
+package: ExcelScript!
+fullName: ExcelScript.PivotHierarchy
+summary: Represents the Excel PivotHierarchy.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a PivotTable from an existing table and adds it to a new worksheet.
+ * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Create a PivotTable based on a table in the current worksheet.
+ let sheet = workbook.getActiveWorksheet();
+ let table = sheet.getTables()[0];
+
+ // Add the PivotTable to a new worksheet.
+ let newSheet = workbook.addWorksheet("Pivot");
+ let pivotTable = newSheet.addPivotTable("My Pivot", table, "A1");
+
+ // Add fields to the PivotTable to show "Sales" per "Type".
+ pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
+ pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getFields()
+ uid: 'ExcelScript!ExcelScript.PivotHierarchy#getFields:member(1)'
+ package: ExcelScript!
+ fullName: getFields()
+ summary: Returns the PivotFields associated with the PivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFields(): PivotField[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getId()
+ uid: 'ExcelScript!ExcelScript.PivotHierarchy#getId:member(1)'
+ package: ExcelScript!
+ fullName: getId()
+ summary: ID of the PivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getId(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.PivotHierarchy#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: Name of the PivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getPivotField(name)
+ uid: 'ExcelScript!ExcelScript.PivotHierarchy#getPivotField:member(1)'
+ package: ExcelScript!
+ fullName: getPivotField(name)
+ summary: 'Gets a PivotField by name. If the PivotField does not exist, then this method returns `undefined`.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPivotField(name: string): PivotField | undefined;'
+ parameters:
+ - id: name
+ description: Name of the PivotField to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: setName(name)
+ uid: 'ExcelScript!ExcelScript.PivotHierarchy#setName:member(1)'
+ package: ExcelScript!
+ fullName: setName(name)
+ summary: Name of the PivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setName(name: string): void;'
+ parameters:
+ - id: name
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotitem.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotitem.yml
index ccf194d6..b4510ab0 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotitem.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotitem.yml
@@ -1,114 +1,114 @@
-### YamlMime:TSType
-name: ExcelScript.PivotItem
-uid: 'ExcelScript!ExcelScript.PivotItem:interface'
-package: ExcelScript!
-fullName: ExcelScript.PivotItem
-summary: Represents the Excel PivotItem.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getId()
- uid: 'ExcelScript!ExcelScript.PivotItem#getId:member(1)'
- package: ExcelScript!
- fullName: getId()
- summary: ID of the PivotItem.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getId(): string;'
- return:
- type: string
- description: ''
- - name: getIsExpanded()
- uid: 'ExcelScript!ExcelScript.PivotItem#getIsExpanded:member(1)'
- package: ExcelScript!
- fullName: getIsExpanded()
- summary: Determines whether the item is expanded to show child items or if it's collapsed and child items are hidden.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIsExpanded(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.PivotItem#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: Name of the PivotItem.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: getVisible()
- uid: 'ExcelScript!ExcelScript.PivotItem#getVisible:member(1)'
- package: ExcelScript!
- fullName: getVisible()
- summary: Specifies if the PivotItem is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVisible(): boolean;'
- return:
- type: boolean
- description: ''
- - name: setIsExpanded(isExpanded)
- uid: 'ExcelScript!ExcelScript.PivotItem#setIsExpanded:member(1)'
- package: ExcelScript!
- fullName: setIsExpanded(isExpanded)
- summary: Determines whether the item is expanded to show child items or if it's collapsed and child items are hidden.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setIsExpanded(isExpanded: boolean): void;'
- parameters:
- - id: isExpanded
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setName(name)
- uid: 'ExcelScript!ExcelScript.PivotItem#setName:member(1)'
- package: ExcelScript!
- fullName: setName(name)
- summary: Name of the PivotItem.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setName(name: string): void;'
- parameters:
- - id: name
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setVisible(visible)
- uid: 'ExcelScript!ExcelScript.PivotItem#setVisible:member(1)'
- package: ExcelScript!
- fullName: setVisible(visible)
- summary: Specifies if the PivotItem is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setVisible(visible: boolean): void;'
- parameters:
- - id: visible
- description: ''
- type: boolean
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.PivotItem
+uid: 'ExcelScript!ExcelScript.PivotItem:interface'
+package: ExcelScript!
+fullName: ExcelScript.PivotItem
+summary: Represents the Excel PivotItem.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getId()
+ uid: 'ExcelScript!ExcelScript.PivotItem#getId:member(1)'
+ package: ExcelScript!
+ fullName: getId()
+ summary: ID of the PivotItem.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getId(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getIsExpanded()
+ uid: 'ExcelScript!ExcelScript.PivotItem#getIsExpanded:member(1)'
+ package: ExcelScript!
+ fullName: getIsExpanded()
+ summary: Determines whether the item is expanded to show child items or if it's collapsed and child items are hidden.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIsExpanded(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.PivotItem#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: Name of the PivotItem.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getVisible()
+ uid: 'ExcelScript!ExcelScript.PivotItem#getVisible:member(1)'
+ package: ExcelScript!
+ fullName: getVisible()
+ summary: Specifies if the PivotItem is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVisible(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: setIsExpanded(isExpanded)
+ uid: 'ExcelScript!ExcelScript.PivotItem#setIsExpanded:member(1)'
+ package: ExcelScript!
+ fullName: setIsExpanded(isExpanded)
+ summary: Determines whether the item is expanded to show child items or if it's collapsed and child items are hidden.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setIsExpanded(isExpanded: boolean): void;'
+ parameters:
+ - id: isExpanded
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setName(name)
+ uid: 'ExcelScript!ExcelScript.PivotItem#setName:member(1)'
+ package: ExcelScript!
+ fullName: setName(name)
+ summary: Name of the PivotItem.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setName(name: string): void;'
+ parameters:
+ - id: name
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setVisible(visible)
+ uid: 'ExcelScript!ExcelScript.PivotItem#setVisible:member(1)'
+ package: ExcelScript!
+ fullName: setVisible(visible)
+ summary: Specifies if the PivotItem is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setVisible(visible: boolean): void;'
+ parameters:
+ - id: visible
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotlabelfilter.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotlabelfilter.yml
index f9b95afd..a6d2d94a 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotlabelfilter.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotlabelfilter.yml
@@ -1,120 +1,120 @@
-### YamlMime:TSType
-name: ExcelScript.PivotLabelFilter
-uid: 'ExcelScript!ExcelScript.PivotLabelFilter:interface'
-package: ExcelScript!
-fullName: ExcelScript.PivotLabelFilter
-summary: >-
- 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.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script filters items that start with "L" from the "Type" field
- * of the "Farm Sales" PivotTable.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the PivotTable.
- const pivotTable = workbook.getActiveWorksheet().getPivotTable("Farm Sales");
-
- // Get the "Type" field.
- const field = pivotTable.getHierarchy("Type").getPivotField("Type");
-
- // Filter out any types that start with "L" (such as "Lemons" and "Limes").
- const filter: ExcelScript.PivotLabelFilter = {
- condition: ExcelScript.LabelFilterCondition.beginsWith,
- substring: "L",
- exclusive: true
- };
-
- // Apply the label filter to the field.
- field.applyFilter({ labelFilter: filter });
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: comparator
- uid: 'ExcelScript!ExcelScript.PivotLabelFilter#comparator:member'
- package: ExcelScript!
- fullName: comparator
- summary: >-
- The comparator is the static value to which other values are compared. The type of comparison is defined by the
- condition. Note: A numeric string is treated as a number when being compared against other numeric strings.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'comparator?: string;'
- return:
- type: string
- - name: condition
- uid: 'ExcelScript!ExcelScript.PivotLabelFilter#condition:member'
- package: ExcelScript!
- fullName: condition
- summary: 'Specifies the condition for the filter, which defines the necessary filtering criteria.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'condition: LabelFilterCondition;'
- return:
- type: ''
- - name: exclusive
- uid: 'ExcelScript!ExcelScript.PivotLabelFilter#exclusive:member'
- package: ExcelScript!
- fullName: exclusive
- summary: >-
- If `true`, filter *excludes* items that meet criteria. The default is `false` (filter to include items
- that meet criteria).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'exclusive?: boolean;'
- return:
- type: boolean
- - name: lowerBound
- uid: 'ExcelScript!ExcelScript.PivotLabelFilter#lowerBound:member'
- package: ExcelScript!
- fullName: lowerBound
- summary: >-
- The lower-bound of the range for the `between` filter condition. Note: A numeric string is treated as a number
- when being compared against other numeric strings.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'lowerBound?: string;'
- return:
- type: string
- - name: substring
- uid: 'ExcelScript!ExcelScript.PivotLabelFilter#substring:member'
- package: ExcelScript!
- fullName: substring
- summary: 'The substring used for the `beginsWith`, `endsWith`, and `contains` filter conditions.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'substring?: string;'
- return:
- type: string
- - name: upperBound
- uid: 'ExcelScript!ExcelScript.PivotLabelFilter#upperBound:member'
- package: ExcelScript!
- fullName: upperBound
- summary: >-
- The upper-bound of the range for the `between` filter condition. Note: A numeric string is treated as a number
- when being compared against other numeric strings.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'upperBound?: string;'
- return:
- type: string
+### YamlMime:TSType
+name: ExcelScript.PivotLabelFilter
+uid: 'ExcelScript!ExcelScript.PivotLabelFilter:interface'
+package: ExcelScript!
+fullName: ExcelScript.PivotLabelFilter
+summary: >-
+ 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.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script filters items that start with "L" from the "Type" field
+ * of the "Farm Sales" PivotTable.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the PivotTable.
+ const pivotTable = workbook.getActiveWorksheet().getPivotTable("Farm Sales");
+
+ // Get the "Type" field.
+ const field = pivotTable.getHierarchy("Type").getPivotField("Type");
+
+ // Filter out any types that start with "L" (such as "Lemons" and "Limes").
+ const filter: ExcelScript.PivotLabelFilter = {
+ condition: ExcelScript.LabelFilterCondition.beginsWith,
+ substring: "L",
+ exclusive: true
+ };
+
+ // Apply the label filter to the field.
+ field.applyFilter({ labelFilter: filter });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: comparator
+ uid: 'ExcelScript!ExcelScript.PivotLabelFilter#comparator:member'
+ package: ExcelScript!
+ fullName: comparator
+ summary: >-
+ The comparator is the static value to which other values are compared. The type of comparison is defined by the
+ condition. Note: A numeric string is treated as a number when being compared against other numeric strings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'comparator?: string;'
+ return:
+ type: string
+ - name: condition
+ uid: 'ExcelScript!ExcelScript.PivotLabelFilter#condition:member'
+ package: ExcelScript!
+ fullName: condition
+ summary: 'Specifies the condition for the filter, which defines the necessary filtering criteria.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'condition: LabelFilterCondition;'
+ return:
+ type: ''
+ - name: exclusive
+ uid: 'ExcelScript!ExcelScript.PivotLabelFilter#exclusive:member'
+ package: ExcelScript!
+ fullName: exclusive
+ summary: >-
+ If `true`, filter *excludes* items that meet criteria. The default is `false` (filter to include items
+ that meet criteria).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'exclusive?: boolean;'
+ return:
+ type: boolean
+ - name: lowerBound
+ uid: 'ExcelScript!ExcelScript.PivotLabelFilter#lowerBound:member'
+ package: ExcelScript!
+ fullName: lowerBound
+ summary: >-
+ The lower-bound of the range for the `between` filter condition. Note: A numeric string is treated as a number
+ when being compared against other numeric strings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'lowerBound?: string;'
+ return:
+ type: string
+ - name: substring
+ uid: 'ExcelScript!ExcelScript.PivotLabelFilter#substring:member'
+ package: ExcelScript!
+ fullName: substring
+ summary: 'The substring used for the `beginsWith`, `endsWith`, and `contains` filter conditions.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'substring?: string;'
+ return:
+ type: string
+ - name: upperBound
+ uid: 'ExcelScript!ExcelScript.PivotLabelFilter#upperBound:member'
+ package: ExcelScript!
+ fullName: upperBound
+ summary: >-
+ The upper-bound of the range for the `between` filter condition. Note: A numeric string is treated as a number
+ when being compared against other numeric strings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'upperBound?: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotlayout.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotlayout.yml
index fe6baca3..10a6cc4f 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotlayout.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotlayout.yml
@@ -1,404 +1,629 @@
-### YamlMime:TSType
-name: ExcelScript.PivotLayout
-uid: 'ExcelScript!ExcelScript.PivotLayout:interface'
-package: ExcelScript!
-fullName: ExcelScript.PivotLayout
-summary: Represents the visual layout of the PivotTable.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getAutoFormat()
- uid: 'ExcelScript!ExcelScript.PivotLayout#getAutoFormat:member(1)'
- package: ExcelScript!
- fullName: getAutoFormat()
- summary: Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAutoFormat(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getBodyAndTotalRange()
- uid: 'ExcelScript!ExcelScript.PivotLayout#getBodyAndTotalRange:member(1)'
- package: ExcelScript!
- fullName: getBodyAndTotalRange()
- summary: Returns the range where the PivotTable's data values reside.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBodyAndTotalRange(): Range;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample finds the first PivotTable in the workbook and logs the values in the "Grand Total" cells.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first PivotTable in the workbook.
- let pivotTable = workbook.getPivotTables()[0];
-
- // Get the names of each data column in the PivotTable.
- let pivotColumnLabelRange = pivotTable.getLayout().getColumnLabelRange();
-
- // Get the range displaying the pivoted data.
- let pivotDataRange = pivotTable.getLayout().getBodyAndTotalRange();
-
- // Get the range with the "grand totals" for the PivotTable columns.
- let grandTotalRange = pivotDataRange.getLastRow();
-
- // Print each of the "Grand Totals" to the console.
- grandTotalRange.getValues()[0].forEach((column, columnIndex) => {
- console.log(`Grand total of ${pivotColumnLabelRange.getValues()[0][columnIndex]}: ${grandTotalRange.getValues()[0][columnIndex]}`);
- // Example log: "Grand total of Sum of Crates Sold Wholesale: 11000"
- });
- }
- ```
- - name: getColumnLabelRange()
- uid: 'ExcelScript!ExcelScript.PivotLayout#getColumnLabelRange:member(1)'
- package: ExcelScript!
- fullName: getColumnLabelRange()
- summary: Returns the range where the PivotTable's column labels reside.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColumnLabelRange(): Range;'
- return:
- type: ''
- description: ''
- - name: getDataHierarchy(cell)
- uid: 'ExcelScript!ExcelScript.PivotLayout#getDataHierarchy:member(1)'
- package: ExcelScript!
- fullName: getDataHierarchy(cell)
- summary: Gets the DataHierarchy that is used to calculate the value in a specified range within the PivotTable.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDataHierarchy(cell: Range | string): DataPivotHierarchy;'
- parameters:
- - id: cell
- description: A single cell within the PivotTable data body.
- type: ' | string'
- return:
- type: ''
- description: ''
- - name: getEnableFieldList()
- uid: 'ExcelScript!ExcelScript.PivotLayout#getEnableFieldList:member(1)'
- package: ExcelScript!
- fullName: getEnableFieldList()
- summary: Specifies if the field list can be shown in the UI.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getEnableFieldList(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getFilterAxisRange()
- uid: 'ExcelScript!ExcelScript.PivotLayout#getFilterAxisRange:member(1)'
- package: ExcelScript!
- fullName: getFilterAxisRange()
- summary: Returns the range of the PivotTable's filter area.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFilterAxisRange(): Range;'
- return:
- type: ''
- description: ''
- - name: getLayoutType()
- uid: 'ExcelScript!ExcelScript.PivotLayout#getLayoutType:member(1)'
- package: ExcelScript!
- fullName: getLayoutType()
- summary: >-
- This property indicates the PivotLayoutType of all fields on the PivotTable. If fields have different states, this
- will be null.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLayoutType(): PivotLayoutType;'
- return:
- type: ''
- description: ''
- - name: getPreserveFormatting()
- uid: 'ExcelScript!ExcelScript.PivotLayout#getPreserveFormatting:member(1)'
- package: ExcelScript!
- fullName: getPreserveFormatting()
- summary: >-
- Specifies if formatting is preserved when the report is refreshed or recalculated by operations such as pivoting,
- sorting, or changing page field items.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPreserveFormatting(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getRange()
- uid: 'ExcelScript!ExcelScript.PivotLayout#getRange:member(1)'
- package: ExcelScript!
- fullName: getRange()
- summary: 'Returns the range the PivotTable exists on, excluding the filter area.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRange(): Range;'
- return:
- type: ''
- description: ''
- - name: getRowLabelRange()
- uid: 'ExcelScript!ExcelScript.PivotLayout#getRowLabelRange:member(1)'
- package: ExcelScript!
- fullName: getRowLabelRange()
- summary: Returns the range where the PivotTable's row labels reside.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRowLabelRange(): Range;'
- return:
- type: ''
- description: ''
- - name: getShowColumnGrandTotals()
- uid: 'ExcelScript!ExcelScript.PivotLayout#getShowColumnGrandTotals:member(1)'
- package: ExcelScript!
- fullName: getShowColumnGrandTotals()
- summary: Specifies if the PivotTable report shows grand totals for columns.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowColumnGrandTotals(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowRowGrandTotals()
- uid: 'ExcelScript!ExcelScript.PivotLayout#getShowRowGrandTotals:member(1)'
- package: ExcelScript!
- fullName: getShowRowGrandTotals()
- summary: Specifies if the PivotTable report shows grand totals for rows.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowRowGrandTotals(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getSubtotalLocation()
- uid: 'ExcelScript!ExcelScript.PivotLayout#getSubtotalLocation:member(1)'
- package: ExcelScript!
- fullName: getSubtotalLocation()
- summary: >-
- This property indicates the `SubtotalLocationType` of all fields on the PivotTable. If fields have different
- states, this will be `null`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSubtotalLocation(): SubtotalLocationType;'
- return:
- type: ''
- description: ''
- - name: setAutoFormat(autoFormat)
- uid: 'ExcelScript!ExcelScript.PivotLayout#setAutoFormat:member(1)'
- package: ExcelScript!
- fullName: setAutoFormat(autoFormat)
- summary: Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setAutoFormat(autoFormat: boolean): void;'
- parameters:
- - id: autoFormat
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: 'setAutoSortOnCell(cell, sortBy)'
- uid: 'ExcelScript!ExcelScript.PivotLayout#setAutoSortOnCell:member(1)'
- package: ExcelScript!
- fullName: 'setAutoSortOnCell(cell, sortBy)'
- summary: >-
- Sets the PivotTable to automatically sort using the specified cell to automatically select all necessary criteria
- and context. This behaves identically to applying an autosort from the UI.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setAutoSortOnCell(cell: Range | string, sortBy: SortBy): void;'
- parameters:
- - id: cell
- description: A single cell to use get the criteria from for applying the autosort.
- type: ' | string'
- - id: sortBy
- description: The direction of the sort.
- type: ''
- return:
- type: void
- description: ''
- - name: setEnableFieldList(enableFieldList)
- uid: 'ExcelScript!ExcelScript.PivotLayout#setEnableFieldList:member(1)'
- package: ExcelScript!
- fullName: setEnableFieldList(enableFieldList)
- summary: Specifies if the field list can be shown in the UI.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setEnableFieldList(enableFieldList: boolean): void;'
- parameters:
- - id: enableFieldList
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setLayoutType(layoutType)
- uid: 'ExcelScript!ExcelScript.PivotLayout#setLayoutType:member(1)'
- package: ExcelScript!
- fullName: setLayoutType(layoutType)
- summary: >-
- This property indicates the PivotLayoutType of all fields on the PivotTable. If fields have different states, this
- will be null.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLayoutType(layoutType: PivotLayoutType): void;'
- parameters:
- - id: layoutType
- description: ''
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the layout of the "Farms Sales" PivotTable to the "tabular"
- * setting. This places the fields from the Rows area in separate columns.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the PivotTable named "Farm Sales".
- const pivot = workbook.getPivotTable("Farm Sales");
-
- // Get the PivotLayout object.
- const layout = pivot.getLayout();
-
- // Set the layout type to "tabular".
- layout.setLayoutType(ExcelScript.PivotLayoutType.tabular);
- }
- ```
- - name: setPreserveFormatting(preserveFormatting)
- uid: 'ExcelScript!ExcelScript.PivotLayout#setPreserveFormatting:member(1)'
- package: ExcelScript!
- fullName: setPreserveFormatting(preserveFormatting)
- summary: >-
- Specifies if formatting is preserved when the report is refreshed or recalculated by operations such as pivoting,
- sorting, or changing page field items.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPreserveFormatting(preserveFormatting: boolean): void;'
- parameters:
- - id: preserveFormatting
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowColumnGrandTotals(showColumnGrandTotals)
- uid: 'ExcelScript!ExcelScript.PivotLayout#setShowColumnGrandTotals:member(1)'
- package: ExcelScript!
- fullName: setShowColumnGrandTotals(showColumnGrandTotals)
- summary: Specifies if the PivotTable report shows grand totals for columns.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowColumnGrandTotals(showColumnGrandTotals: boolean): void;'
- parameters:
- - id: showColumnGrandTotals
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowRowGrandTotals(showRowGrandTotals)
- uid: 'ExcelScript!ExcelScript.PivotLayout#setShowRowGrandTotals:member(1)'
- package: ExcelScript!
- fullName: setShowRowGrandTotals(showRowGrandTotals)
- summary: Specifies if the PivotTable report shows grand totals for rows.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowRowGrandTotals(showRowGrandTotals: boolean): void;'
- parameters:
- - id: showRowGrandTotals
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setSubtotalLocation(subtotalLocation)
- uid: 'ExcelScript!ExcelScript.PivotLayout#setSubtotalLocation:member(1)'
- package: ExcelScript!
- fullName: setSubtotalLocation(subtotalLocation)
- summary: >-
- This property indicates the `SubtotalLocationType` of all fields on the PivotTable. If fields have different
- states, this will be `null`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setSubtotalLocation(subtotalLocation: SubtotalLocationType): void;'
- parameters:
- - id: subtotalLocation
- description: ''
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script displays group subtotals of the "Farms Sales" PivotTable.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the PivotTable named "Farm Sales".
- const pivot = workbook.getPivotTable("Farm Sales");
-
- // Get the PivotLayout object.
- const layout = pivot.getLayout();
-
- // Show all the subtotals at the bottom of each group.
- layout.setSubtotalLocation(ExcelScript.SubtotalLocationType.atBottom);
- }
- ```
+### YamlMime:TSType
+name: ExcelScript.PivotLayout
+uid: 'ExcelScript!ExcelScript.PivotLayout:interface'
+package: ExcelScript!
+fullName: ExcelScript.PivotLayout
+summary: Represents the visual layout of the PivotTable.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: displayBlankLineAfterEachItem(display)
+ uid: 'ExcelScript!ExcelScript.PivotLayout#displayBlankLineAfterEachItem:member(1)'
+ package: ExcelScript!
+ fullName: displayBlankLineAfterEachItem(display)
+ summary: >-
+ Sets whether or not to display a blank line after each item. This is set at the global level for the PivotTable
+ and applied to individual PivotFields. This function overwrites the setting for all fields in the PivotTable to
+ the value of `display` parameter.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'displayBlankLineAfterEachItem(display: boolean): void;'
+ parameters:
+ - id: display
+ description: True turns on the blank-line display setting. False turns it off.
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: getAltTextDescription()
+ uid: 'ExcelScript!ExcelScript.PivotLayout#getAltTextDescription:member(1)'
+ package: ExcelScript!
+ fullName: getAltTextDescription()
+ summary: >-
+ The alt text description of the PivotTable.
+
+
+ Alt text provides alternative, text-based representations of the information contained in the PivotTable. This
+ information is useful for people with vision or cognitive impairments who may not be able to see or understand the
+ table. A title can be read to a person with a disability and is used to determine whether they wish to hear the
+ description of the content.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAltTextDescription(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getAltTextTitle()
+ uid: 'ExcelScript!ExcelScript.PivotLayout#getAltTextTitle:member(1)'
+ package: ExcelScript!
+ fullName: getAltTextTitle()
+ summary: >-
+ The alt text title of the PivotTable.
+
+
+ Alt text provides alternative, text-based representations of the information contained in the PivotTable. This
+ information is useful for people with vision or cognitive impairments who may not be able to see or understand the
+ table. A title can be read to a person with a disability and is used to determine whether they wish to hear the
+ description of the content.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAltTextTitle(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getAutoFormat()
+ uid: 'ExcelScript!ExcelScript.PivotLayout#getAutoFormat:member(1)'
+ package: ExcelScript!
+ fullName: getAutoFormat()
+ summary: Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAutoFormat(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getBodyAndTotalRange()
+ uid: 'ExcelScript!ExcelScript.PivotLayout#getBodyAndTotalRange:member(1)'
+ package: ExcelScript!
+ fullName: getBodyAndTotalRange()
+ summary: Returns the range where the PivotTable's data values reside.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBodyAndTotalRange(): Range;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample finds the first PivotTable in the workbook and logs the values in the "Grand Total" cells.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first PivotTable in the workbook.
+ let pivotTable = workbook.getPivotTables()[0];
+
+ // Get the names of each data column in the PivotTable.
+ let pivotColumnLabelRange = pivotTable.getLayout().getColumnLabelRange();
+
+ // Get the range displaying the pivoted data.
+ let pivotDataRange = pivotTable.getLayout().getBodyAndTotalRange();
+
+ // Get the range with the "grand totals" for the PivotTable columns.
+ let grandTotalRange = pivotDataRange.getLastRow();
+
+ // Print each of the "Grand Totals" to the console.
+ grandTotalRange.getValues()[0].forEach((column, columnIndex) => {
+ console.log(`Grand total of ${pivotColumnLabelRange.getValues()[0][columnIndex]}: ${grandTotalRange.getValues()[0][columnIndex]}`);
+ // Example log: "Grand total of Sum of Crates Sold Wholesale: 11000"
+ });
+ }
+ ```
+ - name: getColumnLabelRange()
+ uid: 'ExcelScript!ExcelScript.PivotLayout#getColumnLabelRange:member(1)'
+ package: ExcelScript!
+ fullName: getColumnLabelRange()
+ summary: Returns the range where the PivotTable's column labels reside.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColumnLabelRange(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getDataHierarchy(cell)
+ uid: 'ExcelScript!ExcelScript.PivotLayout#getDataHierarchy:member(1)'
+ package: ExcelScript!
+ fullName: getDataHierarchy(cell)
+ summary: Gets the DataHierarchy that is used to calculate the value in a specified range within the PivotTable.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDataHierarchy(cell: Range | string): DataPivotHierarchy;'
+ parameters:
+ - id: cell
+ description: A single cell within the PivotTable data body.
+ type: ' | string'
+ return:
+ type: ''
+ description: ''
+ - name: getEmptyCellText()
+ uid: 'ExcelScript!ExcelScript.PivotLayout#getEmptyCellText:member(1)'
+ package: ExcelScript!
+ fullName: getEmptyCellText()
+ summary: >-
+ The text that is automatically filled into any empty cell in the PivotTable if `fillEmptyCells == true`.
+ Note that this value persists if `fillEmptyCells` is set to `false`, and that setting this value does not
+ set that property to `true`. By default, this is an empty string.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getEmptyCellText(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getEnableFieldList()
+ uid: 'ExcelScript!ExcelScript.PivotLayout#getEnableFieldList:member(1)'
+ package: ExcelScript!
+ fullName: getEnableFieldList()
+ summary: Specifies if the field list can be shown in the UI.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getEnableFieldList(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getFillEmptyCells()
+ uid: 'ExcelScript!ExcelScript.PivotLayout#getFillEmptyCells:member(1)'
+ package: ExcelScript!
+ fullName: getFillEmptyCells()
+ summary: >-
+ Specifies whether empty cells in the PivotTable should be populated with the `emptyCellText`. Default is
+ `false`. Note that the value of `emptyCellText` persists when this property is set to `false`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFillEmptyCells(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getFilterAxisRange()
+ uid: 'ExcelScript!ExcelScript.PivotLayout#getFilterAxisRange:member(1)'
+ package: ExcelScript!
+ fullName: getFilterAxisRange()
+ summary: Returns the range of the PivotTable's filter area.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFilterAxisRange(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getLayoutType()
+ uid: 'ExcelScript!ExcelScript.PivotLayout#getLayoutType:member(1)'
+ package: ExcelScript!
+ fullName: getLayoutType()
+ summary: >-
+ This property indicates the PivotLayoutType of all fields on the PivotTable. If fields have different states, this
+ will be null.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLayoutType(): PivotLayoutType;'
+ return:
+ type: ''
+ description: ''
+ - name: getPreserveFormatting()
+ uid: 'ExcelScript!ExcelScript.PivotLayout#getPreserveFormatting:member(1)'
+ package: ExcelScript!
+ fullName: getPreserveFormatting()
+ summary: >-
+ Specifies if formatting is preserved when the report is refreshed or recalculated by operations such as pivoting,
+ sorting, or changing page field items.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPreserveFormatting(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getRange()
+ uid: 'ExcelScript!ExcelScript.PivotLayout#getRange:member(1)'
+ package: ExcelScript!
+ fullName: getRange()
+ summary: 'Returns the range the PivotTable exists on, excluding the filter area.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRange(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getRowLabelRange()
+ uid: 'ExcelScript!ExcelScript.PivotLayout#getRowLabelRange:member(1)'
+ package: ExcelScript!
+ fullName: getRowLabelRange()
+ summary: Returns the range where the PivotTable's row labels reside.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRowLabelRange(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getShowColumnGrandTotals()
+ uid: 'ExcelScript!ExcelScript.PivotLayout#getShowColumnGrandTotals:member(1)'
+ package: ExcelScript!
+ fullName: getShowColumnGrandTotals()
+ summary: Specifies if the PivotTable report shows grand totals for columns.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowColumnGrandTotals(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowFieldHeaders()
+ uid: 'ExcelScript!ExcelScript.PivotLayout#getShowFieldHeaders:member(1)'
+ package: ExcelScript!
+ fullName: getShowFieldHeaders()
+ summary: Specifies whether the PivotTable displays field headers (field captions and filter drop-downs).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowFieldHeaders(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowRowGrandTotals()
+ uid: 'ExcelScript!ExcelScript.PivotLayout#getShowRowGrandTotals:member(1)'
+ package: ExcelScript!
+ fullName: getShowRowGrandTotals()
+ summary: Specifies if the PivotTable report shows grand totals for rows.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowRowGrandTotals(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getSubtotalLocation()
+ uid: 'ExcelScript!ExcelScript.PivotLayout#getSubtotalLocation:member(1)'
+ package: ExcelScript!
+ fullName: getSubtotalLocation()
+ summary: >-
+ This property indicates the `SubtotalLocationType` of all fields on the PivotTable. If fields have different
+ states, this will be `null`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSubtotalLocation(): SubtotalLocationType;'
+ return:
+ type: ''
+ description: ''
+ - name: repeatAllItemLabels(repeatLabels)
+ uid: 'ExcelScript!ExcelScript.PivotLayout#repeatAllItemLabels:member(1)'
+ package: ExcelScript!
+ fullName: repeatAllItemLabels(repeatLabels)
+ summary: Sets the "repeat all item labels" setting across all fields in the PivotTable.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'repeatAllItemLabels(repeatLabels: boolean): void;'
+ parameters:
+ - id: repeatLabels
+ description: True turns on the label-repetition display setting. False turns it off.
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setAltTextDescription(altTextDescription)
+ uid: 'ExcelScript!ExcelScript.PivotLayout#setAltTextDescription:member(1)'
+ package: ExcelScript!
+ fullName: setAltTextDescription(altTextDescription)
+ summary: >-
+ The alt text description of the PivotTable.
+
+
+ Alt text provides alternative, text-based representations of the information contained in the PivotTable. This
+ information is useful for people with vision or cognitive impairments who may not be able to see or understand the
+ table. A title can be read to a person with a disability and is used to determine whether they wish to hear the
+ description of the content.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setAltTextDescription(altTextDescription: string): void;'
+ parameters:
+ - id: altTextDescription
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setAltTextTitle(altTextTitle)
+ uid: 'ExcelScript!ExcelScript.PivotLayout#setAltTextTitle:member(1)'
+ package: ExcelScript!
+ fullName: setAltTextTitle(altTextTitle)
+ summary: >-
+ The alt text title of the PivotTable.
+
+
+ Alt text provides alternative, text-based representations of the information contained in the PivotTable. This
+ information is useful for people with vision or cognitive impairments who may not be able to see or understand the
+ table. A title can be read to a person with a disability and is used to determine whether they wish to hear the
+ description of the content.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setAltTextTitle(altTextTitle: string): void;'
+ parameters:
+ - id: altTextTitle
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setAutoFormat(autoFormat)
+ uid: 'ExcelScript!ExcelScript.PivotLayout#setAutoFormat:member(1)'
+ package: ExcelScript!
+ fullName: setAutoFormat(autoFormat)
+ summary: Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setAutoFormat(autoFormat: boolean): void;'
+ parameters:
+ - id: autoFormat
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: 'setAutoSortOnCell(cell, sortBy)'
+ uid: 'ExcelScript!ExcelScript.PivotLayout#setAutoSortOnCell:member(1)'
+ package: ExcelScript!
+ fullName: 'setAutoSortOnCell(cell, sortBy)'
+ summary: >-
+ Sets the PivotTable to automatically sort using the specified cell to automatically select all necessary criteria
+ and context. This behaves identically to applying an autosort from the UI.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setAutoSortOnCell(cell: Range | string, sortBy: SortBy): void;'
+ parameters:
+ - id: cell
+ description: A single cell to use get the criteria from for applying the autosort.
+ type: ' | string'
+ - id: sortBy
+ description: The direction of the sort.
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setEmptyCellText(emptyCellText)
+ uid: 'ExcelScript!ExcelScript.PivotLayout#setEmptyCellText:member(1)'
+ package: ExcelScript!
+ fullName: setEmptyCellText(emptyCellText)
+ summary: >-
+ The text that is automatically filled into any empty cell in the PivotTable if `fillEmptyCells == true`.
+ Note that this value persists if `fillEmptyCells` is set to `false`, and that setting this value does not
+ set that property to `true`. By default, this is an empty string.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setEmptyCellText(emptyCellText: string): void;'
+ parameters:
+ - id: emptyCellText
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setEnableFieldList(enableFieldList)
+ uid: 'ExcelScript!ExcelScript.PivotLayout#setEnableFieldList:member(1)'
+ package: ExcelScript!
+ fullName: setEnableFieldList(enableFieldList)
+ summary: Specifies if the field list can be shown in the UI.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setEnableFieldList(enableFieldList: boolean): void;'
+ parameters:
+ - id: enableFieldList
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setFillEmptyCells(fillEmptyCells)
+ uid: 'ExcelScript!ExcelScript.PivotLayout#setFillEmptyCells:member(1)'
+ package: ExcelScript!
+ fullName: setFillEmptyCells(fillEmptyCells)
+ summary: >-
+ Specifies whether empty cells in the PivotTable should be populated with the `emptyCellText`. Default is
+ `false`. Note that the value of `emptyCellText` persists when this property is set to `false`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFillEmptyCells(fillEmptyCells: boolean): void;'
+ parameters:
+ - id: fillEmptyCells
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setLayoutType(layoutType)
+ uid: 'ExcelScript!ExcelScript.PivotLayout#setLayoutType:member(1)'
+ package: ExcelScript!
+ fullName: setLayoutType(layoutType)
+ summary: >-
+ This property indicates the PivotLayoutType of all fields on the PivotTable. If fields have different states, this
+ will be null.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLayoutType(layoutType: PivotLayoutType): void;'
+ parameters:
+ - id: layoutType
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the layout of the "Farms Sales" PivotTable to the "tabular"
+ * setting. This places the fields from the Rows area in separate columns.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the PivotTable named "Farm Sales".
+ const pivot = workbook.getPivotTable("Farm Sales");
+
+ // Get the PivotLayout object.
+ const layout = pivot.getLayout();
+
+ // Set the layout type to "tabular".
+ layout.setLayoutType(ExcelScript.PivotLayoutType.tabular);
+ }
+ ```
+ - name: setPreserveFormatting(preserveFormatting)
+ uid: 'ExcelScript!ExcelScript.PivotLayout#setPreserveFormatting:member(1)'
+ package: ExcelScript!
+ fullName: setPreserveFormatting(preserveFormatting)
+ summary: >-
+ Specifies if formatting is preserved when the report is refreshed or recalculated by operations such as pivoting,
+ sorting, or changing page field items.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPreserveFormatting(preserveFormatting: boolean): void;'
+ parameters:
+ - id: preserveFormatting
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowColumnGrandTotals(showColumnGrandTotals)
+ uid: 'ExcelScript!ExcelScript.PivotLayout#setShowColumnGrandTotals:member(1)'
+ package: ExcelScript!
+ fullName: setShowColumnGrandTotals(showColumnGrandTotals)
+ summary: Specifies if the PivotTable report shows grand totals for columns.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowColumnGrandTotals(showColumnGrandTotals: boolean): void;'
+ parameters:
+ - id: showColumnGrandTotals
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowFieldHeaders(showFieldHeaders)
+ uid: 'ExcelScript!ExcelScript.PivotLayout#setShowFieldHeaders:member(1)'
+ package: ExcelScript!
+ fullName: setShowFieldHeaders(showFieldHeaders)
+ summary: Specifies whether the PivotTable displays field headers (field captions and filter drop-downs).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowFieldHeaders(showFieldHeaders: boolean): void;'
+ parameters:
+ - id: showFieldHeaders
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowRowGrandTotals(showRowGrandTotals)
+ uid: 'ExcelScript!ExcelScript.PivotLayout#setShowRowGrandTotals:member(1)'
+ package: ExcelScript!
+ fullName: setShowRowGrandTotals(showRowGrandTotals)
+ summary: Specifies if the PivotTable report shows grand totals for rows.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowRowGrandTotals(showRowGrandTotals: boolean): void;'
+ parameters:
+ - id: showRowGrandTotals
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setSubtotalLocation(subtotalLocation)
+ uid: 'ExcelScript!ExcelScript.PivotLayout#setSubtotalLocation:member(1)'
+ package: ExcelScript!
+ fullName: setSubtotalLocation(subtotalLocation)
+ summary: >-
+ This property indicates the `SubtotalLocationType` of all fields on the PivotTable. If fields have different
+ states, this will be `null`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSubtotalLocation(subtotalLocation: SubtotalLocationType): void;'
+ parameters:
+ - id: subtotalLocation
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script displays group subtotals of the "Farms Sales" PivotTable.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the PivotTable named "Farm Sales".
+ const pivot = workbook.getPivotTable("Farm Sales");
+
+ // Get the PivotLayout object.
+ const layout = pivot.getLayout();
+
+ // Show all the subtotals at the bottom of each group.
+ layout.setSubtotalLocation(ExcelScript.SubtotalLocationType.atBottom);
+ }
+ ```
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotlayouttype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotlayouttype.yml
index 9fa12f25..4891bb01 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotlayouttype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotlayouttype.yml
@@ -1,42 +1,42 @@
-### YamlMime:TSEnum
-name: ExcelScript.PivotLayoutType
-uid: 'ExcelScript!ExcelScript.PivotLayoutType:enum'
-package: ExcelScript!
-fullName: ExcelScript.PivotLayoutType
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the layout of the "Farms Sales" PivotTable to the "tabular"
- * setting. This places the fields from the Rows area in separate columns.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the PivotTable named "Farm Sales".
- const pivot = workbook.getPivotTable("Farm Sales");
-
- // Get the PivotLayout object.
- const layout = pivot.getLayout();
-
- // Set the layout type to "tabular".
- layout.setLayoutType(ExcelScript.PivotLayoutType.tabular);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: compact
- uid: 'ExcelScript!ExcelScript.PivotLayoutType.compact:member'
- package: ExcelScript!
- summary: A horizontally compressed form with labels from the next field in the same column.
- - name: outline
- uid: 'ExcelScript!ExcelScript.PivotLayoutType.outline:member'
- package: ExcelScript!
- summary: Inner fields' items are on same row as outer fields' items and subtotals are always on the bottom.
- - name: tabular
- uid: 'ExcelScript!ExcelScript.PivotLayoutType.tabular:member'
- package: ExcelScript!
- summary: Inner fields' items are always on a new line relative to the outer fields' items.
+### YamlMime:TSEnum
+name: ExcelScript.PivotLayoutType
+uid: 'ExcelScript!ExcelScript.PivotLayoutType:enum'
+package: ExcelScript!
+fullName: ExcelScript.PivotLayoutType
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the layout of the "Farms Sales" PivotTable to the "tabular"
+ * setting. This places the fields from the Rows area in separate columns.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the PivotTable named "Farm Sales".
+ const pivot = workbook.getPivotTable("Farm Sales");
+
+ // Get the PivotLayout object.
+ const layout = pivot.getLayout();
+
+ // Set the layout type to "tabular".
+ layout.setLayoutType(ExcelScript.PivotLayoutType.tabular);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: compact
+ uid: 'ExcelScript!ExcelScript.PivotLayoutType.compact:member'
+ package: ExcelScript!
+ summary: A horizontally compressed form with labels from the next field in the same column.
+ - name: outline
+ uid: 'ExcelScript!ExcelScript.PivotLayoutType.outline:member'
+ package: ExcelScript!
+ summary: Inner fields' items are on same row as outer fields' items and subtotals are always on the bottom.
+ - name: tabular
+ uid: 'ExcelScript!ExcelScript.PivotLayoutType.tabular:member'
+ package: ExcelScript!
+ summary: Inner fields' items are always on a new line relative to the outer fields' items.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotmanualfilter.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotmanualfilter.yml
index be6871ac..5c339e6c 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotmanualfilter.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotmanualfilter.yml
@@ -1,56 +1,56 @@
-### YamlMime:TSType
-name: ExcelScript.PivotManualFilter
-uid: 'ExcelScript!ExcelScript.PivotManualFilter:interface'
-package: ExcelScript!
-fullName: ExcelScript.PivotManualFilter
-summary: >-
- 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.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a manual filter to a PivotTable.
- */
- function main(workbook: ExcelScript.Workbook)
- {
- // Get the first PivotTable in the workbook.
- const pivot = workbook.getPivotTables()[0];
-
- // Get the hierarchy to use as the filter.
- const location = pivot.getHierarchy("Location");
-
- // Use "Location" as the FilterHierarchy.
- pivot.addFilterHierarchy(location);
-
- // Select items for the filter.
- const cityFilter: ExcelScript.PivotManualFilter = {
- selectedItems: ["Seattle", "Chicago"]
- };
-
- // Apply the filter
- // Note that hierarchies and fields have a 1:1 relationship in Excel, so `getFields()[0]` always gets the correct field.
- location.getFields()[0].applyFilter({
- manualFilter: cityFilter
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: selectedItems
- uid: 'ExcelScript!ExcelScript.PivotManualFilter#selectedItems:member'
- package: ExcelScript!
- fullName: selectedItems
- summary: A list of selected items to manually filter. These must be existing and valid items from the chosen field.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'selectedItems?: (string | PivotItem)[];'
- return:
- type: '(string | )[]'
+### YamlMime:TSType
+name: ExcelScript.PivotManualFilter
+uid: 'ExcelScript!ExcelScript.PivotManualFilter:interface'
+package: ExcelScript!
+fullName: ExcelScript.PivotManualFilter
+summary: >-
+ 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.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a manual filter to a PivotTable.
+ */
+ function main(workbook: ExcelScript.Workbook)
+ {
+ // Get the first PivotTable in the workbook.
+ const pivot = workbook.getPivotTables()[0];
+
+ // Get the hierarchy to use as the filter.
+ const location = pivot.getHierarchy("Location");
+
+ // Use "Location" as the FilterHierarchy.
+ pivot.addFilterHierarchy(location);
+
+ // Select items for the filter.
+ const cityFilter: ExcelScript.PivotManualFilter = {
+ selectedItems: ["Seattle", "Chicago"]
+ };
+
+ // Apply the filter
+ // Note that hierarchies and fields have a 1:1 relationship in Excel, so `getFields()[0]` always gets the correct field.
+ location.getFields()[0].applyFilter({
+ manualFilter: cityFilter
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: selectedItems
+ uid: 'ExcelScript!ExcelScript.PivotManualFilter#selectedItems:member'
+ package: ExcelScript!
+ fullName: selectedItems
+ summary: A list of selected items to manually filter. These must be existing and valid items from the chosen field.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'selectedItems?: (string | PivotItem)[];'
+ return:
+ type: '(string | )[]'
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivottable.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivottable.yml
index 32dc3abc..3fd7872b 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivottable.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivottable.yml
@@ -1,680 +1,708 @@
-### YamlMime:TSType
-name: ExcelScript.PivotTable
-uid: 'ExcelScript!ExcelScript.PivotTable:interface'
-package: ExcelScript!
-fullName: ExcelScript.PivotTable
-summary: Represents an Excel PivotTable.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a PivotTable from an existing table and adds it to a new worksheet.
- * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
- */
- function main(workbook: ExcelScript.Workbook) {
- // Create a PivotTable based on a table in the current worksheet.
- let sheet = workbook.getActiveWorksheet();
- let table = sheet.getTables()[0];
-
- // Add the PivotTable to a new worksheet.
- let newSheet = workbook.addWorksheet("Pivot");
- let pivotTable = newSheet.addPivotTable("My Pivot", table, "A1");
-
- // Add fields to the PivotTable to show "Sales" per "Type".
- pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
- pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: addColumnHierarchy(pivotHierarchy)
- uid: 'ExcelScript!ExcelScript.PivotTable#addColumnHierarchy:member(1)'
- package: ExcelScript!
- fullName: addColumnHierarchy(pivotHierarchy)
- summary: >-
- Adds the PivotHierarchy to the current axis. If the hierarchy is present elsewhere on the row, column, or filter
- axis, it will be removed from that location.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- addColumnHierarchy(
- pivotHierarchy: PivotHierarchy
- ): RowColumnPivotHierarchy;
- parameters:
- - id: pivotHierarchy
- description: ''
- type: ''
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a row hierarchy to the PivotTable on the current worksheet.
- * This assumes the source data has columns named
- * "Type", "Classification", and "Sales".
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the PivotTable on the current worksheet.
- let sheet = workbook.getActiveWorksheet();
- let pivotTable = sheet.getPivotTables()[0];
-
- // Add the field "Type" to the PivotTable as a row hierarchy.
- pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
-
- // Add the field "Classification" to the PivotTable as a column hierarchy.
- pivotTable.addColumnHierarchy(pivotTable.getHierarchy("Classification"));
-
- // Add the field "Sales" to the PivotTable as a data hierarchy.
- // By default, this displays the sums of the values in "Sales" based on the "Type".
- pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
- }
- ```
- - name: addDataHierarchy(pivotHierarchy)
- uid: 'ExcelScript!ExcelScript.PivotTable#addDataHierarchy:member(1)'
- package: ExcelScript!
- fullName: addDataHierarchy(pivotHierarchy)
- summary: Adds the PivotHierarchy to the current axis.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addDataHierarchy(pivotHierarchy: PivotHierarchy): DataPivotHierarchy;'
- parameters:
- - id: pivotHierarchy
- description: ''
- type: ''
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a PivotTable from an existing table and adds it to a new worksheet.
- * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
- */
- function main(workbook: ExcelScript.Workbook) {
- // Create a PivotTable based on a table in the current worksheet.
- let sheet = workbook.getActiveWorksheet();
- let table = sheet.getTables()[0];
-
- // Add the PivotTable to a new worksheet.
- let newSheet = workbook.addWorksheet("Pivot");
- let pivotTable = newSheet.addPivotTable("My Pivot", table, "A1");
-
- // Add fields to the PivotTable to show "Sales" per "Type".
- pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
- pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
- }
- ```
- - name: addFilterHierarchy(pivotHierarchy)
- uid: 'ExcelScript!ExcelScript.PivotTable#addFilterHierarchy:member(1)'
- package: ExcelScript!
- fullName: addFilterHierarchy(pivotHierarchy)
- summary: >-
- Adds the PivotHierarchy to the current axis. If the hierarchy is present elsewhere on the row, column, or filter
- axis, it will be removed from that location.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- addFilterHierarchy(
- pivotHierarchy: PivotHierarchy
- ): FilterPivotHierarchy;
- parameters:
- - id: pivotHierarchy
- description: ''
- type: ''
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a manual filter to a PivotTable.
- */
- function main(workbook: ExcelScript.Workbook)
- {
- // Get the first PivotTable in the workbook.
- const pivot = workbook.getPivotTables()[0];
-
- // Get the hierarchy to use as the filter.
- const location = pivot.getHierarchy("Location");
-
- // Use "Location" as the FilterHierarchy.
- pivot.addFilterHierarchy(location);
-
- // Select items for the filter.
- // Note that hierarchies and fields have a 1:1 relationship in Excel,
- // so `getFields()[0]` always gets the correct field.
- location.getFields()[0].applyFilter({
- manualFilter: {
- selectedItems: ["Seattle", "Chicago"]
- }
- });
- }
- ```
- - name: addRowHierarchy(pivotHierarchy)
- uid: 'ExcelScript!ExcelScript.PivotTable#addRowHierarchy:member(1)'
- package: ExcelScript!
- fullName: addRowHierarchy(pivotHierarchy)
- summary: >-
- Adds the PivotHierarchy to the current axis. If the hierarchy is present elsewhere on the row, column, or filter
- axis, it will be removed from that location.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- addRowHierarchy(
- pivotHierarchy: PivotHierarchy
- ): RowColumnPivotHierarchy;
- parameters:
- - id: pivotHierarchy
- description: ''
- type: ''
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a PivotTable from an existing table and adds it to a new worksheet.
- * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
- */
- function main(workbook: ExcelScript.Workbook) {
- // Create a PivotTable based on a table in the current worksheet.
- let sheet = workbook.getActiveWorksheet();
- let table = sheet.getTables()[0];
-
- // Add the PivotTable to a new worksheet.
- let newSheet = workbook.addWorksheet("Pivot");
- let pivotTable = newSheet.addPivotTable("My Pivot", table, "A1");
-
- // Add fields to the PivotTable to show "Sales" per "Type".
- pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
- pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
- }
- ```
- - name: delete()
- uid: 'ExcelScript!ExcelScript.PivotTable#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: Deletes the PivotTable.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: ''
- - name: getAllowMultipleFiltersPerField()
- uid: 'ExcelScript!ExcelScript.PivotTable#getAllowMultipleFiltersPerField:member(1)'
- package: ExcelScript!
- fullName: getAllowMultipleFiltersPerField()
- summary: Specifies if the PivotTable allows the application of multiple PivotFilters on a given PivotField in the table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAllowMultipleFiltersPerField(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getColumnHierarchies()
- uid: 'ExcelScript!ExcelScript.PivotTable#getColumnHierarchies:member(1)'
- package: ExcelScript!
- fullName: getColumnHierarchies()
- summary: The Column Pivot Hierarchies of the PivotTable.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColumnHierarchies(): RowColumnPivotHierarchy[];'
- return:
- type: '[]'
- description: ''
- - name: getColumnHierarchy(name)
- uid: 'ExcelScript!ExcelScript.PivotTable#getColumnHierarchy:member(1)'
- package: ExcelScript!
- fullName: getColumnHierarchy(name)
- summary: >-
- Gets a RowColumnPivotHierarchy by name. If the RowColumnPivotHierarchy does not exist, then this method returns
- `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColumnHierarchy(name: string): RowColumnPivotHierarchy | undefined;'
- parameters:
- - id: name
- description: Name of the RowColumnPivotHierarchy to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getDataHierarchies()
- uid: 'ExcelScript!ExcelScript.PivotTable#getDataHierarchies:member(1)'
- package: ExcelScript!
- fullName: getDataHierarchies()
- summary: The Data Pivot Hierarchies of the PivotTable.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDataHierarchies(): DataPivotHierarchy[];'
- return:
- type: '[]'
- description: ''
- - name: getDataHierarchy(name)
- uid: 'ExcelScript!ExcelScript.PivotTable#getDataHierarchy:member(1)'
- package: ExcelScript!
- fullName: getDataHierarchy(name)
- summary: >-
- Gets a DataPivotHierarchy by name. If the DataPivotHierarchy does not exist, then this method returns
- `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDataHierarchy(name: string): DataPivotHierarchy | undefined;'
- parameters:
- - id: name
- description: Name of the DataPivotHierarchy to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getEnableDataValueEditing()
- uid: 'ExcelScript!ExcelScript.PivotTable#getEnableDataValueEditing:member(1)'
- package: ExcelScript!
- fullName: getEnableDataValueEditing()
- summary: Specifies if the PivotTable allows values in the data body to be edited by the user.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getEnableDataValueEditing(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getFilterHierarchies()
- uid: 'ExcelScript!ExcelScript.PivotTable#getFilterHierarchies:member(1)'
- package: ExcelScript!
- fullName: getFilterHierarchies()
- summary: The Filter Pivot Hierarchies of the PivotTable.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFilterHierarchies(): FilterPivotHierarchy[];'
- return:
- type: '[]'
- description: ''
- - name: getFilterHierarchy(name)
- uid: 'ExcelScript!ExcelScript.PivotTable#getFilterHierarchy:member(1)'
- package: ExcelScript!
- fullName: getFilterHierarchy(name)
- summary: >-
- Gets a FilterPivotHierarchy by name. If the FilterPivotHierarchy does not exist, then this method returns
- `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFilterHierarchy(name: string): FilterPivotHierarchy | undefined;'
- parameters:
- - id: name
- description: Name of the FilterPivotHierarchy to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getHierarchies()
- uid: 'ExcelScript!ExcelScript.PivotTable#getHierarchies:member(1)'
- package: ExcelScript!
- fullName: getHierarchies()
- summary: The Pivot Hierarchies of the PivotTable.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHierarchies(): PivotHierarchy[];'
- return:
- type: '[]'
- description: ''
- - name: getHierarchy(name)
- uid: 'ExcelScript!ExcelScript.PivotTable#getHierarchy:member(1)'
- package: ExcelScript!
- fullName: getHierarchy(name)
- summary: 'Gets a PivotHierarchy by name. If the PivotHierarchy does not exist, then this method returns `undefined`.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHierarchy(name: string): PivotHierarchy | undefined;'
- parameters:
- - id: name
- description: Name of the PivotHierarchy to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getId()
- uid: 'ExcelScript!ExcelScript.PivotTable#getId:member(1)'
- package: ExcelScript!
- fullName: getId()
- summary: ID of the PivotTable.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getId(): string;'
- return:
- type: string
- description: ''
- - name: getLayout()
- uid: 'ExcelScript!ExcelScript.PivotTable#getLayout:member(1)'
- package: ExcelScript!
- fullName: getLayout()
- summary: The PivotLayout describing the layout and visual structure of the PivotTable.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLayout(): PivotLayout;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the layout of the "Farms Sales" PivotTable to the "tabular"
- * setting. This places the fields from the Rows area in separate columns.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the PivotTable named "Farm Sales".
- const pivot = workbook.getPivotTable("Farm Sales");
-
- // Get the PivotLayout object.
- const layout = pivot.getLayout();
-
- // Set the layout type to "tabular".
- layout.setLayoutType(ExcelScript.PivotLayoutType.tabular);
- }
- ```
- - name: getName()
- uid: 'ExcelScript!ExcelScript.PivotTable#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: Name of the PivotTable.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: getRowHierarchies()
- uid: 'ExcelScript!ExcelScript.PivotTable#getRowHierarchies:member(1)'
- package: ExcelScript!
- fullName: getRowHierarchies()
- summary: The Row Pivot Hierarchies of the PivotTable.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRowHierarchies(): RowColumnPivotHierarchy[];'
- return:
- type: '[]'
- description: ''
- - name: getRowHierarchy(name)
- uid: 'ExcelScript!ExcelScript.PivotTable#getRowHierarchy:member(1)'
- package: ExcelScript!
- fullName: getRowHierarchy(name)
- summary: >-
- Gets a RowColumnPivotHierarchy by name. If the RowColumnPivotHierarchy does not exist, then this method returns
- `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRowHierarchy(name: string): RowColumnPivotHierarchy | undefined;'
- parameters:
- - id: name
- description: Name of the RowColumnPivotHierarchy to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample sorts the rows of a PivotTable.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get an existing PivotTable.
- const pivotTable = workbook.getPivotTable("Farm Sales");
-
- // Get the data hierarchy to use as the basis of the sort.
- const valueFieldToSortOn = pivotTable.getDataHierarchy("Sum of Crates Sold Wholesale");
-
- // Get the row to sort.
- const rowToSort = pivotTable.getRowHierarchy("Farm");
-
- // Sort the "Farm" row's only field by the values in "Sum of Crates Sold Wholesale".
- rowToSort.getFields()[0].sortByValues(ExcelScript.SortBy.descending, valueFieldToSortOn);
- }
- ```
- - name: getUseCustomSortLists()
- uid: 'ExcelScript!ExcelScript.PivotTable#getUseCustomSortLists:member(1)'
- package: ExcelScript!
- fullName: getUseCustomSortLists()
- summary: Specifies if the PivotTable uses custom lists when sorting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getUseCustomSortLists(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getWorksheet()
- uid: 'ExcelScript!ExcelScript.PivotTable#getWorksheet:member(1)'
- package: ExcelScript!
- fullName: getWorksheet()
- summary: The worksheet containing the current PivotTable.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWorksheet(): Worksheet;'
- return:
- type: ''
- description: ''
- - name: refresh()
- uid: 'ExcelScript!ExcelScript.PivotTable#refresh:member(1)'
- package: ExcelScript!
- fullName: refresh()
- summary: Refreshes the PivotTable.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'refresh(): void;'
- return:
- type: void
- description: ''
- - name: removeColumnHierarchy(rowColumnPivotHierarchy)
- uid: 'ExcelScript!ExcelScript.PivotTable#removeColumnHierarchy:member(1)'
- package: ExcelScript!
- fullName: removeColumnHierarchy(rowColumnPivotHierarchy)
- summary: Removes the PivotHierarchy from the current axis.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- removeColumnHierarchy(
- rowColumnPivotHierarchy: RowColumnPivotHierarchy
- ): void;
- parameters:
- - id: rowColumnPivotHierarchy
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: removeDataHierarchy(DataPivotHierarchy)
- uid: 'ExcelScript!ExcelScript.PivotTable#removeDataHierarchy:member(1)'
- package: ExcelScript!
- fullName: removeDataHierarchy(DataPivotHierarchy)
- summary: Removes the PivotHierarchy from the current axis.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'removeDataHierarchy(DataPivotHierarchy: DataPivotHierarchy): void;'
- parameters:
- - id: DataPivotHierarchy
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: removeFilterHierarchy(filterPivotHierarchy)
- uid: 'ExcelScript!ExcelScript.PivotTable#removeFilterHierarchy:member(1)'
- package: ExcelScript!
- fullName: removeFilterHierarchy(filterPivotHierarchy)
- summary: Removes the PivotHierarchy from the current axis.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'removeFilterHierarchy(filterPivotHierarchy: FilterPivotHierarchy): void;'
- parameters:
- - id: filterPivotHierarchy
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: removeRowHierarchy(rowColumnPivotHierarchy)
- uid: 'ExcelScript!ExcelScript.PivotTable#removeRowHierarchy:member(1)'
- package: ExcelScript!
- fullName: removeRowHierarchy(rowColumnPivotHierarchy)
- summary: Removes the PivotHierarchy from the current axis.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- removeRowHierarchy(
- rowColumnPivotHierarchy: RowColumnPivotHierarchy
- ): void;
- parameters:
- - id: rowColumnPivotHierarchy
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setAllowMultipleFiltersPerField(allowMultipleFiltersPerField)
- uid: 'ExcelScript!ExcelScript.PivotTable#setAllowMultipleFiltersPerField:member(1)'
- package: ExcelScript!
- fullName: setAllowMultipleFiltersPerField(allowMultipleFiltersPerField)
- summary: Specifies if the PivotTable allows the application of multiple PivotFilters on a given PivotField in the table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setAllowMultipleFiltersPerField(
- allowMultipleFiltersPerField: boolean
- ): void;
- parameters:
- - id: allowMultipleFiltersPerField
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setEnableDataValueEditing(enableDataValueEditing)
- uid: 'ExcelScript!ExcelScript.PivotTable#setEnableDataValueEditing:member(1)'
- package: ExcelScript!
- fullName: setEnableDataValueEditing(enableDataValueEditing)
- summary: Specifies if the PivotTable allows values in the data body to be edited by the user.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setEnableDataValueEditing(enableDataValueEditing: boolean): void;'
- parameters:
- - id: enableDataValueEditing
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setName(name)
- uid: 'ExcelScript!ExcelScript.PivotTable#setName:member(1)'
- package: ExcelScript!
- fullName: setName(name)
- summary: Name of the PivotTable.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setName(name: string): void;'
- parameters:
- - id: name
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setUseCustomSortLists(useCustomSortLists)
- uid: 'ExcelScript!ExcelScript.PivotTable#setUseCustomSortLists:member(1)'
- package: ExcelScript!
- fullName: setUseCustomSortLists(useCustomSortLists)
- summary: Specifies if the PivotTable uses custom lists when sorting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setUseCustomSortLists(useCustomSortLists: boolean): void;'
- parameters:
- - id: useCustomSortLists
- description: ''
- type: boolean
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.PivotTable
+uid: 'ExcelScript!ExcelScript.PivotTable:interface'
+package: ExcelScript!
+fullName: ExcelScript.PivotTable
+summary: Represents an Excel PivotTable.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a PivotTable from an existing table and adds it to a new worksheet.
+ * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Create a PivotTable based on a table in the current worksheet.
+ let sheet = workbook.getActiveWorksheet();
+ let table = sheet.getTables()[0];
+
+ // Add the PivotTable to a new worksheet.
+ let newSheet = workbook.addWorksheet("Pivot");
+ let pivotTable = newSheet.addPivotTable("My Pivot", table, "A1");
+
+ // Add fields to the PivotTable to show "Sales" per "Type".
+ pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
+ pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: addColumnHierarchy(pivotHierarchy)
+ uid: 'ExcelScript!ExcelScript.PivotTable#addColumnHierarchy:member(1)'
+ package: ExcelScript!
+ fullName: addColumnHierarchy(pivotHierarchy)
+ summary: >-
+ Adds the PivotHierarchy to the current axis. If the hierarchy is present elsewhere on the row, column, or filter
+ axis, it will be removed from that location.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ addColumnHierarchy(
+ pivotHierarchy: PivotHierarchy
+ ): RowColumnPivotHierarchy;
+ parameters:
+ - id: pivotHierarchy
+ description: ''
+ type: ''
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a row hierarchy to the PivotTable on the current worksheet.
+ * This assumes the source data has columns named
+ * "Type", "Classification", and "Sales".
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the PivotTable on the current worksheet.
+ let sheet = workbook.getActiveWorksheet();
+ let pivotTable = sheet.getPivotTables()[0];
+
+ // Add the field "Type" to the PivotTable as a row hierarchy.
+ pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
+
+ // Add the field "Classification" to the PivotTable as a column hierarchy.
+ pivotTable.addColumnHierarchy(pivotTable.getHierarchy("Classification"));
+
+ // Add the field "Sales" to the PivotTable as a data hierarchy.
+ // By default, this displays the sums of the values in "Sales" based on the "Type".
+ pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
+ }
+ ```
+ - name: addDataHierarchy(pivotHierarchy)
+ uid: 'ExcelScript!ExcelScript.PivotTable#addDataHierarchy:member(1)'
+ package: ExcelScript!
+ fullName: addDataHierarchy(pivotHierarchy)
+ summary: Adds the PivotHierarchy to the current axis.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addDataHierarchy(pivotHierarchy: PivotHierarchy): DataPivotHierarchy;'
+ parameters:
+ - id: pivotHierarchy
+ description: ''
+ type: ''
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a PivotTable from an existing table and adds it to a new worksheet.
+ * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Create a PivotTable based on a table in the current worksheet.
+ let sheet = workbook.getActiveWorksheet();
+ let table = sheet.getTables()[0];
+
+ // Add the PivotTable to a new worksheet.
+ let newSheet = workbook.addWorksheet("Pivot");
+ let pivotTable = newSheet.addPivotTable("My Pivot", table, "A1");
+
+ // Add fields to the PivotTable to show "Sales" per "Type".
+ pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
+ pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
+ }
+ ```
+ - name: addFilterHierarchy(pivotHierarchy)
+ uid: 'ExcelScript!ExcelScript.PivotTable#addFilterHierarchy:member(1)'
+ package: ExcelScript!
+ fullName: addFilterHierarchy(pivotHierarchy)
+ summary: >-
+ Adds the PivotHierarchy to the current axis. If the hierarchy is present elsewhere on the row, column, or filter
+ axis, it will be removed from that location.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ addFilterHierarchy(
+ pivotHierarchy: PivotHierarchy
+ ): FilterPivotHierarchy;
+ parameters:
+ - id: pivotHierarchy
+ description: ''
+ type: ''
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a manual filter to a PivotTable.
+ */
+ function main(workbook: ExcelScript.Workbook)
+ {
+ // Get the first PivotTable in the workbook.
+ const pivot = workbook.getPivotTables()[0];
+
+ // Get the hierarchy to use as the filter.
+ const location = pivot.getHierarchy("Location");
+
+ // Use "Location" as the FilterHierarchy.
+ pivot.addFilterHierarchy(location);
+
+ // Select items for the filter.
+ // Note that hierarchies and fields have a 1:1 relationship in Excel,
+ // so `getFields()[0]` always gets the correct field.
+ location.getFields()[0].applyFilter({
+ manualFilter: {
+ selectedItems: ["Seattle", "Chicago"]
+ }
+ });
+ }
+ ```
+ - name: addRowHierarchy(pivotHierarchy)
+ uid: 'ExcelScript!ExcelScript.PivotTable#addRowHierarchy:member(1)'
+ package: ExcelScript!
+ fullName: addRowHierarchy(pivotHierarchy)
+ summary: >-
+ Adds the PivotHierarchy to the current axis. If the hierarchy is present elsewhere on the row, column, or filter
+ axis, it will be removed from that location.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ addRowHierarchy(
+ pivotHierarchy: PivotHierarchy
+ ): RowColumnPivotHierarchy;
+ parameters:
+ - id: pivotHierarchy
+ description: ''
+ type: ''
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a PivotTable from an existing table and adds it to a new worksheet.
+ * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Create a PivotTable based on a table in the current worksheet.
+ let sheet = workbook.getActiveWorksheet();
+ let table = sheet.getTables()[0];
+
+ // Add the PivotTable to a new worksheet.
+ let newSheet = workbook.addWorksheet("Pivot");
+ let pivotTable = newSheet.addPivotTable("My Pivot", table, "A1");
+
+ // Add fields to the PivotTable to show "Sales" per "Type".
+ pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
+ pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
+ }
+ ```
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.PivotTable#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: Deletes the PivotTable.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getAllowMultipleFiltersPerField()
+ uid: 'ExcelScript!ExcelScript.PivotTable#getAllowMultipleFiltersPerField:member(1)'
+ package: ExcelScript!
+ fullName: getAllowMultipleFiltersPerField()
+ summary: Specifies if the PivotTable allows the application of multiple PivotFilters on a given PivotField in the table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAllowMultipleFiltersPerField(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getColumnHierarchies()
+ uid: 'ExcelScript!ExcelScript.PivotTable#getColumnHierarchies:member(1)'
+ package: ExcelScript!
+ fullName: getColumnHierarchies()
+ summary: The Column Pivot Hierarchies of the PivotTable.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColumnHierarchies(): RowColumnPivotHierarchy[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getColumnHierarchy(name)
+ uid: 'ExcelScript!ExcelScript.PivotTable#getColumnHierarchy:member(1)'
+ package: ExcelScript!
+ fullName: getColumnHierarchy(name)
+ summary: >-
+ Gets a RowColumnPivotHierarchy by name. If the RowColumnPivotHierarchy does not exist, then this method returns
+ `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColumnHierarchy(name: string): RowColumnPivotHierarchy | undefined;'
+ parameters:
+ - id: name
+ description: Name of the RowColumnPivotHierarchy to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getDataHierarchies()
+ uid: 'ExcelScript!ExcelScript.PivotTable#getDataHierarchies:member(1)'
+ package: ExcelScript!
+ fullName: getDataHierarchies()
+ summary: The Data Pivot Hierarchies of the PivotTable.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDataHierarchies(): DataPivotHierarchy[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getDataHierarchy(name)
+ uid: 'ExcelScript!ExcelScript.PivotTable#getDataHierarchy:member(1)'
+ package: ExcelScript!
+ fullName: getDataHierarchy(name)
+ summary: >-
+ Gets a DataPivotHierarchy by name. If the DataPivotHierarchy does not exist, then this method returns
+ `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDataHierarchy(name: string): DataPivotHierarchy | undefined;'
+ parameters:
+ - id: name
+ description: Name of the DataPivotHierarchy to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getDataSourceString()
+ uid: 'ExcelScript!ExcelScript.PivotTable#getDataSourceString:member(1)'
+ package: ExcelScript!
+ fullName: getDataSourceString()
+ summary: >-
+ Returns the string representation of the data source for the PivotTable. This method currently supports string
+ representations for table and range objects. Otherwise, it returns an empty string.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDataSourceString(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getDataSourceType()
+ uid: 'ExcelScript!ExcelScript.PivotTable#getDataSourceType:member(1)'
+ package: ExcelScript!
+ fullName: getDataSourceType()
+ summary: Gets the type of the data source for the PivotTable.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDataSourceType(): DataSourceType;'
+ return:
+ type: ''
+ description: ''
+ - name: getEnableDataValueEditing()
+ uid: 'ExcelScript!ExcelScript.PivotTable#getEnableDataValueEditing:member(1)'
+ package: ExcelScript!
+ fullName: getEnableDataValueEditing()
+ summary: Specifies if the PivotTable allows values in the data body to be edited by the user.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getEnableDataValueEditing(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getFilterHierarchies()
+ uid: 'ExcelScript!ExcelScript.PivotTable#getFilterHierarchies:member(1)'
+ package: ExcelScript!
+ fullName: getFilterHierarchies()
+ summary: The Filter Pivot Hierarchies of the PivotTable.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFilterHierarchies(): FilterPivotHierarchy[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getFilterHierarchy(name)
+ uid: 'ExcelScript!ExcelScript.PivotTable#getFilterHierarchy:member(1)'
+ package: ExcelScript!
+ fullName: getFilterHierarchy(name)
+ summary: >-
+ Gets a FilterPivotHierarchy by name. If the FilterPivotHierarchy does not exist, then this method returns
+ `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFilterHierarchy(name: string): FilterPivotHierarchy | undefined;'
+ parameters:
+ - id: name
+ description: Name of the FilterPivotHierarchy to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getHierarchies()
+ uid: 'ExcelScript!ExcelScript.PivotTable#getHierarchies:member(1)'
+ package: ExcelScript!
+ fullName: getHierarchies()
+ summary: The Pivot Hierarchies of the PivotTable.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHierarchies(): PivotHierarchy[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getHierarchy(name)
+ uid: 'ExcelScript!ExcelScript.PivotTable#getHierarchy:member(1)'
+ package: ExcelScript!
+ fullName: getHierarchy(name)
+ summary: 'Gets a PivotHierarchy by name. If the PivotHierarchy does not exist, then this method returns `undefined`.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHierarchy(name: string): PivotHierarchy | undefined;'
+ parameters:
+ - id: name
+ description: Name of the PivotHierarchy to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getId()
+ uid: 'ExcelScript!ExcelScript.PivotTable#getId:member(1)'
+ package: ExcelScript!
+ fullName: getId()
+ summary: ID of the PivotTable.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getId(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getLayout()
+ uid: 'ExcelScript!ExcelScript.PivotTable#getLayout:member(1)'
+ package: ExcelScript!
+ fullName: getLayout()
+ summary: The PivotLayout describing the layout and visual structure of the PivotTable.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLayout(): PivotLayout;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the layout of the "Farms Sales" PivotTable to the "tabular"
+ * setting. This places the fields from the Rows area in separate columns.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the PivotTable named "Farm Sales".
+ const pivot = workbook.getPivotTable("Farm Sales");
+
+ // Get the PivotLayout object.
+ const layout = pivot.getLayout();
+
+ // Set the layout type to "tabular".
+ layout.setLayoutType(ExcelScript.PivotLayoutType.tabular);
+ }
+ ```
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.PivotTable#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: Name of the PivotTable.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getRowHierarchies()
+ uid: 'ExcelScript!ExcelScript.PivotTable#getRowHierarchies:member(1)'
+ package: ExcelScript!
+ fullName: getRowHierarchies()
+ summary: The Row Pivot Hierarchies of the PivotTable.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRowHierarchies(): RowColumnPivotHierarchy[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getRowHierarchy(name)
+ uid: 'ExcelScript!ExcelScript.PivotTable#getRowHierarchy:member(1)'
+ package: ExcelScript!
+ fullName: getRowHierarchy(name)
+ summary: >-
+ Gets a RowColumnPivotHierarchy by name. If the RowColumnPivotHierarchy does not exist, then this method returns
+ `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRowHierarchy(name: string): RowColumnPivotHierarchy | undefined;'
+ parameters:
+ - id: name
+ description: Name of the RowColumnPivotHierarchy to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample sorts the rows of a PivotTable.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get an existing PivotTable.
+ const pivotTable = workbook.getPivotTable("Farm Sales");
+
+ // Get the data hierarchy to use as the basis of the sort.
+ const valueFieldToSortOn = pivotTable.getDataHierarchy("Sum of Crates Sold Wholesale");
+
+ // Get the row to sort.
+ const rowToSort = pivotTable.getRowHierarchy("Farm");
+
+ // Sort the "Farm" row's only field by the values in "Sum of Crates Sold Wholesale".
+ rowToSort.getFields()[0].sortByValues(ExcelScript.SortBy.descending, valueFieldToSortOn);
+ }
+ ```
+ - name: getUseCustomSortLists()
+ uid: 'ExcelScript!ExcelScript.PivotTable#getUseCustomSortLists:member(1)'
+ package: ExcelScript!
+ fullName: getUseCustomSortLists()
+ summary: Specifies if the PivotTable uses custom lists when sorting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getUseCustomSortLists(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getWorksheet()
+ uid: 'ExcelScript!ExcelScript.PivotTable#getWorksheet:member(1)'
+ package: ExcelScript!
+ fullName: getWorksheet()
+ summary: The worksheet containing the current PivotTable.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWorksheet(): Worksheet;'
+ return:
+ type: ''
+ description: ''
+ - name: refresh()
+ uid: 'ExcelScript!ExcelScript.PivotTable#refresh:member(1)'
+ package: ExcelScript!
+ fullName: refresh()
+ summary: Refreshes the PivotTable.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'refresh(): void;'
+ return:
+ type: void
+ description: ''
+ - name: removeColumnHierarchy(rowColumnPivotHierarchy)
+ uid: 'ExcelScript!ExcelScript.PivotTable#removeColumnHierarchy:member(1)'
+ package: ExcelScript!
+ fullName: removeColumnHierarchy(rowColumnPivotHierarchy)
+ summary: Removes the PivotHierarchy from the current axis.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ removeColumnHierarchy(
+ rowColumnPivotHierarchy: RowColumnPivotHierarchy
+ ): void;
+ parameters:
+ - id: rowColumnPivotHierarchy
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: removeDataHierarchy(DataPivotHierarchy)
+ uid: 'ExcelScript!ExcelScript.PivotTable#removeDataHierarchy:member(1)'
+ package: ExcelScript!
+ fullName: removeDataHierarchy(DataPivotHierarchy)
+ summary: Removes the PivotHierarchy from the current axis.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'removeDataHierarchy(DataPivotHierarchy: DataPivotHierarchy): void;'
+ parameters:
+ - id: DataPivotHierarchy
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: removeFilterHierarchy(filterPivotHierarchy)
+ uid: 'ExcelScript!ExcelScript.PivotTable#removeFilterHierarchy:member(1)'
+ package: ExcelScript!
+ fullName: removeFilterHierarchy(filterPivotHierarchy)
+ summary: Removes the PivotHierarchy from the current axis.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'removeFilterHierarchy(filterPivotHierarchy: FilterPivotHierarchy): void;'
+ parameters:
+ - id: filterPivotHierarchy
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: removeRowHierarchy(rowColumnPivotHierarchy)
+ uid: 'ExcelScript!ExcelScript.PivotTable#removeRowHierarchy:member(1)'
+ package: ExcelScript!
+ fullName: removeRowHierarchy(rowColumnPivotHierarchy)
+ summary: Removes the PivotHierarchy from the current axis.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ removeRowHierarchy(
+ rowColumnPivotHierarchy: RowColumnPivotHierarchy
+ ): void;
+ parameters:
+ - id: rowColumnPivotHierarchy
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setAllowMultipleFiltersPerField(allowMultipleFiltersPerField)
+ uid: 'ExcelScript!ExcelScript.PivotTable#setAllowMultipleFiltersPerField:member(1)'
+ package: ExcelScript!
+ fullName: setAllowMultipleFiltersPerField(allowMultipleFiltersPerField)
+ summary: Specifies if the PivotTable allows the application of multiple PivotFilters on a given PivotField in the table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setAllowMultipleFiltersPerField(
+ allowMultipleFiltersPerField: boolean
+ ): void;
+ parameters:
+ - id: allowMultipleFiltersPerField
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setEnableDataValueEditing(enableDataValueEditing)
+ uid: 'ExcelScript!ExcelScript.PivotTable#setEnableDataValueEditing:member(1)'
+ package: ExcelScript!
+ fullName: setEnableDataValueEditing(enableDataValueEditing)
+ summary: Specifies if the PivotTable allows values in the data body to be edited by the user.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setEnableDataValueEditing(enableDataValueEditing: boolean): void;'
+ parameters:
+ - id: enableDataValueEditing
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setName(name)
+ uid: 'ExcelScript!ExcelScript.PivotTable#setName:member(1)'
+ package: ExcelScript!
+ fullName: setName(name)
+ summary: Name of the PivotTable.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setName(name: string): void;'
+ parameters:
+ - id: name
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setUseCustomSortLists(useCustomSortLists)
+ uid: 'ExcelScript!ExcelScript.PivotTable#setUseCustomSortLists:member(1)'
+ package: ExcelScript!
+ fullName: setUseCustomSortLists(useCustomSortLists)
+ summary: Specifies if the PivotTable uses custom lists when sorting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setUseCustomSortLists(useCustomSortLists: boolean): void;'
+ parameters:
+ - id: useCustomSortLists
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivottablestyle.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivottablestyle.yml
index a8aa5448..dd992926 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivottablestyle.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivottablestyle.yml
@@ -1,80 +1,80 @@
-### YamlMime:TSType
-name: ExcelScript.PivotTableStyle
-uid: 'ExcelScript!ExcelScript.PivotTableStyle:interface'
-package: ExcelScript!
-fullName: ExcelScript.PivotTableStyle
-summary: 'Represents a PivotTable style, which defines style elements by PivotTable region.'
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: delete()
- uid: 'ExcelScript!ExcelScript.PivotTableStyle#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: Deletes the PivotTable style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: ''
- - name: duplicate()
- uid: 'ExcelScript!ExcelScript.PivotTableStyle#duplicate:member(1)'
- package: ExcelScript!
- fullName: duplicate()
- summary: Creates a duplicate of this PivotTable style with copies of all the style elements.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'duplicate(): PivotTableStyle;'
- return:
- type: ''
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.PivotTableStyle#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: Specifies the name of the PivotTable style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: getReadOnly()
- uid: 'ExcelScript!ExcelScript.PivotTableStyle#getReadOnly:member(1)'
- package: ExcelScript!
- fullName: getReadOnly()
- summary: Specifies if this `PivotTableStyle` object is read-only.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getReadOnly(): boolean;'
- return:
- type: boolean
- description: ''
- - name: setName(name)
- uid: 'ExcelScript!ExcelScript.PivotTableStyle#setName:member(1)'
- package: ExcelScript!
- fullName: setName(name)
- summary: Specifies the name of the PivotTable style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setName(name: string): void;'
- parameters:
- - id: name
- description: ''
- type: string
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.PivotTableStyle
+uid: 'ExcelScript!ExcelScript.PivotTableStyle:interface'
+package: ExcelScript!
+fullName: ExcelScript.PivotTableStyle
+summary: 'Represents a PivotTable style, which defines style elements by PivotTable region.'
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.PivotTableStyle#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: Deletes the PivotTable style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: duplicate()
+ uid: 'ExcelScript!ExcelScript.PivotTableStyle#duplicate:member(1)'
+ package: ExcelScript!
+ fullName: duplicate()
+ summary: Creates a duplicate of this PivotTable style with copies of all the style elements.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'duplicate(): PivotTableStyle;'
+ return:
+ type: ''
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.PivotTableStyle#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: Specifies the name of the PivotTable style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getReadOnly()
+ uid: 'ExcelScript!ExcelScript.PivotTableStyle#getReadOnly:member(1)'
+ package: ExcelScript!
+ fullName: getReadOnly()
+ summary: Specifies if this `PivotTableStyle` object is read-only.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getReadOnly(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: setName(name)
+ uid: 'ExcelScript!ExcelScript.PivotTableStyle#setName:member(1)'
+ package: ExcelScript!
+ fullName: setName(name)
+ summary: Specifies the name of the PivotTable style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setName(name: string): void;'
+ parameters:
+ - id: name
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotvaluefilter.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotvaluefilter.yml
index ff5de7a5..38fa64ea 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotvaluefilter.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotvaluefilter.yml
@@ -1,146 +1,146 @@
-### YamlMime:TSType
-name: ExcelScript.PivotValueFilter
-uid: 'ExcelScript!ExcelScript.PivotValueFilter:interface'
-package: ExcelScript!
-fullName: ExcelScript.PivotValueFilter
-summary: >-
- 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.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a PivotValueFilter to the first row hierarchy in the PivotTable.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the PivotTable on the current worksheet.
- let sheet = workbook.getActiveWorksheet();
- let pivotTable = sheet.getPivotTables()[0];
-
- // Get the first row hierarchy to use as the field which gets filtered.
- let rowHierarchy = pivotTable.getRowHierarchies()[0];
-
- // Get the first data hierarchy to use as the values for filtering the rows.
- let dataHierarchy = pivotTable.getDataHierarchies()[0];
-
- // Create a filter that excludes values greater than 500.
- let filter: ExcelScript.PivotValueFilter = {
- condition: ExcelScript.ValueFilterCondition.greaterThan,
- comparator: 500,
- value: dataHierarchy.getName()
- };
-
- // Apply the filter.
- rowHierarchy.getPivotField(rowHierarchy.getName()).applyFilter({
- valueFilter: filter
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: comparator
- uid: 'ExcelScript!ExcelScript.PivotValueFilter#comparator:member'
- package: ExcelScript!
- fullName: comparator
- summary: >-
- The comparator is the static value to which other values are compared. The type of comparison is defined by the
- condition. For example, if comparator is "50" and condition is "greaterThan", all item values that are not greater
- than 50 will be removed by the filter.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'comparator?: number;'
- return:
- type: number
- - name: condition
- uid: 'ExcelScript!ExcelScript.PivotValueFilter#condition:member'
- package: ExcelScript!
- fullName: condition
- summary: 'Specifies the condition for the filter, which defines the necessary filtering criteria.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'condition: ValueFilterCondition;'
- return:
- type: ''
- - name: exclusive
- uid: 'ExcelScript!ExcelScript.PivotValueFilter#exclusive:member'
- package: ExcelScript!
- fullName: exclusive
- summary: >-
- If `true`, filter *excludes* items that meet criteria. The default is `false` (filter to include items
- that meet criteria).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'exclusive?: boolean;'
- return:
- type: boolean
- - name: lowerBound
- uid: 'ExcelScript!ExcelScript.PivotValueFilter#lowerBound:member'
- package: ExcelScript!
- fullName: lowerBound
- summary: The lower-bound of the range for the `between` filter condition.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'lowerBound?: number;'
- return:
- type: number
- - name: selectionType
- uid: 'ExcelScript!ExcelScript.PivotValueFilter#selectionType:member'
- package: ExcelScript!
- fullName: selectionType
- summary: 'Specifies if the filter is for the top/bottom N items, top/bottom N percent, or top/bottom N sum.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'selectionType?: TopBottomSelectionType;'
- return:
- type: ''
- - name: threshold
- uid: 'ExcelScript!ExcelScript.PivotValueFilter#threshold:member'
- package: ExcelScript!
- fullName: threshold
- summary: 'The "N" threshold number of items, percent, or sum to be filtered for a top/bottom filter condition.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'threshold?: number;'
- return:
- type: number
- - name: upperBound
- uid: 'ExcelScript!ExcelScript.PivotValueFilter#upperBound:member'
- package: ExcelScript!
- fullName: upperBound
- summary: The upper-bound of the range for the `between` filter condition.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'upperBound?: number;'
- return:
- type: number
- - name: value
- uid: 'ExcelScript!ExcelScript.PivotValueFilter#value:member'
- package: ExcelScript!
- fullName: value
- summary: Name of the chosen "value" in the field by which to filter.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'value: string;'
- return:
- type: string
+### YamlMime:TSType
+name: ExcelScript.PivotValueFilter
+uid: 'ExcelScript!ExcelScript.PivotValueFilter:interface'
+package: ExcelScript!
+fullName: ExcelScript.PivotValueFilter
+summary: >-
+ 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.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a PivotValueFilter to the first row hierarchy in the PivotTable.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the PivotTable on the current worksheet.
+ let sheet = workbook.getActiveWorksheet();
+ let pivotTable = sheet.getPivotTables()[0];
+
+ // Get the first row hierarchy to use as the field which gets filtered.
+ let rowHierarchy = pivotTable.getRowHierarchies()[0];
+
+ // Get the first data hierarchy to use as the values for filtering the rows.
+ let dataHierarchy = pivotTable.getDataHierarchies()[0];
+
+ // Create a filter that excludes values greater than 500.
+ let filter: ExcelScript.PivotValueFilter = {
+ condition: ExcelScript.ValueFilterCondition.greaterThan,
+ comparator: 500,
+ value: dataHierarchy.getName()
+ };
+
+ // Apply the filter.
+ rowHierarchy.getPivotField(rowHierarchy.getName()).applyFilter({
+ valueFilter: filter
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: comparator
+ uid: 'ExcelScript!ExcelScript.PivotValueFilter#comparator:member'
+ package: ExcelScript!
+ fullName: comparator
+ summary: >-
+ The comparator is the static value to which other values are compared. The type of comparison is defined by the
+ condition. For example, if comparator is "50" and condition is "greaterThan", all item values that are not greater
+ than 50 will be removed by the filter.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'comparator?: number;'
+ return:
+ type: number
+ - name: condition
+ uid: 'ExcelScript!ExcelScript.PivotValueFilter#condition:member'
+ package: ExcelScript!
+ fullName: condition
+ summary: 'Specifies the condition for the filter, which defines the necessary filtering criteria.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'condition: ValueFilterCondition;'
+ return:
+ type: ''
+ - name: exclusive
+ uid: 'ExcelScript!ExcelScript.PivotValueFilter#exclusive:member'
+ package: ExcelScript!
+ fullName: exclusive
+ summary: >-
+ If `true`, filter *excludes* items that meet criteria. The default is `false` (filter to include items
+ that meet criteria).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'exclusive?: boolean;'
+ return:
+ type: boolean
+ - name: lowerBound
+ uid: 'ExcelScript!ExcelScript.PivotValueFilter#lowerBound:member'
+ package: ExcelScript!
+ fullName: lowerBound
+ summary: The lower-bound of the range for the `between` filter condition.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'lowerBound?: number;'
+ return:
+ type: number
+ - name: selectionType
+ uid: 'ExcelScript!ExcelScript.PivotValueFilter#selectionType:member'
+ package: ExcelScript!
+ fullName: selectionType
+ summary: 'Specifies if the filter is for the top/bottom N items, top/bottom N percent, or top/bottom N sum.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'selectionType?: TopBottomSelectionType;'
+ return:
+ type: ''
+ - name: threshold
+ uid: 'ExcelScript!ExcelScript.PivotValueFilter#threshold:member'
+ package: ExcelScript!
+ fullName: threshold
+ summary: 'The "N" threshold number of items, percent, or sum to be filtered for a top/bottom filter condition.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'threshold?: number;'
+ return:
+ type: number
+ - name: upperBound
+ uid: 'ExcelScript!ExcelScript.PivotValueFilter#upperBound:member'
+ package: ExcelScript!
+ fullName: upperBound
+ summary: The upper-bound of the range for the `between` filter condition.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'upperBound?: number;'
+ return:
+ type: number
+ - name: value
+ uid: 'ExcelScript!ExcelScript.PivotValueFilter#value:member'
+ package: ExcelScript!
+ fullName: value
+ summary: Name of the chosen "value" in the field by which to filter.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'value: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.placement.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.placement.yml
index 74bdd294..fef0b3e3 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.placement.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.placement.yml
@@ -1,48 +1,48 @@
-### YamlMime:TSEnum
-name: ExcelScript.Placement
-uid: 'ExcelScript!ExcelScript.Placement:enum'
-package: ExcelScript!
-fullName: ExcelScript.Placement
-summary: Specifies the way that an object is attached to its underlying cells.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a diamond shape at cell C3.
- * The shape moves and resizes as the grid underneath it changes.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get cell C3 in the current worksheet.
- const sheet = workbook.getActiveWorksheet();
- const cell = sheet.getRange("C3");
-
- // Create a diamond that slightly overlaps the cell C3.
- const diamond = sheet.addGeometricShape(ExcelScript.GeometricShapeType.diamond);
- // Set each dimension so that the shape extends 5 pixels beyond the cell borders.
- diamond.setLeft(cell.getLeft() - 5);
- diamond.setTop(cell.getTop() - 5);
- diamond.setHeight(cell.getHeight() + 10);
- diamond.setWidth(cell.getWidth() + 10);
-
- // Set the placement of the shape so that it resizes and moves with the grid.
- diamond.setPlacement(ExcelScript.Placement.twoCell);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: absolute
- uid: 'ExcelScript!ExcelScript.Placement.absolute:member'
- package: ExcelScript!
- summary: The object is free floating.
- - name: oneCell
- uid: 'ExcelScript!ExcelScript.Placement.oneCell:member'
- package: ExcelScript!
- summary: The object is moved with the cells.
- - name: twoCell
- uid: 'ExcelScript!ExcelScript.Placement.twoCell:member'
- package: ExcelScript!
- summary: The object is moved and sized with the cells.
+### YamlMime:TSEnum
+name: ExcelScript.Placement
+uid: 'ExcelScript!ExcelScript.Placement:enum'
+package: ExcelScript!
+fullName: ExcelScript.Placement
+summary: Specifies the way that an object is attached to its underlying cells.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a diamond shape at cell C3.
+ * The shape moves and resizes as the grid underneath it changes.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get cell C3 in the current worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const cell = sheet.getRange("C3");
+
+ // Create a diamond that slightly overlaps the cell C3.
+ const diamond = sheet.addGeometricShape(ExcelScript.GeometricShapeType.diamond);
+ // Set each dimension so that the shape extends 5 pixels beyond the cell borders.
+ diamond.setLeft(cell.getLeft() - 5);
+ diamond.setTop(cell.getTop() - 5);
+ diamond.setHeight(cell.getHeight() + 10);
+ diamond.setWidth(cell.getWidth() + 10);
+
+ // Set the placement of the shape so that it resizes and moves with the grid.
+ diamond.setPlacement(ExcelScript.Placement.twoCell);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: absolute
+ uid: 'ExcelScript!ExcelScript.Placement.absolute:member'
+ package: ExcelScript!
+ summary: The object is free floating.
+ - name: oneCell
+ uid: 'ExcelScript!ExcelScript.Placement.oneCell:member'
+ package: ExcelScript!
+ summary: The object is moved with the cells.
+ - name: twoCell
+ uid: 'ExcelScript!ExcelScript.Placement.twoCell:member'
+ package: ExcelScript!
+ summary: The object is moved and sized with the cells.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.predefinedcellstyle.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.predefinedcellstyle.yml
index fe8172ed..7f17fdd9 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.predefinedcellstyle.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.predefinedcellstyle.yml
@@ -1,694 +1,694 @@
-### YamlMime:TSType
-name: ExcelScript.PredefinedCellStyle
-uid: 'ExcelScript!ExcelScript.PredefinedCellStyle:interface'
-package: ExcelScript!
-fullName: ExcelScript.PredefinedCellStyle
-summary: An object encapsulating a style's format and other properties.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: delete()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: Deletes this style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: ''
- - name: getAutoIndent()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getAutoIndent:member(1)'
- package: ExcelScript!
- fullName: getAutoIndent()
- summary: Specifies if text is automatically indented when the text alignment in a cell is set to equal distribution.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAutoIndent(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getBorders()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getBorders:member(1)'
- package: ExcelScript!
- fullName: getBorders()
- summary: A collection of four border objects that represent the style of the four borders.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBorders(): RangeBorder[];'
- return:
- type: '[]'
- description: ''
- - name: getBuiltIn()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getBuiltIn:member(1)'
- package: ExcelScript!
- fullName: getBuiltIn()
- summary: Specifies if the style is a built-in style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBuiltIn(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getFill()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getFill:member(1)'
- package: ExcelScript!
- fullName: getFill()
- summary: The fill of the style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFill(): RangeFill;'
- return:
- type: ''
- description: ''
- - name: getFont()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getFont:member(1)'
- package: ExcelScript!
- fullName: getFont()
- summary: A `Font` object that represents the font of the style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFont(): RangeFont;'
- return:
- type: ''
- description: ''
- - name: getFormulaHidden()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getFormulaHidden:member(1)'
- package: ExcelScript!
- fullName: getFormulaHidden()
- summary: Specifies if the formula will be hidden when the worksheet is protected.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormulaHidden(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getHorizontalAlignment()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getHorizontalAlignment:member(1)'
- package: ExcelScript!
- fullName: getHorizontalAlignment()
- summary: Represents the horizontal alignment for the style. See `ExcelScript.HorizontalAlignment` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHorizontalAlignment(): HorizontalAlignment;'
- return:
- type: ''
- description: ''
- - name: getIncludeAlignment()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getIncludeAlignment:member(1)'
- package: ExcelScript!
- fullName: getIncludeAlignment()
- summary: >-
- Specifies if the style includes the auto indent, horizontal alignment, vertical alignment, wrap text, indent
- level, and text orientation properties.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIncludeAlignment(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getIncludeBorder()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getIncludeBorder:member(1)'
- package: ExcelScript!
- fullName: getIncludeBorder()
- summary: 'Specifies if the style includes the color, color index, line style, and weight border properties.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIncludeBorder(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getIncludeFont()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getIncludeFont:member(1)'
- package: ExcelScript!
- fullName: getIncludeFont()
- summary: >-
- Specifies if the style includes the background, bold, color, color index, font style, italic, name, size,
- strikethrough, subscript, superscript, and underline font properties.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIncludeFont(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getIncludeNumber()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getIncludeNumber:member(1)'
- package: ExcelScript!
- fullName: getIncludeNumber()
- summary: Specifies if the style includes the number format property.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIncludeNumber(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getIncludePatterns()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getIncludePatterns:member(1)'
- package: ExcelScript!
- fullName: getIncludePatterns()
- summary: >-
- Specifies if the style includes the color, color index, invert if negative, pattern, pattern color, and pattern
- color index interior properties.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIncludePatterns(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getIncludeProtection()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getIncludeProtection:member(1)'
- package: ExcelScript!
- fullName: getIncludeProtection()
- summary: Specifies if the style includes the formula hidden and locked protection properties.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIncludeProtection(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getIndentLevel()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getIndentLevel:member(1)'
- package: ExcelScript!
- fullName: getIndentLevel()
- summary: An integer from 0 to 250 that indicates the indent level for the style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIndentLevel(): number;'
- return:
- type: number
- description: ''
- - name: getLocked()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getLocked:member(1)'
- package: ExcelScript!
- fullName: getLocked()
- summary: Specifies if the object is locked when the worksheet is protected.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLocked(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: The name of the style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: getNumberFormat()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getNumberFormat:member(1)'
- package: ExcelScript!
- fullName: getNumberFormat()
- summary: The format code of the number format for the style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNumberFormat(): string;'
- return:
- type: string
- description: ''
- - name: getNumberFormatLocal()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getNumberFormatLocal:member(1)'
- package: ExcelScript!
- fullName: getNumberFormatLocal()
- summary: The localized format code of the number format for the style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNumberFormatLocal(): string;'
- return:
- type: string
- description: ''
- - name: getRangeBorder(index)
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getRangeBorder:member(1)'
- package: ExcelScript!
- fullName: getRangeBorder(index)
- summary: Gets a border object using its name.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRangeBorder(index: BorderIndex): RangeBorder;'
- parameters:
- - id: index
- description: Index value of the border object to be retrieved. See `ExcelScript.BorderIndex` for details.
- type: ''
- return:
- type: ''
- description: ''
- - name: getRangeBorderTintAndShade()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getRangeBorderTintAndShade:member(1)'
- package: ExcelScript!
- fullName: getRangeBorderTintAndShade()
- summary: >-
- Specifies a double that lightens or darkens a color for range borders. The value is between -1 (darkest) and 1
- (brightest), with 0 for the original color. A `null` value indicates that the entire border collection doesn't
- have a uniform `tintAndShade` setting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRangeBorderTintAndShade(): number;'
- return:
- type: number
- description: ''
- - name: getReadingOrder()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getReadingOrder:member(1)'
- package: ExcelScript!
- fullName: getReadingOrder()
- summary: The reading order for the style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getReadingOrder(): ReadingOrder;'
- return:
- type: ''
- description: ''
- - name: getShrinkToFit()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getShrinkToFit:member(1)'
- package: ExcelScript!
- fullName: getShrinkToFit()
- summary: Specifies if text automatically shrinks to fit in the available column width.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShrinkToFit(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getTextOrientation()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getTextOrientation:member(1)'
- package: ExcelScript!
- fullName: getTextOrientation()
- summary: The text orientation for the style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTextOrientation(): number;'
- return:
- type: number
- description: ''
- - name: getVerticalAlignment()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getVerticalAlignment:member(1)'
- package: ExcelScript!
- fullName: getVerticalAlignment()
- summary: Specifies the vertical alignment for the style. See `ExcelScript.VerticalAlignment` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVerticalAlignment(): VerticalAlignment;'
- return:
- type: ''
- description: ''
- - name: getWrapText()
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getWrapText:member(1)'
- package: ExcelScript!
- fullName: getWrapText()
- summary: Specifies if Excel wraps the text in the object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWrapText(): boolean;'
- return:
- type: boolean
- description: ''
- - name: setAutoIndent(autoIndent)
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setAutoIndent:member(1)'
- package: ExcelScript!
- fullName: setAutoIndent(autoIndent)
- summary: Specifies if text is automatically indented when the text alignment in a cell is set to equal distribution.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setAutoIndent(autoIndent: boolean): void;'
- parameters:
- - id: autoIndent
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setFormulaHidden(formulaHidden)
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setFormulaHidden:member(1)'
- package: ExcelScript!
- fullName: setFormulaHidden(formulaHidden)
- summary: Specifies if the formula will be hidden when the worksheet is protected.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFormulaHidden(formulaHidden: boolean): void;'
- parameters:
- - id: formulaHidden
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setHorizontalAlignment(horizontalAlignment)
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setHorizontalAlignment:member(1)'
- package: ExcelScript!
- fullName: setHorizontalAlignment(horizontalAlignment)
- summary: Represents the horizontal alignment for the style. See `ExcelScript.HorizontalAlignment` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setHorizontalAlignment(horizontalAlignment: HorizontalAlignment): void;'
- parameters:
- - id: horizontalAlignment
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setIncludeAlignment(includeAlignment)
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setIncludeAlignment:member(1)'
- package: ExcelScript!
- fullName: setIncludeAlignment(includeAlignment)
- summary: >-
- Specifies if the style includes the auto indent, horizontal alignment, vertical alignment, wrap text, indent
- level, and text orientation properties.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setIncludeAlignment(includeAlignment: boolean): void;'
- parameters:
- - id: includeAlignment
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setIncludeBorder(includeBorder)
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setIncludeBorder:member(1)'
- package: ExcelScript!
- fullName: setIncludeBorder(includeBorder)
- summary: 'Specifies if the style includes the color, color index, line style, and weight border properties.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setIncludeBorder(includeBorder: boolean): void;'
- parameters:
- - id: includeBorder
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setIncludeFont(includeFont)
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setIncludeFont:member(1)'
- package: ExcelScript!
- fullName: setIncludeFont(includeFont)
- summary: >-
- Specifies if the style includes the background, bold, color, color index, font style, italic, name, size,
- strikethrough, subscript, superscript, and underline font properties.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setIncludeFont(includeFont: boolean): void;'
- parameters:
- - id: includeFont
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setIncludeNumber(includeNumber)
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setIncludeNumber:member(1)'
- package: ExcelScript!
- fullName: setIncludeNumber(includeNumber)
- summary: Specifies if the style includes the number format property.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setIncludeNumber(includeNumber: boolean): void;'
- parameters:
- - id: includeNumber
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setIncludePatterns(includePatterns)
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setIncludePatterns:member(1)'
- package: ExcelScript!
- fullName: setIncludePatterns(includePatterns)
- summary: >-
- Specifies if the style includes the color, color index, invert if negative, pattern, pattern color, and pattern
- color index interior properties.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setIncludePatterns(includePatterns: boolean): void;'
- parameters:
- - id: includePatterns
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setIncludeProtection(includeProtection)
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setIncludeProtection:member(1)'
- package: ExcelScript!
- fullName: setIncludeProtection(includeProtection)
- summary: Specifies if the style includes the formula hidden and locked protection properties.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setIncludeProtection(includeProtection: boolean): void;'
- parameters:
- - id: includeProtection
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setIndentLevel(indentLevel)
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setIndentLevel:member(1)'
- package: ExcelScript!
- fullName: setIndentLevel(indentLevel)
- summary: An integer from 0 to 250 that indicates the indent level for the style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setIndentLevel(indentLevel: number): void;'
- parameters:
- - id: indentLevel
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setLocked(locked)
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setLocked:member(1)'
- package: ExcelScript!
- fullName: setLocked(locked)
- summary: Specifies if the object is locked when the worksheet is protected.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLocked(locked: boolean): void;'
- parameters:
- - id: locked
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setNumberFormat(numberFormat)
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setNumberFormat:member(1)'
- package: ExcelScript!
- fullName: setNumberFormat(numberFormat)
- summary: The format code of the number format for the style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setNumberFormat(numberFormat: string): void;'
- parameters:
- - id: numberFormat
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setNumberFormatLocal(numberFormatLocal)
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setNumberFormatLocal:member(1)'
- package: ExcelScript!
- fullName: setNumberFormatLocal(numberFormatLocal)
- summary: The localized format code of the number format for the style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setNumberFormatLocal(numberFormatLocal: string): void;'
- parameters:
- - id: numberFormatLocal
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setRangeBorderTintAndShade(rangeBorderTintAndShade)
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setRangeBorderTintAndShade:member(1)'
- package: ExcelScript!
- fullName: setRangeBorderTintAndShade(rangeBorderTintAndShade)
- summary: >-
- Specifies a double that lightens or darkens a color for range borders. The value is between -1 (darkest) and 1
- (brightest), with 0 for the original color. A `null` value indicates that the entire border collection doesn't
- have a uniform `tintAndShade` setting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setRangeBorderTintAndShade(rangeBorderTintAndShade: number): void;'
- parameters:
- - id: rangeBorderTintAndShade
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setReadingOrder(readingOrder)
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setReadingOrder:member(1)'
- package: ExcelScript!
- fullName: setReadingOrder(readingOrder)
- summary: The reading order for the style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setReadingOrder(readingOrder: ReadingOrder): void;'
- parameters:
- - id: readingOrder
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setShrinkToFit(shrinkToFit)
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setShrinkToFit:member(1)'
- package: ExcelScript!
- fullName: setShrinkToFit(shrinkToFit)
- summary: Specifies if text automatically shrinks to fit in the available column width.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShrinkToFit(shrinkToFit: boolean): void;'
- parameters:
- - id: shrinkToFit
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setTextOrientation(textOrientation)
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setTextOrientation:member(1)'
- package: ExcelScript!
- fullName: setTextOrientation(textOrientation)
- summary: The text orientation for the style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTextOrientation(textOrientation: number): void;'
- parameters:
- - id: textOrientation
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setVerticalAlignment(verticalAlignment)
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setVerticalAlignment:member(1)'
- package: ExcelScript!
- fullName: setVerticalAlignment(verticalAlignment)
- summary: Specifies the vertical alignment for the style. See `ExcelScript.VerticalAlignment` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setVerticalAlignment(verticalAlignment: VerticalAlignment): void;'
- parameters:
- - id: verticalAlignment
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setWrapText(wrapText)
- uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setWrapText:member(1)'
- package: ExcelScript!
- fullName: setWrapText(wrapText)
- summary: Specifies if Excel wraps the text in the object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setWrapText(wrapText: boolean): void;'
- parameters:
- - id: wrapText
- description: ''
- type: boolean
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.PredefinedCellStyle
+uid: 'ExcelScript!ExcelScript.PredefinedCellStyle:interface'
+package: ExcelScript!
+fullName: ExcelScript.PredefinedCellStyle
+summary: An object encapsulating a style's format and other properties.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: Deletes this style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getAutoIndent()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getAutoIndent:member(1)'
+ package: ExcelScript!
+ fullName: getAutoIndent()
+ summary: Specifies if text is automatically indented when the text alignment in a cell is set to equal distribution.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAutoIndent(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getBorders()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getBorders:member(1)'
+ package: ExcelScript!
+ fullName: getBorders()
+ summary: A collection of four border objects that represent the style of the four borders.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBorders(): RangeBorder[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getBuiltIn()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getBuiltIn:member(1)'
+ package: ExcelScript!
+ fullName: getBuiltIn()
+ summary: Specifies if the style is a built-in style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBuiltIn(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getFill()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getFill:member(1)'
+ package: ExcelScript!
+ fullName: getFill()
+ summary: The fill of the style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFill(): RangeFill;'
+ return:
+ type: ''
+ description: ''
+ - name: getFont()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getFont:member(1)'
+ package: ExcelScript!
+ fullName: getFont()
+ summary: A `Font` object that represents the font of the style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFont(): RangeFont;'
+ return:
+ type: ''
+ description: ''
+ - name: getFormulaHidden()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getFormulaHidden:member(1)'
+ package: ExcelScript!
+ fullName: getFormulaHidden()
+ summary: Specifies if the formula will be hidden when the worksheet is protected.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormulaHidden(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getHorizontalAlignment()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getHorizontalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: getHorizontalAlignment()
+ summary: Represents the horizontal alignment for the style. See `ExcelScript.HorizontalAlignment` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHorizontalAlignment(): HorizontalAlignment;'
+ return:
+ type: ''
+ description: ''
+ - name: getIncludeAlignment()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getIncludeAlignment:member(1)'
+ package: ExcelScript!
+ fullName: getIncludeAlignment()
+ summary: >-
+ Specifies if the style includes the auto indent, horizontal alignment, vertical alignment, wrap text, indent
+ level, and text orientation properties.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIncludeAlignment(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getIncludeBorder()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getIncludeBorder:member(1)'
+ package: ExcelScript!
+ fullName: getIncludeBorder()
+ summary: 'Specifies if the style includes the color, color index, line style, and weight border properties.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIncludeBorder(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getIncludeFont()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getIncludeFont:member(1)'
+ package: ExcelScript!
+ fullName: getIncludeFont()
+ summary: >-
+ Specifies if the style includes the background, bold, color, color index, font style, italic, name, size,
+ strikethrough, subscript, superscript, and underline font properties.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIncludeFont(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getIncludeNumber()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getIncludeNumber:member(1)'
+ package: ExcelScript!
+ fullName: getIncludeNumber()
+ summary: Specifies if the style includes the number format property.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIncludeNumber(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getIncludePatterns()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getIncludePatterns:member(1)'
+ package: ExcelScript!
+ fullName: getIncludePatterns()
+ summary: >-
+ Specifies if the style includes the color, color index, invert if negative, pattern, pattern color, and pattern
+ color index interior properties.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIncludePatterns(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getIncludeProtection()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getIncludeProtection:member(1)'
+ package: ExcelScript!
+ fullName: getIncludeProtection()
+ summary: Specifies if the style includes the formula hidden and locked protection properties.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIncludeProtection(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getIndentLevel()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getIndentLevel:member(1)'
+ package: ExcelScript!
+ fullName: getIndentLevel()
+ summary: An integer from 0 to 250 that indicates the indent level for the style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIndentLevel(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getLocked()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getLocked:member(1)'
+ package: ExcelScript!
+ fullName: getLocked()
+ summary: Specifies if the object is locked when the worksheet is protected.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLocked(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: The name of the style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getNumberFormat()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: getNumberFormat()
+ summary: The format code of the number format for the style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNumberFormat(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getNumberFormatLocal()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getNumberFormatLocal:member(1)'
+ package: ExcelScript!
+ fullName: getNumberFormatLocal()
+ summary: The localized format code of the number format for the style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNumberFormatLocal(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getRangeBorder(index)
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getRangeBorder:member(1)'
+ package: ExcelScript!
+ fullName: getRangeBorder(index)
+ summary: Gets a border object using its name.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRangeBorder(index: BorderIndex): RangeBorder;'
+ parameters:
+ - id: index
+ description: Index value of the border object to be retrieved. See `ExcelScript.BorderIndex` for details.
+ type: ''
+ return:
+ type: ''
+ description: ''
+ - name: getRangeBorderTintAndShade()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getRangeBorderTintAndShade:member(1)'
+ package: ExcelScript!
+ fullName: getRangeBorderTintAndShade()
+ summary: >-
+ Specifies a double that lightens or darkens a color for range borders. The value is between -1 (darkest) and 1
+ (brightest), with 0 for the original color. A `null` value indicates that the entire border collection doesn't
+ have a uniform `tintAndShade` setting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRangeBorderTintAndShade(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getReadingOrder()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getReadingOrder:member(1)'
+ package: ExcelScript!
+ fullName: getReadingOrder()
+ summary: The reading order for the style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getReadingOrder(): ReadingOrder;'
+ return:
+ type: ''
+ description: ''
+ - name: getShrinkToFit()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getShrinkToFit:member(1)'
+ package: ExcelScript!
+ fullName: getShrinkToFit()
+ summary: Specifies if text automatically shrinks to fit in the available column width.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShrinkToFit(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getTextOrientation()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getTextOrientation:member(1)'
+ package: ExcelScript!
+ fullName: getTextOrientation()
+ summary: The text orientation for the style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTextOrientation(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getVerticalAlignment()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getVerticalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: getVerticalAlignment()
+ summary: Specifies the vertical alignment for the style. See `ExcelScript.VerticalAlignment` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVerticalAlignment(): VerticalAlignment;'
+ return:
+ type: ''
+ description: ''
+ - name: getWrapText()
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#getWrapText:member(1)'
+ package: ExcelScript!
+ fullName: getWrapText()
+ summary: Specifies if Excel wraps the text in the object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWrapText(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: setAutoIndent(autoIndent)
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setAutoIndent:member(1)'
+ package: ExcelScript!
+ fullName: setAutoIndent(autoIndent)
+ summary: Specifies if text is automatically indented when the text alignment in a cell is set to equal distribution.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setAutoIndent(autoIndent: boolean): void;'
+ parameters:
+ - id: autoIndent
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setFormulaHidden(formulaHidden)
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setFormulaHidden:member(1)'
+ package: ExcelScript!
+ fullName: setFormulaHidden(formulaHidden)
+ summary: Specifies if the formula will be hidden when the worksheet is protected.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFormulaHidden(formulaHidden: boolean): void;'
+ parameters:
+ - id: formulaHidden
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setHorizontalAlignment(horizontalAlignment)
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setHorizontalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: setHorizontalAlignment(horizontalAlignment)
+ summary: Represents the horizontal alignment for the style. See `ExcelScript.HorizontalAlignment` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setHorizontalAlignment(horizontalAlignment: HorizontalAlignment): void;'
+ parameters:
+ - id: horizontalAlignment
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setIncludeAlignment(includeAlignment)
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setIncludeAlignment:member(1)'
+ package: ExcelScript!
+ fullName: setIncludeAlignment(includeAlignment)
+ summary: >-
+ Specifies if the style includes the auto indent, horizontal alignment, vertical alignment, wrap text, indent
+ level, and text orientation properties.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setIncludeAlignment(includeAlignment: boolean): void;'
+ parameters:
+ - id: includeAlignment
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setIncludeBorder(includeBorder)
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setIncludeBorder:member(1)'
+ package: ExcelScript!
+ fullName: setIncludeBorder(includeBorder)
+ summary: 'Specifies if the style includes the color, color index, line style, and weight border properties.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setIncludeBorder(includeBorder: boolean): void;'
+ parameters:
+ - id: includeBorder
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setIncludeFont(includeFont)
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setIncludeFont:member(1)'
+ package: ExcelScript!
+ fullName: setIncludeFont(includeFont)
+ summary: >-
+ Specifies if the style includes the background, bold, color, color index, font style, italic, name, size,
+ strikethrough, subscript, superscript, and underline font properties.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setIncludeFont(includeFont: boolean): void;'
+ parameters:
+ - id: includeFont
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setIncludeNumber(includeNumber)
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setIncludeNumber:member(1)'
+ package: ExcelScript!
+ fullName: setIncludeNumber(includeNumber)
+ summary: Specifies if the style includes the number format property.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setIncludeNumber(includeNumber: boolean): void;'
+ parameters:
+ - id: includeNumber
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setIncludePatterns(includePatterns)
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setIncludePatterns:member(1)'
+ package: ExcelScript!
+ fullName: setIncludePatterns(includePatterns)
+ summary: >-
+ Specifies if the style includes the color, color index, invert if negative, pattern, pattern color, and pattern
+ color index interior properties.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setIncludePatterns(includePatterns: boolean): void;'
+ parameters:
+ - id: includePatterns
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setIncludeProtection(includeProtection)
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setIncludeProtection:member(1)'
+ package: ExcelScript!
+ fullName: setIncludeProtection(includeProtection)
+ summary: Specifies if the style includes the formula hidden and locked protection properties.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setIncludeProtection(includeProtection: boolean): void;'
+ parameters:
+ - id: includeProtection
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setIndentLevel(indentLevel)
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setIndentLevel:member(1)'
+ package: ExcelScript!
+ fullName: setIndentLevel(indentLevel)
+ summary: An integer from 0 to 250 that indicates the indent level for the style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setIndentLevel(indentLevel: number): void;'
+ parameters:
+ - id: indentLevel
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setLocked(locked)
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setLocked:member(1)'
+ package: ExcelScript!
+ fullName: setLocked(locked)
+ summary: Specifies if the object is locked when the worksheet is protected.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLocked(locked: boolean): void;'
+ parameters:
+ - id: locked
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setNumberFormat(numberFormat)
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: setNumberFormat(numberFormat)
+ summary: The format code of the number format for the style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setNumberFormat(numberFormat: string): void;'
+ parameters:
+ - id: numberFormat
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setNumberFormatLocal(numberFormatLocal)
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setNumberFormatLocal:member(1)'
+ package: ExcelScript!
+ fullName: setNumberFormatLocal(numberFormatLocal)
+ summary: The localized format code of the number format for the style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setNumberFormatLocal(numberFormatLocal: string): void;'
+ parameters:
+ - id: numberFormatLocal
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setRangeBorderTintAndShade(rangeBorderTintAndShade)
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setRangeBorderTintAndShade:member(1)'
+ package: ExcelScript!
+ fullName: setRangeBorderTintAndShade(rangeBorderTintAndShade)
+ summary: >-
+ Specifies a double that lightens or darkens a color for range borders. The value is between -1 (darkest) and 1
+ (brightest), with 0 for the original color. A `null` value indicates that the entire border collection doesn't
+ have a uniform `tintAndShade` setting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setRangeBorderTintAndShade(rangeBorderTintAndShade: number): void;'
+ parameters:
+ - id: rangeBorderTintAndShade
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setReadingOrder(readingOrder)
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setReadingOrder:member(1)'
+ package: ExcelScript!
+ fullName: setReadingOrder(readingOrder)
+ summary: The reading order for the style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setReadingOrder(readingOrder: ReadingOrder): void;'
+ parameters:
+ - id: readingOrder
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setShrinkToFit(shrinkToFit)
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setShrinkToFit:member(1)'
+ package: ExcelScript!
+ fullName: setShrinkToFit(shrinkToFit)
+ summary: Specifies if text automatically shrinks to fit in the available column width.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShrinkToFit(shrinkToFit: boolean): void;'
+ parameters:
+ - id: shrinkToFit
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setTextOrientation(textOrientation)
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setTextOrientation:member(1)'
+ package: ExcelScript!
+ fullName: setTextOrientation(textOrientation)
+ summary: The text orientation for the style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTextOrientation(textOrientation: number): void;'
+ parameters:
+ - id: textOrientation
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setVerticalAlignment(verticalAlignment)
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setVerticalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: setVerticalAlignment(verticalAlignment)
+ summary: Specifies the vertical alignment for the style. See `ExcelScript.VerticalAlignment` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setVerticalAlignment(verticalAlignment: VerticalAlignment): void;'
+ parameters:
+ - id: verticalAlignment
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setWrapText(wrapText)
+ uid: 'ExcelScript!ExcelScript.PredefinedCellStyle#setWrapText:member(1)'
+ package: ExcelScript!
+ fullName: setWrapText(wrapText)
+ summary: Specifies if Excel wraps the text in the object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setWrapText(wrapText: boolean): void;'
+ parameters:
+ - id: wrapText
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.presetcriteriaconditionalformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.presetcriteriaconditionalformat.yml
index 87143810..1f455156 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.presetcriteriaconditionalformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.presetcriteriaconditionalformat.yml
@@ -1,86 +1,86 @@
-### YamlMime:TSType
-name: ExcelScript.PresetCriteriaConditionalFormat
-uid: 'ExcelScript!ExcelScript.PresetCriteriaConditionalFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.PresetCriteriaConditionalFormat
-summary: >-
- Represents the preset criteria conditional format such as above average, below average, unique values, contains blank,
- nonblank, error, and noerror.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a conditional format that uses a preset criterion.
- * Any cell in row 1 will have the color fill set to green if it is a duplicate value
- * (of anything else in row 1).
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range for row 1.
- const sheet = workbook.getActiveWorksheet();
- const formattedRange = sheet.getRange("1:1");
-
- // Add new conditional formatting to that range.
- const conditionalFormat = formattedRange.addConditionalFormat(
- ExcelScript.ConditionalFormatType.presetCriteria);
-
- // Set the conditional formatting to apply a green fill.
- const presetFormat: ExcelScript.PresetCriteriaConditionalFormat = conditionalFormat.getPreset();
- presetFormat.getFormat().getFill().setColor("green");
-
- // Set a rule to apply the conditional format when values are duplicated in the range.
- const duplicateRule: ExcelScript.ConditionalPresetCriteriaRule = {
- criterion: ExcelScript.ConditionalFormatPresetCriterion.duplicateValues
- };
- presetFormat.setRule(duplicateRule);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getFormat()
- uid: 'ExcelScript!ExcelScript.PresetCriteriaConditionalFormat#getFormat:member(1)'
- package: ExcelScript!
- fullName: getFormat()
- summary: 'Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormat(): ConditionalRangeFormat;'
- return:
- type: ''
- description: ''
- - name: getRule()
- uid: 'ExcelScript!ExcelScript.PresetCriteriaConditionalFormat#getRule:member(1)'
- package: ExcelScript!
- fullName: getRule()
- summary: The rule of the conditional format.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRule(): ConditionalPresetCriteriaRule;'
- return:
- type: ''
- description: ''
- - name: setRule(rule)
- uid: 'ExcelScript!ExcelScript.PresetCriteriaConditionalFormat#setRule:member(1)'
- package: ExcelScript!
- fullName: setRule(rule)
- summary: The rule of the conditional format.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setRule(rule: ConditionalPresetCriteriaRule): void;'
- parameters:
- - id: rule
- description: ''
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.PresetCriteriaConditionalFormat
+uid: 'ExcelScript!ExcelScript.PresetCriteriaConditionalFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.PresetCriteriaConditionalFormat
+summary: >-
+ Represents the preset criteria conditional format such as above average, below average, unique values, contains blank,
+ nonblank, error, and noerror.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a conditional format that uses a preset criterion.
+ * Any cell in row 1 will have the color fill set to green if it is a duplicate value
+ * (of anything else in row 1).
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range for row 1.
+ const sheet = workbook.getActiveWorksheet();
+ const formattedRange = sheet.getRange("1:1");
+
+ // Add new conditional formatting to that range.
+ const conditionalFormat = formattedRange.addConditionalFormat(
+ ExcelScript.ConditionalFormatType.presetCriteria);
+
+ // Set the conditional formatting to apply a green fill.
+ const presetFormat: ExcelScript.PresetCriteriaConditionalFormat = conditionalFormat.getPreset();
+ presetFormat.getFormat().getFill().setColor("green");
+
+ // Set a rule to apply the conditional format when values are duplicated in the range.
+ const duplicateRule: ExcelScript.ConditionalPresetCriteriaRule = {
+ criterion: ExcelScript.ConditionalFormatPresetCriterion.duplicateValues
+ };
+ presetFormat.setRule(duplicateRule);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getFormat()
+ uid: 'ExcelScript!ExcelScript.PresetCriteriaConditionalFormat#getFormat:member(1)'
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: 'Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): ConditionalRangeFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getRule()
+ uid: 'ExcelScript!ExcelScript.PresetCriteriaConditionalFormat#getRule:member(1)'
+ package: ExcelScript!
+ fullName: getRule()
+ summary: The rule of the conditional format.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRule(): ConditionalPresetCriteriaRule;'
+ return:
+ type: ''
+ description: ''
+ - name: setRule(rule)
+ uid: 'ExcelScript!ExcelScript.PresetCriteriaConditionalFormat#setRule:member(1)'
+ package: ExcelScript!
+ fullName: setRule(rule)
+ summary: The rule of the conditional format.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setRule(rule: ConditionalPresetCriteriaRule): void;'
+ parameters:
+ - id: rule
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.printcomments.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.printcomments.yml
index eb0c98d1..d4c722a9 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.printcomments.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.printcomments.yml
@@ -1,42 +1,42 @@
-### YamlMime:TSEnum
-name: ExcelScript.PrintComments
-uid: 'ExcelScript!ExcelScript.PrintComments:enum'
-package: ExcelScript!
-fullName: ExcelScript.PrintComments
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script makes the comments print at the end of the worksheet
- * when the workbook is printed.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Access every worksheet in the workbook.
- workbook.getWorksheets().forEach(worksheet => {
- // Get the page layout for each sheet.
- const layout = worksheet.getPageLayout();
-
- // Change the comment printing settings to print them at the end of the sheet.
- layout.setPrintComments(ExcelScript.PrintComments.endSheet);
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: endSheet
- uid: 'ExcelScript!ExcelScript.PrintComments.endSheet:member'
- package: ExcelScript!
- summary: Comments will be printed as end notes at the end of the worksheet.
- - name: inPlace
- uid: 'ExcelScript!ExcelScript.PrintComments.inPlace:member'
- package: ExcelScript!
- summary: Comments will be printed where they were inserted in the worksheet.
- - name: noComments
- uid: 'ExcelScript!ExcelScript.PrintComments.noComments:member'
- package: ExcelScript!
- summary: Comments will not be printed.
+### YamlMime:TSEnum
+name: ExcelScript.PrintComments
+uid: 'ExcelScript!ExcelScript.PrintComments:enum'
+package: ExcelScript!
+fullName: ExcelScript.PrintComments
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script makes the comments print at the end of the worksheet
+ * when the workbook is printed.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Access every worksheet in the workbook.
+ workbook.getWorksheets().forEach(worksheet => {
+ // Get the page layout for each sheet.
+ const layout = worksheet.getPageLayout();
+
+ // Change the comment printing settings to print them at the end of the sheet.
+ layout.setPrintComments(ExcelScript.PrintComments.endSheet);
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: endSheet
+ uid: 'ExcelScript!ExcelScript.PrintComments.endSheet:member'
+ package: ExcelScript!
+ summary: Comments will be printed as end notes at the end of the worksheet.
+ - name: inPlace
+ uid: 'ExcelScript!ExcelScript.PrintComments.inPlace:member'
+ package: ExcelScript!
+ summary: Comments will be printed where they were inserted in the worksheet.
+ - name: noComments
+ uid: 'ExcelScript!ExcelScript.PrintComments.noComments:member'
+ package: ExcelScript!
+ summary: Comments will not be printed.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.printerrortype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.printerrortype.yml
index 99a2025e..6dbe9d9d 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.printerrortype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.printerrortype.yml
@@ -1,26 +1,26 @@
-### YamlMime:TSEnum
-name: ExcelScript.PrintErrorType
-uid: 'ExcelScript!ExcelScript.PrintErrorType:enum'
-package: ExcelScript!
-fullName: ExcelScript.PrintErrorType
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: asDisplayed
- uid: 'ExcelScript!ExcelScript.PrintErrorType.asDisplayed:member'
- package: ExcelScript!
- summary: ''
- - name: blank
- uid: 'ExcelScript!ExcelScript.PrintErrorType.blank:member'
- package: ExcelScript!
- summary: ''
- - name: dash
- uid: 'ExcelScript!ExcelScript.PrintErrorType.dash:member'
- package: ExcelScript!
- summary: ''
- - name: notAvailable
- uid: 'ExcelScript!ExcelScript.PrintErrorType.notAvailable:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.PrintErrorType
+uid: 'ExcelScript!ExcelScript.PrintErrorType:enum'
+package: ExcelScript!
+fullName: ExcelScript.PrintErrorType
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: asDisplayed
+ uid: 'ExcelScript!ExcelScript.PrintErrorType.asDisplayed:member'
+ package: ExcelScript!
+ summary: ''
+ - name: blank
+ uid: 'ExcelScript!ExcelScript.PrintErrorType.blank:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dash
+ uid: 'ExcelScript!ExcelScript.PrintErrorType.dash:member'
+ package: ExcelScript!
+ summary: ''
+ - name: notAvailable
+ uid: 'ExcelScript!ExcelScript.PrintErrorType.notAvailable:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.printmarginunit.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.printmarginunit.yml
index 5488769a..c16d7ba8 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.printmarginunit.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.printmarginunit.yml
@@ -1,22 +1,22 @@
-### YamlMime:TSEnum
-name: ExcelScript.PrintMarginUnit
-uid: 'ExcelScript!ExcelScript.PrintMarginUnit:enum'
-package: ExcelScript!
-fullName: ExcelScript.PrintMarginUnit
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: centimeters
- uid: 'ExcelScript!ExcelScript.PrintMarginUnit.centimeters:member'
- package: ExcelScript!
- summary: Assign the page margins in centimeters.
- - name: inches
- uid: 'ExcelScript!ExcelScript.PrintMarginUnit.inches:member'
- package: ExcelScript!
- summary: Assign the page margins in inches.
- - name: points
- uid: 'ExcelScript!ExcelScript.PrintMarginUnit.points:member'
- package: ExcelScript!
- summary: Assign the page margins in points. A point is 1/72 of an inch.
+### YamlMime:TSEnum
+name: ExcelScript.PrintMarginUnit
+uid: 'ExcelScript!ExcelScript.PrintMarginUnit:enum'
+package: ExcelScript!
+fullName: ExcelScript.PrintMarginUnit
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: centimeters
+ uid: 'ExcelScript!ExcelScript.PrintMarginUnit.centimeters:member'
+ package: ExcelScript!
+ summary: Assign the page margins in centimeters.
+ - name: inches
+ uid: 'ExcelScript!ExcelScript.PrintMarginUnit.inches:member'
+ package: ExcelScript!
+ summary: Assign the page margins in inches.
+ - name: points
+ uid: 'ExcelScript!ExcelScript.PrintMarginUnit.points:member'
+ package: ExcelScript!
+ summary: Assign the page margins in points. A point is 1/72 of an inch.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.printorder.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.printorder.yml
index 975ed45a..a4ed4e18 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.printorder.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.printorder.yml
@@ -1,39 +1,39 @@
-### YamlMime:TSEnum
-name: ExcelScript.PrintOrder
-uid: 'ExcelScript!ExcelScript.PrintOrder:enum'
-package: ExcelScript!
-fullName: ExcelScript.PrintOrder
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the print order for every worksheet in the workbook.
- * The order of printed content will go over (e.g., left-to-right)
- * then down (i.e., top-to-bottom).
- */
- function main(workbook: ExcelScript.Workbook) {
- // Access every worksheet in the workbook.
- workbook.getWorksheets().forEach(worksheet => {
- // Get the page layout for each sheet.
- const layout: ExcelScript.PageLayout = worksheet.getPageLayout();
-
- // Set the print order to over-then-down.
- layout.setPrintOrder(ExcelScript.PrintOrder.overThenDown);
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: downThenOver
- uid: 'ExcelScript!ExcelScript.PrintOrder.downThenOver:member'
- package: ExcelScript!
- summary: Process down the rows before processing across pages or page fields to the right.
- - name: overThenDown
- uid: 'ExcelScript!ExcelScript.PrintOrder.overThenDown:member'
- package: ExcelScript!
- summary: Process across pages or page fields to the right before moving down the rows.
+### YamlMime:TSEnum
+name: ExcelScript.PrintOrder
+uid: 'ExcelScript!ExcelScript.PrintOrder:enum'
+package: ExcelScript!
+fullName: ExcelScript.PrintOrder
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the print order for every worksheet in the workbook.
+ * The order of printed content will go over (e.g., left-to-right)
+ * then down (i.e., top-to-bottom).
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Access every worksheet in the workbook.
+ workbook.getWorksheets().forEach(worksheet => {
+ // Get the page layout for each sheet.
+ const layout: ExcelScript.PageLayout = worksheet.getPageLayout();
+
+ // Set the print order to over-then-down.
+ layout.setPrintOrder(ExcelScript.PrintOrder.overThenDown);
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: downThenOver
+ uid: 'ExcelScript!ExcelScript.PrintOrder.downThenOver:member'
+ package: ExcelScript!
+ summary: Process down the rows before processing across pages or page fields to the right.
+ - name: overThenDown
+ uid: 'ExcelScript!ExcelScript.PrintOrder.overThenDown:member'
+ package: ExcelScript!
+ summary: Process across pages or page fields to the right before moving down the rows.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.protectionselectionmode.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.protectionselectionmode.yml
index f5bab587..0eee010e 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.protectionselectionmode.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.protectionselectionmode.yml
@@ -1,44 +1,44 @@
-### YamlMime:TSEnum
-name: ExcelScript.ProtectionSelectionMode
-uid: 'ExcelScript!ExcelScript.ProtectionSelectionMode:enum'
-package: ExcelScript!
-fullName: ExcelScript.ProtectionSelectionMode
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script protects cells from being selected on the current worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the protection settings for the current worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const sheetProtection = currentSheet.getProtection();
-
- // Create a new WorksheetProtectionOptions object with the selectionMode property set to `none`.
- let protectionOptions : ExcelScript.WorksheetProtectionOptions = {
- selectionMode: ExcelScript.ProtectionSelectionMode.none
- }
-
- // Apply the given protection options.
- sheetProtection.protect(protectionOptions);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: none
- uid: 'ExcelScript!ExcelScript.ProtectionSelectionMode.none:member'
- package: ExcelScript!
- summary: Selection is not allowed for any cells.
- - name: normal
- uid: 'ExcelScript!ExcelScript.ProtectionSelectionMode.normal:member'
- package: ExcelScript!
- summary: Selection is allowed for all cells.
- - name: unlocked
- uid: 'ExcelScript!ExcelScript.ProtectionSelectionMode.unlocked:member'
- package: ExcelScript!
- summary: Selection is allowed only for cells that are not locked.
+### YamlMime:TSEnum
+name: ExcelScript.ProtectionSelectionMode
+uid: 'ExcelScript!ExcelScript.ProtectionSelectionMode:enum'
+package: ExcelScript!
+fullName: ExcelScript.ProtectionSelectionMode
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script protects cells from being selected on the current worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the protection settings for the current worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const sheetProtection = currentSheet.getProtection();
+
+ // Create a new WorksheetProtectionOptions object with the selectionMode property set to `none`.
+ let protectionOptions : ExcelScript.WorksheetProtectionOptions = {
+ selectionMode: ExcelScript.ProtectionSelectionMode.none
+ }
+
+ // Apply the given protection options.
+ sheetProtection.protect(protectionOptions);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: none
+ uid: 'ExcelScript!ExcelScript.ProtectionSelectionMode.none:member'
+ package: ExcelScript!
+ summary: Selection is not allowed for any cells.
+ - name: normal
+ uid: 'ExcelScript!ExcelScript.ProtectionSelectionMode.normal:member'
+ package: ExcelScript!
+ summary: Selection is allowed for all cells.
+ - name: unlocked
+ uid: 'ExcelScript!ExcelScript.ProtectionSelectionMode.unlocked:member'
+ package: ExcelScript!
+ summary: Selection is allowed only for cells that are not locked.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.query.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.query.yml
index 3f7625a8..144c9f8f 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.query.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.query.yml
@@ -1,109 +1,109 @@
-### YamlMime:TSType
-name: ExcelScript.Query
-uid: 'ExcelScript!ExcelScript.Query:interface'
-package: ExcelScript!
-fullName: ExcelScript.Query
-summary: Represents a Power Query query.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script logs information about all the Power Query queries in the workbook.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get all the Power Query queries in the workbook.
- const queries = workbook.getQueries();
-
- // For each query, log the date it was last refreshed.
- queries.forEach((query: ExcelScript.Query) => {
- console.log(`Query ${query.getName()} - last refreshed ${query.getRefreshDate()}`);
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getError()
- uid: 'ExcelScript!ExcelScript.Query#getError:member(1)'
- package: ExcelScript!
- fullName: getError()
- summary: Gets the query error message from when the query was last refreshed.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getError(): QueryError;'
- return:
- type: ''
- description: ''
- - name: getLoadedTo()
- uid: 'ExcelScript!ExcelScript.Query#getLoadedTo:member(1)'
- package: ExcelScript!
- fullName: getLoadedTo()
- summary: Gets the query loaded to object type.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLoadedTo(): LoadToType;'
- return:
- type: ''
- description: ''
- - name: getLoadedToDataModel()
- uid: 'ExcelScript!ExcelScript.Query#getLoadedToDataModel:member(1)'
- package: ExcelScript!
- fullName: getLoadedToDataModel()
- summary: Specifies if the query loaded to the data model.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLoadedToDataModel(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.Query#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: Gets the name of the query. Query names cannot contain periods or quotation marks.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: getRefreshDate()
- uid: 'ExcelScript!ExcelScript.Query#getRefreshDate:member(1)'
- package: ExcelScript!
- fullName: getRefreshDate()
- summary: Gets the date and time when the query was last refreshed.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRefreshDate(): Date;'
- return:
- type: Date
- description: ''
- - name: getRowsLoadedCount()
- uid: 'ExcelScript!ExcelScript.Query#getRowsLoadedCount:member(1)'
- package: ExcelScript!
- fullName: getRowsLoadedCount()
- summary: >-
- Gets the number of rows that were loaded when the query was last refreshed. If last refresh has errors the value
- will be -1.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRowsLoadedCount(): number;'
- return:
- type: number
- description: ''
+### YamlMime:TSType
+name: ExcelScript.Query
+uid: 'ExcelScript!ExcelScript.Query:interface'
+package: ExcelScript!
+fullName: ExcelScript.Query
+summary: Represents a Power Query query.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script logs information about all the Power Query queries in the workbook.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get all the Power Query queries in the workbook.
+ const queries = workbook.getQueries();
+
+ // For each query, log the date it was last refreshed.
+ queries.forEach((query: ExcelScript.Query) => {
+ console.log(`Query ${query.getName()} - last refreshed ${query.getRefreshDate()}`);
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getError()
+ uid: 'ExcelScript!ExcelScript.Query#getError:member(1)'
+ package: ExcelScript!
+ fullName: getError()
+ summary: Gets the query error message from when the query was last refreshed.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getError(): QueryError;'
+ return:
+ type: ''
+ description: ''
+ - name: getLoadedTo()
+ uid: 'ExcelScript!ExcelScript.Query#getLoadedTo:member(1)'
+ package: ExcelScript!
+ fullName: getLoadedTo()
+ summary: Gets the query loaded to object type.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLoadedTo(): LoadToType;'
+ return:
+ type: ''
+ description: ''
+ - name: getLoadedToDataModel()
+ uid: 'ExcelScript!ExcelScript.Query#getLoadedToDataModel:member(1)'
+ package: ExcelScript!
+ fullName: getLoadedToDataModel()
+ summary: Specifies if the query loaded to the data model.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLoadedToDataModel(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.Query#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: Gets the name of the query. Query names cannot contain periods or quotation marks.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getRefreshDate()
+ uid: 'ExcelScript!ExcelScript.Query#getRefreshDate:member(1)'
+ package: ExcelScript!
+ fullName: getRefreshDate()
+ summary: Gets the date and time when the query was last refreshed.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRefreshDate(): Date;'
+ return:
+ type: Date
+ description: ''
+ - name: getRowsLoadedCount()
+ uid: 'ExcelScript!ExcelScript.Query#getRowsLoadedCount:member(1)'
+ package: ExcelScript!
+ fullName: getRowsLoadedCount()
+ summary: >-
+ Gets the number of rows that were loaded when the query was last refreshed. If last refresh has errors the value
+ will be -1.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRowsLoadedCount(): number;'
+ return:
+ type: number
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.queryerror.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.queryerror.yml
index 96e268ae..011bf8aa 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.queryerror.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.queryerror.yml
@@ -1,34 +1,34 @@
-### YamlMime:TSEnum
-name: ExcelScript.QueryError
-uid: 'ExcelScript!ExcelScript.QueryError:enum'
-package: ExcelScript!
-fullName: ExcelScript.QueryError
-summary: An enum that specifies the query load error message.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: failedDownload
- uid: 'ExcelScript!ExcelScript.QueryError.failedDownload:member'
- package: ExcelScript!
- summary: Download failed.
- - name: failedLoadToDataModel
- uid: 'ExcelScript!ExcelScript.QueryError.failedLoadToDataModel:member'
- package: ExcelScript!
- summary: Load to the data model failed.
- - name: failedLoadToWorksheet
- uid: 'ExcelScript!ExcelScript.QueryError.failedLoadToWorksheet:member'
- package: ExcelScript!
- summary: Load to the worksheet failed.
- - name: failedToCompleteDownload
- uid: 'ExcelScript!ExcelScript.QueryError.failedToCompleteDownload:member'
- package: ExcelScript!
- summary: Download did not complete.
- - name: none
- uid: 'ExcelScript!ExcelScript.QueryError.none:member'
- package: ExcelScript!
- summary: No error.
- - name: unknown
- uid: 'ExcelScript!ExcelScript.QueryError.unknown:member'
- package: ExcelScript!
- summary: Unknown error.
+### YamlMime:TSEnum
+name: ExcelScript.QueryError
+uid: 'ExcelScript!ExcelScript.QueryError:enum'
+package: ExcelScript!
+fullName: ExcelScript.QueryError
+summary: An enum that specifies the query load error message.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: failedDownload
+ uid: 'ExcelScript!ExcelScript.QueryError.failedDownload:member'
+ package: ExcelScript!
+ summary: Download failed.
+ - name: failedLoadToDataModel
+ uid: 'ExcelScript!ExcelScript.QueryError.failedLoadToDataModel:member'
+ package: ExcelScript!
+ summary: Load to the data model failed.
+ - name: failedLoadToWorksheet
+ uid: 'ExcelScript!ExcelScript.QueryError.failedLoadToWorksheet:member'
+ package: ExcelScript!
+ summary: Load to the worksheet failed.
+ - name: failedToCompleteDownload
+ uid: 'ExcelScript!ExcelScript.QueryError.failedToCompleteDownload:member'
+ package: ExcelScript!
+ summary: Download did not complete.
+ - name: none
+ uid: 'ExcelScript!ExcelScript.QueryError.none:member'
+ package: ExcelScript!
+ summary: No error.
+ - name: unknown
+ uid: 'ExcelScript!ExcelScript.QueryError.unknown:member'
+ package: ExcelScript!
+ summary: Unknown error.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.range.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.range.yml
index 43e0ea27..c0a5d47a 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.range.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.range.yml
@@ -1,2995 +1,3050 @@
-### YamlMime:TSType
-name: ExcelScript.Range
-uid: 'ExcelScript!ExcelScript.Range:interface'
-package: ExcelScript!
-fullName: ExcelScript.Range
-summary: 'Range represents a set of one or more contiguous cells such as a cell, a row, a column, or a block of cells.'
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script logs the address of the used range in the current worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current, active worksheet.
- let currentWorksheet = workbook.getActiveWorksheet();
-
- // Get the range containing all the cells with data or formatting.
- let usedRange = currentWorksheet.getUsedRange();
-
- // Log the range's address to the console.
- console.log(usedRange.getAddress());
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: addConditionalFormat(type)
- uid: 'ExcelScript!ExcelScript.Range#addConditionalFormat:member(1)'
- package: ExcelScript!
- fullName: addConditionalFormat(type)
- summary: Adds a new conditional format to the collection at the first/top priority.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addConditionalFormat(type: ConditionalFormatType): ConditionalFormat;'
- parameters:
- - id: type
- description: The type of conditional format being added. See `ExcelScript.ConditionalFormatType` for details.
- type: ''
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample applies conditional formatting to the currently used range in the worksheet.
- * The conditional formatting is a green fill for the top 10% of values.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Get the used range in the worksheet.
- let range = selectedSheet.getUsedRange();
-
- // Set the fill color to green for the top 10% of values in the range.
- let conditionalFormat = range.addConditionalFormat(ExcelScript.ConditionalFormatType.topBottom)
- conditionalFormat.getTopBottom().getFormat().getFill().setColor("green");
- conditionalFormat.getTopBottom().setRule({
- rank: 10, // The percentage threshold.
- type: ExcelScript.ConditionalTopBottomCriterionType.topPercent // The type of the top/bottom condition.
- });
- }
- ```
- - name: 'autoFill(destinationRange, autoFillType)'
- uid: 'ExcelScript!ExcelScript.Range#autoFill:member(1)'
- package: ExcelScript!
- fullName: 'autoFill(destinationRange, autoFillType)'
- summary: >-
- Fills a range from the current range to the destination range using the specified AutoFill logic. The destination
- range can be `null` or can extend the source range either horizontally or vertically. Discontiguous ranges are not
- supported.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- autoFill(
- destinationRange?: Range | string,
- autoFillType?: AutoFillType
- ): void;
- parameters:
- - id: destinationRange
- description: >-
- The destination range to AutoFill. If the destination range is `null`, data is filled out based on
- the surrounding cells (which is the behavior when double-clicking the UI's range fill handle).
- type: ' | string'
- - id: autoFillType
- description: >-
- The type of AutoFill. Specifies how the destination range is to be filled, based on the contents of the
- current range. Default is "FillDefault".
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script uses the autofill feature to complete a table.
- * See https://support.microsoft.com/office/74e31bdd-d993-45da-aa82-35a236c5b5db
- * for examples of autofill scenarios.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current, active worksheet.
- let currentWorksheet = workbook.getActiveWorksheet();
-
- // Get the data range that shows the pattern.
- let dataRange = currentWorksheet.getRange("C2:C3");
-
- // Autofill the connected range. C2:C3 are filled in. C4:C14 are blank.
- // This uses the default behavior to match a pattern with the table's contents.
- dataRange.autoFill("C2:C14");
- }
- ```
- - name: calculate()
- uid: 'ExcelScript!ExcelScript.Range#calculate:member(1)'
- package: ExcelScript!
- fullName: calculate()
- summary: Calculates a range of cells on a worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'calculate(): void;'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script recalculates the used range of a specific worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Only recalculate if the calculation mode is not set to automatic.
- if (workbook.getApplication().getCalculationMode() !== ExcelScript.CalculationMode.automatic) {
- // Get the used range from a worksheet named "Monthly Report".
- const sheet = workbook.getWorksheet("Monthly Report");
- const range = sheet.getUsedRange();
- console.log(`Calculating ${range.getAddress()}`);
-
- // Force all the used cells in that worksheet to calculate.
- sheet.getUsedRange().calculate();
- }
- }
- ```
- - name: clear(applyTo)
- uid: 'ExcelScript!ExcelScript.Range#clear:member(1)'
- package: ExcelScript!
- fullName: clear(applyTo)
- summary: 'Clear range values and formatting, such as fill and border.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'clear(applyTo?: ClearApplyTo): void;'
- parameters:
- - id: applyTo
- description: Optional. Determines the type of clear action. See `ExcelScript.ClearApplyTo` for details.
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script removes all the formatting from the selected range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the selected range.
- let range = workbook.getSelectedRange();
-
- // Clear all the formatting in that range.
- range.clear(ExcelScript.ClearApplyTo.formats);
- }
- ```
- - name: clearAllConditionalFormats()
- uid: 'ExcelScript!ExcelScript.Range#clearAllConditionalFormats:member(1)'
- package: ExcelScript!
- fullName: clearAllConditionalFormats()
- summary: Clears all conditional formats active on the current specified range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'clearAllConditionalFormats(): void;'
- return:
- type: void
- description: ''
- - name: convertDataTypeToText()
- uid: 'ExcelScript!ExcelScript.Range#convertDataTypeToText:member(1)'
- package: ExcelScript!
- fullName: convertDataTypeToText()
- summary: Converts the range cells with data types into text.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'convertDataTypeToText(): void;'
- return:
- type: void
- description: ''
- - name: 'copyFrom(sourceRange, copyType, skipBlanks, transpose)'
- uid: 'ExcelScript!ExcelScript.Range#copyFrom:member(1)'
- package: ExcelScript!
- fullName: 'copyFrom(sourceRange, copyType, skipBlanks, transpose)'
- summary: >-
- Copies cell data or formatting from the source range or `RangeAreas` to the current range. The destination range
- can be a different size than the source range or `RangeAreas`. The destination is expanded automatically
- if it's smaller than the source. Note: Like the copy functionality in the Excel UI, if the destination range is an
- exact multiple greater than the source range in either rows or columns, then the source content is replicated
- multiple times. For example, a 2x2 range copy into a 2x6 range will result in 3 copies of the original 2x2 range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- copyFrom(
- sourceRange: Range | RangeAreas | string,
- copyType?: RangeCopyType,
- skipBlanks?: boolean,
- transpose?: boolean
- ): void;
- parameters:
- - id: sourceRange
- description: >-
- The source range or `RangeAreas` to copy from. When the source `RangeAreas` has multiple ranges, their form
- must be able to be created by removing full rows or columns from a rectangular range.
- type: >-
- | | string
- - id: copyType
- description: The type of cell data or formatting to copy over. Default is "All".
- type: ''
- - id: skipBlanks
- description: True if to skip blank cells in the source range. Default is false.
- type: boolean
- - id: transpose
- description: True if to transpose the cells in the destination range. Default is false.
- type: boolean
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script copies a table from one worksheet to a new worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the worksheet named "TableTemplate".
- let base = workbook.getWorksheet("TableTemplate");
-
- // Get the range to be copied based on the first table.
- let tableRange = base.getTables()[0].getRange();
-
- // Get the area in a new worksheet for the new table.
- let newWorksheet = workbook.addWorksheet();
- let newRange = newWorksheet.getRangeByIndexes(0,0, tableRange.getRowCount(), tableRange.getColumnCount());
-
- // Copy the existing data into the new range.
- newRange.copyFrom(tableRange);
- }
- ```
- - name: delete(shift)
- uid: 'ExcelScript!ExcelScript.Range#delete:member(1)'
- package: ExcelScript!
- fullName: delete(shift)
- summary: Deletes the cells associated with the range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(shift: DeleteShiftDirection): void;'
- parameters:
- - id: shift
- description: Specifies which way to shift the cells. See `ExcelScript.DeleteShiftDirection` for details.
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample creates a sample range, then deletes
- * "A1" using different DeleteShiftDirection values.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Add sample data to better visualize the delete changes.
- const currentSheet = workbook.getActiveWorksheet();
- currentSheet.getRange("A1:D4").setValues([
- [1,2,3,4],
- [5,6,7,8],
- [9,10,11,12],
- [13,14,15,16]]);
-
- // Delete A1 and shift the cells from the right to fill the space.
- // The value being deleted is 1.
- currentSheet.getRange("A1").delete(ExcelScript.DeleteShiftDirection.left);
-
- // Delete A1 and shift the cells from the bottom to fill the space.
- // The value being deleted is 2.
- currentSheet.getRange("A1").delete(ExcelScript.DeleteShiftDirection.up);
-
- // Log the sample range. The values should be:
- /*
- 5, 3, 4, "",
- 9, 6, 7, 8,
- 13, 10, 11, 12,
- "", 14, 15, 16
- */
- console.log(currentSheet.getRange("A1:D4").getValues());
- }
- ```
- - name: 'find(text, criteria)'
- uid: 'ExcelScript!ExcelScript.Range#find:member(1)'
- package: ExcelScript!
- fullName: 'find(text, criteria)'
- summary: >-
- Finds the given string based on the criteria specified. If the current range is larger than a single cell, then
- the search will be limited to that range, else the search will cover the entire sheet starting after that cell. If
- there are no matches, then this method returns `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'find(text: string, criteria: SearchCriteria): Range;'
- parameters:
- - id: text
- description: The string to find.
- type: string
- - id: criteria
- description: >-
- Additional search criteria, including the search direction and whether the search needs to match the entire
- cell or be case-sensitive.
- type: ''
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script searches through a table column and finds cells marked "no change".
- * Those cells have "no change" replaced with the value from the cell to the left.
- * This script uses Range.find instead of Worksheet.findAll
- * to limit the search to a specific range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range of a table named "Orders".
- let table = workbook.getTable("Orders");
- let range = table.getColumnByName("March").getRange();
-
- // Find all cells with the value "no change".
- let cellToOverwrite = range.find("no change", { completeMatch: true });
- while (cellToOverwrite) {
- let cellToCopyFrom = cellToOverwrite.getOffsetRange(0,-1);
- cellToOverwrite.setValue(cellToCopyFrom.getValue());
- cellToOverwrite = range.find("no change", { completeMatch: true });
- }
- }
- ```
- - name: flashFill()
- uid: 'ExcelScript!ExcelScript.Range#flashFill:member(1)'
- package: ExcelScript!
- fullName: flashFill()
- summary: >-
- Does a Flash Fill to the current range. Flash Fill automatically fills data when it senses a pattern, so the range
- must be a single column range and have data around it in order to find a pattern.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'flashFill(): void;'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script uses the Flash Fill feature to complete a table.
- * See https://support.microsoft.com/office/3f9bcf1e-db93-4890-94a0-1578341f73f7
- * for the example table.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current, active worksheet.
- let currentWorksheet = workbook.getActiveWorksheet();
-
- // Get the data range with a pattern and cells to fill. C2 is filled in. C3:C6 are blank.
- let dataRange = currentWorksheet.getRange("C2:C6");
-
- // Flash fill the connected range.
- dataRange.flashFill();
- }
- ```
- - name: 'getAbsoluteResizedRange(numRows, numColumns)'
- uid: 'ExcelScript!ExcelScript.Range#getAbsoluteResizedRange:member(1)'
- package: ExcelScript!
- fullName: 'getAbsoluteResizedRange(numRows, numColumns)'
- summary: >-
- Gets a `Range` object with the same top-left cell as the current `Range` object, but with the specified numbers of
- rows and columns.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAbsoluteResizedRange(numRows: number, numColumns: number): Range;'
- parameters:
- - id: numRows
- description: The number of rows of the new range size.
- type: number
- - id: numColumns
- description: The number of columns of the new range size.
- type: number
- return:
- type: ''
- description: ''
- - name: getAddress()
- uid: 'ExcelScript!ExcelScript.Range#getAddress:member(1)'
- package: ExcelScript!
- fullName: getAddress()
- summary: 'Specifies the range reference in A1-style. Address value contains the sheet reference (e.g., "Sheet1!A1:B4").'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAddress(): string;'
- return:
- type: string
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script logs the address of the used range in each worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Iterate over every worksheet in the workbook.
- workbook.getWorksheets().forEach((sheet) => {
- // Get the used range for a single worksheet.
- let range = sheet.getUsedRange();
-
- // Print the address of the used range to the console.
- console.log(range.getAddress());
- });
- }
- ```
- - name: getAddressLocal()
- uid: 'ExcelScript!ExcelScript.Range#getAddressLocal:member(1)'
- package: ExcelScript!
- fullName: getAddressLocal()
- summary: Represents the range reference for the specified range in the language of the user.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAddressLocal(): string;'
- return:
- type: string
- description: ''
- - name: getBoundingRect(anotherRange)
- uid: 'ExcelScript!ExcelScript.Range#getBoundingRect:member(1)'
- package: ExcelScript!
- fullName: getBoundingRect(anotherRange)
- summary: >-
- Gets the smallest range object that encompasses the given ranges. For example, the `GetBoundingRect` of "B2:C5"
- and "D10:E15" is "B2:E15".
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBoundingRect(anotherRange: Range | string): Range;'
- parameters:
- - id: anotherRange
- description: 'The range object, address, or range name.'
- type: ' | string'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script gets the bounding range of two existing ranges and puts a border around it.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- let sheet = workbook.getActiveWorksheet();
-
- // Create two range objects for the sample.
- let range1 = sheet.getRange("B2:C5");
- let range2 = sheet.getRange("D10:E15");
-
- // Get the rectangular range that fully includes both ranges.
- let boundingRectangle = range1.getBoundingRect(range2);
-
- // Add a border around the whole bounding range (B2:E15).
- let format = boundingRectangle.getFormat();
- format.getRangeBorder(ExcelScript.BorderIndex.edgeTop).setStyle(ExcelScript.BorderLineStyle.continuous); // Top border
- format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom).setStyle(ExcelScript.BorderLineStyle.continuous); // Bottom border
- format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft).setStyle(ExcelScript.BorderLineStyle.continuous); // Left border
- format.getRangeBorder(ExcelScript.BorderIndex.edgeRight).setStyle(ExcelScript.BorderLineStyle.continuous); // Right border
- }
- ```
- - name: 'getCell(row, column)'
- uid: 'ExcelScript!ExcelScript.Range#getCell:member(1)'
- package: ExcelScript!
- fullName: 'getCell(row, column)'
- summary: >-
- Gets the range object containing the single cell based on row and column numbers. The cell can be outside the
- bounds of its parent range, so long as it stays within the worksheet grid. The returned cell is located relative
- to the top left cell of the range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCell(row: number, column: number): Range;'
- parameters:
- - id: row
- description: Row number of the cell to be retrieved. Zero-indexed.
- type: number
- - id: column
- description: Column number of the cell to be retrieved. Zero-indexed.
- type: number
- return:
- type: ''
- description: ''
- - name: getCellCount()
- uid: 'ExcelScript!ExcelScript.Range#getCellCount:member(1)'
- package: ExcelScript!
- fullName: getCellCount()
- summary: >-
- Specifies the number of cells in the range. This API will return -1 if the cell count exceeds 2^31-1
- (2,147,483,647).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCellCount(): number;'
- return:
- type: number
- description: ''
- - name: getColumn(column)
- uid: 'ExcelScript!ExcelScript.Range#getColumn:member(1)'
- package: ExcelScript!
- fullName: getColumn(column)
- summary: Gets a column contained in the range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColumn(column: number): Range;'
- parameters:
- - id: column
- description: Column number of the range to be retrieved. Zero-indexed.
- type: number
- return:
- type: ''
- description: ''
- - name: getColumnCount()
- uid: 'ExcelScript!ExcelScript.Range#getColumnCount:member(1)'
- package: ExcelScript!
- fullName: getColumnCount()
- summary: Specifies the total number of columns in the range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColumnCount(): number;'
- return:
- type: number
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample provides the count of negative numbers that are present
- * in the used range of the current worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the working range.
- let usedRange = workbook.getActiveWorksheet().getUsedRange();
- let rowCount = usedRange.getRowCount();
- let columnCount = usedRange.getColumnCount();
-
- // Save the values locally to avoid repeatedly asking the workbook.
- let usedRangeValues = usedRange.getValues();
-
- // Start the negative number counter.
- let negativeCount = 0;
-
- // Iterate over the entire range looking for negative numbers.
- for (let i = 0; i < rowCount; i++) {
- for (let j = 0; j < columnCount; j++) {
- if (usedRangeValues[i][j] < 0) {
- negativeCount++;
- }
- }
- }
-
- // Log the negative number count to the console.
- console.log(negativeCount);
- }
- ```
- - name: getColumnHidden()
- uid: 'ExcelScript!ExcelScript.Range#getColumnHidden:member(1)'
- package: ExcelScript!
- fullName: getColumnHidden()
- summary: >-
- Represents if all columns in the current range are hidden. Value is `true` when all columns in a range are hidden.
- Value is `false` when no columns in the range are hidden. Value is `null` when some columns in a range are hidden
- and other columns in the same range are not hidden.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColumnHidden(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getColumnIndex()
- uid: 'ExcelScript!ExcelScript.Range#getColumnIndex:member(1)'
- package: ExcelScript!
- fullName: getColumnIndex()
- summary: Specifies the column number of the first cell in the range. Zero-indexed.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColumnIndex(): number;'
- return:
- type: number
- description: ''
- - name: getColumnsAfter(count)
- uid: 'ExcelScript!ExcelScript.Range#getColumnsAfter:member(1)'
- package: ExcelScript!
- fullName: getColumnsAfter(count)
- summary: Gets a certain number of columns to the right of the current `Range` object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColumnsAfter(count?: number): Range;'
- parameters:
- - id: count
- description: >-
- Optional. The number of columns to include in the resulting range. In general, use a positive number to
- create a range outside the current range. You can also use a negative number to create a range within the
- current range. The default value is 1.
- type: number
- return:
- type: ''
- description: ''
- - name: getColumnsBefore(count)
- uid: 'ExcelScript!ExcelScript.Range#getColumnsBefore:member(1)'
- package: ExcelScript!
- fullName: getColumnsBefore(count)
- summary: Gets a certain number of columns to the left of the current `Range` object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColumnsBefore(count?: number): Range;'
- parameters:
- - id: count
- description: >-
- Optional. The number of columns to include in the resulting range. In general, use a positive number to
- create a range outside the current range. You can also use a negative number to create a range within the
- current range. The default value is 1.
- type: number
- return:
- type: ''
- description: ''
- - name: getConditionalFormat(id)
- uid: 'ExcelScript!ExcelScript.Range#getConditionalFormat:member(1)'
- package: ExcelScript!
- fullName: getConditionalFormat(id)
- summary: >-
- Returns a conditional format identified by its ID. If the conditional format object does not exist, then this
- method returns `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getConditionalFormat(id: string): ConditionalFormat | undefined;'
- parameters:
- - id: id
- description: The ID of the conditional format.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getConditionalFormats()
- uid: 'ExcelScript!ExcelScript.Range#getConditionalFormats:member(1)'
- package: ExcelScript!
- fullName: getConditionalFormats()
- summary: The collection of `ConditionalFormats` that intersect the range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getConditionalFormats(): ConditionalFormat[];'
- return:
- type: '[]'
- description: ''
- - name: getDataValidation()
- uid: 'ExcelScript!ExcelScript.Range#getDataValidation:member(1)'
- package: ExcelScript!
- fullName: getDataValidation()
- summary: Returns a data validation object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDataValidation(): DataValidation;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a drop-down selection list for a cell. It uses the existing values of the selected range as the choices for the list.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the values for data validation.
- let selectedRange = workbook.getSelectedRange();
- let rangeValues = selectedRange.getValues();
-
- // Convert the values into a comma-delimited string.
- let dataValidationListString = "";
- rangeValues.forEach((rangeValueRow) => {
- rangeValueRow.forEach((value) => {
- dataValidationListString += value + ",";
- });
- });
-
- // Clear the old range.
- selectedRange.clear(ExcelScript.ClearApplyTo.contents);
-
- // Apply the data validation to the first cell in the selected range.
- let targetCell = selectedRange.getCell(0,0);
- let dataValidation = targetCell.getDataValidation();
-
- // Set the content of the drop-down list.
- dataValidation.setRule({
- list: {
- inCellDropDown: true,
- source: dataValidationListString
- }
- });
- }
- ```
- - name: getDependents()
- uid: 'ExcelScript!ExcelScript.Range#getDependents:member(1)'
- package: ExcelScript!
- fullName: getDependents()
- summary: >-
- Returns a `WorkbookRangeAreas` object that represents the range containing all the dependent cells of a specified
- range in the same worksheet or across multiple worksheets.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDependents(): WorkbookRangeAreas;'
- return:
- type: ''
- description: ''
- - name: getDirectDependents()
- uid: 'ExcelScript!ExcelScript.Range#getDirectDependents:member(1)'
- package: ExcelScript!
- fullName: getDirectDependents()
- summary: >-
- Returns a `WorkbookRangeAreas` object that represents the range containing all the direct dependent cells of a
- specified range in the same worksheet or across multiple worksheets.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDirectDependents(): WorkbookRangeAreas;'
- return:
- type: ''
- description: ''
- - name: getDirectPrecedents()
- uid: 'ExcelScript!ExcelScript.Range#getDirectPrecedents:member(1)'
- package: ExcelScript!
- fullName: getDirectPrecedents()
- summary: >-
- Returns a `WorkbookRangeAreas` object that represents the range containing all the direct precedent cells of a
- specified range in the same worksheet or across multiple worksheets.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDirectPrecedents(): WorkbookRangeAreas;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script finds the direct precedents of the active cell.
- * It changes the font and color of those precedent cells.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the active cell.
- const selected = workbook.getActiveCell();
-
- // Get the cells that are direct precedents of the current cell.
- const precedents : ExcelScript.WorkbookRangeAreas = selected.getDirectPrecedents();
-
- // Set the font to bold and the fill color to orange for all the precedent cells.
- precedents.getRanges().forEach(range => {
- range.getFormat().getFill().setColor("orange");
- range.getFormat().getFont().setBold(true);
- });
- }
- ```
- - name: getEntireColumn()
- uid: 'ExcelScript!ExcelScript.Range#getEntireColumn:member(1)'
- package: ExcelScript!
- fullName: getEntireColumn()
- summary: >-
- Gets an object that represents the entire column of the range (for example, if the current range represents cells
- "B4:E11", its `getEntireColumn` is a range that represents columns "B:E").
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getEntireColumn(): Range;'
- return:
- type: ''
- description: ''
- - name: getEntireRow()
- uid: 'ExcelScript!ExcelScript.Range#getEntireRow:member(1)'
- package: ExcelScript!
- fullName: getEntireRow()
- summary: >-
- Gets an object that represents the entire row of the range (for example, if the current range represents cells
- "B4:E11", its `GetEntireRow` is a range that represents rows "4:11").
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getEntireRow(): Range;'
- return:
- type: ''
- description: ''
- - name: 'getExtendedRange(direction, activeCell)'
- uid: 'ExcelScript!ExcelScript.Range#getExtendedRange:member(1)'
- package: ExcelScript!
- fullName: 'getExtendedRange(direction, activeCell)'
- summary: >-
- Returns a range object that includes the current range and up to the edge of the range, based on the provided
- direction. This matches the Ctrl+Shift+Arrow key behavior in the Excel on Windows
- UI.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- getExtendedRange(
- direction: KeyboardDirection,
- activeCell?: Range | string
- ): Range;
- parameters:
- - id: direction
- description: The direction from the active cell.
- type: ''
- - id: activeCell
- description: >-
- The active cell in this range. By default, the active cell is the top-left cell of the range. An error is
- thrown if the active cell is not in this range.
- type: ' | string'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script makes the font bold on all the contiguous cells between
- * A1 and the bottom of the used range of the first column.
- */
- function main(workbook: ExcelScript.Workbook)
- {
- // Get the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Get every cell that's used between A1 and the end of the column.
- // This recreates the Ctrl+Shift+Down arrow key behavior.
- let firstCell = selectedSheet.getRange("A1");
- let firstColumn = firstCell.getExtendedRange(ExcelScript.KeyboardDirection.down);
-
- // Set the font to bold in that range.
- firstColumn.getFormat().getFont().setBold(true);
- }
- ```
- - name: getFormat()
- uid: 'ExcelScript!ExcelScript.Range#getFormat:member(1)'
- package: ExcelScript!
- fullName: getFormat()
- summary: 'Returns a format object, encapsulating the range''s font, fill, borders, alignment, and other properties.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormat(): RangeFormat;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script gives the total row of a table a green color fill.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table in the workbook.
- let table = workbook.getTables()[0];
-
- // Get the range for the total row of the table.
- let totalRange = table.getTotalRowRange();
-
- // Set the fill color to green.
- totalRange.getFormat().getFill().setColor("green");
- }
- ```
- - name: getFormula()
- uid: 'ExcelScript!ExcelScript.Range#getFormula:member(1)'
- package: ExcelScript!
- fullName: getFormula()
- summary: >-
- Represents the cell formula in A1-style notation. If the range contains multiple cells, the data from first cell
- (represented by row index of 0 and column index of 0) will be returned.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormula(): string;'
- return:
- type: string
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /*
- * This script sets a cell's formula,
- * then displays how Excel stores the cell's formula and value separately.
- */
- function main(workbook: ExcelScript.Workbook) {
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Set A1 to 2.
- let a1 = selectedSheet.getRange("A1");
- a1.setValue(2);
-
- // Set B1 to the formula =(2*A1), which should equal 4.
- let b1 = selectedSheet.getRange("B1")
- b1.setFormula("=(2*A1)");
-
- // Log the current results for `getFormula` and `getValue` at B1.
- console.log(`B1 - Formula: ${b1.getFormula()} | Value: ${b1.getValue()}`);
- }
- ```
- - name: getFormulaLocal()
- uid: 'ExcelScript!ExcelScript.Range#getFormulaLocal:member(1)'
- package: ExcelScript!
- fullName: getFormulaLocal()
- summary: >-
- Represents the cell formula in A1-style notation, in the user's language and number-formatting locale. For
- example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If the range contains
- multiple cells, the data from first cell (represented by row index of 0 and column index of 0) will be returned.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormulaLocal(): string;'
- return:
- type: string
- description: ''
- - name: getFormulaR1C1()
- uid: 'ExcelScript!ExcelScript.Range#getFormulaR1C1:member(1)'
- package: ExcelScript!
- fullName: getFormulaR1C1()
- summary: >-
- Represents the cell formula in R1C1-style notation. If the range contains multiple cells, the data from first cell
- (represented by row index of 0 and column index of 0) will be returned.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormulaR1C1(): string;'
- return:
- type: string
- description: ''
- - name: getFormulas()
- uid: 'ExcelScript!ExcelScript.Range#getFormulas:member(1)'
- package: ExcelScript!
- fullName: getFormulas()
- summary: 'Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormulas(): string[][];'
- return:
- type: 'string[][]'
- description: ''
- - name: getFormulasLocal()
- uid: 'ExcelScript!ExcelScript.Range#getFormulasLocal:member(1)'
- package: ExcelScript!
- fullName: getFormulasLocal()
- summary: >-
- Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the
- English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its value is
- returned instead.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormulasLocal(): string[][];'
- return:
- type: 'string[][]'
- description: ''
- - name: getFormulasR1C1()
- uid: 'ExcelScript!ExcelScript.Range#getFormulasR1C1:member(1)'
- package: ExcelScript!
- fullName: getFormulasR1C1()
- summary: 'Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormulasR1C1(): string[][];'
- return:
- type: 'string[][]'
- description: ''
- - name: getHasSpill()
- uid: 'ExcelScript!ExcelScript.Range#getHasSpill:member(1)'
- package: ExcelScript!
- fullName: getHasSpill()
- summary: >-
- Represents if all cells have a spill border. Returns `true` if all cells have a spill border, or `false` if all
- cells do not have a spill border. Returns `null` if there are cells both with and without spill borders within the
- range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHasSpill(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getHeight()
- uid: 'ExcelScript!ExcelScript.Range#getHeight:member(1)'
- package: ExcelScript!
- fullName: getHeight()
- summary: 'Returns the distance in points, for 100% zoom, from the top edge of the range to the bottom edge of the range.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHeight(): number;'
- return:
- type: number
- description: ''
- - name: getHidden()
- uid: 'ExcelScript!ExcelScript.Range#getHidden:member(1)'
- package: ExcelScript!
- fullName: getHidden()
- summary: >-
- Represents if all cells in the current range are hidden. Value is `true` when all cells in a range are hidden.
- Value is `false` when no cells in the range are hidden. Value is `null` when some cells in a range are hidden and
- other cells in the same range are not hidden.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHidden(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getHyperlink()
- uid: 'ExcelScript!ExcelScript.Range#getHyperlink:member(1)'
- package: ExcelScript!
- fullName: getHyperlink()
- summary: Represents the hyperlink for the current range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHyperlink(): RangeHyperlink;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample clears all of the hyperlinks from the current worksheet
- * and removes the usual hyperlink formatting.
- */
- function main(workbook: ExcelScript.Workbook, sheetName: string = 'Sheet1') {
- // Get the active worksheet.
- let sheet = workbook.getWorksheet(sheetName);
-
- // Get the used range to operate on.
- // For large ranges (over 10000 entries), consider splitting the operation into batches for performance.
- const targetRange = sheet.getUsedRange(true);
- console.log(`Target Range to clear hyperlinks from: ${targetRange.getAddress()}`);
-
- const rowCount = targetRange.getRowCount();
- const colCount = targetRange.getColumnCount();
- console.log(`Searching for hyperlinks in ${targetRange.getAddress()} which contains ${(rowCount * colCount)} cells`);
-
- // Go through each individual cell looking for a hyperlink.
- // This allows us to limit the formatting changes to only the cells with hyperlink formatting.
- let clearedCount = 0;
- for (let i = 0; i < rowCount; i++) {
- for (let j = 0; j < colCount; j++) {
- const cell = targetRange.getCell(i, j);
- const hyperlink = cell.getHyperlink();
- if (hyperlink) {
- cell.clear(ExcelScript.ClearApplyTo.hyperlinks);
- cell.getFormat().getFont().setUnderline(ExcelScript.RangeUnderlineStyle.none);
- cell.getFormat().getFont().setColor('Black');
- clearedCount++;
- }
- }
- }
-
- console.log(`Done. Cleared hyperlinks from ${clearedCount} cells`);
- }
- ```
- - name: getImage()
- uid: 'ExcelScript!ExcelScript.Range#getImage:member(1)'
- package: ExcelScript!
- fullName: getImage()
- summary: Renders the range as a base64-encoded png image.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getImage(): string;'
- return:
- type: string
- description: ''
- - name: getIntersection(anotherRange)
- uid: 'ExcelScript!ExcelScript.Range#getIntersection:member(1)'
- package: ExcelScript!
- fullName: getIntersection(anotherRange)
- summary: >-
- Gets the range object that represents the rectangular intersection of the given ranges. If no intersection is
- found, then this method returns `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIntersection(anotherRange: Range | string): Range;'
- parameters:
- - id: anotherRange
- description: The range object or range address that will be used to determine the intersection of ranges.
- type: ' | string'
- return:
- type: ''
- description: ''
- - name: getIsEntireColumn()
- uid: 'ExcelScript!ExcelScript.Range#getIsEntireColumn:member(1)'
- package: ExcelScript!
- fullName: getIsEntireColumn()
- summary: Represents if the current range is an entire column.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIsEntireColumn(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getIsEntireRow()
- uid: 'ExcelScript!ExcelScript.Range#getIsEntireRow:member(1)'
- package: ExcelScript!
- fullName: getIsEntireRow()
- summary: Represents if the current range is an entire row.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIsEntireRow(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getLastCell()
- uid: 'ExcelScript!ExcelScript.Range#getLastCell:member(1)'
- package: ExcelScript!
- fullName: getLastCell()
- summary: 'Gets the last cell within the range. For example, the last cell of "B2:D5" is "D5".'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLastCell(): Range;'
- return:
- type: ''
- description: ''
- - name: getLastColumn()
- uid: 'ExcelScript!ExcelScript.Range#getLastColumn:member(1)'
- package: ExcelScript!
- fullName: getLastColumn()
- summary: 'Gets the last column within the range. For example, the last column of "B2:D5" is "D2:D5".'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLastColumn(): Range;'
- return:
- type: ''
- description: ''
- - name: getLastRow()
- uid: 'ExcelScript!ExcelScript.Range#getLastRow:member(1)'
- package: ExcelScript!
- fullName: getLastRow()
- summary: 'Gets the last row within the range. For example, the last row of "B2:D5" is "B5:D5".'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLastRow(): Range;'
- return:
- type: ''
- description: ''
- - name: getLeft()
- uid: 'ExcelScript!ExcelScript.Range#getLeft:member(1)'
- package: ExcelScript!
- fullName: getLeft()
- summary: 'Returns the distance in points, for 100% zoom, from the left edge of the worksheet to the left edge of the range.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLeft(): number;'
- return:
- type: number
- description: ''
- - name: getLinkedDataTypeState()
- uid: 'ExcelScript!ExcelScript.Range#getLinkedDataTypeState:member(1)'
- package: ExcelScript!
- fullName: getLinkedDataTypeState()
- summary: Represents the data type state of the cell.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLinkedDataTypeState(): LinkedDataTypeState;'
- return:
- type: ''
- description: ''
- - name: getLinkedDataTypeStates()
- uid: 'ExcelScript!ExcelScript.Range#getLinkedDataTypeStates:member(1)'
- package: ExcelScript!
- fullName: getLinkedDataTypeStates()
- summary: Represents the data type state of each cell.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLinkedDataTypeStates(): LinkedDataTypeState[][];'
- return:
- type: '[][]'
- description: ''
- - name: getMergedAreas()
- uid: 'ExcelScript!ExcelScript.Range#getMergedAreas:member(1)'
- package: ExcelScript!
- fullName: getMergedAreas()
- summary: >-
- Returns a `RangeAreas` object that represents the merged areas in this range. Note that if the merged areas count
- in this range is more than 512, then this method will fail to return the result. If the `RangeAreas` object
- doesn't exist, then this function returns `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMergedAreas(): RangeAreas;'
- return:
- type: ''
- description: ''
- - name: getNumberFormat()
- uid: 'ExcelScript!ExcelScript.Range#getNumberFormat:member(1)'
- package: ExcelScript!
- fullName: getNumberFormat()
- summary: >-
- Represents cell Excel number format code for the given range. If the range contains multiple cells, the data from
- first cell (represented by row index of 0 and column index of 0) will be returned.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNumberFormat(): string;'
- return:
- type: string
- description: ''
- - name: getNumberFormatCategories()
- uid: 'ExcelScript!ExcelScript.Range#getNumberFormatCategories:member(1)'
- package: ExcelScript!
- fullName: getNumberFormatCategories()
- summary: Represents the category of number format of each cell.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNumberFormatCategories(): NumberFormatCategory[][];'
- return:
- type: '[][]'
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script finds cells in a table column that are not formatted as currency
- * and sets the fill color to red.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the "Cost" column from the "Expenses" table.
- const table = workbook.getTable("Expenses");
- const costColumn = table.getColumnByName("Cost");
- const costColumnRange = costColumn.getRangeBetweenHeaderAndTotal();
-
- // Get the number format categories for the column's range.
- const numberFormatCategories = costColumnRange.getNumberFormatCategories();
-
- // If any cell in the column doesn't have a currency format, make the cell red.
- numberFormatCategories.forEach((category, index) =>{
- if (category[0] != ExcelScript.NumberFormatCategory.currency) {
- costColumnRange.getCell(index, 0).getFormat().getFill().setColor("red");
- }
- });
- }
- ```
- - name: getNumberFormatCategory()
- uid: 'ExcelScript!ExcelScript.Range#getNumberFormatCategory:member(1)'
- package: ExcelScript!
- fullName: getNumberFormatCategory()
- summary: >-
- Specifies the number format category of first cell in the range (represented by row index of 0 and column index of
- 0).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNumberFormatCategory(): NumberFormatCategory;'
- return:
- type: ''
- description: ''
- - name: getNumberFormatLocal()
- uid: 'ExcelScript!ExcelScript.Range#getNumberFormatLocal:member(1)'
- package: ExcelScript!
- fullName: getNumberFormatLocal()
- summary: >-
- Represents cell Excel number format code for the given range, based on the language settings of the user.​ Excel
- does not perform any language or format coercion when getting or setting the `numberFormatLocal` property. Any
- returned text uses the locally-formatted strings based on the language specified in the system settings. If the
- range contains multiple cells, the data from first cell (represented by row index of 0 and column index of 0) will
- be returned.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNumberFormatLocal(): string;'
- return:
- type: string
- description: ''
- - name: getNumberFormats()
- uid: 'ExcelScript!ExcelScript.Range#getNumberFormats:member(1)'
- package: ExcelScript!
- fullName: getNumberFormats()
- summary: Represents Excel's number format code for the given range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNumberFormats(): string[][];'
- return:
- type: 'string[][]'
- description: ''
- - name: getNumberFormatsLocal()
- uid: 'ExcelScript!ExcelScript.Range#getNumberFormatsLocal:member(1)'
- package: ExcelScript!
- fullName: getNumberFormatsLocal()
- summary: >-
- Represents Excel's number format code for the given range, based on the language settings of the user. Excel does
- not perform any language or format coercion when getting or setting the `numberFormatLocal` property. Any returned
- text uses the locally-formatted strings based on the language specified in the system settings.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNumberFormatsLocal(): string[][];'
- return:
- type: 'string[][]'
- description: ''
- - name: 'getOffsetRange(rowOffset, columnOffset)'
- uid: 'ExcelScript!ExcelScript.Range#getOffsetRange:member(1)'
- package: ExcelScript!
- fullName: 'getOffsetRange(rowOffset, columnOffset)'
- summary: >-
- Gets an object which represents a range that's offset from the specified range. The dimension of the returned
- range will match this range. If the resulting range is forced outside the bounds of the worksheet grid, an error
- will be thrown.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getOffsetRange(rowOffset: number, columnOffset: number): Range;'
- parameters:
- - id: rowOffset
- description: >-
- The number of rows (positive, negative, or 0) by which the range is to be offset. Positive values are offset
- downward, and negative values are offset upward.
- type: number
- - id: columnOffset
- description: >-
- The number of columns (positive, negative, or 0) by which the range is to be offset. Positive values are
- offset to the right, and negative values are offset to the left.
- type: number
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script gets adjacent cells using relative references.
- * Note that if the active cell is on the top row, part of the script fails,
- * because it references the cell above the currently selected one.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the currently active cell in the workbook.
- let activeCell = workbook.getActiveCell();
- console.log(`The active cell's address is: ${activeCell.getAddress()}`);
-
- // Get the cell to the right of the active cell and set its value and color.
- let rightCell = activeCell.getOffsetRange(0,1);
- rightCell.setValue("Right cell");
- console.log(`The right cell's address is: ${rightCell.getAddress()}`);
- rightCell.getFormat().getFont().setColor("Magenta");
- rightCell.getFormat().getFill().setColor("Cyan");
-
- // Get the cell to the above of the active cell and set its value and color.
- // Note that this operation will fail if the active cell is in the top row.
- let aboveCell = activeCell.getOffsetRange(-1, 0);
- aboveCell.setValue("Above cell");
- console.log(`The above cell's address is: ${aboveCell.getAddress()}`);
- aboveCell.getFormat().getFont().setColor("White");
- aboveCell.getFormat().getFill().setColor("Black");
- }
- ```
- - name: getPivotTables(fullyContained)
- uid: 'ExcelScript!ExcelScript.Range#getPivotTables:member(1)'
- package: ExcelScript!
- fullName: getPivotTables(fullyContained)
- summary: Gets a scoped collection of PivotTables that overlap with the range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPivotTables(fullyContained?: boolean): PivotTable[];'
- parameters:
- - id: fullyContained
- description: >-
- If `true`, returns only PivotTables that are fully contained within the range bounds. The default
- value is `false`.
- type: boolean
- return:
- type: '[]'
- description: ''
- - name: getPrecedents()
- uid: 'ExcelScript!ExcelScript.Range#getPrecedents:member(1)'
- package: ExcelScript!
- fullName: getPrecedents()
- summary: >-
- Returns a `WorkbookRangeAreas` object that represents the range containing all the precedent cells of a specified
- range in the same worksheet or across multiple worksheets.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPrecedents(): WorkbookRangeAreas;'
- return:
- type: ''
- description: ''
- - name: getPredefinedCellStyle()
- uid: 'ExcelScript!ExcelScript.Range#getPredefinedCellStyle:member(1)'
- package: ExcelScript!
- fullName: getPredefinedCellStyle()
- summary: >-
- Represents the style of the current range. If the styles of the cells are inconsistent, `null` will be returned.
- For custom styles, the style name will be returned. For built-in styles, a string representing a value in the
- `BuiltInStyle` enum will be returned.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPredefinedCellStyle(): string;'
- return:
- type: string
- description: ''
- - name: 'getRangeEdge(direction, activeCell)'
- uid: 'ExcelScript!ExcelScript.Range#getRangeEdge:member(1)'
- package: ExcelScript!
- fullName: 'getRangeEdge(direction, activeCell)'
- summary: >-
- Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This
- matches the Ctrl+Arrow key behavior in the Excel on Windows UI.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- getRangeEdge(
- direction: KeyboardDirection,
- activeCell?: Range | string
- ): Range;
- parameters:
- - id: direction
- description: The direction from the active cell.
- type: ''
- - id: activeCell
- description: >-
- The active cell in this range. By default, the active cell is the top-left cell of the range. An error is
- thrown if the active cell is not in this range.
- type: ' | string'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds the value "Total" after the end of the first column.
- */
- function main(workbook: ExcelScript.Workbook)
- {
- // Get the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Get the last used cell at the end of the column.
- // This recreates the Ctrl+Down arrow key behavior.
- let firstCell = selectedSheet.getRange("A1");
- let firstColumn = selectedSheet.getRange("A1").getRangeEdge(ExcelScript.KeyboardDirection.down);
- let cellAfter = firstColumn.getOffsetRange(1, 0);
-
- // Set the value of the cell after the current end of the used column to "Total".
- cellAfter.setValue("Total");
- }
- ```
- - name: 'getResizedRange(deltaRows, deltaColumns)'
- uid: 'ExcelScript!ExcelScript.Range#getResizedRange:member(1)'
- package: ExcelScript!
- fullName: 'getResizedRange(deltaRows, deltaColumns)'
- summary: >-
- Gets a `Range` object similar to the current `Range` object, but with its bottom-right corner expanded (or
- contracted) by some number of rows and columns.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getResizedRange(deltaRows: number, deltaColumns: number): Range;'
- parameters:
- - id: deltaRows
- description: >-
- The number of rows by which to expand the bottom-right corner, relative to the current range. Use a positive
- number to expand the range, or a negative number to decrease it.
- type: number
- - id: deltaColumns
- description: >-
- The number of columns by which to expand the bottom-right corner, relative to the current range. Use a
- positive number to expand the range, or a negative number to decrease it.
- type: number
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script copies the formatting in the active cell to the neighboring cells.
- * Note that this script only works when the active cell isn't on an edge of the worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the active cell.
- let activeCell = workbook.getActiveCell();
-
- // Get the cell that's one row above and one column to the left of the active cell.
- let cornerCell = activeCell.getOffsetRange(-1,-1);
-
- // Get a range that includes all the cells surrounding the active cell.
- let surroundingRange = cornerCell.getResizedRange(2, 2)
-
- // Copy the formatting from the active cell to the new range.
- surroundingRange.copyFrom(
- activeCell, /* The source range. */
- ExcelScript.RangeCopyType.formats /* What to copy. */
- );
- }
- ```
- - name: getRow(row)
- uid: 'ExcelScript!ExcelScript.Range#getRow:member(1)'
- package: ExcelScript!
- fullName: getRow(row)
- summary: Gets a row contained in the range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRow(row: number): Range;'
- parameters:
- - id: row
- description: Row number of the range to be retrieved. Zero-indexed.
- type: number
- return:
- type: ''
- description: ''
- - name: getRowCount()
- uid: 'ExcelScript!ExcelScript.Range#getRowCount:member(1)'
- package: ExcelScript!
- fullName: getRowCount()
- summary: Returns the total number of rows in the range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRowCount(): number;'
- return:
- type: number
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample provides the count of negative numbers that are present
- * in the used range of the current worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the working range.
- let usedRange = workbook.getActiveWorksheet().getUsedRange();
- let rowCount = usedRange.getRowCount();
- let columnCount = usedRange.getColumnCount();
-
- // Save the values locally to avoid repeatedly asking the workbook.
- let usedRangeValues = usedRange.getValues();
-
- // Start the negative number counter.
- let negativeCount = 0;
-
- // Iterate over the entire range looking for negative numbers.
- for (let i = 0; i < rowCount; i++) {
- for (let j = 0; j < columnCount; j++) {
- if (usedRangeValues[i][j] < 0) {
- negativeCount++;
- }
- }
- }
-
- // Log the negative number count to the console.
- console.log(negativeCount);
- }
- ```
- - name: getRowHidden()
- uid: 'ExcelScript!ExcelScript.Range#getRowHidden:member(1)'
- package: ExcelScript!
- fullName: getRowHidden()
- summary: >-
- Represents if all rows in the current range are hidden. Value is `true` when all rows in a range are hidden. Value
- is `false` when no rows in the range are hidden. Value is `null` when some rows in a range are hidden and other
- rows in the same range are not hidden.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRowHidden(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getRowIndex()
- uid: 'ExcelScript!ExcelScript.Range#getRowIndex:member(1)'
- package: ExcelScript!
- fullName: getRowIndex()
- summary: Returns the row number of the first cell in the range. Zero-indexed.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRowIndex(): number;'
- return:
- type: number
- description: ''
- - name: getRowsAbove(count)
- uid: 'ExcelScript!ExcelScript.Range#getRowsAbove:member(1)'
- package: ExcelScript!
- fullName: getRowsAbove(count)
- summary: Gets a certain number of rows above the current `Range` object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRowsAbove(count?: number): Range;'
- parameters:
- - id: count
- description: >-
- Optional. The number of rows to include in the resulting range. In general, use a positive number to create
- a range outside the current range. You can also use a negative number to create a range within the current
- range. The default value is 1.
- type: number
- return:
- type: ''
- description: ''
- - name: getRowsBelow(count)
- uid: 'ExcelScript!ExcelScript.Range#getRowsBelow:member(1)'
- package: ExcelScript!
- fullName: getRowsBelow(count)
- summary: Gets a certain number of rows below the current `Range` object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRowsBelow(count?: number): Range;'
- parameters:
- - id: count
- description: >-
- Optional. The number of rows to include in the resulting range. In general, use a positive number to create
- a range outside the current range. You can also use a negative number to create a range within the current
- range. The default value is 1.
- type: number
- return:
- type: ''
- description: ''
- - name: getSavedAsArray()
- uid: 'ExcelScript!ExcelScript.Range#getSavedAsArray:member(1)'
- package: ExcelScript!
- fullName: getSavedAsArray()
- summary: >-
- Represents if all the cells would be saved as an array formula. Returns `true` if all cells would be saved as an
- array formula, or `false` if all cells would not be saved as an array formula. Returns `null` if some cells would
- be saved as an array formula and some would not be.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSavedAsArray(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getSort()
- uid: 'ExcelScript!ExcelScript.Range#getSort:member(1)'
- package: ExcelScript!
- fullName: getSort()
- summary: Represents the range sort of the current range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSort(): RangeSort;'
- return:
- type: ''
- description: ''
- - name: 'getSpecialCells(cellType, cellValueType)'
- uid: 'ExcelScript!ExcelScript.Range#getSpecialCells:member(1)'
- package: ExcelScript!
- fullName: 'getSpecialCells(cellType, cellValueType)'
- summary: >-
- Gets the `RangeAreas` object, comprising one or more ranges, that represents all the cells that match the
- specified type and value. If no special cells are found, then this method returns `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- getSpecialCells(
- cellType: SpecialCellType,
- cellValueType?: SpecialCellValueType
- ): RangeAreas;
- parameters:
- - id: cellType
- description: The type of cells to include.
- type: ''
- - id: cellValueType
- description: >-
- If `cellType` is either `constants` or `formulas`, this argument is used to determine which types of
- cells to include in the result. These values can be combined together to return more than one type. The
- default is to select all constants or formulas, no matter what the type.
- type: ''
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample gets all the blank cells in the current worksheet's used range. It then highlights all those cells with a yellow background.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current used range.
- let range = workbook.getActiveWorksheet().getUsedRange();
-
- // Get all the blank cells.
- let blankCells = range.getSpecialCells(ExcelScript.SpecialCellType.blanks);
- // Highlight the blank cells with a yellow background.
- blankCells.getFormat().getFill().setColor("yellow");
- }
- ```
- - name: getSpillingToRange()
- uid: 'ExcelScript!ExcelScript.Range#getSpillingToRange:member(1)'
- package: ExcelScript!
- fullName: getSpillingToRange()
- summary: >-
- Gets the range object containing the spill range when called on an anchor cell. If the range isn't an anchor cell
- or the spill range can't be found, then this method returns `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSpillingToRange(): Range;'
- return:
- type: ''
- description: ''
- - name: getSpillParent()
- uid: 'ExcelScript!ExcelScript.Range#getSpillParent:member(1)'
- package: ExcelScript!
- fullName: getSpillParent()
- summary: >-
- Gets the range object containing the anchor cell for the cell getting spilled into. If it's not a spilled cell, or
- more than one cell is given, then this method returns `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSpillParent(): Range;'
- return:
- type: ''
- description: ''
- - name: getSurroundingRegion()
- uid: 'ExcelScript!ExcelScript.Range#getSurroundingRegion:member(1)'
- package: ExcelScript!
- fullName: getSurroundingRegion()
- summary: >-
- Returns a `Range` object that represents the surrounding region for the top-left cell in this range. A surrounding
- region is a range bounded by any combination of blank rows and blank columns relative to this range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSurroundingRegion(): Range;'
- return:
- type: ''
- description: ''
- - name: getTables(fullyContained)
- uid: 'ExcelScript!ExcelScript.Range#getTables:member(1)'
- package: ExcelScript!
- fullName: getTables(fullyContained)
- summary: Gets a scoped collection of tables that overlap with the range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTables(fullyContained?: boolean): Table[];'
- parameters:
- - id: fullyContained
- description: >-
- If `true`, returns only tables that are fully contained within the range bounds. The default value
- is `false`.
- type: boolean
- return:
- type: '[]'
- description: ''
- - name: getText()
- uid: 'ExcelScript!ExcelScript.Range#getText:member(1)'
- package: ExcelScript!
- fullName: getText()
- summary: >-
- Represents Text value of the specified range. The Text value will not depend on the cell width. The \# sign
- substitution that happens in Excel UI will not affect the text value returned by the API. If the range contains
- multiple cells, the data from first cell (represented by row index of 0 and column index of 0) will be returned.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getText(): string;'
- return:
- type: string
- description: ''
- - name: getTexts()
- uid: 'ExcelScript!ExcelScript.Range#getTexts:member(1)'
- package: ExcelScript!
- fullName: getTexts()
- summary: >-
- Text values of the specified range. The text value will not depend on the cell width. The number sign (\#)
- substitution that happens in the Excel UI will not affect the text value returned by the API.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTexts(): string[][];'
- return:
- type: 'string[][]'
- description: ''
- - name: getTop()
- uid: 'ExcelScript!ExcelScript.Range#getTop:member(1)'
- package: ExcelScript!
- fullName: getTop()
- summary: 'Returns the distance in points, for 100% zoom, from the top edge of the worksheet to the top edge of the range.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTop(): number;'
- return:
- type: number
- description: ''
- - name: getUsedRange(valuesOnly)
- uid: 'ExcelScript!ExcelScript.Range#getUsedRange:member(1)'
- package: ExcelScript!
- fullName: getUsedRange(valuesOnly)
- summary: >-
- Returns the used range of the given range object. If there are no used cells within the range, then this method
- returns `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getUsedRange(valuesOnly?: boolean): Range;'
- parameters:
- - id: valuesOnly
- description: Considers only cells with values as used cells.
- type: boolean
- return:
- type: ''
- description: ''
- - name: getValue()
- uid: 'ExcelScript!ExcelScript.Range#getValue:member(1)'
- package: ExcelScript!
- fullName: getValue()
- summary: >-
- Represents the raw value of the specified range. The data returned could be of type string, number, or a boolean.
- Cell that contain an error will return the error string. If the range contains multiple cells, the data from first
- cell (represented by row index of 0 and column index of 0) will be returned.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getValue(): string | number | boolean;'
- return:
- type: string | number | boolean
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample reads the value of A1 and prints it to the console.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Get the value of cell A1.
- let range = selectedSheet.getRange("A1");
-
- // Print the value of A1.
- console.log(range.getValue());
- }
- ```
- - name: getValues()
- uid: 'ExcelScript!ExcelScript.Range#getValues:member(1)'
- package: ExcelScript!
- fullName: getValues()
- summary: >-
- Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells
- that contain an error will return the error string. If the returned value starts with a plus ("+"), minus ("-"),
- or equal sign ("="), Excel interprets this value as a formula.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getValues(): (string | number | boolean)[][];'
- return:
- type: '(string | number | boolean)[][]'
- description: ''
- - name: getValueType()
- uid: 'ExcelScript!ExcelScript.Range#getValueType:member(1)'
- package: ExcelScript!
- fullName: getValueType()
- summary: >-
- Represents the type of data in the cell. If the range contains multiple cells, the data from first cell
- (represented by row index of 0 and column index of 0) will be returned.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getValueType(): RangeValueType;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script formats rows in a worksheet based on the first value in that row.
- * If it's the boolean value TRUE, the row is bolded.
- * If it's FALSE, nothing is changed.
- * If the value type isn't a boolean, the row is italicized.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the used range in the active worksheet.
- const sheet = workbook.getActiveWorksheet();
- const usedRange = sheet.getUsedRange();
-
- // Get the values in the first column.
- const firstColumnValues = usedRange.getColumn(0).getValues();
-
- // Look at the first cell in each row.
- const rowCount = usedRange.getRowCount();
- for (let i = 0; i < rowCount; i++) {
- // Get the type of the first cell to make sure it's a boolean.
- let firstValueType = usedRange.getCell(i, 0).getValueType();
-
- // Set the bold or italic of the row as described earlier.
- if (firstValueType === ExcelScript.RangeValueType.boolean) {
- if (firstColumnValues[i][0] as boolean === true) {
- usedRange.getRow(i).getFormat().getFont().setBold(true);
- } else {
- usedRange.getRow(i).getFormat().getFont().setBold(false);
- }
- } else {
- usedRange.getRow(i).getFormat().getFont().setItalic(true);
- }
- }
- }
- ```
- - name: getValueTypes()
- uid: 'ExcelScript!ExcelScript.Range#getValueTypes:member(1)'
- package: ExcelScript!
- fullName: getValueTypes()
- summary: Specifies the type of data in each cell.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getValueTypes(): RangeValueType[][];'
- return:
- type: '[][]'
- description: ''
- - name: getVisibleView()
- uid: 'ExcelScript!ExcelScript.Range#getVisibleView:member(1)'
- package: ExcelScript!
- fullName: getVisibleView()
- summary: Represents the visible rows of the current range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVisibleView(): RangeView;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script copies values and formatting from the
- * visible range of a table in Sheet1 into Sheet2.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the filtered data from Sheet1.
- const currentSheet = workbook.getWorksheet("Sheet1");
- const table = currentSheet.getTables()[0];
- const visibleTableRange: ExcelScript.RangeView = table.getRange().getVisibleView();
- const source = currentSheet.getRanges(visibleTableRange.getCellAddresses().toString());
-
- // Copy the data into the other sheet.
- const otherSheet = workbook.getWorksheet("Sheet2");
- const otherRangeCorner = otherSheet.getRange("A1");
- otherRangeCorner.copyFrom(source, ExcelScript.RangeCopyType.all);
- }
- ```
- - name: getWidth()
- uid: 'ExcelScript!ExcelScript.Range#getWidth:member(1)'
- package: ExcelScript!
- fullName: getWidth()
- summary: 'Returns the distance in points, for 100% zoom, from the left edge of the range to the right edge of the range.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWidth(): number;'
- return:
- type: number
- description: ''
- - name: getWorksheet()
- uid: 'ExcelScript!ExcelScript.Range#getWorksheet:member(1)'
- package: ExcelScript!
- fullName: getWorksheet()
- summary: The worksheet containing the current range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWorksheet(): Worksheet;'
- return:
- type: ''
- description: ''
- - name: group(groupOption)
- uid: 'ExcelScript!ExcelScript.Range#group:member(1)'
- package: ExcelScript!
- fullName: group(groupOption)
- summary: Groups columns and rows for an outline.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'group(groupOption: GroupOption): void;'
- parameters:
- - id: groupOption
- description: >-
- Specifies how the range can be grouped by rows or columns. An `InvalidArgument` error is thrown when the
- group option differs from the range's `isEntireRow` or `isEntireColumn` property (i.e., `range.isEntireRow`
- is true and `groupOption` is "ByColumns" or `range.isEntireColumn` is true and `groupOption` is "ByRows").
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a two-level column-based outline on Sheet1.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Group columns A-F in the worksheet named Sheet1.
- const sheet = workbook.getWorksheet("Sheet1");
- const firstLevel = sheet.getRange("A:F");
- firstLevel.group(ExcelScript.GroupOption.byColumns);
-
- // Create a second level to the outline by grouping subsections.
- sheet.getRange("A:B").group(ExcelScript.GroupOption.byColumns);
- sheet.getRange("D:E").group(ExcelScript.GroupOption.byColumns);
- }
- ```
- - name: hideGroupDetails(groupOption)
- uid: 'ExcelScript!ExcelScript.Range#hideGroupDetails:member(1)'
- package: ExcelScript!
- fullName: hideGroupDetails(groupOption)
- summary: Hides the details of the row or column group.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'hideGroupDetails(groupOption: GroupOption): void;'
- parameters:
- - id: groupOption
- description: Specifies whether to hide the details of grouped rows or grouped columns.
- type: ''
- return:
- type: void
- description: ''
- - name: insert(shift)
- uid: 'ExcelScript!ExcelScript.Range#insert:member(1)'
- package: ExcelScript!
- fullName: insert(shift)
- summary: >-
- Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make
- space. Returns a new `Range` object at the now blank space.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'insert(shift: InsertShiftDirection): Range;'
- parameters:
- - id: shift
- description: Specifies which way to shift the cells. See `ExcelScript.InsertShiftDirection` for details.
- type: ''
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script inserts headers at the top of the worksheet.
- */
- function main(workbook: ExcelScript.Workbook)
- {
- let currentSheet = workbook.getActiveWorksheet();
-
- // Create headers for 3 columns.
- let myHeaders = [["NAME", "ID", "ROLE"]];
-
- // Add a blank first row and push existing data down a row.
- let firstRow = currentSheet.getRange("1:1");
- firstRow.insert(ExcelScript.InsertShiftDirection.down);
-
- // Add the headers.
- currentSheet.getRange("A1:C1").setValues(myHeaders);
- }
- ```
- - name: merge(across)
- uid: 'ExcelScript!ExcelScript.Range#merge:member(1)'
- package: ExcelScript!
- fullName: merge(across)
- summary: Merge the range cells into one region in the worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'merge(across?: boolean): void;'
- parameters:
- - id: across
- description: >-
- Optional. Set `true` to merge cells in each row of the specified range as separate merged cells. The default
- value is `false`.
- type: boolean
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script merges a group of cells into a single region.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the active worksheet.
- const selectedSheet = workbook.getActiveWorksheet();
-
- // Merge cells A1 through A4.
- const range = selectedSheet.getRange("A1:A4");
- range.merge();
- }
- ```
- - name: moveTo(destinationRange)
- uid: 'ExcelScript!ExcelScript.Range#moveTo:member(1)'
- package: ExcelScript!
- fullName: moveTo(destinationRange)
- summary: >-
- Moves cell values, formatting, and formulas from current range to the destination range, replacing the old
- information in those cells. The destination range will be expanded automatically if it is smaller than the current
- range. Any cells in the destination range that are outside of the original range's area are not changed.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'moveTo(destinationRange: Range | string): void;'
- parameters:
- - id: destinationRange
- description: destinationRange Specifies the range to where the information in this range will be moved.
- type: ' | string'
- return:
- type: void
- description: ''
- - name: 'removeDuplicates(columns, includesHeader)'
- uid: 'ExcelScript!ExcelScript.Range#removeDuplicates:member(1)'
- package: ExcelScript!
- fullName: 'removeDuplicates(columns, includesHeader)'
- summary: Removes duplicate values from the range specified by the columns.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- removeDuplicates(
- columns: number[],
- includesHeader: boolean
- ): RemoveDuplicatesResult;
- parameters:
- - id: columns
- description: >-
- The columns inside the range that may contain duplicates. At least one column needs to be specified.
- Zero-indexed.
- type: 'number[]'
- - id: includesHeader
- description: True if the input data contains header. Default is false.
- type: boolean
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script removes duplicate rows from a range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the used range of the active worksheet.
- const usedRange = workbook.getActiveWorksheet().getUsedRange();
-
- // Remove any row that has a same value in the 0-indexed column as a previous row.
- const removedResults = usedRange.removeDuplicates([0], true);
-
- // Log the count of removed rows.
- console.log(`Rows removed: ${removedResults.getRemoved()}.`);
- }
- ```
- - name: 'replaceAll(text, replacement, criteria)'
- uid: 'ExcelScript!ExcelScript.Range#replaceAll:member(1)'
- package: ExcelScript!
- fullName: 'replaceAll(text, replacement, criteria)'
- summary: Finds and replaces the given string based on the criteria specified within the current range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- replaceAll(
- text: string,
- replacement: string,
- criteria: ReplaceCriteria
- ): number;
- parameters:
- - id: text
- description: String to find.
- type: string
- - id: replacement
- description: The string that replaces the original string.
- type: string
- - id: criteria
- description: Additional replacement criteria.
- type: ''
- return:
- type: number
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script searches through a table column and replaces
- * cells marked "monthly special" with "parsnip".
- * This script uses Range.replaceAll instead of Worksheet.replaceAll
- * to limit the search to a specific range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range of a table named "Orders".
- let table = workbook.getTable("Orders");
- let range = table.getColumnByName("Vegetable").getRange();
-
- // Change the value of any cells with the value "monthly special".
- range.replaceAll("monthly special", "parsnip", {completeMatch: true});
- }
- ```
- - name: select()
- uid: 'ExcelScript!ExcelScript.Range#select:member(1)'
- package: ExcelScript!
- fullName: select()
- summary: Selects the specified range in the Excel UI.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'select(): void;'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script selects the first row of a table.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table on the current worksheet.
- const sheet = workbook.getActiveWorksheet()
- const table = sheet.getTables()[0];
-
- // Get the first data row in the table.
- const row = table.getRangeBetweenHeaderAndTotal().getRow(0);
-
- // Select the first data row.
- row.select();
- }
- ```
- - name: setColumnHidden(columnHidden)
- uid: 'ExcelScript!ExcelScript.Range#setColumnHidden:member(1)'
- package: ExcelScript!
- fullName: setColumnHidden(columnHidden)
- summary: >-
- Represents if all columns in the current range are hidden. Value is `true` when all columns in a range are hidden.
- Value is `false` when no columns in the range are hidden. Value is `null` when some columns in a range are hidden
- and other columns in the same range are not hidden.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setColumnHidden(columnHidden: boolean): void;'
- parameters:
- - id: columnHidden
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setDirty()
- uid: 'ExcelScript!ExcelScript.Range#setDirty:member(1)'
- package: ExcelScript!
- fullName: setDirty()
- summary: Set a range to be recalculated when the next recalculation occurs.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setDirty(): void;'
- return:
- type: void
- description: ''
- - name: setFormula(formula)
- uid: 'ExcelScript!ExcelScript.Range#setFormula:member(1)'
- package: ExcelScript!
- fullName: setFormula(formula)
- summary: >-
- Sets the cell formula in A1-style notation. If the range contains multiple cells, each cell in the given range
- will be updated with the input data.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFormula(formula: string): void;'
- parameters:
- - id: formula
- description: ''
- type: string
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /*
- * This script sets a cell's formula,
- * then displays how Excel stores the cell's formula and value separately.
- */
- function main(workbook: ExcelScript.Workbook) {
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Set A1 to 2.
- let a1 = selectedSheet.getRange("A1");
- a1.setValue(2);
-
- // Set B1 to the formula =(2*A1), which should equal 4.
- let b1 = selectedSheet.getRange("B1")
- b1.setFormula("=(2*A1)");
-
- // Log the current results for `getFormula` and `getValue` at B1.
- console.log(`B1 - Formula: ${b1.getFormula()} | Value: ${b1.getValue()}`);
- }
- ```
- - name: setFormulaLocal(formulaLocal)
- uid: 'ExcelScript!ExcelScript.Range#setFormulaLocal:member(1)'
- package: ExcelScript!
- fullName: setFormulaLocal(formulaLocal)
- summary: >-
- Set the cell formula in A1-style notation, in the user's language and number-formatting locale. For example, the
- English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If the range contains multiple cells,
- each cell in the given range will be updated with the input data.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFormulaLocal(formulaLocal: string): void;'
- parameters:
- - id: formulaLocal
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setFormulaR1C1(formulaR1C1)
- uid: 'ExcelScript!ExcelScript.Range#setFormulaR1C1:member(1)'
- package: ExcelScript!
- fullName: setFormulaR1C1(formulaR1C1)
- summary: >-
- Sets the cell formula in R1C1-style notation. If the range contains multiple cells, each cell in the given range
- will be updated with the input data.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFormulaR1C1(formulaR1C1: string): void;'
- parameters:
- - id: formulaR1C1
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setFormulas(formulas)
- uid: 'ExcelScript!ExcelScript.Range#setFormulas:member(1)'
- package: ExcelScript!
- fullName: setFormulas(formulas)
- summary: 'Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFormulas(formulas: string[][]): void;'
- parameters:
- - id: formulas
- description: ''
- type: 'string[][]'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the values of a range, then adds SUM formulas to calculate
- * the totals for each row of that range.
- */
- function main(workbook: ExcelScript.Workbook)
- {
- let currentSheet = workbook.getActiveWorksheet();
-
- // Set the values of a range.
- let values = [[1, 2, 4], [8, 16, 32], [64, 128, 256]];
- let valueRange = currentSheet.getRange("A1:C3");
- valueRange.setValues(values);
-
- // Set the formulas of a range.
- let formulas = [["=SUM(A1:C1)"], ["=SUM(A2:C2)"], ["=SUM(A3:C3)"]];
- let formulaRange = currentSheet.getRange("D1:D3");
- formulaRange.setFormulas(formulas);
- }
- ```
- - name: setFormulasLocal(formulasLocal)
- uid: 'ExcelScript!ExcelScript.Range#setFormulasLocal:member(1)'
- package: ExcelScript!
- fullName: setFormulasLocal(formulasLocal)
- summary: >-
- Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the
- English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its value is
- returned instead.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFormulasLocal(formulasLocal: string[][]): void;'
- parameters:
- - id: formulasLocal
- description: ''
- type: 'string[][]'
- return:
- type: void
- description: ''
- - name: setFormulasR1C1(formulasR1C1)
- uid: 'ExcelScript!ExcelScript.Range#setFormulasR1C1:member(1)'
- package: ExcelScript!
- fullName: setFormulasR1C1(formulasR1C1)
- summary: 'Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFormulasR1C1(formulasR1C1: string[][]): void;'
- parameters:
- - id: formulasR1C1
- description: ''
- type: 'string[][]'
- return:
- type: void
- description: ''
- - name: setHyperlink(hyperlink)
- uid: 'ExcelScript!ExcelScript.Range#setHyperlink:member(1)'
- package: ExcelScript!
- fullName: setHyperlink(hyperlink)
- summary: Represents the hyperlink for the current range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setHyperlink(hyperlink: RangeHyperlink): void;'
- parameters:
- - id: hyperlink
- description: ''
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script inserts a hyperlink to the first cell of the last worksheet in the workbook.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the active cell.
- let cell = workbook.getActiveCell();
-
- // Get the last worksheet in the workbook.
- // Note that this might be the current sheet if there's only one worksheet.
- let lastSheet = workbook.getLastWorksheet();
-
- // Get sheet name.
- let linkedSheetName = lastSheet.getName();
- console.log(`Setting hyperlink of ${cell.getAddress()} to the ${linkedSheetName} sheet's A1 cell`);
-
- // Set the text for the hyperlink.
- let value = `Click to go to: ${linkedSheetName}`;
-
- // Create the hyperlink using that cell's value.
- cell.setHyperlink({
- textToDisplay: value.toString(),
- screenTip: `Navigate to ${linkedSheetName}`,
- documentReference: `${linkedSheetName}!A1`
- });
- }
- ```
- - name: setNumberFormat(numberFormat)
- uid: 'ExcelScript!ExcelScript.Range#setNumberFormat:member(1)'
- package: ExcelScript!
- fullName: setNumberFormat(numberFormat)
- summary: >-
- Sets cell Excel number format code for the given range. If the range contains multiple cells, each cell in the
- given range will be updated with the input data.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setNumberFormat(numberFormat: string): void;'
- parameters:
- - id: numberFormat
- description: ''
- type: string
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the number format in column C to show the data as a percentage.
- */
- function main(workbook: ExcelScript.Workbook) {
- const selectedSheet = workbook.getActiveWorksheet();
-
- // Set number format for column C to a percentage that rounds to the nearest percentage point.
- selectedSheet.getRange("C:C").setNumberFormat("0%");
- }
- ```
- - name: setNumberFormatLocal(numberFormatLocal)
- uid: 'ExcelScript!ExcelScript.Range#setNumberFormatLocal:member(1)'
- package: ExcelScript!
- fullName: setNumberFormatLocal(numberFormatLocal)
- summary: >-
- Sets cell Excel number format code for the given range, based on the language settings of the user.​ Excel does
- not perform any language or format coercion when getting or setting the `numberFormatLocal` property. Any returned
- text uses the locally-formatted strings based on the language specified in the system settings. If the range
- contains multiple cells, each cell in the given range will be updated with the input data.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setNumberFormatLocal(numberFormatLocal: string): void;'
- parameters:
- - id: numberFormatLocal
- description: ''
- type: string
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the number format in column D to show the data as a percentage with a decimal.
- */
- function main(workbook: ExcelScript.Workbook) {
- const selectedSheet = workbook.getActiveWorksheet();
-
- // Set number format for column D to a percentage that rounds to the nearest tenth of a percentage.
- selectedSheet.getRange("D:D").setNumberFormatLocal("0.0%");
- }
- ```
- - name: setNumberFormats(numberFormats)
- uid: 'ExcelScript!ExcelScript.Range#setNumberFormats:member(1)'
- package: ExcelScript!
- fullName: setNumberFormats(numberFormats)
- summary: Represents Excel's number format code for the given range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setNumberFormats(numberFormats: string[][]): void;'
- parameters:
- - id: numberFormats
- description: ''
- type: 'string[][]'
- return:
- type: void
- description: ''
- - name: setNumberFormatsLocal(numberFormatsLocal)
- uid: 'ExcelScript!ExcelScript.Range#setNumberFormatsLocal:member(1)'
- package: ExcelScript!
- fullName: setNumberFormatsLocal(numberFormatsLocal)
- summary: >-
- Represents Excel's number format code for the given range, based on the language settings of the user. Excel does
- not perform any language or format coercion when getting or setting the `numberFormatLocal` property. Any returned
- text uses the locally-formatted strings based on the language specified in the system settings.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setNumberFormatsLocal(numberFormatsLocal: string[][]): void;'
- parameters:
- - id: numberFormatsLocal
- description: ''
- type: 'string[][]'
- return:
- type: void
- description: ''
- - name: setPredefinedCellStyle(predefinedCellStyle)
- uid: 'ExcelScript!ExcelScript.Range#setPredefinedCellStyle:member(1)'
- package: ExcelScript!
- fullName: setPredefinedCellStyle(predefinedCellStyle)
- summary: Represents the style of the current range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPredefinedCellStyle(predefinedCellStyle: string): void;'
- parameters:
- - id: predefinedCellStyle
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setRowHidden(rowHidden)
- uid: 'ExcelScript!ExcelScript.Range#setRowHidden:member(1)'
- package: ExcelScript!
- fullName: setRowHidden(rowHidden)
- summary: >-
- Represents if all rows in the current range are hidden. Value is `true` when all rows in a range are hidden. Value
- is `false` when no rows in the range are hidden. Value is `null` when some rows in a range are hidden and other
- rows in the same range are not hidden.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setRowHidden(rowHidden: boolean): void;'
- parameters:
- - id: rowHidden
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setValue(value)
- uid: 'ExcelScript!ExcelScript.Range#setValue:member(1)'
- package: ExcelScript!
- fullName: setValue(value)
- summary: >-
- Sets the raw value of the specified range. The data being set could be of type string, number, or a boolean.
- `null` value will be ignored (not set or overwritten in Excel). If the range contains multiple cells, each cell in
- the given range will be updated with the input data.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setValue(value: any): void;'
- parameters:
- - id: value
- description: ''
- type: any
- return:
- type: void
- description: ''
- - name: setValues(values)
- uid: 'ExcelScript!ExcelScript.Range#setValues:member(1)'
- package: ExcelScript!
- fullName: setValues(values)
- summary: >-
- Sets the raw values of the specified range. The data provided could be a string, number, or boolean. If the
- provided value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a
- formula.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setValues(values: (string | number | boolean)[][]): void;'
- parameters:
- - id: values
- description: ''
- type: '(string | number | boolean)[][]'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample inserts some pre-loaded data into a range.
- * It also shows how to get a range that fits the data.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the active cell.
- let currentCell = workbook.getActiveCell();
-
- // Calculate the range needed to fit the given data.
- let targetRange = currentCell.getResizedRange(DATA.length - 1, DATA[0].length - 1);
-
- // Set range values to the data.
- targetRange.setValues(DATA);
-
- // Autofit the columns so the worksheet is readable.
- targetRange.getFormat().autofitColumns();
- }
-
- /*
- * This sample's data is in a static 2-dimensional array.
- * You could also get the input from other ranges or sources.
- * Note that each row must have the same number of columns to be valid.
- */
- const DATA = [
- ['Date', 'Salesperson', 'Product', 'Amount']
- , ['3/2/2020', 'Anne', 'Pizza', '$1400']
- , ['3/2/2020', 'Mariya', 'Pizza', '$1700']
- , ['3/7/2020', 'Mark', 'Sandwiches', '$1010']
- , ['3/24/2020', 'Anne', 'Pizza', '$750']
- , ['3/28/2020', 'Mark', 'Salads', '$510']
- , ['4/17/2020', 'Laura', 'Salads', '$900']
- , ['4/17/2020', 'Mariya', 'Salads', '$1600']
- , ['4/28/2020', 'Laura', 'Sandwiches', '$680']
- ];
- ```
- - name: showCard()
- uid: 'ExcelScript!ExcelScript.Range#showCard:member(1)'
- package: ExcelScript!
- fullName: showCard()
- summary: Displays the card for an active cell if it has rich value content.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'showCard(): void;'
- return:
- type: void
- description: ''
- - name: showGroupDetails(groupOption)
- uid: 'ExcelScript!ExcelScript.Range#showGroupDetails:member(1)'
- package: ExcelScript!
- fullName: showGroupDetails(groupOption)
- summary: Shows the details of the row or column group.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'showGroupDetails(groupOption: GroupOption): void;'
- parameters:
- - id: groupOption
- description: Specifies whether to show the details of grouped rows or grouped columns.
- type: ''
- return:
- type: void
- description: ''
- - name: ungroup(groupOption)
- uid: 'ExcelScript!ExcelScript.Range#ungroup:member(1)'
- package: ExcelScript!
- fullName: ungroup(groupOption)
- summary: Ungroups columns and rows for an outline.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'ungroup(groupOption: GroupOption): void;'
- parameters:
- - id: groupOption
- description: Specifies how the range can be ungrouped by rows or columns.
- type: ''
- return:
- type: void
- description: ''
- - name: unmerge()
- uid: 'ExcelScript!ExcelScript.Range#unmerge:member(1)'
- package: ExcelScript!
- fullName: unmerge()
- summary: Unmerge the range cells into separate cells.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'unmerge(): void;'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script unmerges every used cell in the current worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the active worksheet.
- const selectedSheet = workbook.getActiveWorksheet();
-
- // Separate all regions into single cells in the currently used range.
- const range = selectedSheet.getUsedRange();
- range.unmerge();
- }
- ```
+### YamlMime:TSType
+name: ExcelScript.Range
+uid: 'ExcelScript!ExcelScript.Range:interface'
+package: ExcelScript!
+fullName: ExcelScript.Range
+summary: 'Range represents a set of one or more contiguous cells such as a cell, a row, a column, or a block of cells.'
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script logs the address of the used range in the current worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current, active worksheet.
+ let currentWorksheet = workbook.getActiveWorksheet();
+
+ // Get the range containing all the cells with data or formatting.
+ let usedRange = currentWorksheet.getUsedRange();
+
+ // Log the range's address to the console.
+ console.log(usedRange.getAddress());
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: addConditionalFormat(type)
+ uid: 'ExcelScript!ExcelScript.Range#addConditionalFormat:member(1)'
+ package: ExcelScript!
+ fullName: addConditionalFormat(type)
+ summary: Adds a new conditional format to the collection at the first/top priority.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addConditionalFormat(type: ConditionalFormatType): ConditionalFormat;'
+ parameters:
+ - id: type
+ description: The type of conditional format being added. See `ExcelScript.ConditionalFormatType` for details.
+ type: ''
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample applies conditional formatting to the currently used range in the worksheet.
+ * The conditional formatting is a green fill for the top 10% of values.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Get the used range in the worksheet.
+ let range = selectedSheet.getUsedRange();
+
+ // Set the fill color to green for the top 10% of values in the range.
+ let conditionalFormat = range.addConditionalFormat(ExcelScript.ConditionalFormatType.topBottom)
+ conditionalFormat.getTopBottom().getFormat().getFill().setColor("green");
+ conditionalFormat.getTopBottom().setRule({
+ rank: 10, // The percentage threshold.
+ type: ExcelScript.ConditionalTopBottomCriterionType.topPercent // The type of the top/bottom condition.
+ });
+ }
+ ```
+ - name: 'autoFill(destinationRange, autoFillType)'
+ uid: 'ExcelScript!ExcelScript.Range#autoFill:member(1)'
+ package: ExcelScript!
+ fullName: 'autoFill(destinationRange, autoFillType)'
+ summary: >-
+ Fills a range from the current range to the destination range using the specified AutoFill logic. The destination
+ range can be `null` or can extend the source range either horizontally or vertically. Discontiguous ranges are not
+ supported.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ autoFill(
+ destinationRange?: Range | string,
+ autoFillType?: AutoFillType
+ ): void;
+ parameters:
+ - id: destinationRange
+ description: >-
+ The destination range to AutoFill. If the destination range is `null`, data is filled out based on
+ the surrounding cells (which is the behavior when double-clicking the UI's range fill handle).
+ type: ' | string'
+ - id: autoFillType
+ description: >-
+ The type of AutoFill. Specifies how the destination range is to be filled, based on the contents of the
+ current range. Default is "FillDefault".
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script uses the autofill feature to complete a table.
+ * See https://support.microsoft.com/office/74e31bdd-d993-45da-aa82-35a236c5b5db
+ * for examples of autofill scenarios.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current, active worksheet.
+ let currentWorksheet = workbook.getActiveWorksheet();
+
+ // Get the data range that shows the pattern.
+ let dataRange = currentWorksheet.getRange("C2:C3");
+
+ // Autofill the connected range. C2:C3 are filled in. C4:C14 are blank.
+ // This uses the default behavior to match a pattern with the table's contents.
+ dataRange.autoFill("C2:C14");
+ }
+ ```
+ - name: calculate()
+ uid: 'ExcelScript!ExcelScript.Range#calculate:member(1)'
+ package: ExcelScript!
+ fullName: calculate()
+ summary: Calculates a range of cells on a worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'calculate(): void;'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script recalculates the used range of a specific worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Only recalculate if the calculation mode is not set to automatic.
+ if (workbook.getApplication().getCalculationMode() !== ExcelScript.CalculationMode.automatic) {
+ // Get the used range from a worksheet named "Monthly Report".
+ const sheet = workbook.getWorksheet("Monthly Report");
+ const range = sheet.getUsedRange();
+ console.log(`Calculating ${range.getAddress()}`);
+
+ // Force all the used cells in that worksheet to calculate.
+ sheet.getUsedRange().calculate();
+ }
+ }
+ ```
+ - name: clear(applyTo)
+ uid: 'ExcelScript!ExcelScript.Range#clear:member(1)'
+ package: ExcelScript!
+ fullName: clear(applyTo)
+ summary: 'Clear range values and formatting, such as fill and border.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clear(applyTo?: ClearApplyTo): void;'
+ parameters:
+ - id: applyTo
+ description: Optional. Determines the type of clear action. See `ExcelScript.ClearApplyTo` for details.
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script removes all the formatting from the selected range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the selected range.
+ let range = workbook.getSelectedRange();
+
+ // Clear all the formatting in that range.
+ range.clear(ExcelScript.ClearApplyTo.formats);
+ }
+ ```
+ - name: clearAllConditionalFormats()
+ uid: 'ExcelScript!ExcelScript.Range#clearAllConditionalFormats:member(1)'
+ package: ExcelScript!
+ fullName: clearAllConditionalFormats()
+ summary: Clears all conditional formats active on the current specified range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clearAllConditionalFormats(): void;'
+ return:
+ type: void
+ description: ''
+ - name: clearOrResetContents()
+ uid: 'ExcelScript!ExcelScript.Range#clearOrResetContents:member(1)'
+ package: ExcelScript!
+ fullName: clearOrResetContents()
+ summary: >-
+ Clears the values of the cells in the range, with special consideration given to cells containing controls. If the
+ range contains only blank values and controls set to their default value, then the values and control formatting
+ are removed. Otherwise, this sets the cells with controls to their default value and clears the values of the
+ other cells in the range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clearOrResetContents(): void;'
+ return:
+ type: void
+ description: ''
+ - name: convertDataTypeToText()
+ uid: 'ExcelScript!ExcelScript.Range#convertDataTypeToText:member(1)'
+ package: ExcelScript!
+ fullName: convertDataTypeToText()
+ summary: Converts the range cells with data types into text.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'convertDataTypeToText(): void;'
+ return:
+ type: void
+ description: ''
+ - name: 'copyFrom(sourceRange, copyType, skipBlanks, transpose)'
+ uid: 'ExcelScript!ExcelScript.Range#copyFrom:member(1)'
+ package: ExcelScript!
+ fullName: 'copyFrom(sourceRange, copyType, skipBlanks, transpose)'
+ summary: >-
+ Copies cell data or formatting from the source range or `RangeAreas` to the current range. The destination range
+ can be a different size than the source range or `RangeAreas`. The destination is expanded automatically
+ if it's smaller than the source. Note: Like the copy functionality in the Excel UI, if the destination range is an
+ exact multiple greater than the source range in either rows or columns, then the source content is replicated
+ multiple times. For example, a 2x2 range copy into a 2x6 range will result in 3 copies of the original 2x2 range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ copyFrom(
+ sourceRange: Range | RangeAreas | string,
+ copyType?: RangeCopyType,
+ skipBlanks?: boolean,
+ transpose?: boolean
+ ): void;
+ parameters:
+ - id: sourceRange
+ description: >-
+ The source range or `RangeAreas` to copy from. When the source `RangeAreas` has multiple ranges, their form
+ must be able to be created by removing full rows or columns from a rectangular range.
+ type: >-
+ | | string
+ - id: copyType
+ description: The type of cell data or formatting to copy over. Default is "All".
+ type: ''
+ - id: skipBlanks
+ description: True if to skip blank cells in the source range. Default is false.
+ type: boolean
+ - id: transpose
+ description: True if to transpose the cells in the destination range. Default is false.
+ type: boolean
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script copies a table from one worksheet to a new worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the worksheet named "TableTemplate".
+ let base = workbook.getWorksheet("TableTemplate");
+
+ // Get the range to be copied based on the first table.
+ let tableRange = base.getTables()[0].getRange();
+
+ // Get the area in a new worksheet for the new table.
+ let newWorksheet = workbook.addWorksheet();
+ let newRange = newWorksheet.getRangeByIndexes(0,0, tableRange.getRowCount(), tableRange.getColumnCount());
+
+ // Copy the existing data into the new range.
+ newRange.copyFrom(tableRange);
+ }
+ ```
+ - name: delete(shift)
+ uid: 'ExcelScript!ExcelScript.Range#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete(shift)
+ summary: Deletes the cells associated with the range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(shift: DeleteShiftDirection): void;'
+ parameters:
+ - id: shift
+ description: Specifies which way to shift the cells. See `ExcelScript.DeleteShiftDirection` for details.
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample creates a sample range, then deletes
+ * "A1" using different DeleteShiftDirection values.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Add sample data to better visualize the delete changes.
+ const currentSheet = workbook.getActiveWorksheet();
+ currentSheet.getRange("A1:D4").setValues([
+ [1,2,3,4],
+ [5,6,7,8],
+ [9,10,11,12],
+ [13,14,15,16]]);
+
+ // Delete A1 and shift the cells from the right to fill the space.
+ // The value being deleted is 1.
+ currentSheet.getRange("A1").delete(ExcelScript.DeleteShiftDirection.left);
+
+ // Delete A1 and shift the cells from the bottom to fill the space.
+ // The value being deleted is 2.
+ currentSheet.getRange("A1").delete(ExcelScript.DeleteShiftDirection.up);
+
+ // Log the sample range. The values should be:
+ /*
+ 5, 3, 4, "",
+ 9, 6, 7, 8,
+ 13, 10, 11, 12,
+ "", 14, 15, 16
+ */
+ console.log(currentSheet.getRange("A1:D4").getValues());
+ }
+ ```
+ - name: 'find(text, criteria)'
+ uid: 'ExcelScript!ExcelScript.Range#find:member(1)'
+ package: ExcelScript!
+ fullName: 'find(text, criteria)'
+ summary: >-
+ Finds the given string based on the criteria specified. If the current range is larger than a single cell, then
+ the search will be limited to that range, else the search will cover the entire sheet starting after that cell. If
+ there are no matches, then this method returns `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'find(text: string, criteria: SearchCriteria): Range;'
+ parameters:
+ - id: text
+ description: The string to find.
+ type: string
+ - id: criteria
+ description: >-
+ Additional search criteria, including the search direction and whether the search needs to match the entire
+ cell or be case-sensitive.
+ type: ''
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script searches through a table column and finds cells marked "no change".
+ * Those cells have "no change" replaced with the value from the cell to the left.
+ * This script uses Range.find instead of Worksheet.findAll
+ * to limit the search to a specific range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range of a table named "Orders".
+ let table = workbook.getTable("Orders");
+ let range = table.getColumnByName("March").getRange();
+
+ // Find all cells with the value "no change".
+ let cellToOverwrite = range.find("no change", { completeMatch: true });
+ while (cellToOverwrite) {
+ let cellToCopyFrom = cellToOverwrite.getOffsetRange(0,-1);
+ cellToOverwrite.setValue(cellToCopyFrom.getValue());
+ cellToOverwrite = range.find("no change", { completeMatch: true });
+ }
+ }
+ ```
+ - name: flashFill()
+ uid: 'ExcelScript!ExcelScript.Range#flashFill:member(1)'
+ package: ExcelScript!
+ fullName: flashFill()
+ summary: >-
+ Does a Flash Fill to the current range. Flash Fill automatically fills data when it senses a pattern, so the range
+ must be a single column range and have data around it in order to find a pattern.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'flashFill(): void;'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script uses the Flash Fill feature to complete a table.
+ * See https://support.microsoft.com/office/3f9bcf1e-db93-4890-94a0-1578341f73f7
+ * for the example table.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current, active worksheet.
+ let currentWorksheet = workbook.getActiveWorksheet();
+
+ // Get the data range with a pattern and cells to fill. C2 is filled in. C3:C6 are blank.
+ let dataRange = currentWorksheet.getRange("C2:C6");
+
+ // Flash fill the connected range.
+ dataRange.flashFill();
+ }
+ ```
+ - name: 'getAbsoluteResizedRange(numRows, numColumns)'
+ uid: 'ExcelScript!ExcelScript.Range#getAbsoluteResizedRange:member(1)'
+ package: ExcelScript!
+ fullName: 'getAbsoluteResizedRange(numRows, numColumns)'
+ summary: >-
+ Gets a `Range` object with the same top-left cell as the current `Range` object, but with the specified numbers of
+ rows and columns.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAbsoluteResizedRange(numRows: number, numColumns: number): Range;'
+ parameters:
+ - id: numRows
+ description: The number of rows of the new range size.
+ type: number
+ - id: numColumns
+ description: The number of columns of the new range size.
+ type: number
+ return:
+ type: ''
+ description: ''
+ - name: getAddress()
+ uid: 'ExcelScript!ExcelScript.Range#getAddress:member(1)'
+ package: ExcelScript!
+ fullName: getAddress()
+ summary: 'Specifies the range reference in A1-style. Address value contains the sheet reference (e.g., "Sheet1!A1:B4").'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAddress(): string;'
+ return:
+ type: string
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script logs the address of the used range in each worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Iterate over every worksheet in the workbook.
+ workbook.getWorksheets().forEach((sheet) => {
+ // Get the used range for a single worksheet.
+ let range = sheet.getUsedRange();
+
+ // Print the address of the used range to the console.
+ console.log(range.getAddress());
+ });
+ }
+ ```
+ - name: getAddressLocal()
+ uid: 'ExcelScript!ExcelScript.Range#getAddressLocal:member(1)'
+ package: ExcelScript!
+ fullName: getAddressLocal()
+ summary: Represents the range reference for the specified range in the language of the user.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAddressLocal(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getBoundingRect(anotherRange)
+ uid: 'ExcelScript!ExcelScript.Range#getBoundingRect:member(1)'
+ package: ExcelScript!
+ fullName: getBoundingRect(anotherRange)
+ summary: >-
+ Gets the smallest range object that encompasses the given ranges. For example, the `GetBoundingRect` of "B2:C5"
+ and "D10:E15" is "B2:E15".
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBoundingRect(anotherRange: Range | string): Range;'
+ parameters:
+ - id: anotherRange
+ description: 'The range object, address, or range name.'
+ type: ' | string'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script gets the bounding range of two existing ranges and puts a border around it.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ let sheet = workbook.getActiveWorksheet();
+
+ // Create two range objects for the sample.
+ let range1 = sheet.getRange("B2:C5");
+ let range2 = sheet.getRange("D10:E15");
+
+ // Get the rectangular range that fully includes both ranges.
+ let boundingRectangle = range1.getBoundingRect(range2);
+
+ // Add a border around the whole bounding range (B2:E15).
+ let format = boundingRectangle.getFormat();
+ format.getRangeBorder(ExcelScript.BorderIndex.edgeTop).setStyle(ExcelScript.BorderLineStyle.continuous); // Top border
+ format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom).setStyle(ExcelScript.BorderLineStyle.continuous); // Bottom border
+ format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft).setStyle(ExcelScript.BorderLineStyle.continuous); // Left border
+ format.getRangeBorder(ExcelScript.BorderIndex.edgeRight).setStyle(ExcelScript.BorderLineStyle.continuous); // Right border
+ }
+ ```
+ - name: 'getCell(row, column)'
+ uid: 'ExcelScript!ExcelScript.Range#getCell:member(1)'
+ package: ExcelScript!
+ fullName: 'getCell(row, column)'
+ summary: >-
+ Gets the range object containing the single cell based on row and column numbers. The cell can be outside the
+ bounds of its parent range, so long as it stays within the worksheet grid. The returned cell is located relative
+ to the top left cell of the range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCell(row: number, column: number): Range;'
+ parameters:
+ - id: row
+ description: Row number of the cell to be retrieved. Zero-indexed.
+ type: number
+ - id: column
+ description: Column number of the cell to be retrieved. Zero-indexed.
+ type: number
+ return:
+ type: ''
+ description: ''
+ - name: getCellCount()
+ uid: 'ExcelScript!ExcelScript.Range#getCellCount:member(1)'
+ package: ExcelScript!
+ fullName: getCellCount()
+ summary: >-
+ Specifies the number of cells in the range. This API will return -1 if the cell count exceeds 2^31-1
+ (2,147,483,647).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCellCount(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getColumn(column)
+ uid: 'ExcelScript!ExcelScript.Range#getColumn:member(1)'
+ package: ExcelScript!
+ fullName: getColumn(column)
+ summary: Gets a column contained in the range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColumn(column: number): Range;'
+ parameters:
+ - id: column
+ description: Column number of the range to be retrieved. Zero-indexed.
+ type: number
+ return:
+ type: ''
+ description: ''
+ - name: getColumnCount()
+ uid: 'ExcelScript!ExcelScript.Range#getColumnCount:member(1)'
+ package: ExcelScript!
+ fullName: getColumnCount()
+ summary: Specifies the total number of columns in the range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColumnCount(): number;'
+ return:
+ type: number
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample provides the count of negative numbers that are present
+ * in the used range of the current worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the working range.
+ let usedRange = workbook.getActiveWorksheet().getUsedRange();
+ let rowCount = usedRange.getRowCount();
+ let columnCount = usedRange.getColumnCount();
+
+ // Save the values locally to avoid repeatedly asking the workbook.
+ let usedRangeValues = usedRange.getValues();
+
+ // Start the negative number counter.
+ let negativeCount = 0;
+
+ // Iterate over the entire range looking for negative numbers.
+ for (let i = 0; i < rowCount; i++) {
+ for (let j = 0; j < columnCount; j++) {
+ if (usedRangeValues[i][j] < 0) {
+ negativeCount++;
+ }
+ }
+ }
+
+ // Log the negative number count to the console.
+ console.log(negativeCount);
+ }
+ ```
+ - name: getColumnHidden()
+ uid: 'ExcelScript!ExcelScript.Range#getColumnHidden:member(1)'
+ package: ExcelScript!
+ fullName: getColumnHidden()
+ summary: >-
+ Represents if all columns in the current range are hidden. Value is `true` when all columns in a range are hidden.
+ Value is `false` when no columns in the range are hidden. Value is `null` when some columns in a range are hidden
+ and other columns in the same range are not hidden.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColumnHidden(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getColumnIndex()
+ uid: 'ExcelScript!ExcelScript.Range#getColumnIndex:member(1)'
+ package: ExcelScript!
+ fullName: getColumnIndex()
+ summary: Specifies the column number of the first cell in the range. Zero-indexed.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColumnIndex(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getColumnsAfter(count)
+ uid: 'ExcelScript!ExcelScript.Range#getColumnsAfter:member(1)'
+ package: ExcelScript!
+ fullName: getColumnsAfter(count)
+ summary: Gets a certain number of columns to the right of the current `Range` object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColumnsAfter(count?: number): Range;'
+ parameters:
+ - id: count
+ description: >-
+ Optional. The number of columns to include in the resulting range. In general, use a positive number to
+ create a range outside the current range. You can also use a negative number to create a range within the
+ current range. The default value is 1.
+ type: number
+ return:
+ type: ''
+ description: ''
+ - name: getColumnsBefore(count)
+ uid: 'ExcelScript!ExcelScript.Range#getColumnsBefore:member(1)'
+ package: ExcelScript!
+ fullName: getColumnsBefore(count)
+ summary: Gets a certain number of columns to the left of the current `Range` object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColumnsBefore(count?: number): Range;'
+ parameters:
+ - id: count
+ description: >-
+ Optional. The number of columns to include in the resulting range. In general, use a positive number to
+ create a range outside the current range. You can also use a negative number to create a range within the
+ current range. The default value is 1.
+ type: number
+ return:
+ type: ''
+ description: ''
+ - name: getConditionalFormat(id)
+ uid: 'ExcelScript!ExcelScript.Range#getConditionalFormat:member(1)'
+ package: ExcelScript!
+ fullName: getConditionalFormat(id)
+ summary: >-
+ Returns a conditional format identified by its ID. If the conditional format object does not exist, then this
+ method returns `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getConditionalFormat(id: string): ConditionalFormat | undefined;'
+ parameters:
+ - id: id
+ description: The ID of the conditional format.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getConditionalFormats()
+ uid: 'ExcelScript!ExcelScript.Range#getConditionalFormats:member(1)'
+ package: ExcelScript!
+ fullName: getConditionalFormats()
+ summary: The collection of `ConditionalFormats` that intersect the range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getConditionalFormats(): ConditionalFormat[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getControl()
+ uid: 'ExcelScript!ExcelScript.Range#getControl:member(1)'
+ package: ExcelScript!
+ fullName: getControl()
+ summary: >-
+ Accesses the cell control applied to this range. If the range has multiple cell controls, this returns
+ `EmptyCellControl`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getControl(): CellControl;'
+ return:
+ type: ''
+ description: ''
+ - name: getDataValidation()
+ uid: 'ExcelScript!ExcelScript.Range#getDataValidation:member(1)'
+ package: ExcelScript!
+ fullName: getDataValidation()
+ summary: Returns a data validation object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDataValidation(): DataValidation;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a drop-down selection list for a cell. It uses the existing values of the selected range as the choices for the list.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the values for data validation.
+ let selectedRange = workbook.getSelectedRange();
+ let rangeValues = selectedRange.getValues();
+
+ // Convert the values into a comma-delimited string.
+ let dataValidationListString = "";
+ rangeValues.forEach((rangeValueRow) => {
+ rangeValueRow.forEach((value) => {
+ dataValidationListString += value + ",";
+ });
+ });
+
+ // Clear the old range.
+ selectedRange.clear(ExcelScript.ClearApplyTo.contents);
+
+ // Apply the data validation to the first cell in the selected range.
+ let targetCell = selectedRange.getCell(0,0);
+ let dataValidation = targetCell.getDataValidation();
+
+ // Set the content of the drop-down list.
+ dataValidation.setRule({
+ list: {
+ inCellDropDown: true,
+ source: dataValidationListString
+ }
+ });
+ }
+ ```
+ - name: getDependents()
+ uid: 'ExcelScript!ExcelScript.Range#getDependents:member(1)'
+ package: ExcelScript!
+ fullName: getDependents()
+ summary: >-
+ Returns a `WorkbookRangeAreas` object that represents the range containing all the dependent cells of a specified
+ range in the same worksheet or across multiple worksheets. Note: This API returns an `ItemNotFound` error if no
+ dependents are found.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDependents(): WorkbookRangeAreas;'
+ return:
+ type: ''
+ description: ''
+ - name: getDirectDependents()
+ uid: 'ExcelScript!ExcelScript.Range#getDirectDependents:member(1)'
+ package: ExcelScript!
+ fullName: getDirectDependents()
+ summary: >-
+ Returns a `WorkbookRangeAreas` object that represents the range containing all the direct dependent cells of a
+ specified range in the same worksheet or across multiple worksheets. Note: This API returns an `ItemNotFound`
+ error if no dependents are found.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDirectDependents(): WorkbookRangeAreas;'
+ return:
+ type: ''
+ description: ''
+ - name: getDirectPrecedents()
+ uid: 'ExcelScript!ExcelScript.Range#getDirectPrecedents:member(1)'
+ package: ExcelScript!
+ fullName: getDirectPrecedents()
+ summary: >-
+ Returns a `WorkbookRangeAreas` object that represents the range containing all the direct precedent cells of a
+ specified range in the same worksheet or across multiple worksheets. Note: This API returns an `ItemNotFound`
+ error if no precedents are found.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDirectPrecedents(): WorkbookRangeAreas;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script finds the direct precedents of the active cell.
+ * It changes the font and color of those precedent cells.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the active cell.
+ const selected = workbook.getActiveCell();
+
+ // Get the cells that are direct precedents of the current cell.
+ const precedents : ExcelScript.WorkbookRangeAreas = selected.getDirectPrecedents();
+
+ // Set the font to bold and the fill color to orange for all the precedent cells.
+ precedents.getRanges().forEach(range => {
+ range.getFormat().getFill().setColor("orange");
+ range.getFormat().getFont().setBold(true);
+ });
+ }
+ ```
+ - name: getEntireColumn()
+ uid: 'ExcelScript!ExcelScript.Range#getEntireColumn:member(1)'
+ package: ExcelScript!
+ fullName: getEntireColumn()
+ summary: >-
+ Gets an object that represents the entire column of the range (for example, if the current range represents cells
+ "B4:E11", its `getEntireColumn` is a range that represents columns "B:E").
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getEntireColumn(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getEntireRow()
+ uid: 'ExcelScript!ExcelScript.Range#getEntireRow:member(1)'
+ package: ExcelScript!
+ fullName: getEntireRow()
+ summary: >-
+ Gets an object that represents the entire row of the range (for example, if the current range represents cells
+ "B4:E11", its `GetEntireRow` is a range that represents rows "4:11").
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getEntireRow(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: 'getExtendedRange(direction, activeCell)'
+ uid: 'ExcelScript!ExcelScript.Range#getExtendedRange:member(1)'
+ package: ExcelScript!
+ fullName: 'getExtendedRange(direction, activeCell)'
+ summary: >-
+ Returns a range object that includes the current range and up to the edge of the range, based on the provided
+ direction. This matches the Ctrl+Shift+Arrow key behavior in the Excel on Windows
+ UI.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ getExtendedRange(
+ direction: KeyboardDirection,
+ activeCell?: Range | string
+ ): Range;
+ parameters:
+ - id: direction
+ description: The direction from the active cell.
+ type: ''
+ - id: activeCell
+ description: >-
+ The active cell in this range. By default, the active cell is the top-left cell of the range. An error is
+ thrown if the active cell is not in this range.
+ type: ' | string'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script makes the font bold on all the contiguous cells between
+ * A1 and the bottom of the used range of the first column.
+ */
+ function main(workbook: ExcelScript.Workbook)
+ {
+ // Get the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Get every cell that's used between A1 and the end of the column.
+ // This recreates the Ctrl+Shift+Down arrow key behavior.
+ let firstCell = selectedSheet.getRange("A1");
+ let firstColumn = firstCell.getExtendedRange(ExcelScript.KeyboardDirection.down);
+
+ // Set the font to bold in that range.
+ firstColumn.getFormat().getFont().setBold(true);
+ }
+ ```
+ - name: getFormat()
+ uid: 'ExcelScript!ExcelScript.Range#getFormat:member(1)'
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: 'Returns a format object, encapsulating the range''s font, fill, borders, alignment, and other properties.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): RangeFormat;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script gives the total row of a table a green color fill.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table in the workbook.
+ let table = workbook.getTables()[0];
+
+ // Get the range for the total row of the table.
+ let totalRange = table.getTotalRowRange();
+
+ // Set the fill color to green.
+ totalRange.getFormat().getFill().setColor("green");
+ }
+ ```
+ - name: getFormula()
+ uid: 'ExcelScript!ExcelScript.Range#getFormula:member(1)'
+ package: ExcelScript!
+ fullName: getFormula()
+ summary: >-
+ Represents the cell formula in A1-style notation. If the range contains multiple cells, the data from first cell
+ (represented by row index of 0 and column index of 0) will be returned.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormula(): string;'
+ return:
+ type: string
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /*
+ * This script sets a cell's formula,
+ * then displays how Excel stores the cell's formula and value separately.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Set A1 to 2.
+ let a1 = selectedSheet.getRange("A1");
+ a1.setValue(2);
+
+ // Set B1 to the formula =(2*A1), which should equal 4.
+ let b1 = selectedSheet.getRange("B1")
+ b1.setFormula("=(2*A1)");
+
+ // Log the current results for `getFormula` and `getValue` at B1.
+ console.log(`B1 - Formula: ${b1.getFormula()} | Value: ${b1.getValue()}`);
+ }
+ ```
+ - name: getFormulaLocal()
+ uid: 'ExcelScript!ExcelScript.Range#getFormulaLocal:member(1)'
+ package: ExcelScript!
+ fullName: getFormulaLocal()
+ summary: >-
+ Represents the cell formula in A1-style notation, in the user's language and number-formatting locale. For
+ example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If the range contains
+ multiple cells, the data from first cell (represented by row index of 0 and column index of 0) will be returned.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormulaLocal(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getFormulaR1C1()
+ uid: 'ExcelScript!ExcelScript.Range#getFormulaR1C1:member(1)'
+ package: ExcelScript!
+ fullName: getFormulaR1C1()
+ summary: >-
+ Represents the cell formula in R1C1-style notation. If the range contains multiple cells, the data from first cell
+ (represented by row index of 0 and column index of 0) will be returned.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormulaR1C1(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getFormulas()
+ uid: 'ExcelScript!ExcelScript.Range#getFormulas:member(1)'
+ package: ExcelScript!
+ fullName: getFormulas()
+ summary: 'Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormulas(): string[][];'
+ return:
+ type: 'string[][]'
+ description: ''
+ - name: getFormulasLocal()
+ uid: 'ExcelScript!ExcelScript.Range#getFormulasLocal:member(1)'
+ package: ExcelScript!
+ fullName: getFormulasLocal()
+ summary: >-
+ Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the
+ English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its value is
+ returned instead.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormulasLocal(): string[][];'
+ return:
+ type: 'string[][]'
+ description: ''
+ - name: getFormulasR1C1()
+ uid: 'ExcelScript!ExcelScript.Range#getFormulasR1C1:member(1)'
+ package: ExcelScript!
+ fullName: getFormulasR1C1()
+ summary: 'Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormulasR1C1(): string[][];'
+ return:
+ type: 'string[][]'
+ description: ''
+ - name: getHasSpill()
+ uid: 'ExcelScript!ExcelScript.Range#getHasSpill:member(1)'
+ package: ExcelScript!
+ fullName: getHasSpill()
+ summary: >-
+ Represents if all cells have a spill border. Returns `true` if all cells have a spill border, or `false` if all
+ cells do not have a spill border. Returns `null` if there are cells both with and without spill borders within the
+ range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHasSpill(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getHeight()
+ uid: 'ExcelScript!ExcelScript.Range#getHeight:member(1)'
+ package: ExcelScript!
+ fullName: getHeight()
+ summary: 'Returns the distance in points, for 100% zoom, from the top edge of the range to the bottom edge of the range.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHeight(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getHidden()
+ uid: 'ExcelScript!ExcelScript.Range#getHidden:member(1)'
+ package: ExcelScript!
+ fullName: getHidden()
+ summary: >-
+ Represents if all cells in the current range are hidden. Value is `true` when all cells in a range are hidden.
+ Value is `false` when no cells in the range are hidden. Value is `null` when some cells in a range are hidden and
+ other cells in the same range are not hidden.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHidden(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getHyperlink()
+ uid: 'ExcelScript!ExcelScript.Range#getHyperlink:member(1)'
+ package: ExcelScript!
+ fullName: getHyperlink()
+ summary: Represents the hyperlink for the current range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHyperlink(): RangeHyperlink;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample clears all of the hyperlinks from the current worksheet
+ * and removes the usual hyperlink formatting.
+ */
+ function main(workbook: ExcelScript.Workbook, sheetName: string = 'Sheet1') {
+ // Get the active worksheet.
+ let sheet = workbook.getWorksheet(sheetName);
+
+ // Get the used range to operate on.
+ // For large ranges (over 10000 entries), consider splitting the operation into batches for performance.
+ const targetRange = sheet.getUsedRange(true);
+ console.log(`Target Range to clear hyperlinks from: ${targetRange.getAddress()}`);
+
+ const rowCount = targetRange.getRowCount();
+ const colCount = targetRange.getColumnCount();
+ console.log(`Searching for hyperlinks in ${targetRange.getAddress()} which contains ${(rowCount * colCount)} cells`);
+
+ // Go through each individual cell looking for a hyperlink.
+ // This allows us to limit the formatting changes to only the cells with hyperlink formatting.
+ let clearedCount = 0;
+ for (let i = 0; i < rowCount; i++) {
+ for (let j = 0; j < colCount; j++) {
+ const cell = targetRange.getCell(i, j);
+ const hyperlink = cell.getHyperlink();
+ if (hyperlink) {
+ cell.clear(ExcelScript.ClearApplyTo.hyperlinks);
+ cell.getFormat().getFont().setUnderline(ExcelScript.RangeUnderlineStyle.none);
+ cell.getFormat().getFont().setColor('Black');
+ clearedCount++;
+ }
+ }
+ }
+
+ console.log(`Done. Cleared hyperlinks from ${clearedCount} cells`);
+ }
+ ```
+ - name: getImage()
+ uid: 'ExcelScript!ExcelScript.Range#getImage:member(1)'
+ package: ExcelScript!
+ fullName: getImage()
+ summary: Renders the range as a Base64-encoded PNG image.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getImage(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getIntersection(anotherRange)
+ uid: 'ExcelScript!ExcelScript.Range#getIntersection:member(1)'
+ package: ExcelScript!
+ fullName: getIntersection(anotherRange)
+ summary: >-
+ Gets the range object that represents the rectangular intersection of the given ranges. If no intersection is
+ found, then this method returns `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIntersection(anotherRange: Range | string): Range;'
+ parameters:
+ - id: anotherRange
+ description: The range object or range address that will be used to determine the intersection of ranges.
+ type: ' | string'
+ return:
+ type: ''
+ description: ''
+ - name: getIsEntireColumn()
+ uid: 'ExcelScript!ExcelScript.Range#getIsEntireColumn:member(1)'
+ package: ExcelScript!
+ fullName: getIsEntireColumn()
+ summary: Represents if the current range is an entire column.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIsEntireColumn(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getIsEntireRow()
+ uid: 'ExcelScript!ExcelScript.Range#getIsEntireRow:member(1)'
+ package: ExcelScript!
+ fullName: getIsEntireRow()
+ summary: Represents if the current range is an entire row.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIsEntireRow(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getLastCell()
+ uid: 'ExcelScript!ExcelScript.Range#getLastCell:member(1)'
+ package: ExcelScript!
+ fullName: getLastCell()
+ summary: 'Gets the last cell within the range. For example, the last cell of "B2:D5" is "D5".'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLastCell(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getLastColumn()
+ uid: 'ExcelScript!ExcelScript.Range#getLastColumn:member(1)'
+ package: ExcelScript!
+ fullName: getLastColumn()
+ summary: 'Gets the last column within the range. For example, the last column of "B2:D5" is "D2:D5".'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLastColumn(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getLastRow()
+ uid: 'ExcelScript!ExcelScript.Range#getLastRow:member(1)'
+ package: ExcelScript!
+ fullName: getLastRow()
+ summary: 'Gets the last row within the range. For example, the last row of "B2:D5" is "B5:D5".'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLastRow(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getLeft()
+ uid: 'ExcelScript!ExcelScript.Range#getLeft:member(1)'
+ package: ExcelScript!
+ fullName: getLeft()
+ summary: 'Returns the distance in points, for 100% zoom, from the left edge of the worksheet to the left edge of the range.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLeft(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getLinkedDataTypeState()
+ uid: 'ExcelScript!ExcelScript.Range#getLinkedDataTypeState:member(1)'
+ package: ExcelScript!
+ fullName: getLinkedDataTypeState()
+ summary: Represents the data type state of the cell.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLinkedDataTypeState(): LinkedDataTypeState;'
+ return:
+ type: ''
+ description: ''
+ - name: getLinkedDataTypeStates()
+ uid: 'ExcelScript!ExcelScript.Range#getLinkedDataTypeStates:member(1)'
+ package: ExcelScript!
+ fullName: getLinkedDataTypeStates()
+ summary: Represents the data type state of each cell.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLinkedDataTypeStates(): LinkedDataTypeState[][];'
+ return:
+ type: '[][]'
+ description: ''
+ - name: getMergedAreas()
+ uid: 'ExcelScript!ExcelScript.Range#getMergedAreas:member(1)'
+ package: ExcelScript!
+ fullName: getMergedAreas()
+ summary: >-
+ Returns a `RangeAreas` object that represents the merged areas in this range. Note that if the merged areas count
+ in this range is more than 512, then this method will fail to return the result. If the `RangeAreas` object
+ doesn't exist, then this function returns `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMergedAreas(): RangeAreas;'
+ return:
+ type: ''
+ description: ''
+ - name: getNumberFormat()
+ uid: 'ExcelScript!ExcelScript.Range#getNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: getNumberFormat()
+ summary: >-
+ Represents cell Excel number format code for the given range. If the range contains multiple cells, the data from
+ first cell (represented by row index of 0 and column index of 0) will be returned.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNumberFormat(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getNumberFormatCategories()
+ uid: 'ExcelScript!ExcelScript.Range#getNumberFormatCategories:member(1)'
+ package: ExcelScript!
+ fullName: getNumberFormatCategories()
+ summary: Represents the category of number format of each cell.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNumberFormatCategories(): NumberFormatCategory[][];'
+ return:
+ type: '[][]'
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script finds cells in a table column that are not formatted as currency
+ * and sets the fill color to red.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the "Cost" column from the "Expenses" table.
+ const table = workbook.getTable("Expenses");
+ const costColumn = table.getColumnByName("Cost");
+ const costColumnRange = costColumn.getRangeBetweenHeaderAndTotal();
+
+ // Get the number format categories for the column's range.
+ const numberFormatCategories = costColumnRange.getNumberFormatCategories();
+
+ // If any cell in the column doesn't have a currency format, make the cell red.
+ numberFormatCategories.forEach((category, index) =>{
+ if (category[0] != ExcelScript.NumberFormatCategory.currency) {
+ costColumnRange.getCell(index, 0).getFormat().getFill().setColor("red");
+ }
+ });
+ }
+ ```
+ - name: getNumberFormatCategory()
+ uid: 'ExcelScript!ExcelScript.Range#getNumberFormatCategory:member(1)'
+ package: ExcelScript!
+ fullName: getNumberFormatCategory()
+ summary: >-
+ Specifies the number format category of first cell in the range (represented by row index of 0 and column index of
+ 0).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNumberFormatCategory(): NumberFormatCategory;'
+ return:
+ type: ''
+ description: ''
+ - name: getNumberFormatLocal()
+ uid: 'ExcelScript!ExcelScript.Range#getNumberFormatLocal:member(1)'
+ package: ExcelScript!
+ fullName: getNumberFormatLocal()
+ summary: >-
+ Represents cell Excel number format code for the given range, based on the language settings of the user.​ Excel
+ does not perform any language or format coercion when getting or setting the `numberFormatLocal` property. Any
+ returned text uses the locally-formatted strings based on the language specified in the system settings. If the
+ range contains multiple cells, the data from first cell (represented by row index of 0 and column index of 0) will
+ be returned.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNumberFormatLocal(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getNumberFormats()
+ uid: 'ExcelScript!ExcelScript.Range#getNumberFormats:member(1)'
+ package: ExcelScript!
+ fullName: getNumberFormats()
+ summary: Represents Excel's number format code for the given range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNumberFormats(): string[][];'
+ return:
+ type: 'string[][]'
+ description: ''
+ - name: getNumberFormatsLocal()
+ uid: 'ExcelScript!ExcelScript.Range#getNumberFormatsLocal:member(1)'
+ package: ExcelScript!
+ fullName: getNumberFormatsLocal()
+ summary: >-
+ Represents Excel's number format code for the given range, based on the language settings of the user. Excel does
+ not perform any language or format coercion when getting or setting the `numberFormatLocal` property. Any returned
+ text uses the locally-formatted strings based on the language specified in the system settings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNumberFormatsLocal(): string[][];'
+ return:
+ type: 'string[][]'
+ description: ''
+ - name: 'getOffsetRange(rowOffset, columnOffset)'
+ uid: 'ExcelScript!ExcelScript.Range#getOffsetRange:member(1)'
+ package: ExcelScript!
+ fullName: 'getOffsetRange(rowOffset, columnOffset)'
+ summary: >-
+ Gets an object which represents a range that's offset from the specified range. The dimension of the returned
+ range will match this range. If the resulting range is forced outside the bounds of the worksheet grid, an error
+ will be thrown.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getOffsetRange(rowOffset: number, columnOffset: number): Range;'
+ parameters:
+ - id: rowOffset
+ description: >-
+ The number of rows (positive, negative, or 0) by which the range is to be offset. Positive values are offset
+ downward, and negative values are offset upward.
+ type: number
+ - id: columnOffset
+ description: >-
+ The number of columns (positive, negative, or 0) by which the range is to be offset. Positive values are
+ offset to the right, and negative values are offset to the left.
+ type: number
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script gets adjacent cells using relative references.
+ * Note that if the active cell is on the top row, part of the script fails,
+ * because it references the cell above the currently selected one.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the currently active cell in the workbook.
+ let activeCell = workbook.getActiveCell();
+ console.log(`The active cell's address is: ${activeCell.getAddress()}`);
+
+ // Get the cell to the right of the active cell and set its value and color.
+ let rightCell = activeCell.getOffsetRange(0,1);
+ rightCell.setValue("Right cell");
+ console.log(`The right cell's address is: ${rightCell.getAddress()}`);
+ rightCell.getFormat().getFont().setColor("Magenta");
+ rightCell.getFormat().getFill().setColor("Cyan");
+
+ // Get the cell to the above of the active cell and set its value and color.
+ // Note that this operation will fail if the active cell is in the top row.
+ let aboveCell = activeCell.getOffsetRange(-1, 0);
+ aboveCell.setValue("Above cell");
+ console.log(`The above cell's address is: ${aboveCell.getAddress()}`);
+ aboveCell.getFormat().getFont().setColor("White");
+ aboveCell.getFormat().getFill().setColor("Black");
+ }
+ ```
+ - name: getPivotTables(fullyContained)
+ uid: 'ExcelScript!ExcelScript.Range#getPivotTables:member(1)'
+ package: ExcelScript!
+ fullName: getPivotTables(fullyContained)
+ summary: Gets a scoped collection of PivotTables that overlap with the range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPivotTables(fullyContained?: boolean): PivotTable[];'
+ parameters:
+ - id: fullyContained
+ description: >-
+ If `true`, returns only PivotTables that are fully contained within the range bounds. The default
+ value is `false`.
+ type: boolean
+ return:
+ type: '[]'
+ description: ''
+ - name: getPrecedents()
+ uid: 'ExcelScript!ExcelScript.Range#getPrecedents:member(1)'
+ package: ExcelScript!
+ fullName: getPrecedents()
+ summary: >-
+ Returns a `WorkbookRangeAreas` object that represents the range containing all the precedent cells of a specified
+ range in the same worksheet or across multiple worksheets. Note: This API returns an `ItemNotFound` error if no
+ precedents are found.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPrecedents(): WorkbookRangeAreas;'
+ return:
+ type: ''
+ description: ''
+ - name: getPredefinedCellStyle()
+ uid: 'ExcelScript!ExcelScript.Range#getPredefinedCellStyle:member(1)'
+ package: ExcelScript!
+ fullName: getPredefinedCellStyle()
+ summary: >-
+ Represents the style of the current range. If the styles of the cells are inconsistent, `null` will be returned.
+ For custom styles, the style name will be returned. For built-in styles, a string representing a value in the
+ `BuiltInStyle` enum will be returned.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPredefinedCellStyle(): string;'
+ return:
+ type: string
+ description: ''
+ - name: 'getRangeEdge(direction, activeCell)'
+ uid: 'ExcelScript!ExcelScript.Range#getRangeEdge:member(1)'
+ package: ExcelScript!
+ fullName: 'getRangeEdge(direction, activeCell)'
+ summary: >-
+ Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This
+ matches the Ctrl+Arrow key behavior in the Excel on Windows UI.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ getRangeEdge(
+ direction: KeyboardDirection,
+ activeCell?: Range | string
+ ): Range;
+ parameters:
+ - id: direction
+ description: The direction from the active cell.
+ type: ''
+ - id: activeCell
+ description: >-
+ The active cell in this range. By default, the active cell is the top-left cell of the range. An error is
+ thrown if the active cell is not in this range.
+ type: ' | string'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds the value "Total" after the end of the first column.
+ */
+ function main(workbook: ExcelScript.Workbook)
+ {
+ // Get the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Get the last used cell at the end of the column.
+ // This recreates the Ctrl+Down arrow key behavior.
+ let firstCell = selectedSheet.getRange("A1");
+ let firstColumn = selectedSheet.getRange("A1").getRangeEdge(ExcelScript.KeyboardDirection.down);
+ let cellAfter = firstColumn.getOffsetRange(1, 0);
+
+ // Set the value of the cell after the current end of the used column to "Total".
+ cellAfter.setValue("Total");
+ }
+ ```
+ - name: 'getResizedRange(deltaRows, deltaColumns)'
+ uid: 'ExcelScript!ExcelScript.Range#getResizedRange:member(1)'
+ package: ExcelScript!
+ fullName: 'getResizedRange(deltaRows, deltaColumns)'
+ summary: >-
+ Gets a `Range` object similar to the current `Range` object, but with its bottom-right corner expanded (or
+ contracted) by some number of rows and columns.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getResizedRange(deltaRows: number, deltaColumns: number): Range;'
+ parameters:
+ - id: deltaRows
+ description: >-
+ The number of rows by which to expand the bottom-right corner, relative to the current range. Use a positive
+ number to expand the range, or a negative number to decrease it.
+ type: number
+ - id: deltaColumns
+ description: >-
+ The number of columns by which to expand the bottom-right corner, relative to the current range. Use a
+ positive number to expand the range, or a negative number to decrease it.
+ type: number
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script copies the formatting in the active cell to the neighboring cells.
+ * Note that this script only works when the active cell isn't on an edge of the worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the active cell.
+ let activeCell = workbook.getActiveCell();
+
+ // Get the cell that's one row above and one column to the left of the active cell.
+ let cornerCell = activeCell.getOffsetRange(-1,-1);
+
+ // Get a range that includes all the cells surrounding the active cell.
+ let surroundingRange = cornerCell.getResizedRange(2, 2)
+
+ // Copy the formatting from the active cell to the new range.
+ surroundingRange.copyFrom(
+ activeCell, /* The source range. */
+ ExcelScript.RangeCopyType.formats /* What to copy. */
+ );
+ }
+ ```
+ - name: getRow(row)
+ uid: 'ExcelScript!ExcelScript.Range#getRow:member(1)'
+ package: ExcelScript!
+ fullName: getRow(row)
+ summary: Gets a row contained in the range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRow(row: number): Range;'
+ parameters:
+ - id: row
+ description: Row number of the range to be retrieved. Zero-indexed.
+ type: number
+ return:
+ type: ''
+ description: ''
+ - name: getRowCount()
+ uid: 'ExcelScript!ExcelScript.Range#getRowCount:member(1)'
+ package: ExcelScript!
+ fullName: getRowCount()
+ summary: Returns the total number of rows in the range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRowCount(): number;'
+ return:
+ type: number
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample provides the count of negative numbers that are present
+ * in the used range of the current worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the working range.
+ let usedRange = workbook.getActiveWorksheet().getUsedRange();
+ let rowCount = usedRange.getRowCount();
+ let columnCount = usedRange.getColumnCount();
+
+ // Save the values locally to avoid repeatedly asking the workbook.
+ let usedRangeValues = usedRange.getValues();
+
+ // Start the negative number counter.
+ let negativeCount = 0;
+
+ // Iterate over the entire range looking for negative numbers.
+ for (let i = 0; i < rowCount; i++) {
+ for (let j = 0; j < columnCount; j++) {
+ if (usedRangeValues[i][j] < 0) {
+ negativeCount++;
+ }
+ }
+ }
+
+ // Log the negative number count to the console.
+ console.log(negativeCount);
+ }
+ ```
+ - name: getRowHidden()
+ uid: 'ExcelScript!ExcelScript.Range#getRowHidden:member(1)'
+ package: ExcelScript!
+ fullName: getRowHidden()
+ summary: >-
+ Represents if all rows in the current range are hidden. Value is `true` when all rows in a range are hidden. Value
+ is `false` when no rows in the range are hidden. Value is `null` when some rows in a range are hidden and other
+ rows in the same range are not hidden.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRowHidden(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getRowIndex()
+ uid: 'ExcelScript!ExcelScript.Range#getRowIndex:member(1)'
+ package: ExcelScript!
+ fullName: getRowIndex()
+ summary: Returns the row number of the first cell in the range. Zero-indexed.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRowIndex(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getRowsAbove(count)
+ uid: 'ExcelScript!ExcelScript.Range#getRowsAbove:member(1)'
+ package: ExcelScript!
+ fullName: getRowsAbove(count)
+ summary: Gets a certain number of rows above the current `Range` object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRowsAbove(count?: number): Range;'
+ parameters:
+ - id: count
+ description: >-
+ Optional. The number of rows to include in the resulting range. In general, use a positive number to create
+ a range outside the current range. You can also use a negative number to create a range within the current
+ range. The default value is 1.
+ type: number
+ return:
+ type: ''
+ description: ''
+ - name: getRowsBelow(count)
+ uid: 'ExcelScript!ExcelScript.Range#getRowsBelow:member(1)'
+ package: ExcelScript!
+ fullName: getRowsBelow(count)
+ summary: Gets a certain number of rows below the current `Range` object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRowsBelow(count?: number): Range;'
+ parameters:
+ - id: count
+ description: >-
+ Optional. The number of rows to include in the resulting range. In general, use a positive number to create
+ a range outside the current range. You can also use a negative number to create a range within the current
+ range. The default value is 1.
+ type: number
+ return:
+ type: ''
+ description: ''
+ - name: getSavedAsArray()
+ uid: 'ExcelScript!ExcelScript.Range#getSavedAsArray:member(1)'
+ package: ExcelScript!
+ fullName: getSavedAsArray()
+ summary: >-
+ Represents if all the cells would be saved as an array formula. Returns `true` if all cells would be saved as an
+ array formula, or `false` if all cells would not be saved as an array formula. Returns `null` if some cells would
+ be saved as an array formula and some would not be.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSavedAsArray(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getSort()
+ uid: 'ExcelScript!ExcelScript.Range#getSort:member(1)'
+ package: ExcelScript!
+ fullName: getSort()
+ summary: Represents the range sort of the current range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSort(): RangeSort;'
+ return:
+ type: ''
+ description: ''
+ - name: 'getSpecialCells(cellType, cellValueType)'
+ uid: 'ExcelScript!ExcelScript.Range#getSpecialCells:member(1)'
+ package: ExcelScript!
+ fullName: 'getSpecialCells(cellType, cellValueType)'
+ summary: >-
+ Gets the `RangeAreas` object, comprising one or more ranges, that represents all the cells that match the
+ specified type and value. If no special cells are found, then this method returns `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ getSpecialCells(
+ cellType: SpecialCellType,
+ cellValueType?: SpecialCellValueType
+ ): RangeAreas;
+ parameters:
+ - id: cellType
+ description: The type of cells to include.
+ type: ''
+ - id: cellValueType
+ description: >-
+ If `cellType` is either `constants` or `formulas`, this argument is used to determine which types of
+ cells to include in the result. These values can be combined together to return more than one type. The
+ default is to select all constants or formulas, no matter what the type.
+ type: ''
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample gets all the blank cells in the current worksheet's used range. It then highlights all those cells with a yellow background.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current used range.
+ let range = workbook.getActiveWorksheet().getUsedRange();
+
+ // Get all the blank cells.
+ let blankCells = range.getSpecialCells(ExcelScript.SpecialCellType.blanks);
+ // Highlight the blank cells with a yellow background.
+ blankCells.getFormat().getFill().setColor("yellow");
+ }
+ ```
+ - name: getSpillingToRange()
+ uid: 'ExcelScript!ExcelScript.Range#getSpillingToRange:member(1)'
+ package: ExcelScript!
+ fullName: getSpillingToRange()
+ summary: >-
+ Gets the range object containing the spill range when called on an anchor cell. If the range isn't an anchor cell
+ or the spill range can't be found, then this method returns `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSpillingToRange(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getSpillParent()
+ uid: 'ExcelScript!ExcelScript.Range#getSpillParent:member(1)'
+ package: ExcelScript!
+ fullName: getSpillParent()
+ summary: >-
+ Gets the range object containing the anchor cell for the cell getting spilled into. If it's not a spilled cell, or
+ more than one cell is given, then this method returns `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSpillParent(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getSurroundingRegion()
+ uid: 'ExcelScript!ExcelScript.Range#getSurroundingRegion:member(1)'
+ package: ExcelScript!
+ fullName: getSurroundingRegion()
+ summary: >-
+ Returns a `Range` object that represents the surrounding region for the top-left cell in this range. A surrounding
+ region is a range bounded by any combination of blank rows and blank columns relative to this range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSurroundingRegion(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getTables(fullyContained)
+ uid: 'ExcelScript!ExcelScript.Range#getTables:member(1)'
+ package: ExcelScript!
+ fullName: getTables(fullyContained)
+ summary: Gets a scoped collection of tables that overlap with the range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTables(fullyContained?: boolean): Table[];'
+ parameters:
+ - id: fullyContained
+ description: >-
+ If `true`, returns only tables that are fully contained within the range bounds. The default value
+ is `false`.
+ type: boolean
+ return:
+ type: '[]'
+ description: ''
+ - name: getText()
+ uid: 'ExcelScript!ExcelScript.Range#getText:member(1)'
+ package: ExcelScript!
+ fullName: getText()
+ summary: >-
+ Represents Text value of the specified range. The Text value will not depend on the cell width. The \# sign
+ substitution that happens in Excel UI will not affect the text value returned by the API. If the range contains
+ multiple cells, the data from first cell (represented by row index of 0 and column index of 0) will be returned.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getText(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getTexts()
+ uid: 'ExcelScript!ExcelScript.Range#getTexts:member(1)'
+ package: ExcelScript!
+ fullName: getTexts()
+ summary: >-
+ Text values of the specified range. The text value will not depend on the cell width. The number sign (\#)
+ substitution that happens in the Excel UI will not affect the text value returned by the API.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTexts(): string[][];'
+ return:
+ type: 'string[][]'
+ description: ''
+ - name: getTop()
+ uid: 'ExcelScript!ExcelScript.Range#getTop:member(1)'
+ package: ExcelScript!
+ fullName: getTop()
+ summary: 'Returns the distance in points, for 100% zoom, from the top edge of the worksheet to the top edge of the range.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTop(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getUsedRange(valuesOnly)
+ uid: 'ExcelScript!ExcelScript.Range#getUsedRange:member(1)'
+ package: ExcelScript!
+ fullName: getUsedRange(valuesOnly)
+ summary: >-
+ Returns the used range of the given range object. If there are no used cells within the range, then this method
+ returns `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getUsedRange(valuesOnly?: boolean): Range;'
+ parameters:
+ - id: valuesOnly
+ description: Considers only cells with values as used cells.
+ type: boolean
+ return:
+ type: ''
+ description: ''
+ - name: getValue()
+ uid: 'ExcelScript!ExcelScript.Range#getValue:member(1)'
+ package: ExcelScript!
+ fullName: getValue()
+ summary: >-
+ Represents the raw value of the specified range. The data returned could be of type string, number, or a boolean.
+ Cell that contain an error will return the error string. If the range contains multiple cells, the data from first
+ cell (represented by row index of 0 and column index of 0) will be returned.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getValue(): string | number | boolean;'
+ return:
+ type: string | number | boolean
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample reads the value of A1 and prints it to the console.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Get the value of cell A1.
+ let range = selectedSheet.getRange("A1");
+
+ // Print the value of A1.
+ console.log(range.getValue());
+ }
+ ```
+ - name: getValues()
+ uid: 'ExcelScript!ExcelScript.Range#getValues:member(1)'
+ package: ExcelScript!
+ fullName: getValues()
+ summary: >-
+ Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells
+ that contain an error will return the error string. If the returned value starts with a plus ("+"), minus ("-"),
+ or equal sign ("="), Excel interprets this value as a formula.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getValues(): (string | number | boolean)[][];'
+ return:
+ type: '(string | number | boolean)[][]'
+ description: ''
+ - name: getValueType()
+ uid: 'ExcelScript!ExcelScript.Range#getValueType:member(1)'
+ package: ExcelScript!
+ fullName: getValueType()
+ summary: >-
+ Represents the type of data in the cell. If the range contains multiple cells, the data from first cell
+ (represented by row index of 0 and column index of 0) will be returned.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getValueType(): RangeValueType;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script formats rows in a worksheet based on the first value in that row.
+ * If it's the boolean value TRUE, the row is bolded.
+ * If it's FALSE, nothing is changed.
+ * If the value type isn't a boolean, the row is italicized.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the used range in the active worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const usedRange = sheet.getUsedRange();
+
+ // Get the values in the first column.
+ const firstColumnValues = usedRange.getColumn(0).getValues();
+
+ // Look at the first cell in each row.
+ const rowCount = usedRange.getRowCount();
+ for (let i = 0; i < rowCount; i++) {
+ // Get the type of the first cell to make sure it's a boolean.
+ let firstValueType = usedRange.getCell(i, 0).getValueType();
+
+ // Set the bold or italic of the row as described earlier.
+ if (firstValueType === ExcelScript.RangeValueType.boolean) {
+ if (firstColumnValues[i][0] as boolean === true) {
+ usedRange.getRow(i).getFormat().getFont().setBold(true);
+ } else {
+ usedRange.getRow(i).getFormat().getFont().setBold(false);
+ }
+ } else {
+ usedRange.getRow(i).getFormat().getFont().setItalic(true);
+ }
+ }
+ }
+ ```
+ - name: getValueTypes()
+ uid: 'ExcelScript!ExcelScript.Range#getValueTypes:member(1)'
+ package: ExcelScript!
+ fullName: getValueTypes()
+ summary: Specifies the type of data in each cell.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getValueTypes(): RangeValueType[][];'
+ return:
+ type: '[][]'
+ description: ''
+ - name: getVisibleView()
+ uid: 'ExcelScript!ExcelScript.Range#getVisibleView:member(1)'
+ package: ExcelScript!
+ fullName: getVisibleView()
+ summary: Represents the visible rows of the current range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVisibleView(): RangeView;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script copies values and formatting from the
+ * visible range of a table in Sheet1 into Sheet2.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the filtered data from Sheet1.
+ const currentSheet = workbook.getWorksheet("Sheet1");
+ const table = currentSheet.getTables()[0];
+ const visibleTableRange: ExcelScript.RangeView = table.getRange().getVisibleView();
+ const source = currentSheet.getRanges(visibleTableRange.getCellAddresses().toString());
+
+ // Copy the data into the other sheet.
+ const otherSheet = workbook.getWorksheet("Sheet2");
+ const otherRangeCorner = otherSheet.getRange("A1");
+ otherRangeCorner.copyFrom(source, ExcelScript.RangeCopyType.all);
+ }
+ ```
+ - name: getWidth()
+ uid: 'ExcelScript!ExcelScript.Range#getWidth:member(1)'
+ package: ExcelScript!
+ fullName: getWidth()
+ summary: 'Returns the distance in points, for 100% zoom, from the left edge of the range to the right edge of the range.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWidth(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getWorksheet()
+ uid: 'ExcelScript!ExcelScript.Range#getWorksheet:member(1)'
+ package: ExcelScript!
+ fullName: getWorksheet()
+ summary: The worksheet containing the current range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWorksheet(): Worksheet;'
+ return:
+ type: ''
+ description: ''
+ - name: group(groupOption)
+ uid: 'ExcelScript!ExcelScript.Range#group:member(1)'
+ package: ExcelScript!
+ fullName: group(groupOption)
+ summary: Groups columns and rows for an outline.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'group(groupOption: GroupOption): void;'
+ parameters:
+ - id: groupOption
+ description: >-
+ Specifies how the range can be grouped by rows or columns. An `InvalidArgument` error is thrown when the
+ group option differs from the range's `isEntireRow` or `isEntireColumn` property (i.e., `range.isEntireRow`
+ is true and `groupOption` is "ByColumns" or `range.isEntireColumn` is true and `groupOption` is "ByRows").
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a two-level column-based outline on Sheet1.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Group columns A-F in the worksheet named Sheet1.
+ const sheet = workbook.getWorksheet("Sheet1");
+ const firstLevel = sheet.getRange("A:F");
+ firstLevel.group(ExcelScript.GroupOption.byColumns);
+
+ // Create a second level to the outline by grouping subsections.
+ sheet.getRange("A:B").group(ExcelScript.GroupOption.byColumns);
+ sheet.getRange("D:E").group(ExcelScript.GroupOption.byColumns);
+ }
+ ```
+ - name: hideGroupDetails(groupOption)
+ uid: 'ExcelScript!ExcelScript.Range#hideGroupDetails:member(1)'
+ package: ExcelScript!
+ fullName: hideGroupDetails(groupOption)
+ summary: Hides the details of the row or column group.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'hideGroupDetails(groupOption: GroupOption): void;'
+ parameters:
+ - id: groupOption
+ description: Specifies whether to hide the details of grouped rows or grouped columns.
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: insert(shift)
+ uid: 'ExcelScript!ExcelScript.Range#insert:member(1)'
+ package: ExcelScript!
+ fullName: insert(shift)
+ summary: >-
+ Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make
+ space. Returns a new `Range` object at the now blank space.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'insert(shift: InsertShiftDirection): Range;'
+ parameters:
+ - id: shift
+ description: Specifies which way to shift the cells. See `ExcelScript.InsertShiftDirection` for details.
+ type: ''
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script inserts headers at the top of the worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook)
+ {
+ let currentSheet = workbook.getActiveWorksheet();
+
+ // Create headers for 3 columns.
+ let myHeaders = [["NAME", "ID", "ROLE"]];
+
+ // Add a blank first row and push existing data down a row.
+ let firstRow = currentSheet.getRange("1:1");
+ firstRow.insert(ExcelScript.InsertShiftDirection.down);
+
+ // Add the headers.
+ currentSheet.getRange("A1:C1").setValues(myHeaders);
+ }
+ ```
+ - name: merge(across)
+ uid: 'ExcelScript!ExcelScript.Range#merge:member(1)'
+ package: ExcelScript!
+ fullName: merge(across)
+ summary: Merge the range cells into one region in the worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'merge(across?: boolean): void;'
+ parameters:
+ - id: across
+ description: >-
+ Optional. Set `true` to merge cells in each row of the specified range as separate merged cells. The default
+ value is `false`.
+ type: boolean
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script merges a group of cells into a single region.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the active worksheet.
+ const selectedSheet = workbook.getActiveWorksheet();
+
+ // Merge cells A1 through A4.
+ const range = selectedSheet.getRange("A1:A4");
+ range.merge();
+ }
+ ```
+ - name: moveTo(destinationRange)
+ uid: 'ExcelScript!ExcelScript.Range#moveTo:member(1)'
+ package: ExcelScript!
+ fullName: moveTo(destinationRange)
+ summary: >-
+ Moves cell values, formatting, and formulas from current range to the destination range, replacing the old
+ information in those cells. The destination range will be expanded automatically if it is smaller than the current
+ range. Any cells in the destination range that are outside of the original range's area are not changed.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'moveTo(destinationRange: Range | string): void;'
+ parameters:
+ - id: destinationRange
+ description: destinationRange Specifies the range to where the information in this range will be moved.
+ type: ' | string'
+ return:
+ type: void
+ description: ''
+ - name: 'removeDuplicates(columns, includesHeader)'
+ uid: 'ExcelScript!ExcelScript.Range#removeDuplicates:member(1)'
+ package: ExcelScript!
+ fullName: 'removeDuplicates(columns, includesHeader)'
+ summary: Removes duplicate values from the range specified by the columns.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ removeDuplicates(
+ columns: number[],
+ includesHeader: boolean
+ ): RemoveDuplicatesResult;
+ parameters:
+ - id: columns
+ description: >-
+ The columns inside the range that may contain duplicates. At least one column needs to be specified.
+ Zero-indexed.
+ type: 'number[]'
+ - id: includesHeader
+ description: True if the input data contains header. Default is false.
+ type: boolean
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script removes duplicate rows from a range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the used range of the active worksheet.
+ const usedRange = workbook.getActiveWorksheet().getUsedRange();
+
+ // Remove any row that has a same value in the 0-indexed column as a previous row.
+ const removedResults = usedRange.removeDuplicates([0], true);
+
+ // Log the count of removed rows.
+ console.log(`Rows removed: ${removedResults.getRemoved()}.`);
+ }
+ ```
+ - name: 'replaceAll(text, replacement, criteria)'
+ uid: 'ExcelScript!ExcelScript.Range#replaceAll:member(1)'
+ package: ExcelScript!
+ fullName: 'replaceAll(text, replacement, criteria)'
+ summary: Finds and replaces the given string based on the criteria specified within the current range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ replaceAll(
+ text: string,
+ replacement: string,
+ criteria: ReplaceCriteria
+ ): number;
+ parameters:
+ - id: text
+ description: String to find.
+ type: string
+ - id: replacement
+ description: The string that replaces the original string.
+ type: string
+ - id: criteria
+ description: Additional replacement criteria.
+ type: ''
+ return:
+ type: number
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script searches through a table column and replaces
+ * cells marked "monthly special" with "parsnip".
+ * This script uses Range.replaceAll instead of Worksheet.replaceAll
+ * to limit the search to a specific range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range of a table named "Orders".
+ let table = workbook.getTable("Orders");
+ let range = table.getColumnByName("Vegetable").getRange();
+
+ // Change the value of any cells with the value "monthly special".
+ range.replaceAll("monthly special", "parsnip", {completeMatch: true});
+ }
+ ```
+ - name: select()
+ uid: 'ExcelScript!ExcelScript.Range#select:member(1)'
+ package: ExcelScript!
+ fullName: select()
+ summary: Selects the specified range in the Excel UI.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'select(): void;'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script selects the first row of a table.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table on the current worksheet.
+ const sheet = workbook.getActiveWorksheet()
+ const table = sheet.getTables()[0];
+
+ // Get the first data row in the table.
+ const row = table.getRangeBetweenHeaderAndTotal().getRow(0);
+
+ // Select the first data row.
+ row.select();
+ }
+ ```
+ - name: setColumnHidden(columnHidden)
+ uid: 'ExcelScript!ExcelScript.Range#setColumnHidden:member(1)'
+ package: ExcelScript!
+ fullName: setColumnHidden(columnHidden)
+ summary: >-
+ Represents if all columns in the current range are hidden. Value is `true` when all columns in a range are hidden.
+ Value is `false` when no columns in the range are hidden. Value is `null` when some columns in a range are hidden
+ and other columns in the same range are not hidden.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setColumnHidden(columnHidden: boolean): void;'
+ parameters:
+ - id: columnHidden
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setControl(control)
+ uid: 'ExcelScript!ExcelScript.Range#setControl:member(1)'
+ package: ExcelScript!
+ fullName: setControl(control)
+ summary: >-
+ Accesses the cell control applied to this range. If the range has multiple cell controls, this returns
+ `EmptyCellControl`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setControl(control: CellControl): void;'
+ parameters:
+ - id: control
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setDirty()
+ uid: 'ExcelScript!ExcelScript.Range#setDirty:member(1)'
+ package: ExcelScript!
+ fullName: setDirty()
+ summary: Set a range to be recalculated when the next recalculation occurs.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setDirty(): void;'
+ return:
+ type: void
+ description: ''
+ - name: setFormula(formula)
+ uid: 'ExcelScript!ExcelScript.Range#setFormula:member(1)'
+ package: ExcelScript!
+ fullName: setFormula(formula)
+ summary: >-
+ Sets the cell formula in A1-style notation. If the range contains multiple cells, each cell in the given range
+ will be updated with the input data.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFormula(formula: string): void;'
+ parameters:
+ - id: formula
+ description: ''
+ type: string
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /*
+ * This script sets a cell's formula,
+ * then displays how Excel stores the cell's formula and value separately.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Set A1 to 2.
+ let a1 = selectedSheet.getRange("A1");
+ a1.setValue(2);
+
+ // Set B1 to the formula =(2*A1), which should equal 4.
+ let b1 = selectedSheet.getRange("B1")
+ b1.setFormula("=(2*A1)");
+
+ // Log the current results for `getFormula` and `getValue` at B1.
+ console.log(`B1 - Formula: ${b1.getFormula()} | Value: ${b1.getValue()}`);
+ }
+ ```
+ - name: setFormulaLocal(formulaLocal)
+ uid: 'ExcelScript!ExcelScript.Range#setFormulaLocal:member(1)'
+ package: ExcelScript!
+ fullName: setFormulaLocal(formulaLocal)
+ summary: >-
+ Set the cell formula in A1-style notation, in the user's language and number-formatting locale. For example, the
+ English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If the range contains multiple cells,
+ each cell in the given range will be updated with the input data.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFormulaLocal(formulaLocal: string): void;'
+ parameters:
+ - id: formulaLocal
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setFormulaR1C1(formulaR1C1)
+ uid: 'ExcelScript!ExcelScript.Range#setFormulaR1C1:member(1)'
+ package: ExcelScript!
+ fullName: setFormulaR1C1(formulaR1C1)
+ summary: >-
+ Sets the cell formula in R1C1-style notation. If the range contains multiple cells, each cell in the given range
+ will be updated with the input data.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFormulaR1C1(formulaR1C1: string): void;'
+ parameters:
+ - id: formulaR1C1
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setFormulas(formulas)
+ uid: 'ExcelScript!ExcelScript.Range#setFormulas:member(1)'
+ package: ExcelScript!
+ fullName: setFormulas(formulas)
+ summary: 'Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFormulas(formulas: string[][]): void;'
+ parameters:
+ - id: formulas
+ description: ''
+ type: 'string[][]'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the values of a range, then adds SUM formulas to calculate
+ * the totals for each row of that range.
+ */
+ function main(workbook: ExcelScript.Workbook)
+ {
+ let currentSheet = workbook.getActiveWorksheet();
+
+ // Set the values of a range.
+ let values = [[1, 2, 4], [8, 16, 32], [64, 128, 256]];
+ let valueRange = currentSheet.getRange("A1:C3");
+ valueRange.setValues(values);
+
+ // Set the formulas of a range.
+ let formulas = [["=SUM(A1:C1)"], ["=SUM(A2:C2)"], ["=SUM(A3:C3)"]];
+ let formulaRange = currentSheet.getRange("D1:D3");
+ formulaRange.setFormulas(formulas);
+ }
+ ```
+ - name: setFormulasLocal(formulasLocal)
+ uid: 'ExcelScript!ExcelScript.Range#setFormulasLocal:member(1)'
+ package: ExcelScript!
+ fullName: setFormulasLocal(formulasLocal)
+ summary: >-
+ Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the
+ English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its value is
+ returned instead.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFormulasLocal(formulasLocal: string[][]): void;'
+ parameters:
+ - id: formulasLocal
+ description: ''
+ type: 'string[][]'
+ return:
+ type: void
+ description: ''
+ - name: setFormulasR1C1(formulasR1C1)
+ uid: 'ExcelScript!ExcelScript.Range#setFormulasR1C1:member(1)'
+ package: ExcelScript!
+ fullName: setFormulasR1C1(formulasR1C1)
+ summary: 'Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFormulasR1C1(formulasR1C1: string[][]): void;'
+ parameters:
+ - id: formulasR1C1
+ description: ''
+ type: 'string[][]'
+ return:
+ type: void
+ description: ''
+ - name: setHyperlink(hyperlink)
+ uid: 'ExcelScript!ExcelScript.Range#setHyperlink:member(1)'
+ package: ExcelScript!
+ fullName: setHyperlink(hyperlink)
+ summary: Represents the hyperlink for the current range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setHyperlink(hyperlink: RangeHyperlink): void;'
+ parameters:
+ - id: hyperlink
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script inserts a hyperlink to the first cell of the last worksheet in the workbook.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the active cell.
+ let cell = workbook.getActiveCell();
+
+ // Get the last worksheet in the workbook.
+ // Note that this might be the current sheet if there's only one worksheet.
+ let lastSheet = workbook.getLastWorksheet();
+
+ // Get sheet name.
+ let linkedSheetName = lastSheet.getName();
+ console.log(`Setting hyperlink of ${cell.getAddress()} to the ${linkedSheetName} sheet's A1 cell`);
+
+ // Set the text for the hyperlink.
+ let value = `Click to go to: ${linkedSheetName}`;
+
+ // Create the hyperlink using that cell's value.
+ cell.setHyperlink({
+ textToDisplay: value.toString(),
+ screenTip: `Navigate to ${linkedSheetName}`,
+ documentReference: `${linkedSheetName}!A1`
+ });
+ }
+ ```
+ - name: setNumberFormat(numberFormat)
+ uid: 'ExcelScript!ExcelScript.Range#setNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: setNumberFormat(numberFormat)
+ summary: >-
+ Sets cell Excel number format code for the given range. If the range contains multiple cells, each cell in the
+ given range will be updated with the input data.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setNumberFormat(numberFormat: string): void;'
+ parameters:
+ - id: numberFormat
+ description: ''
+ type: string
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the number format in column C to show the data as a percentage.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ const selectedSheet = workbook.getActiveWorksheet();
+
+ // Set number format for column C to a percentage that rounds to the nearest percentage point.
+ selectedSheet.getRange("C:C").setNumberFormat("0%");
+ }
+ ```
+ - name: setNumberFormatLocal(numberFormatLocal)
+ uid: 'ExcelScript!ExcelScript.Range#setNumberFormatLocal:member(1)'
+ package: ExcelScript!
+ fullName: setNumberFormatLocal(numberFormatLocal)
+ summary: >-
+ Sets cell Excel number format code for the given range, based on the language settings of the user.​ Excel does
+ not perform any language or format coercion when getting or setting the `numberFormatLocal` property. Any returned
+ text uses the locally-formatted strings based on the language specified in the system settings. If the range
+ contains multiple cells, each cell in the given range will be updated with the input data.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setNumberFormatLocal(numberFormatLocal: string): void;'
+ parameters:
+ - id: numberFormatLocal
+ description: ''
+ type: string
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the number format in column D to show the data as a percentage with a decimal.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ const selectedSheet = workbook.getActiveWorksheet();
+
+ // Set number format for column D to a percentage that rounds to the nearest tenth of a percentage.
+ selectedSheet.getRange("D:D").setNumberFormatLocal("0.0%");
+ }
+ ```
+ - name: setNumberFormats(numberFormats)
+ uid: 'ExcelScript!ExcelScript.Range#setNumberFormats:member(1)'
+ package: ExcelScript!
+ fullName: setNumberFormats(numberFormats)
+ summary: Represents Excel's number format code for the given range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setNumberFormats(numberFormats: string[][]): void;'
+ parameters:
+ - id: numberFormats
+ description: ''
+ type: 'string[][]'
+ return:
+ type: void
+ description: ''
+ - name: setNumberFormatsLocal(numberFormatsLocal)
+ uid: 'ExcelScript!ExcelScript.Range#setNumberFormatsLocal:member(1)'
+ package: ExcelScript!
+ fullName: setNumberFormatsLocal(numberFormatsLocal)
+ summary: >-
+ Represents Excel's number format code for the given range, based on the language settings of the user. Excel does
+ not perform any language or format coercion when getting or setting the `numberFormatLocal` property. Any returned
+ text uses the locally-formatted strings based on the language specified in the system settings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setNumberFormatsLocal(numberFormatsLocal: string[][]): void;'
+ parameters:
+ - id: numberFormatsLocal
+ description: ''
+ type: 'string[][]'
+ return:
+ type: void
+ description: ''
+ - name: setPredefinedCellStyle(predefinedCellStyle)
+ uid: 'ExcelScript!ExcelScript.Range#setPredefinedCellStyle:member(1)'
+ package: ExcelScript!
+ fullName: setPredefinedCellStyle(predefinedCellStyle)
+ summary: Represents the style of the current range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPredefinedCellStyle(predefinedCellStyle: string): void;'
+ parameters:
+ - id: predefinedCellStyle
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setRowHidden(rowHidden)
+ uid: 'ExcelScript!ExcelScript.Range#setRowHidden:member(1)'
+ package: ExcelScript!
+ fullName: setRowHidden(rowHidden)
+ summary: >-
+ Represents if all rows in the current range are hidden. Value is `true` when all rows in a range are hidden. Value
+ is `false` when no rows in the range are hidden. Value is `null` when some rows in a range are hidden and other
+ rows in the same range are not hidden.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setRowHidden(rowHidden: boolean): void;'
+ parameters:
+ - id: rowHidden
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setValue(value)
+ uid: 'ExcelScript!ExcelScript.Range#setValue:member(1)'
+ package: ExcelScript!
+ fullName: setValue(value)
+ summary: >-
+ Sets the raw value of the specified range. The data being set could be of type string, number, or a boolean.
+ `null` value will be ignored (not set or overwritten in Excel). If the range contains multiple cells, each cell in
+ the given range will be updated with the input data.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setValue(value: any): void;'
+ parameters:
+ - id: value
+ description: ''
+ type: any
+ return:
+ type: void
+ description: ''
+ - name: setValues(values)
+ uid: 'ExcelScript!ExcelScript.Range#setValues:member(1)'
+ package: ExcelScript!
+ fullName: setValues(values)
+ summary: >-
+ Sets the raw values of the specified range. The data provided could be a string, number, or boolean. If the
+ provided value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a
+ formula.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setValues(values: (string | number | boolean)[][]): void;'
+ parameters:
+ - id: values
+ description: ''
+ type: '(string | number | boolean)[][]'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample inserts some pre-loaded data into a range.
+ * It also shows how to get a range that fits the data.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the active cell.
+ let currentCell = workbook.getActiveCell();
+
+ // Calculate the range needed to fit the given data.
+ let targetRange = currentCell.getResizedRange(DATA.length - 1, DATA[0].length - 1);
+
+ // Set range values to the data.
+ targetRange.setValues(DATA);
+
+ // Autofit the columns so the worksheet is readable.
+ targetRange.getFormat().autofitColumns();
+ }
+
+ /*
+ * This sample's data is in a static 2-dimensional array.
+ * You could also get the input from other ranges or sources.
+ * Note that each row must have the same number of columns to be valid.
+ */
+ const DATA = [
+ ['Date', 'Salesperson', 'Product', 'Amount']
+ , ['3/2/2020', 'Anne', 'Pizza', '$1400']
+ , ['3/2/2020', 'Mariya', 'Pizza', '$1700']
+ , ['3/7/2020', 'Mark', 'Sandwiches', '$1010']
+ , ['3/24/2020', 'Anne', 'Pizza', '$750']
+ , ['3/28/2020', 'Mark', 'Salads', '$510']
+ , ['4/17/2020', 'Laura', 'Salads', '$900']
+ , ['4/17/2020', 'Mariya', 'Salads', '$1600']
+ , ['4/28/2020', 'Laura', 'Sandwiches', '$680']
+ ];
+ ```
+ - name: showCard()
+ uid: 'ExcelScript!ExcelScript.Range#showCard:member(1)'
+ package: ExcelScript!
+ fullName: showCard()
+ summary: Displays the card for an active cell if it has rich value content.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'showCard(): void;'
+ return:
+ type: void
+ description: ''
+ - name: showGroupDetails(groupOption)
+ uid: 'ExcelScript!ExcelScript.Range#showGroupDetails:member(1)'
+ package: ExcelScript!
+ fullName: showGroupDetails(groupOption)
+ summary: Shows the details of the row or column group.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'showGroupDetails(groupOption: GroupOption): void;'
+ parameters:
+ - id: groupOption
+ description: Specifies whether to show the details of grouped rows or grouped columns.
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: ungroup(groupOption)
+ uid: 'ExcelScript!ExcelScript.Range#ungroup:member(1)'
+ package: ExcelScript!
+ fullName: ungroup(groupOption)
+ summary: Ungroups columns and rows for an outline.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'ungroup(groupOption: GroupOption): void;'
+ parameters:
+ - id: groupOption
+ description: Specifies how the range can be ungrouped by rows or columns.
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: unmerge()
+ uid: 'ExcelScript!ExcelScript.Range#unmerge:member(1)'
+ package: ExcelScript!
+ fullName: unmerge()
+ summary: Unmerge the range cells into separate cells.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'unmerge(): void;'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script unmerges every used cell in the current worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the active worksheet.
+ const selectedSheet = workbook.getActiveWorksheet();
+
+ // Separate all regions into single cells in the currently used range.
+ const range = selectedSheet.getUsedRange();
+ range.unmerge();
+ }
+ ```
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.rangeareas.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.rangeareas.yml
index 4a8cd0d8..062ca91c 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.rangeareas.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.rangeareas.yml
@@ -1,587 +1,604 @@
-### YamlMime:TSType
-name: ExcelScript.RangeAreas
-uid: 'ExcelScript!ExcelScript.RangeAreas:interface'
-package: ExcelScript!
-fullName: ExcelScript.RangeAreas
-summary: '`RangeAreas` represents a collection of one or more rectangular ranges in the same worksheet.'
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script clears all the cells in the current worksheet that are displaying errors.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the used range on the current sheet.
- const currentSheet = workbook.getActiveWorksheet();
- const usedRange = currentSheet.getUsedRange();
-
- // Get the RangeAreas object for each cell with a formula error.
- const errorCells = usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas, ExcelScript.SpecialCellValueType.errors);
-
- // If there are any error cells, clear them.
- if (errorCells) {
- errorCells.clear();
- }
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: addConditionalFormat(type)
- uid: 'ExcelScript!ExcelScript.RangeAreas#addConditionalFormat:member(1)'
- package: ExcelScript!
- fullName: addConditionalFormat(type)
- summary: Adds a new conditional format to the collection at the first/top priority.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addConditionalFormat(type: ConditionalFormatType): ConditionalFormat;'
- parameters:
- - id: type
- description: The type of conditional format being added. See `ExcelScript.ConditionalFormatType` for details.
- type: ''
- return:
- type: ''
- description: ''
- - name: calculate()
- uid: 'ExcelScript!ExcelScript.RangeAreas#calculate:member(1)'
- package: ExcelScript!
- fullName: calculate()
- summary: Calculates all cells in the `RangeAreas`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'calculate(): void;'
- return:
- type: void
- description: ''
- - name: clear(applyTo)
- uid: 'ExcelScript!ExcelScript.RangeAreas#clear:member(1)'
- package: ExcelScript!
- fullName: clear(applyTo)
- summary: >-
- Clears values, format, fill, border, and other properties on each of the areas that comprise this `RangeAreas`
- object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'clear(applyTo?: ClearApplyTo): void;'
- parameters:
- - id: applyTo
- description: Optional. Determines the type of clear action. See `ExcelScript.ClearApplyTo` for details. Default is "All".
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script clears all the cells in the current worksheet that are displaying errors.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the used range on the current sheet.
- const currentSheet = workbook.getActiveWorksheet();
- const usedRange = currentSheet.getUsedRange();
-
- // Get the RangeAreas object for each cell with a formula error.
- const errorCells = usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas, ExcelScript.SpecialCellValueType.errors);
-
- // If there are any error cells, clear them.
- if (errorCells) {
- errorCells.clear();
- }
- }
- ```
- - name: clearAllConditionalFormats()
- uid: 'ExcelScript!ExcelScript.RangeAreas#clearAllConditionalFormats:member(1)'
- package: ExcelScript!
- fullName: clearAllConditionalFormats()
- summary: Clears all conditional formats active on the current specified range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'clearAllConditionalFormats(): void;'
- return:
- type: void
- description: ''
- - name: convertDataTypeToText()
- uid: 'ExcelScript!ExcelScript.RangeAreas#convertDataTypeToText:member(1)'
- package: ExcelScript!
- fullName: convertDataTypeToText()
- summary: Converts all cells in the `RangeAreas` with data types into text.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'convertDataTypeToText(): void;'
- return:
- type: void
- description: ''
- - name: 'copyFrom(sourceRange, copyType, skipBlanks, transpose)'
- uid: 'ExcelScript!ExcelScript.RangeAreas#copyFrom:member(1)'
- package: ExcelScript!
- fullName: 'copyFrom(sourceRange, copyType, skipBlanks, transpose)'
- summary: >-
- Copies cell data or formatting from the source range or `RangeAreas` to the current `RangeAreas`. The
- destination `RangeAreas` can be a different size than the source range or `RangeAreas`. The destination
- will be expanded automatically if it is smaller than the source.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- copyFrom(
- sourceRange: Range | RangeAreas | string,
- copyType?: RangeCopyType,
- skipBlanks?: boolean,
- transpose?: boolean
- ): void;
- parameters:
- - id: sourceRange
- description: >-
- The source range or `RangeAreas` to copy from. When the source `RangeAreas` has multiple ranges, their form
- must able to be created by removing full rows or columns from a rectangular range.
- type: >-
- | | string
- - id: copyType
- description: The type of cell data or formatting to copy over. Default is "All".
- type: ''
- - id: skipBlanks
- description: True if to skip blank cells in the source range or `RangeAreas`. Default is false.
- type: boolean
- - id: transpose
- description: True if to transpose the cells in the destination `RangeAreas`. Default is false.
- type: boolean
- return:
- type: void
- description: ''
- - name: getAddress()
- uid: 'ExcelScript!ExcelScript.RangeAreas#getAddress:member(1)'
- package: ExcelScript!
- fullName: getAddress()
- summary: >-
- Returns the `RangeAreas` reference in A1-style. Address value will contain the worksheet name for each rectangular
- block of cells (e.g., "Sheet1!A1:B4, Sheet1!D1:D4").
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAddress(): string;'
- return:
- type: string
- description: ''
- - name: getAddressLocal()
- uid: 'ExcelScript!ExcelScript.RangeAreas#getAddressLocal:member(1)'
- package: ExcelScript!
- fullName: getAddressLocal()
- summary: Returns the `RangeAreas` reference in the user locale.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAddressLocal(): string;'
- return:
- type: string
- description: ''
- - name: getAreaCount()
- uid: 'ExcelScript!ExcelScript.RangeAreas#getAreaCount:member(1)'
- package: ExcelScript!
- fullName: getAreaCount()
- summary: Returns the number of rectangular ranges that comprise this `RangeAreas` object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAreaCount(): number;'
- return:
- type: number
- description: ''
- - name: getAreas()
- uid: 'ExcelScript!ExcelScript.RangeAreas#getAreas:member(1)'
- package: ExcelScript!
- fullName: getAreas()
- summary: Returns a collection of rectangular ranges that comprise this `RangeAreas` object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAreas(): Range[];'
- return:
- type: '[]'
- description: ''
- - name: getCellCount()
- uid: 'ExcelScript!ExcelScript.RangeAreas#getCellCount:member(1)'
- package: ExcelScript!
- fullName: getCellCount()
- summary: >-
- Returns the number of cells in the `RangeAreas` object, summing up the cell counts of all of the individual
- rectangular ranges. Returns -1 if the cell count exceeds 2^31-1 (2,147,483,647).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCellCount(): number;'
- return:
- type: number
- description: ''
- - name: getConditionalFormat(id)
- uid: 'ExcelScript!ExcelScript.RangeAreas#getConditionalFormat:member(1)'
- package: ExcelScript!
- fullName: getConditionalFormat(id)
- summary: >-
- Returns a conditional format identified by its ID. If the conditional format object does not exist, then this
- method returns `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getConditionalFormat(id: string): ConditionalFormat | undefined;'
- parameters:
- - id: id
- description: The ID of the conditional format.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getConditionalFormats()
- uid: 'ExcelScript!ExcelScript.RangeAreas#getConditionalFormats:member(1)'
- package: ExcelScript!
- fullName: getConditionalFormats()
- summary: Returns a collection of conditional formats that intersect with any cells in this `RangeAreas` object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getConditionalFormats(): ConditionalFormat[];'
- return:
- type: '[]'
- description: ''
- - name: getDataValidation()
- uid: 'ExcelScript!ExcelScript.RangeAreas#getDataValidation:member(1)'
- package: ExcelScript!
- fullName: getDataValidation()
- summary: Returns a data validation object for all ranges in the `RangeAreas`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDataValidation(): DataValidation;'
- return:
- type: ''
- description: ''
- - name: getEntireColumn()
- uid: 'ExcelScript!ExcelScript.RangeAreas#getEntireColumn:member(1)'
- package: ExcelScript!
- fullName: getEntireColumn()
- summary: >-
- Returns a `RangeAreas` object that represents the entire columns of the `RangeAreas` (for example, if the current
- `RangeAreas` represents cells "B4:E11, H2", it returns a `RangeAreas` that represents columns "B:E, H:H").
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getEntireColumn(): RangeAreas;'
- return:
- type: ''
- description: ''
- - name: getEntireRow()
- uid: 'ExcelScript!ExcelScript.RangeAreas#getEntireRow:member(1)'
- package: ExcelScript!
- fullName: getEntireRow()
- summary: >-
- Returns a `RangeAreas` object that represents the entire rows of the `RangeAreas` (for example, if the current
- `RangeAreas` represents cells "B4:E11", it returns a `RangeAreas` that represents rows "4:11").
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getEntireRow(): RangeAreas;'
- return:
- type: ''
- description: ''
- - name: getFormat()
- uid: 'ExcelScript!ExcelScript.RangeAreas#getFormat:member(1)'
- package: ExcelScript!
- fullName: getFormat()
- summary: >-
- Returns a `RangeFormat` object, encapsulating the font, fill, borders, alignment, and other properties for all
- ranges in the `RangeAreas` object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormat(): RangeFormat;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script finds and highlights all the cells in the current worksheet that contain a formula.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the used range on the current sheet.
- const currentSheet = workbook.getActiveWorksheet();
- const usedRange = currentSheet.getUsedRange();
-
- // Get the RangeAreas object for each cell with a formula.
- const formulaCells = usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas);
-
- // Add a light blue background to the cells containing formulas.
- formulaCells.getFormat().getFill().setColor("#ADD8E6");
- }
- ```
- - name: getIntersection(anotherRange)
- uid: 'ExcelScript!ExcelScript.RangeAreas#getIntersection:member(1)'
- package: ExcelScript!
- fullName: getIntersection(anotherRange)
- summary: >-
- Returns the `RangeAreas` object that represents the intersection of the given ranges or `RangeAreas`. If
- no intersection is found, then this method returns `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIntersection(anotherRange: Range | RangeAreas | string): RangeAreas;'
- parameters:
- - id: anotherRange
- description: 'The range, `RangeAreas` object, or address that will be used to determine the intersection.'
- type: >-
- | | string
- return:
- type: ''
- description: ''
- - name: getIsEntireColumn()
- uid: 'ExcelScript!ExcelScript.RangeAreas#getIsEntireColumn:member(1)'
- package: ExcelScript!
- fullName: getIsEntireColumn()
- summary: 'Specifies if all the ranges on this `RangeAreas` object represent entire columns (e.g., "A:C, Q:Z").'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIsEntireColumn(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getIsEntireRow()
- uid: 'ExcelScript!ExcelScript.RangeAreas#getIsEntireRow:member(1)'
- package: ExcelScript!
- fullName: getIsEntireRow()
- summary: 'Specifies if all the ranges on this `RangeAreas` object represent entire rows (e.g., "1:3, 5:7").'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIsEntireRow(): boolean;'
- return:
- type: boolean
- description: ''
- - name: 'getOffsetRangeAreas(rowOffset, columnOffset)'
- uid: 'ExcelScript!ExcelScript.RangeAreas#getOffsetRangeAreas:member(1)'
- package: ExcelScript!
- fullName: 'getOffsetRangeAreas(rowOffset, columnOffset)'
- summary: >-
- Returns a `RangeAreas` object that is shifted by the specific row and column offset. The dimension of the returned
- `RangeAreas` will match the original object. If the resulting `RangeAreas` is forced outside the bounds of the
- worksheet grid, an error will be thrown.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- getOffsetRangeAreas(
- rowOffset: number,
- columnOffset: number
- ): RangeAreas;
- parameters:
- - id: rowOffset
- description: >-
- The number of rows (positive, negative, or 0) by which the `RangeAreas` is to be offset. Positive values are
- offset downward, and negative values are offset upward.
- type: number
- - id: columnOffset
- description: >-
- The number of columns (positive, negative, or 0) by which the `RangeAreas` is to be offset. Positive values
- are offset to the right, and negative values are offset to the left.
- type: number
- return:
- type: ''
- description: ''
- - name: getPredefinedCellStyle()
- uid: 'ExcelScript!ExcelScript.RangeAreas#getPredefinedCellStyle:member(1)'
- package: ExcelScript!
- fullName: getPredefinedCellStyle()
- summary: >-
- Represents the style for all ranges in this `RangeAreas` object. If the styles of the cells are inconsistent,
- `null` will be returned. For custom styles, the style name will be returned. For built-in styles, a string
- representing a value in the `BuiltInStyle` enum will be returned.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPredefinedCellStyle(): string;'
- return:
- type: string
- description: ''
- - name: 'getSpecialCells(cellType, cellValueType)'
- uid: 'ExcelScript!ExcelScript.RangeAreas#getSpecialCells:member(1)'
- package: ExcelScript!
- fullName: 'getSpecialCells(cellType, cellValueType)'
- summary: >-
- Returns a `RangeAreas` object that represents all the cells that match the specified type and value. If no special
- cells are found that match the criteria, then this method returns `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- getSpecialCells(
- cellType: SpecialCellType,
- cellValueType?: SpecialCellValueType
- ): RangeAreas;
- parameters:
- - id: cellType
- description: The type of cells to include.
- type: ''
- - id: cellValueType
- description: >-
- If `cellType` is either `constants` or `formulas`, this argument is used to determine which types of
- cells to include in the result. These values can be combined together to return more than one type. The
- default is to select all constants or formulas, no matter what the type.
- type: ''
- return:
- type: ''
- description: ''
- - name: getTables(fullyContained)
- uid: 'ExcelScript!ExcelScript.RangeAreas#getTables:member(1)'
- package: ExcelScript!
- fullName: getTables(fullyContained)
- summary: Returns a scoped collection of tables that overlap with any range in this `RangeAreas` object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTables(fullyContained?: boolean): Table[];'
- parameters:
- - id: fullyContained
- description: >-
- If `true`, returns only tables that are fully contained within the range bounds. Default is
- `false`.
- type: boolean
- return:
- type: '[]'
- description: ''
- - name: getUsedRangeAreas(valuesOnly)
- uid: 'ExcelScript!ExcelScript.RangeAreas#getUsedRangeAreas:member(1)'
- package: ExcelScript!
- fullName: getUsedRangeAreas(valuesOnly)
- summary: >-
- Returns the used `RangeAreas` that comprises all the used areas of individual rectangular ranges in the
- `RangeAreas` object. If there are no used cells within the `RangeAreas`, then this method returns
- `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getUsedRangeAreas(valuesOnly?: boolean): RangeAreas;'
- parameters:
- - id: valuesOnly
- description: Whether to only consider cells with values as used cells.
- type: boolean
- return:
- type: ''
- description: ''
- - name: getWorksheet()
- uid: 'ExcelScript!ExcelScript.RangeAreas#getWorksheet:member(1)'
- package: ExcelScript!
- fullName: getWorksheet()
- summary: Returns the worksheet for the current `RangeAreas`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWorksheet(): Worksheet;'
- return:
- type: ''
- description: ''
- - name: setDirty()
- uid: 'ExcelScript!ExcelScript.RangeAreas#setDirty:member(1)'
- package: ExcelScript!
- fullName: setDirty()
- summary: Sets the `RangeAreas` to be recalculated when the next recalculation occurs.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setDirty(): void;'
- return:
- type: void
- description: ''
- - name: setPredefinedCellStyle(predefinedCellStyle)
- uid: 'ExcelScript!ExcelScript.RangeAreas#setPredefinedCellStyle:member(1)'
- package: ExcelScript!
- fullName: setPredefinedCellStyle(predefinedCellStyle)
- summary: >-
- Represents the style for all ranges in this `RangeAreas` object. If the styles of the cells are inconsistent,
- `null` will be returned. For custom styles, the style name will be returned. For built-in styles, a string
- representing a value in the `BuiltInStyle` enum will be returned.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPredefinedCellStyle(predefinedCellStyle: string): void;'
- parameters:
- - id: predefinedCellStyle
- description: ''
- type: string
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the cell style to "warning text"
- * on every cell with a formula error.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the used range in the current worksheet.
- const sheet = workbook.getActiveWorksheet();
- const usedRange = sheet.getUsedRange();
-
- // Get any cells that are displaying errors.
- const errorCells = usedRange.getSpecialCells(
- ExcelScript.SpecialCellType.formulas,
- ExcelScript.SpecialCellValueType.errors
- );
-
- // Check if there are error cells before proceeding.
- if (errorCells) {
- // Use the built-in warning text style on the error cells.
- errorCells.setPredefinedCellStyle(
- ExcelScript.BuiltInStyle.warningText.toString()
- );
- } else {
- console.log("No formula errors in the worksheet.");
- }
- }
- ```
+### YamlMime:TSType
+name: ExcelScript.RangeAreas
+uid: 'ExcelScript!ExcelScript.RangeAreas:interface'
+package: ExcelScript!
+fullName: ExcelScript.RangeAreas
+summary: '`RangeAreas` represents a collection of one or more rectangular ranges in the same worksheet.'
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script clears all the cells in the current worksheet that are displaying errors.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the used range on the current sheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const usedRange = currentSheet.getUsedRange();
+
+ // Get the RangeAreas object for each cell with a formula error.
+ const errorCells = usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas, ExcelScript.SpecialCellValueType.errors);
+
+ // If there are any error cells, clear them.
+ if (errorCells) {
+ errorCells.clear();
+ }
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: addConditionalFormat(type)
+ uid: 'ExcelScript!ExcelScript.RangeAreas#addConditionalFormat:member(1)'
+ package: ExcelScript!
+ fullName: addConditionalFormat(type)
+ summary: Adds a new conditional format to the collection at the first/top priority.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addConditionalFormat(type: ConditionalFormatType): ConditionalFormat;'
+ parameters:
+ - id: type
+ description: The type of conditional format being added. See `ExcelScript.ConditionalFormatType` for details.
+ type: ''
+ return:
+ type: ''
+ description: ''
+ - name: calculate()
+ uid: 'ExcelScript!ExcelScript.RangeAreas#calculate:member(1)'
+ package: ExcelScript!
+ fullName: calculate()
+ summary: Calculates all cells in the `RangeAreas`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'calculate(): void;'
+ return:
+ type: void
+ description: ''
+ - name: clear(applyTo)
+ uid: 'ExcelScript!ExcelScript.RangeAreas#clear:member(1)'
+ package: ExcelScript!
+ fullName: clear(applyTo)
+ summary: >-
+ Clears values, format, fill, border, and other properties on each of the areas that comprise this `RangeAreas`
+ object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clear(applyTo?: ClearApplyTo): void;'
+ parameters:
+ - id: applyTo
+ description: Optional. Determines the type of clear action. See `ExcelScript.ClearApplyTo` for details. Default is "All".
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script clears all the cells in the current worksheet that are displaying errors.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the used range on the current sheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const usedRange = currentSheet.getUsedRange();
+
+ // Get the RangeAreas object for each cell with a formula error.
+ const errorCells = usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas, ExcelScript.SpecialCellValueType.errors);
+
+ // If there are any error cells, clear them.
+ if (errorCells) {
+ errorCells.clear();
+ }
+ }
+ ```
+ - name: clearAllConditionalFormats()
+ uid: 'ExcelScript!ExcelScript.RangeAreas#clearAllConditionalFormats:member(1)'
+ package: ExcelScript!
+ fullName: clearAllConditionalFormats()
+ summary: Clears all conditional formats active on the current specified range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clearAllConditionalFormats(): void;'
+ return:
+ type: void
+ description: ''
+ - name: clearOrResetContents()
+ uid: 'ExcelScript!ExcelScript.RangeAreas#clearOrResetContents:member(1)'
+ package: ExcelScript!
+ fullName: clearOrResetContents()
+ summary: >-
+ Clears the values of the cells in the ranges, with special consideration given to cells containing controls. If
+ the ranges contain only blank values and controls set to their default value, then the values and control
+ formatting are removed. Otherwise, this sets the cells with controls to their default value and clears the values
+ of the other cells in the ranges.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clearOrResetContents(): void;'
+ return:
+ type: void
+ description: ''
+ - name: convertDataTypeToText()
+ uid: 'ExcelScript!ExcelScript.RangeAreas#convertDataTypeToText:member(1)'
+ package: ExcelScript!
+ fullName: convertDataTypeToText()
+ summary: Converts all cells in the `RangeAreas` with data types into text.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'convertDataTypeToText(): void;'
+ return:
+ type: void
+ description: ''
+ - name: 'copyFrom(sourceRange, copyType, skipBlanks, transpose)'
+ uid: 'ExcelScript!ExcelScript.RangeAreas#copyFrom:member(1)'
+ package: ExcelScript!
+ fullName: 'copyFrom(sourceRange, copyType, skipBlanks, transpose)'
+ summary: >-
+ Copies cell data or formatting from the source range or `RangeAreas` to the current `RangeAreas`. The
+ destination `RangeAreas` can be a different size than the source range or `RangeAreas`. The destination
+ will be expanded automatically if it is smaller than the source.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ copyFrom(
+ sourceRange: Range | RangeAreas | string,
+ copyType?: RangeCopyType,
+ skipBlanks?: boolean,
+ transpose?: boolean
+ ): void;
+ parameters:
+ - id: sourceRange
+ description: >-
+ The source range or `RangeAreas` to copy from. When the source `RangeAreas` has multiple ranges, their form
+ must able to be created by removing full rows or columns from a rectangular range.
+ type: >-
+ | | string
+ - id: copyType
+ description: The type of cell data or formatting to copy over. Default is "All".
+ type: ''
+ - id: skipBlanks
+ description: True if to skip blank cells in the source range or `RangeAreas`. Default is false.
+ type: boolean
+ - id: transpose
+ description: True if to transpose the cells in the destination `RangeAreas`. Default is false.
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: getAddress()
+ uid: 'ExcelScript!ExcelScript.RangeAreas#getAddress:member(1)'
+ package: ExcelScript!
+ fullName: getAddress()
+ summary: >-
+ Returns the `RangeAreas` reference in A1-style. Address value will contain the worksheet name for each rectangular
+ block of cells (e.g., "Sheet1!A1:B4, Sheet1!D1:D4").
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAddress(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getAddressLocal()
+ uid: 'ExcelScript!ExcelScript.RangeAreas#getAddressLocal:member(1)'
+ package: ExcelScript!
+ fullName: getAddressLocal()
+ summary: Returns the `RangeAreas` reference in the user locale.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAddressLocal(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getAreaCount()
+ uid: 'ExcelScript!ExcelScript.RangeAreas#getAreaCount:member(1)'
+ package: ExcelScript!
+ fullName: getAreaCount()
+ summary: Returns the number of rectangular ranges that comprise this `RangeAreas` object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAreaCount(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getAreas()
+ uid: 'ExcelScript!ExcelScript.RangeAreas#getAreas:member(1)'
+ package: ExcelScript!
+ fullName: getAreas()
+ summary: Returns a collection of rectangular ranges that comprise this `RangeAreas` object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAreas(): Range[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getCellCount()
+ uid: 'ExcelScript!ExcelScript.RangeAreas#getCellCount:member(1)'
+ package: ExcelScript!
+ fullName: getCellCount()
+ summary: >-
+ Returns the number of cells in the `RangeAreas` object, summing up the cell counts of all of the individual
+ rectangular ranges. Returns -1 if the cell count exceeds 2^31-1 (2,147,483,647).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCellCount(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getConditionalFormat(id)
+ uid: 'ExcelScript!ExcelScript.RangeAreas#getConditionalFormat:member(1)'
+ package: ExcelScript!
+ fullName: getConditionalFormat(id)
+ summary: >-
+ Returns a conditional format identified by its ID. If the conditional format object does not exist, then this
+ method returns `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getConditionalFormat(id: string): ConditionalFormat | undefined;'
+ parameters:
+ - id: id
+ description: The ID of the conditional format.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getConditionalFormats()
+ uid: 'ExcelScript!ExcelScript.RangeAreas#getConditionalFormats:member(1)'
+ package: ExcelScript!
+ fullName: getConditionalFormats()
+ summary: Returns a collection of conditional formats that intersect with any cells in this `RangeAreas` object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getConditionalFormats(): ConditionalFormat[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getDataValidation()
+ uid: 'ExcelScript!ExcelScript.RangeAreas#getDataValidation:member(1)'
+ package: ExcelScript!
+ fullName: getDataValidation()
+ summary: Returns a data validation object for all ranges in the `RangeAreas`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDataValidation(): DataValidation;'
+ return:
+ type: ''
+ description: ''
+ - name: getEntireColumn()
+ uid: 'ExcelScript!ExcelScript.RangeAreas#getEntireColumn:member(1)'
+ package: ExcelScript!
+ fullName: getEntireColumn()
+ summary: >-
+ Returns a `RangeAreas` object that represents the entire columns of the `RangeAreas` (for example, if the current
+ `RangeAreas` represents cells "B4:E11, H2", it returns a `RangeAreas` that represents columns "B:E, H:H").
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getEntireColumn(): RangeAreas;'
+ return:
+ type: ''
+ description: ''
+ - name: getEntireRow()
+ uid: 'ExcelScript!ExcelScript.RangeAreas#getEntireRow:member(1)'
+ package: ExcelScript!
+ fullName: getEntireRow()
+ summary: >-
+ Returns a `RangeAreas` object that represents the entire rows of the `RangeAreas` (for example, if the current
+ `RangeAreas` represents cells "B4:E11", it returns a `RangeAreas` that represents rows "4:11").
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getEntireRow(): RangeAreas;'
+ return:
+ type: ''
+ description: ''
+ - name: getFormat()
+ uid: 'ExcelScript!ExcelScript.RangeAreas#getFormat:member(1)'
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: >-
+ Returns a `RangeFormat` object, encapsulating the font, fill, borders, alignment, and other properties for all
+ ranges in the `RangeAreas` object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): RangeFormat;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script finds and highlights all the cells in the current worksheet that contain a formula.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the used range on the current sheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const usedRange = currentSheet.getUsedRange();
+
+ // Get the RangeAreas object for each cell with a formula.
+ const formulaCells = usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas);
+
+ // Add a light blue background to the cells containing formulas.
+ formulaCells.getFormat().getFill().setColor("#ADD8E6");
+ }
+ ```
+ - name: getIntersection(anotherRange)
+ uid: 'ExcelScript!ExcelScript.RangeAreas#getIntersection:member(1)'
+ package: ExcelScript!
+ fullName: getIntersection(anotherRange)
+ summary: >-
+ Returns the `RangeAreas` object that represents the intersection of the given ranges or `RangeAreas`. If
+ no intersection is found, then this method returns `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIntersection(anotherRange: Range | RangeAreas | string): RangeAreas;'
+ parameters:
+ - id: anotherRange
+ description: 'The range, `RangeAreas` object, or address that will be used to determine the intersection.'
+ type: >-
+ | | string
+ return:
+ type: ''
+ description: ''
+ - name: getIsEntireColumn()
+ uid: 'ExcelScript!ExcelScript.RangeAreas#getIsEntireColumn:member(1)'
+ package: ExcelScript!
+ fullName: getIsEntireColumn()
+ summary: 'Specifies if all the ranges on this `RangeAreas` object represent entire columns (e.g., "A:C, Q:Z").'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIsEntireColumn(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getIsEntireRow()
+ uid: 'ExcelScript!ExcelScript.RangeAreas#getIsEntireRow:member(1)'
+ package: ExcelScript!
+ fullName: getIsEntireRow()
+ summary: 'Specifies if all the ranges on this `RangeAreas` object represent entire rows (e.g., "1:3, 5:7").'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIsEntireRow(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: 'getOffsetRangeAreas(rowOffset, columnOffset)'
+ uid: 'ExcelScript!ExcelScript.RangeAreas#getOffsetRangeAreas:member(1)'
+ package: ExcelScript!
+ fullName: 'getOffsetRangeAreas(rowOffset, columnOffset)'
+ summary: >-
+ Returns a `RangeAreas` object that is shifted by the specific row and column offset. The dimension of the returned
+ `RangeAreas` will match the original object. If the resulting `RangeAreas` is forced outside the bounds of the
+ worksheet grid, an error will be thrown.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ getOffsetRangeAreas(
+ rowOffset: number,
+ columnOffset: number
+ ): RangeAreas;
+ parameters:
+ - id: rowOffset
+ description: >-
+ The number of rows (positive, negative, or 0) by which the `RangeAreas` is to be offset. Positive values are
+ offset downward, and negative values are offset upward.
+ type: number
+ - id: columnOffset
+ description: >-
+ The number of columns (positive, negative, or 0) by which the `RangeAreas` is to be offset. Positive values
+ are offset to the right, and negative values are offset to the left.
+ type: number
+ return:
+ type: ''
+ description: ''
+ - name: getPredefinedCellStyle()
+ uid: 'ExcelScript!ExcelScript.RangeAreas#getPredefinedCellStyle:member(1)'
+ package: ExcelScript!
+ fullName: getPredefinedCellStyle()
+ summary: >-
+ Represents the style for all ranges in this `RangeAreas` object. If the styles of the cells are inconsistent,
+ `null` will be returned. For custom styles, the style name will be returned. For built-in styles, a string
+ representing a value in the `BuiltInStyle` enum will be returned.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPredefinedCellStyle(): string;'
+ return:
+ type: string
+ description: ''
+ - name: 'getSpecialCells(cellType, cellValueType)'
+ uid: 'ExcelScript!ExcelScript.RangeAreas#getSpecialCells:member(1)'
+ package: ExcelScript!
+ fullName: 'getSpecialCells(cellType, cellValueType)'
+ summary: >-
+ Returns a `RangeAreas` object that represents all the cells that match the specified type and value. If no special
+ cells are found that match the criteria, then this method returns `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ getSpecialCells(
+ cellType: SpecialCellType,
+ cellValueType?: SpecialCellValueType
+ ): RangeAreas;
+ parameters:
+ - id: cellType
+ description: The type of cells to include.
+ type: ''
+ - id: cellValueType
+ description: >-
+ If `cellType` is either `constants` or `formulas`, this argument is used to determine which types of
+ cells to include in the result. These values can be combined together to return more than one type. The
+ default is to select all constants or formulas, no matter what the type.
+ type: ''
+ return:
+ type: ''
+ description: ''
+ - name: getTables(fullyContained)
+ uid: 'ExcelScript!ExcelScript.RangeAreas#getTables:member(1)'
+ package: ExcelScript!
+ fullName: getTables(fullyContained)
+ summary: Returns a scoped collection of tables that overlap with any range in this `RangeAreas` object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTables(fullyContained?: boolean): Table[];'
+ parameters:
+ - id: fullyContained
+ description: >-
+ If `true`, returns only tables that are fully contained within the range bounds. Default is
+ `false`.
+ type: boolean
+ return:
+ type: '[]'
+ description: ''
+ - name: getUsedRangeAreas(valuesOnly)
+ uid: 'ExcelScript!ExcelScript.RangeAreas#getUsedRangeAreas:member(1)'
+ package: ExcelScript!
+ fullName: getUsedRangeAreas(valuesOnly)
+ summary: >-
+ Returns the used `RangeAreas` that comprises all the used areas of individual rectangular ranges in the
+ `RangeAreas` object. If there are no used cells within the `RangeAreas`, then this method returns
+ `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getUsedRangeAreas(valuesOnly?: boolean): RangeAreas;'
+ parameters:
+ - id: valuesOnly
+ description: Whether to only consider cells with values as used cells.
+ type: boolean
+ return:
+ type: ''
+ description: ''
+ - name: getWorksheet()
+ uid: 'ExcelScript!ExcelScript.RangeAreas#getWorksheet:member(1)'
+ package: ExcelScript!
+ fullName: getWorksheet()
+ summary: Returns the worksheet for the current `RangeAreas`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWorksheet(): Worksheet;'
+ return:
+ type: ''
+ description: ''
+ - name: setDirty()
+ uid: 'ExcelScript!ExcelScript.RangeAreas#setDirty:member(1)'
+ package: ExcelScript!
+ fullName: setDirty()
+ summary: Sets the `RangeAreas` to be recalculated when the next recalculation occurs.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setDirty(): void;'
+ return:
+ type: void
+ description: ''
+ - name: setPredefinedCellStyle(predefinedCellStyle)
+ uid: 'ExcelScript!ExcelScript.RangeAreas#setPredefinedCellStyle:member(1)'
+ package: ExcelScript!
+ fullName: setPredefinedCellStyle(predefinedCellStyle)
+ summary: >-
+ Represents the style for all ranges in this `RangeAreas` object. If the styles of the cells are inconsistent,
+ `null` will be returned. For custom styles, the style name will be returned. For built-in styles, a string
+ representing a value in the `BuiltInStyle` enum will be returned.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPredefinedCellStyle(predefinedCellStyle: string): void;'
+ parameters:
+ - id: predefinedCellStyle
+ description: ''
+ type: string
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the cell style to "warning text"
+ * on every cell with a formula error.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the used range in the current worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const usedRange = sheet.getUsedRange();
+
+ // Get any cells that are displaying errors.
+ const errorCells = usedRange.getSpecialCells(
+ ExcelScript.SpecialCellType.formulas,
+ ExcelScript.SpecialCellValueType.errors
+ );
+
+ // Check if there are error cells before proceeding.
+ if (errorCells) {
+ // Use the built-in warning text style on the error cells.
+ errorCells.setPredefinedCellStyle(
+ ExcelScript.BuiltInStyle.warningText.toString()
+ );
+ } else {
+ console.log("No formula errors in the worksheet.");
+ }
+ }
+ ```
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.rangeborder.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.rangeborder.yml
index 95aade86..1598a6f3 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.rangeborder.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.rangeborder.yml
@@ -1,210 +1,210 @@
-### YamlMime:TSType
-name: ExcelScript.RangeBorder
-uid: 'ExcelScript!ExcelScript.RangeBorder:interface'
-package: ExcelScript!
-fullName: ExcelScript.RangeBorder
-summary: Represents the border of an object.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getColor()
- uid: 'ExcelScript!ExcelScript.RangeBorder#getColor:member(1)'
- package: ExcelScript!
- fullName: getColor()
- summary: >-
- HTML color code representing the color of the border line, in the form \#RRGGBB (e.g., "FFA500"), or as a named
- HTML color (e.g., "orange").
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColor(): string;'
- return:
- type: string
- description: ''
- - name: getSideIndex()
- uid: 'ExcelScript!ExcelScript.RangeBorder#getSideIndex:member(1)'
- package: ExcelScript!
- fullName: getSideIndex()
- summary: Constant value that indicates the specific side of the border. See `ExcelScript.BorderIndex` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSideIndex(): BorderIndex;'
- return:
- type: ''
- description: ''
- - name: getStyle()
- uid: 'ExcelScript!ExcelScript.RangeBorder#getStyle:member(1)'
- package: ExcelScript!
- fullName: getStyle()
- summary: >-
- One of the constants of line style specifying the line style for the border. See `ExcelScript.BorderLineStyle` for
- details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getStyle(): BorderLineStyle;'
- return:
- type: ''
- description: ''
- - name: getTintAndShade()
- uid: 'ExcelScript!ExcelScript.RangeBorder#getTintAndShade:member(1)'
- package: ExcelScript!
- fullName: getTintAndShade()
- summary: >-
- Specifies a double that lightens or darkens a color for the range border, the value is between -1 (darkest) and 1
- (brightest), with 0 for the original color. A `null` value indicates that the border doesn't have a uniform
- `tintAndShade` setting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTintAndShade(): number;'
- return:
- type: number
- description: ''
- - name: getWeight()
- uid: 'ExcelScript!ExcelScript.RangeBorder#getWeight:member(1)'
- package: ExcelScript!
- fullName: getWeight()
- summary: Specifies the weight of the border around a range. See `ExcelScript.BorderWeight` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWeight(): BorderWeight;'
- return:
- type: ''
- description: ''
- - name: setColor(color)
- uid: 'ExcelScript!ExcelScript.RangeBorder#setColor:member(1)'
- package: ExcelScript!
- fullName: setColor(color)
- summary: >-
- HTML color code representing the color of the border line, in the form \#RRGGBB (e.g., "FFA500"), or as a named
- HTML color (e.g., "orange").
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setColor(color: string): void;'
- parameters:
- - id: color
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setStyle(style)
- uid: 'ExcelScript!ExcelScript.RangeBorder#setStyle:member(1)'
- package: ExcelScript!
- fullName: setStyle(style)
- summary: >-
- One of the constants of line style specifying the line style for the border. See `ExcelScript.BorderLineStyle` for
- details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setStyle(style: BorderLineStyle): void;'
- parameters:
- - id: style
- description: ''
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a border around the outside of a range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get a range from the current worksheet.
- let range = workbook.getActiveWorksheet().getRange("B2:E15");
-
- // Add a border around the whole bounding range.
- let format = range.getFormat();
- format.getRangeBorder(ExcelScript.BorderIndex.edgeTop).setStyle(ExcelScript.BorderLineStyle.continuous); // Top border
- format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom).setStyle(ExcelScript.BorderLineStyle.continuous); // Bottom border
- format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft).setStyle(ExcelScript.BorderLineStyle.continuous); // Left border
- format.getRangeBorder(ExcelScript.BorderIndex.edgeRight).setStyle(ExcelScript.BorderLineStyle.continuous); // Right border
- }
- ```
- - name: setTintAndShade(tintAndShade)
- uid: 'ExcelScript!ExcelScript.RangeBorder#setTintAndShade:member(1)'
- package: ExcelScript!
- fullName: setTintAndShade(tintAndShade)
- summary: >-
- Specifies a double that lightens or darkens a color for the range border, the value is between -1 (darkest) and 1
- (brightest), with 0 for the original color. A `null` value indicates that the border doesn't have a uniform
- `tintAndShade` setting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTintAndShade(tintAndShade: number): void;'
- parameters:
- - id: tintAndShade
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setWeight(weight)
- uid: 'ExcelScript!ExcelScript.RangeBorder#setWeight:member(1)'
- package: ExcelScript!
- fullName: setWeight(weight)
- summary: Specifies the weight of the border around a range. See `ExcelScript.BorderWeight` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setWeight(weight: BorderWeight): void;'
- parameters:
- - id: weight
- description: ''
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a border around a range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the RangeFormat object for the range "B2:G10".
- const currentSheet = workbook.getActiveWorksheet();
- const rangeForBorder = currentSheet.getRange("B2:G10");
- const format = rangeForBorder.getFormat();
-
- // Get a RangeBorder object for each edge of the range and set the border properties.
- let edgeTop = format.getRangeBorder(ExcelScript.BorderIndex.edgeTop);
- edgeTop.setStyle(ExcelScript.BorderLineStyle.dashDot);
- edgeTop.setWeight(ExcelScript.BorderWeight.thick);
-
- let edgeBottom = format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom);
- edgeBottom.setStyle(ExcelScript.BorderLineStyle.dashDot);
- edgeBottom.setWeight(ExcelScript.BorderWeight.thick);
-
- let edgeLeft = format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft);
- edgeLeft.setStyle(ExcelScript.BorderLineStyle.dashDot);
- edgeLeft.setWeight(ExcelScript.BorderWeight.thick);
-
- let edgeRight = format.getRangeBorder(ExcelScript.BorderIndex.edgeRight);
- edgeRight.setStyle(ExcelScript.BorderLineStyle.dashDot);
- edgeRight.setWeight(ExcelScript.BorderWeight.thick);
- }
- ```
+### YamlMime:TSType
+name: ExcelScript.RangeBorder
+uid: 'ExcelScript!ExcelScript.RangeBorder:interface'
+package: ExcelScript!
+fullName: ExcelScript.RangeBorder
+summary: Represents the border of an object.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getColor()
+ uid: 'ExcelScript!ExcelScript.RangeBorder#getColor:member(1)'
+ package: ExcelScript!
+ fullName: getColor()
+ summary: >-
+ HTML color code representing the color of the border line, in the form \#RRGGBB (e.g., "FFA500"), or as a named
+ HTML color (e.g., "orange").
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getSideIndex()
+ uid: 'ExcelScript!ExcelScript.RangeBorder#getSideIndex:member(1)'
+ package: ExcelScript!
+ fullName: getSideIndex()
+ summary: Constant value that indicates the specific side of the border. See `ExcelScript.BorderIndex` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSideIndex(): BorderIndex;'
+ return:
+ type: ''
+ description: ''
+ - name: getStyle()
+ uid: 'ExcelScript!ExcelScript.RangeBorder#getStyle:member(1)'
+ package: ExcelScript!
+ fullName: getStyle()
+ summary: >-
+ One of the constants of line style specifying the line style for the border. See `ExcelScript.BorderLineStyle` for
+ details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getStyle(): BorderLineStyle;'
+ return:
+ type: ''
+ description: ''
+ - name: getTintAndShade()
+ uid: 'ExcelScript!ExcelScript.RangeBorder#getTintAndShade:member(1)'
+ package: ExcelScript!
+ fullName: getTintAndShade()
+ summary: >-
+ Specifies a double that lightens or darkens a color for the range border, the value is between -1 (darkest) and 1
+ (brightest), with 0 for the original color. A `null` value indicates that the border doesn't have a uniform
+ `tintAndShade` setting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTintAndShade(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getWeight()
+ uid: 'ExcelScript!ExcelScript.RangeBorder#getWeight:member(1)'
+ package: ExcelScript!
+ fullName: getWeight()
+ summary: Specifies the weight of the border around a range. See `ExcelScript.BorderWeight` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWeight(): BorderWeight;'
+ return:
+ type: ''
+ description: ''
+ - name: setColor(color)
+ uid: 'ExcelScript!ExcelScript.RangeBorder#setColor:member(1)'
+ package: ExcelScript!
+ fullName: setColor(color)
+ summary: >-
+ HTML color code representing the color of the border line, in the form \#RRGGBB (e.g., "FFA500"), or as a named
+ HTML color (e.g., "orange").
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setColor(color: string): void;'
+ parameters:
+ - id: color
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setStyle(style)
+ uid: 'ExcelScript!ExcelScript.RangeBorder#setStyle:member(1)'
+ package: ExcelScript!
+ fullName: setStyle(style)
+ summary: >-
+ One of the constants of line style specifying the line style for the border. See `ExcelScript.BorderLineStyle` for
+ details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setStyle(style: BorderLineStyle): void;'
+ parameters:
+ - id: style
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a border around the outside of a range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get a range from the current worksheet.
+ let range = workbook.getActiveWorksheet().getRange("B2:E15");
+
+ // Add a border around the whole bounding range.
+ let format = range.getFormat();
+ format.getRangeBorder(ExcelScript.BorderIndex.edgeTop).setStyle(ExcelScript.BorderLineStyle.continuous); // Top border
+ format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom).setStyle(ExcelScript.BorderLineStyle.continuous); // Bottom border
+ format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft).setStyle(ExcelScript.BorderLineStyle.continuous); // Left border
+ format.getRangeBorder(ExcelScript.BorderIndex.edgeRight).setStyle(ExcelScript.BorderLineStyle.continuous); // Right border
+ }
+ ```
+ - name: setTintAndShade(tintAndShade)
+ uid: 'ExcelScript!ExcelScript.RangeBorder#setTintAndShade:member(1)'
+ package: ExcelScript!
+ fullName: setTintAndShade(tintAndShade)
+ summary: >-
+ Specifies a double that lightens or darkens a color for the range border, the value is between -1 (darkest) and 1
+ (brightest), with 0 for the original color. A `null` value indicates that the border doesn't have a uniform
+ `tintAndShade` setting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTintAndShade(tintAndShade: number): void;'
+ parameters:
+ - id: tintAndShade
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setWeight(weight)
+ uid: 'ExcelScript!ExcelScript.RangeBorder#setWeight:member(1)'
+ package: ExcelScript!
+ fullName: setWeight(weight)
+ summary: Specifies the weight of the border around a range. See `ExcelScript.BorderWeight` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setWeight(weight: BorderWeight): void;'
+ parameters:
+ - id: weight
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a border around a range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the RangeFormat object for the range "B2:G10".
+ const currentSheet = workbook.getActiveWorksheet();
+ const rangeForBorder = currentSheet.getRange("B2:G10");
+ const format = rangeForBorder.getFormat();
+
+ // Get a RangeBorder object for each edge of the range and set the border properties.
+ let edgeTop = format.getRangeBorder(ExcelScript.BorderIndex.edgeTop);
+ edgeTop.setStyle(ExcelScript.BorderLineStyle.dashDot);
+ edgeTop.setWeight(ExcelScript.BorderWeight.thick);
+
+ let edgeBottom = format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom);
+ edgeBottom.setStyle(ExcelScript.BorderLineStyle.dashDot);
+ edgeBottom.setWeight(ExcelScript.BorderWeight.thick);
+
+ let edgeLeft = format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft);
+ edgeLeft.setStyle(ExcelScript.BorderLineStyle.dashDot);
+ edgeLeft.setWeight(ExcelScript.BorderWeight.thick);
+
+ let edgeRight = format.getRangeBorder(ExcelScript.BorderIndex.edgeRight);
+ edgeRight.setStyle(ExcelScript.BorderLineStyle.dashDot);
+ edgeRight.setWeight(ExcelScript.BorderWeight.thick);
+ }
+ ```
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.rangecopytype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.rangecopytype.yml
index 883bc41d..5374f173 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.rangecopytype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.rangecopytype.yml
@@ -1,58 +1,58 @@
-### YamlMime:TSEnum
-name: ExcelScript.RangeCopyType
-uid: 'ExcelScript!ExcelScript.RangeCopyType:enum'
-package: ExcelScript!
-fullName: ExcelScript.RangeCopyType
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script copies all of the values from the current worksheet to a new worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the used range on the current worksheet.
- let usedRange = workbook.getActiveWorksheet().getUsedRange();
-
- // Create a new worksheet with a default name.
- let newSheet = workbook.addWorksheet();
-
- // Copy the values from the used range to the new worksheet.
- let copyType = ExcelScript.RangeCopyType.values; /* Change this to copy different information, such as formats. */
- let targetRange = newSheet.getRangeByIndexes(
- usedRange.getRowIndex(),
- usedRange.getColumnIndex(),
- usedRange.getRowCount(),
- usedRange.getColumnCount());
- targetRange.copyFrom(usedRange, copyType);
-
- // Switch the view to the new worksheet.
- newSheet.activate();
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: all
- uid: 'ExcelScript!ExcelScript.RangeCopyType.all:member'
- package: ExcelScript!
- summary: ''
- - name: formats
- uid: 'ExcelScript!ExcelScript.RangeCopyType.formats:member'
- package: ExcelScript!
- summary: ''
- - name: formulas
- uid: 'ExcelScript!ExcelScript.RangeCopyType.formulas:member'
- package: ExcelScript!
- summary: ''
- - name: link
- uid: 'ExcelScript!ExcelScript.RangeCopyType.link:member'
- package: ExcelScript!
- summary: ''
- - name: values
- uid: 'ExcelScript!ExcelScript.RangeCopyType.values:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.RangeCopyType
+uid: 'ExcelScript!ExcelScript.RangeCopyType:enum'
+package: ExcelScript!
+fullName: ExcelScript.RangeCopyType
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script copies all of the values from the current worksheet to a new worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the used range on the current worksheet.
+ let usedRange = workbook.getActiveWorksheet().getUsedRange();
+
+ // Create a new worksheet with a default name.
+ let newSheet = workbook.addWorksheet();
+
+ // Copy the values from the used range to the new worksheet.
+ let copyType = ExcelScript.RangeCopyType.values; /* Change this to copy different information, such as formats. */
+ let targetRange = newSheet.getRangeByIndexes(
+ usedRange.getRowIndex(),
+ usedRange.getColumnIndex(),
+ usedRange.getRowCount(),
+ usedRange.getColumnCount());
+ targetRange.copyFrom(usedRange, copyType);
+
+ // Switch the view to the new worksheet.
+ newSheet.activate();
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: all
+ uid: 'ExcelScript!ExcelScript.RangeCopyType.all:member'
+ package: ExcelScript!
+ summary: ''
+ - name: formats
+ uid: 'ExcelScript!ExcelScript.RangeCopyType.formats:member'
+ package: ExcelScript!
+ summary: ''
+ - name: formulas
+ uid: 'ExcelScript!ExcelScript.RangeCopyType.formulas:member'
+ package: ExcelScript!
+ summary: ''
+ - name: link
+ uid: 'ExcelScript!ExcelScript.RangeCopyType.link:member'
+ package: ExcelScript!
+ summary: ''
+ - name: values
+ uid: 'ExcelScript!ExcelScript.RangeCopyType.values:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.rangefill.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.rangefill.yml
index 9bdbf77c..8d0780a6 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.rangefill.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.rangefill.yml
@@ -1,267 +1,267 @@
-### YamlMime:TSType
-name: ExcelScript.RangeFill
-uid: 'ExcelScript!ExcelScript.RangeFill:interface'
-package: ExcelScript!
-fullName: ExcelScript.RangeFill
-summary: Represents the background of a range object.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the fill color of the used range to green.
- */
- function main(workbook: ExcelScript.Workbook)
- {
- // Get the used range of the current worksheet.
- let currentSheet = workbook.getActiveWorksheet();
- let usedRange = currentSheet.getUsedRange();
-
- // Get the RangeFill object.
- let fill = usedRange.getFormat().getFill();
-
- // Set the fill color to green.
- fill.setColor("green");
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: clear()
- uid: 'ExcelScript!ExcelScript.RangeFill#clear:member(1)'
- package: ExcelScript!
- fullName: clear()
- summary: Resets the range background.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'clear(): void;'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script removes all fill color and styles from the used range.
- */
- function main(workbook: ExcelScript.Workbook)
- {
- // Get the used range of the current worksheet.
- let currentSheet = workbook.getActiveWorksheet();
- let usedRange = currentSheet.getUsedRange();
-
- // Clear the fill from the entire range.
- usedRange.getFormat().getFill().clear();
- }
- ```
- - name: getColor()
- uid: 'ExcelScript!ExcelScript.RangeFill#getColor:member(1)'
- package: ExcelScript!
- fullName: getColor()
- summary: >-
- HTML color code representing the color of the background, in the form \#RRGGBB (e.g., "FFA500"), or as a named
- HTML color (e.g., "orange")
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColor(): string;'
- return:
- type: string
- description: ''
- - name: getPattern()
- uid: 'ExcelScript!ExcelScript.RangeFill#getPattern:member(1)'
- package: ExcelScript!
- fullName: getPattern()
- summary: >-
- The pattern of a range. See `ExcelScript.FillPattern` for details. LinearGradient and RectangularGradient are not
- supported. A `null` value indicates that the entire range doesn't have a uniform pattern setting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPattern(): FillPattern;'
- return:
- type: ''
- description: ''
- - name: getPatternColor()
- uid: 'ExcelScript!ExcelScript.RangeFill#getPatternColor:member(1)'
- package: ExcelScript!
- fullName: getPatternColor()
- summary: >-
- The HTML color code representing the color of the range pattern, in the form \#RRGGBB (e.g., "FFA500"), or as a
- named HTML color (e.g., "orange").
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPatternColor(): string;'
- return:
- type: string
- description: ''
- - name: getPatternTintAndShade()
- uid: 'ExcelScript!ExcelScript.RangeFill#getPatternTintAndShade:member(1)'
- package: ExcelScript!
- fullName: getPatternTintAndShade()
- summary: >-
- Specifies a double that lightens or darkens a pattern color for the range fill. The value is between -1 (darkest)
- and 1 (brightest), with 0 for the original color. A `null` value indicates that the range doesn't have uniform
- `patternTintAndShade` settings.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPatternTintAndShade(): number;'
- return:
- type: number
- description: ''
- - name: getTintAndShade()
- uid: 'ExcelScript!ExcelScript.RangeFill#getTintAndShade:member(1)'
- package: ExcelScript!
- fullName: getTintAndShade()
- summary: >-
- Specifies a double that lightens or darkens a color for the range fill. The value is between -1 (darkest) and 1
- (brightest), with 0 for the original color. A `null` value indicates that the range doesn't have uniform
- `tintAndShade` settings.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTintAndShade(): number;'
- return:
- type: number
- description: ''
- - name: setColor(color)
- uid: 'ExcelScript!ExcelScript.RangeFill#setColor:member(1)'
- package: ExcelScript!
- fullName: setColor(color)
- summary: >-
- HTML color code representing the color of the background, in the form \#RRGGBB (e.g., "FFA500"), or as a named
- HTML color (e.g., "orange")
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setColor(color: string): void;'
- parameters:
- - id: color
- description: ''
- type: string
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the fill color of cell A2 to blue.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range representing cell A2 from the current worksheet.
- let cell = workbook.getActiveWorksheet().getRange("A2");
-
- // Set the fill color to blue.
- cell.getFormat().getFill().setColor("blue");
- }
- ```
- - name: setPattern(pattern)
- uid: 'ExcelScript!ExcelScript.RangeFill#setPattern:member(1)'
- package: ExcelScript!
- fullName: setPattern(pattern)
- summary: >-
- The pattern of a range. See `ExcelScript.FillPattern` for details. LinearGradient and RectangularGradient are not
- supported. A `null` value indicates that the entire range doesn't have a uniform pattern setting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPattern(pattern: FillPattern): void;'
- parameters:
- - id: pattern
- description: ''
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets a black-checkered fill on the selected range.
- */
- function main(workbook: ExcelScript.Workbook) {
- const selected = workbook.getSelectedRange();
- selected.getFormat().getFill().setPattern(ExcelScript.FillPattern.checker);
- selected.getFormat().getFill().setPatternColor("black");
- }
- ```
- - name: setPatternColor(patternColor)
- uid: 'ExcelScript!ExcelScript.RangeFill#setPatternColor:member(1)'
- package: ExcelScript!
- fullName: setPatternColor(patternColor)
- summary: >-
- The HTML color code representing the color of the range pattern, in the form \#RRGGBB (e.g., "FFA500"), or as a
- named HTML color (e.g., "orange").
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPatternColor(patternColor: string): void;'
- parameters:
- - id: patternColor
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setPatternTintAndShade(patternTintAndShade)
- uid: 'ExcelScript!ExcelScript.RangeFill#setPatternTintAndShade:member(1)'
- package: ExcelScript!
- fullName: setPatternTintAndShade(patternTintAndShade)
- summary: >-
- Specifies a double that lightens or darkens a pattern color for the range fill. The value is between -1 (darkest)
- and 1 (brightest), with 0 for the original color. A `null` value indicates that the range doesn't have uniform
- `patternTintAndShade` settings.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPatternTintAndShade(patternTintAndShade: number): void;'
- parameters:
- - id: patternTintAndShade
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setTintAndShade(tintAndShade)
- uid: 'ExcelScript!ExcelScript.RangeFill#setTintAndShade:member(1)'
- package: ExcelScript!
- fullName: setTintAndShade(tintAndShade)
- summary: >-
- Specifies a double that lightens or darkens a color for the range fill. The value is between -1 (darkest) and 1
- (brightest), with 0 for the original color. A `null` value indicates that the range doesn't have uniform
- `tintAndShade` settings.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTintAndShade(tintAndShade: number): void;'
- parameters:
- - id: tintAndShade
- description: ''
- type: number
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.RangeFill
+uid: 'ExcelScript!ExcelScript.RangeFill:interface'
+package: ExcelScript!
+fullName: ExcelScript.RangeFill
+summary: Represents the background of a range object.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the fill color of the used range to green.
+ */
+ function main(workbook: ExcelScript.Workbook)
+ {
+ // Get the used range of the current worksheet.
+ let currentSheet = workbook.getActiveWorksheet();
+ let usedRange = currentSheet.getUsedRange();
+
+ // Get the RangeFill object.
+ let fill = usedRange.getFormat().getFill();
+
+ // Set the fill color to green.
+ fill.setColor("green");
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: clear()
+ uid: 'ExcelScript!ExcelScript.RangeFill#clear:member(1)'
+ package: ExcelScript!
+ fullName: clear()
+ summary: Resets the range background.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clear(): void;'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script removes all fill color and styles from the used range.
+ */
+ function main(workbook: ExcelScript.Workbook)
+ {
+ // Get the used range of the current worksheet.
+ let currentSheet = workbook.getActiveWorksheet();
+ let usedRange = currentSheet.getUsedRange();
+
+ // Clear the fill from the entire range.
+ usedRange.getFormat().getFill().clear();
+ }
+ ```
+ - name: getColor()
+ uid: 'ExcelScript!ExcelScript.RangeFill#getColor:member(1)'
+ package: ExcelScript!
+ fullName: getColor()
+ summary: >-
+ HTML color code representing the color of the background, in the form \#RRGGBB (e.g., "FFA500"), or as a named
+ HTML color (e.g., "orange")
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getPattern()
+ uid: 'ExcelScript!ExcelScript.RangeFill#getPattern:member(1)'
+ package: ExcelScript!
+ fullName: getPattern()
+ summary: >-
+ The pattern of a range. See `ExcelScript.FillPattern` for details. LinearGradient and RectangularGradient are not
+ supported. A `null` value indicates that the entire range doesn't have a uniform pattern setting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPattern(): FillPattern;'
+ return:
+ type: ''
+ description: ''
+ - name: getPatternColor()
+ uid: 'ExcelScript!ExcelScript.RangeFill#getPatternColor:member(1)'
+ package: ExcelScript!
+ fullName: getPatternColor()
+ summary: >-
+ The HTML color code representing the color of the range pattern, in the form \#RRGGBB (e.g., "FFA500"), or as a
+ named HTML color (e.g., "orange").
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPatternColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getPatternTintAndShade()
+ uid: 'ExcelScript!ExcelScript.RangeFill#getPatternTintAndShade:member(1)'
+ package: ExcelScript!
+ fullName: getPatternTintAndShade()
+ summary: >-
+ Specifies a double that lightens or darkens a pattern color for the range fill. The value is between -1 (darkest)
+ and 1 (brightest), with 0 for the original color. A `null` value indicates that the range doesn't have uniform
+ `patternTintAndShade` settings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPatternTintAndShade(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getTintAndShade()
+ uid: 'ExcelScript!ExcelScript.RangeFill#getTintAndShade:member(1)'
+ package: ExcelScript!
+ fullName: getTintAndShade()
+ summary: >-
+ Specifies a double that lightens or darkens a color for the range fill. The value is between -1 (darkest) and 1
+ (brightest), with 0 for the original color. A `null` value indicates that the range doesn't have uniform
+ `tintAndShade` settings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTintAndShade(): number;'
+ return:
+ type: number
+ description: ''
+ - name: setColor(color)
+ uid: 'ExcelScript!ExcelScript.RangeFill#setColor:member(1)'
+ package: ExcelScript!
+ fullName: setColor(color)
+ summary: >-
+ HTML color code representing the color of the background, in the form \#RRGGBB (e.g., "FFA500"), or as a named
+ HTML color (e.g., "orange")
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setColor(color: string): void;'
+ parameters:
+ - id: color
+ description: ''
+ type: string
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the fill color of cell A2 to blue.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range representing cell A2 from the current worksheet.
+ let cell = workbook.getActiveWorksheet().getRange("A2");
+
+ // Set the fill color to blue.
+ cell.getFormat().getFill().setColor("blue");
+ }
+ ```
+ - name: setPattern(pattern)
+ uid: 'ExcelScript!ExcelScript.RangeFill#setPattern:member(1)'
+ package: ExcelScript!
+ fullName: setPattern(pattern)
+ summary: >-
+ The pattern of a range. See `ExcelScript.FillPattern` for details. LinearGradient and RectangularGradient are not
+ supported. A `null` value indicates that the entire range doesn't have a uniform pattern setting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPattern(pattern: FillPattern): void;'
+ parameters:
+ - id: pattern
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets a black-checkered fill on the selected range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ const selected = workbook.getSelectedRange();
+ selected.getFormat().getFill().setPattern(ExcelScript.FillPattern.checker);
+ selected.getFormat().getFill().setPatternColor("black");
+ }
+ ```
+ - name: setPatternColor(patternColor)
+ uid: 'ExcelScript!ExcelScript.RangeFill#setPatternColor:member(1)'
+ package: ExcelScript!
+ fullName: setPatternColor(patternColor)
+ summary: >-
+ The HTML color code representing the color of the range pattern, in the form \#RRGGBB (e.g., "FFA500"), or as a
+ named HTML color (e.g., "orange").
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPatternColor(patternColor: string): void;'
+ parameters:
+ - id: patternColor
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setPatternTintAndShade(patternTintAndShade)
+ uid: 'ExcelScript!ExcelScript.RangeFill#setPatternTintAndShade:member(1)'
+ package: ExcelScript!
+ fullName: setPatternTintAndShade(patternTintAndShade)
+ summary: >-
+ Specifies a double that lightens or darkens a pattern color for the range fill. The value is between -1 (darkest)
+ and 1 (brightest), with 0 for the original color. A `null` value indicates that the range doesn't have uniform
+ `patternTintAndShade` settings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPatternTintAndShade(patternTintAndShade: number): void;'
+ parameters:
+ - id: patternTintAndShade
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setTintAndShade(tintAndShade)
+ uid: 'ExcelScript!ExcelScript.RangeFill#setTintAndShade:member(1)'
+ package: ExcelScript!
+ fullName: setTintAndShade(tintAndShade)
+ summary: >-
+ Specifies a double that lightens or darkens a color for the range fill. The value is between -1 (darkest) and 1
+ (brightest), with 0 for the original color. A `null` value indicates that the range doesn't have uniform
+ `tintAndShade` settings.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTintAndShade(tintAndShade: number): void;'
+ parameters:
+ - id: tintAndShade
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.rangefont.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.rangefont.yml
index f2f81c7d..35e496f0 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.rangefont.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.rangefont.yml
@@ -1,399 +1,399 @@
-### YamlMime:TSType
-name: ExcelScript.RangeFont
-uid: 'ExcelScript!ExcelScript.RangeFont:interface'
-package: ExcelScript!
-fullName: ExcelScript.RangeFont
-summary: 'This object represents the font attributes (font name, font size, color, etc.) for an object.'
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the font of A1 to Arial, size 16.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get A1 on the current worksheet.
- const cell = workbook.getActiveWorksheet().getCell(0,0);
-
- // Adjust the font settings for that cell.
- const cellFont = cell.getFormat().getFont();
- cellFont.setName("Arial");
- cellFont.setSize(16);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getBold()
- uid: 'ExcelScript!ExcelScript.RangeFont#getBold:member(1)'
- package: ExcelScript!
- fullName: getBold()
- summary: Represents the bold status of the font.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBold(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getColor()
- uid: 'ExcelScript!ExcelScript.RangeFont#getColor:member(1)'
- package: ExcelScript!
- fullName: getColor()
- summary: 'HTML color code representation of the text color (e.g., \#FF0000 represents Red).'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColor(): string;'
- return:
- type: string
- description: ''
- - name: getItalic()
- uid: 'ExcelScript!ExcelScript.RangeFont#getItalic:member(1)'
- package: ExcelScript!
- fullName: getItalic()
- summary: Specifies the italic status of the font.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getItalic(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.RangeFont#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: 'Font name (e.g., "Calibri"). The name''s length should not be greater than 31 characters.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: getSize()
- uid: 'ExcelScript!ExcelScript.RangeFont#getSize:member(1)'
- package: ExcelScript!
- fullName: getSize()
- summary: Font size.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSize(): number;'
- return:
- type: number
- description: ''
- - name: getStrikethrough()
- uid: 'ExcelScript!ExcelScript.RangeFont#getStrikethrough:member(1)'
- package: ExcelScript!
- fullName: getStrikethrough()
- summary: >-
- Specifies the strikethrough status of font. A `null` value indicates that the entire range doesn't have a uniform
- strikethrough setting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getStrikethrough(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getSubscript()
- uid: 'ExcelScript!ExcelScript.RangeFont#getSubscript:member(1)'
- package: ExcelScript!
- fullName: getSubscript()
- summary: >-
- Specifies the subscript status of font. Returns `true` if all the fonts of the range are subscript. Returns
- `false` if all the fonts of the range are superscript or normal (neither superscript, nor subscript). Returns
- `null` otherwise.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSubscript(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getSuperscript()
- uid: 'ExcelScript!ExcelScript.RangeFont#getSuperscript:member(1)'
- package: ExcelScript!
- fullName: getSuperscript()
- summary: >-
- Specifies the superscript status of font. Returns `true` if all the fonts of the range are superscript. Returns
- `false` if all the fonts of the range are subscript or normal (neither superscript, nor subscript). Returns `null`
- otherwise.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSuperscript(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getTintAndShade()
- uid: 'ExcelScript!ExcelScript.RangeFont#getTintAndShade:member(1)'
- package: ExcelScript!
- fullName: getTintAndShade()
- summary: >-
- Specifies a double that lightens or darkens a color for the range font. The value is between -1 (darkest) and 1
- (brightest), with 0 for the original color. A `null` value indicates that the entire range doesn't have a uniform
- font `tintAndShade` setting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTintAndShade(): number;'
- return:
- type: number
- description: ''
- - name: getUnderline()
- uid: 'ExcelScript!ExcelScript.RangeFont#getUnderline:member(1)'
- package: ExcelScript!
- fullName: getUnderline()
- summary: Type of underline applied to the font. See `ExcelScript.RangeUnderlineStyle` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getUnderline(): RangeUnderlineStyle;'
- return:
- type: ''
- description: ''
- - name: setBold(bold)
- uid: 'ExcelScript!ExcelScript.RangeFont#setBold:member(1)'
- package: ExcelScript!
- fullName: setBold(bold)
- summary: Represents the bold status of the font.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setBold(bold: boolean): void;'
- parameters:
- - id: bold
- description: ''
- type: boolean
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script bolds the text of cell A1.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get A1 on the current worksheet.
- const cell = workbook.getActiveWorksheet().getCell(0,0);
-
- // Bold the font for that cell
- cell.getFormat().getFont().setBold(true);
- }
- ```
- - name: setColor(color)
- uid: 'ExcelScript!ExcelScript.RangeFont#setColor:member(1)'
- package: ExcelScript!
- fullName: setColor(color)
- summary: 'HTML color code representation of the text color (e.g., \#FF0000 represents Red).'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setColor(color: string): void;'
- parameters:
- - id: color
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setItalic(italic)
- uid: 'ExcelScript!ExcelScript.RangeFont#setItalic:member(1)'
- package: ExcelScript!
- fullName: setItalic(italic)
- summary: Specifies the italic status of the font.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setItalic(italic: boolean): void;'
- parameters:
- - id: italic
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setName(name)
- uid: 'ExcelScript!ExcelScript.RangeFont#setName:member(1)'
- package: ExcelScript!
- fullName: setName(name)
- summary: 'Font name (e.g., "Calibri"). The name''s length should not be greater than 31 characters.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setName(name: string): void;'
- parameters:
- - id: name
- description: ''
- type: string
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the font style of A1 to Arial.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get A1 on the current worksheet.
- const cell = workbook.getActiveWorksheet().getCell(0,0);
-
- // Adjust the font settings for that cell.
- cell.getFormat().getFont().setName("Arial");
- }
- ```
- - name: setSize(size)
- uid: 'ExcelScript!ExcelScript.RangeFont#setSize:member(1)'
- package: ExcelScript!
- fullName: setSize(size)
- summary: Font size.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setSize(size: number): void;'
- parameters:
- - id: size
- description: ''
- type: number
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the font size of A1 to 16.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get A1 on the current worksheet.
- const cell = workbook.getActiveWorksheet().getCell(0,0);
-
- // Adjust the font settings for that cell.clear
- cell.getFormat().getFont().setSize(16);
- }
- ```
- - name: setStrikethrough(strikethrough)
- uid: 'ExcelScript!ExcelScript.RangeFont#setStrikethrough:member(1)'
- package: ExcelScript!
- fullName: setStrikethrough(strikethrough)
- summary: >-
- Specifies the strikethrough status of font. A `null` value indicates that the entire range doesn't have a uniform
- strikethrough setting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setStrikethrough(strikethrough: boolean): void;'
- parameters:
- - id: strikethrough
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setSubscript(subscript)
- uid: 'ExcelScript!ExcelScript.RangeFont#setSubscript:member(1)'
- package: ExcelScript!
- fullName: setSubscript(subscript)
- summary: >-
- Specifies the subscript status of font. Returns `true` if all the fonts of the range are subscript. Returns
- `false` if all the fonts of the range are superscript or normal (neither superscript, nor subscript). Returns
- `null` otherwise.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setSubscript(subscript: boolean): void;'
- parameters:
- - id: subscript
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setSuperscript(superscript)
- uid: 'ExcelScript!ExcelScript.RangeFont#setSuperscript:member(1)'
- package: ExcelScript!
- fullName: setSuperscript(superscript)
- summary: >-
- Specifies the superscript status of font. Returns `true` if all the fonts of the range are superscript. Returns
- `false` if all the fonts of the range are subscript or normal (neither superscript, nor subscript). Returns `null`
- otherwise.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setSuperscript(superscript: boolean): void;'
- parameters:
- - id: superscript
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setTintAndShade(tintAndShade)
- uid: 'ExcelScript!ExcelScript.RangeFont#setTintAndShade:member(1)'
- package: ExcelScript!
- fullName: setTintAndShade(tintAndShade)
- summary: >-
- Specifies a double that lightens or darkens a color for the range font. The value is between -1 (darkest) and 1
- (brightest), with 0 for the original color. A `null` value indicates that the entire range doesn't have a uniform
- font `tintAndShade` setting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTintAndShade(tintAndShade: number): void;'
- parameters:
- - id: tintAndShade
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setUnderline(underline)
- uid: 'ExcelScript!ExcelScript.RangeFont#setUnderline:member(1)'
- package: ExcelScript!
- fullName: setUnderline(underline)
- summary: Type of underline applied to the font. See `ExcelScript.RangeUnderlineStyle` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setUnderline(underline: RangeUnderlineStyle): void;'
- parameters:
- - id: underline
- description: ''
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.RangeFont
+uid: 'ExcelScript!ExcelScript.RangeFont:interface'
+package: ExcelScript!
+fullName: ExcelScript.RangeFont
+summary: 'This object represents the font attributes (font name, font size, color, etc.) for an object.'
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the font of A1 to Arial, size 16.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get A1 on the current worksheet.
+ const cell = workbook.getActiveWorksheet().getCell(0,0);
+
+ // Adjust the font settings for that cell.
+ const cellFont = cell.getFormat().getFont();
+ cellFont.setName("Arial");
+ cellFont.setSize(16);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getBold()
+ uid: 'ExcelScript!ExcelScript.RangeFont#getBold:member(1)'
+ package: ExcelScript!
+ fullName: getBold()
+ summary: Represents the bold status of the font.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBold(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getColor()
+ uid: 'ExcelScript!ExcelScript.RangeFont#getColor:member(1)'
+ package: ExcelScript!
+ fullName: getColor()
+ summary: 'HTML color code representation of the text color (e.g., \#FF0000 represents Red).'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getItalic()
+ uid: 'ExcelScript!ExcelScript.RangeFont#getItalic:member(1)'
+ package: ExcelScript!
+ fullName: getItalic()
+ summary: Specifies the italic status of the font.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItalic(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.RangeFont#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: 'Font name (e.g., "Calibri"). The name''s length should not be greater than 31 characters.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getSize()
+ uid: 'ExcelScript!ExcelScript.RangeFont#getSize:member(1)'
+ package: ExcelScript!
+ fullName: getSize()
+ summary: Font size.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSize(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getStrikethrough()
+ uid: 'ExcelScript!ExcelScript.RangeFont#getStrikethrough:member(1)'
+ package: ExcelScript!
+ fullName: getStrikethrough()
+ summary: >-
+ Specifies the strikethrough status of font. A `null` value indicates that the entire range doesn't have a uniform
+ strikethrough setting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getStrikethrough(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getSubscript()
+ uid: 'ExcelScript!ExcelScript.RangeFont#getSubscript:member(1)'
+ package: ExcelScript!
+ fullName: getSubscript()
+ summary: >-
+ Specifies the subscript status of font. Returns `true` if all the fonts of the range are subscript. Returns
+ `false` if all the fonts of the range are superscript or normal (neither superscript, nor subscript). Returns
+ `null` otherwise.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSubscript(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getSuperscript()
+ uid: 'ExcelScript!ExcelScript.RangeFont#getSuperscript:member(1)'
+ package: ExcelScript!
+ fullName: getSuperscript()
+ summary: >-
+ Specifies the superscript status of font. Returns `true` if all the fonts of the range are superscript. Returns
+ `false` if all the fonts of the range are subscript or normal (neither superscript, nor subscript). Returns `null`
+ otherwise.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSuperscript(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getTintAndShade()
+ uid: 'ExcelScript!ExcelScript.RangeFont#getTintAndShade:member(1)'
+ package: ExcelScript!
+ fullName: getTintAndShade()
+ summary: >-
+ Specifies a double that lightens or darkens a color for the range font. The value is between -1 (darkest) and 1
+ (brightest), with 0 for the original color. A `null` value indicates that the entire range doesn't have a uniform
+ font `tintAndShade` setting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTintAndShade(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getUnderline()
+ uid: 'ExcelScript!ExcelScript.RangeFont#getUnderline:member(1)'
+ package: ExcelScript!
+ fullName: getUnderline()
+ summary: Type of underline applied to the font. See `ExcelScript.RangeUnderlineStyle` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getUnderline(): RangeUnderlineStyle;'
+ return:
+ type: ''
+ description: ''
+ - name: setBold(bold)
+ uid: 'ExcelScript!ExcelScript.RangeFont#setBold:member(1)'
+ package: ExcelScript!
+ fullName: setBold(bold)
+ summary: Represents the bold status of the font.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setBold(bold: boolean): void;'
+ parameters:
+ - id: bold
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script bolds the text of cell A1.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get A1 on the current worksheet.
+ const cell = workbook.getActiveWorksheet().getCell(0,0);
+
+ // Bold the font for that cell
+ cell.getFormat().getFont().setBold(true);
+ }
+ ```
+ - name: setColor(color)
+ uid: 'ExcelScript!ExcelScript.RangeFont#setColor:member(1)'
+ package: ExcelScript!
+ fullName: setColor(color)
+ summary: 'HTML color code representation of the text color (e.g., \#FF0000 represents Red).'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setColor(color: string): void;'
+ parameters:
+ - id: color
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setItalic(italic)
+ uid: 'ExcelScript!ExcelScript.RangeFont#setItalic:member(1)'
+ package: ExcelScript!
+ fullName: setItalic(italic)
+ summary: Specifies the italic status of the font.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setItalic(italic: boolean): void;'
+ parameters:
+ - id: italic
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setName(name)
+ uid: 'ExcelScript!ExcelScript.RangeFont#setName:member(1)'
+ package: ExcelScript!
+ fullName: setName(name)
+ summary: 'Font name (e.g., "Calibri"). The name''s length should not be greater than 31 characters.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setName(name: string): void;'
+ parameters:
+ - id: name
+ description: ''
+ type: string
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the font style of A1 to Arial.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get A1 on the current worksheet.
+ const cell = workbook.getActiveWorksheet().getCell(0,0);
+
+ // Adjust the font settings for that cell.
+ cell.getFormat().getFont().setName("Arial");
+ }
+ ```
+ - name: setSize(size)
+ uid: 'ExcelScript!ExcelScript.RangeFont#setSize:member(1)'
+ package: ExcelScript!
+ fullName: setSize(size)
+ summary: Font size.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSize(size: number): void;'
+ parameters:
+ - id: size
+ description: ''
+ type: number
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the font size of A1 to 16.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get A1 on the current worksheet.
+ const cell = workbook.getActiveWorksheet().getCell(0,0);
+
+ // Adjust the font settings for that cell.clear
+ cell.getFormat().getFont().setSize(16);
+ }
+ ```
+ - name: setStrikethrough(strikethrough)
+ uid: 'ExcelScript!ExcelScript.RangeFont#setStrikethrough:member(1)'
+ package: ExcelScript!
+ fullName: setStrikethrough(strikethrough)
+ summary: >-
+ Specifies the strikethrough status of font. A `null` value indicates that the entire range doesn't have a uniform
+ strikethrough setting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setStrikethrough(strikethrough: boolean): void;'
+ parameters:
+ - id: strikethrough
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setSubscript(subscript)
+ uid: 'ExcelScript!ExcelScript.RangeFont#setSubscript:member(1)'
+ package: ExcelScript!
+ fullName: setSubscript(subscript)
+ summary: >-
+ Specifies the subscript status of font. Returns `true` if all the fonts of the range are subscript. Returns
+ `false` if all the fonts of the range are superscript or normal (neither superscript, nor subscript). Returns
+ `null` otherwise.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSubscript(subscript: boolean): void;'
+ parameters:
+ - id: subscript
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setSuperscript(superscript)
+ uid: 'ExcelScript!ExcelScript.RangeFont#setSuperscript:member(1)'
+ package: ExcelScript!
+ fullName: setSuperscript(superscript)
+ summary: >-
+ Specifies the superscript status of font. Returns `true` if all the fonts of the range are superscript. Returns
+ `false` if all the fonts of the range are subscript or normal (neither superscript, nor subscript). Returns `null`
+ otherwise.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSuperscript(superscript: boolean): void;'
+ parameters:
+ - id: superscript
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setTintAndShade(tintAndShade)
+ uid: 'ExcelScript!ExcelScript.RangeFont#setTintAndShade:member(1)'
+ package: ExcelScript!
+ fullName: setTintAndShade(tintAndShade)
+ summary: >-
+ Specifies a double that lightens or darkens a color for the range font. The value is between -1 (darkest) and 1
+ (brightest), with 0 for the original color. A `null` value indicates that the entire range doesn't have a uniform
+ font `tintAndShade` setting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTintAndShade(tintAndShade: number): void;'
+ parameters:
+ - id: tintAndShade
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setUnderline(underline)
+ uid: 'ExcelScript!ExcelScript.RangeFont#setUnderline:member(1)'
+ package: ExcelScript!
+ fullName: setUnderline(underline)
+ summary: Type of underline applied to the font. See `ExcelScript.RangeUnderlineStyle` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setUnderline(underline: RangeUnderlineStyle): void;'
+ parameters:
+ - id: underline
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.rangeformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.rangeformat.yml
index 27f84ff0..296ec870 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.rangeformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.rangeformat.yml
@@ -1,823 +1,823 @@
-### YamlMime:TSType
-name: ExcelScript.RangeFormat
-uid: 'ExcelScript!ExcelScript.RangeFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.RangeFormat
-summary: 'A format object encapsulating the range''s font, fill, borders, alignment, and other properties.'
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies some simple formatting to the top row of the used range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the top row of the used range in the current worksheet.
- const selectedSheet = workbook.getActiveWorksheet();
- const topRow = selectedSheet.getUsedRange().getRow(0);
-
- // For the top row, set the fill to black, the font color to white, and the font to be bold.
- const format: ExcelScript.RangeFormat = topRow.getFormat();
- format.getFill().setColor("black");
- format.getFont().setColor("white");
- format.getFont().setBold(true);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: adjustIndent(amount)
- uid: 'ExcelScript!ExcelScript.RangeFormat#adjustIndent:member(1)'
- package: ExcelScript!
- fullName: adjustIndent(amount)
- summary: >-
- Adjusts the indentation of the range formatting. The indent value ranges from 0 to 250 and is measured in
- characters.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'adjustIndent(amount: number): void;'
- parameters:
- - id: amount
- description: >-
- The number of character spaces by which the current indent is adjusted. This value should be between -250
- and 250. **Note**: If the amount would raise the indent level above 250, the indent level stays with
- 250. Similarly, if the amount would lower the indent level below 0, the indent level stays 0.
- type: number
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adjusts the indentation of a specific table column.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table in the current worksheet.
- const selectedSheet = workbook.getActiveWorksheet();
- const table = selectedSheet.getTables()[0];
-
- // Get the data range of the second column.
- const secondColumn = table.getColumn(2);
- const data = secondColumn.getRangeBetweenHeaderAndTotal();
-
- // Add an indentation of 1 character space to the data range.
- data.getFormat().adjustIndent(1);
- }
- ```
- - name: autofitColumns()
- uid: 'ExcelScript!ExcelScript.RangeFormat#autofitColumns:member(1)'
- package: ExcelScript!
- fullName: autofitColumns()
- summary: >-
- Changes the width of the columns of the current range to achieve the best fit, based on the current data in the
- columns.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'autofitColumns(): void;'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a new table from existing data and autofits the columns.
- */
- function main(workbook: ExcelScript.Workbook) {
- const currentSheet = workbook.getActiveWorksheet();
- const usedRange = currentSheet.getUsedRange();
-
- // Create the table.
- const table = currentSheet.addTable(usedRange, true);
-
- // Format the table columns.
- table.getRange().getFormat().autofitColumns();
- }
- ```
- - name: autofitRows()
- uid: 'ExcelScript!ExcelScript.RangeFormat#autofitRows:member(1)'
- package: ExcelScript!
- fullName: autofitRows()
- summary: >-
- Changes the height of the rows of the current range to achieve the best fit, based on the current data in the
- columns.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'autofitRows(): void;'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a new table from existing data and autofits the rows.
- */
- function main(workbook: ExcelScript.Workbook) {
- const currentSheet = workbook.getActiveWorksheet();
- const usedRange = currentSheet.getUsedRange();
-
- // Create the table.
- const table = currentSheet.addTable(usedRange, true);
-
- // Format the table rows.
- table.getRange().getFormat().autofitRows();
- }
- ```
- - name: getAutoIndent()
- uid: 'ExcelScript!ExcelScript.RangeFormat#getAutoIndent:member(1)'
- package: ExcelScript!
- fullName: getAutoIndent()
- summary: Specifies if text is automatically indented when text alignment is set to equal distribution.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAutoIndent(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getBorders()
- uid: 'ExcelScript!ExcelScript.RangeFormat#getBorders:member(1)'
- package: ExcelScript!
- fullName: getBorders()
- summary: Collection of border objects that apply to the overall range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBorders(): RangeBorder[];'
- return:
- type: '[]'
- description: ''
- - name: getColumnWidth()
- uid: 'ExcelScript!ExcelScript.RangeFormat#getColumnWidth:member(1)'
- package: ExcelScript!
- fullName: getColumnWidth()
- summary: >-
- Specifies the width of all columns within the range. If the column widths are not uniform, `null` will be
- returned.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColumnWidth(): number;'
- return:
- type: number
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script doubles the column width for every column in the active worksheet's used range.
- */
- function main(workbook: ExcelScript.Workbook) {
- const currentSheet = workbook.getActiveWorksheet();
- const usedRange = currentSheet.getUsedRange();
-
- // To optimize performance, get all the current row heights before setting them.
- let currentWidths = Array(usedRange.getColumnCount());
- for (let column = 0; column < currentWidths.length; column++) {
- currentWidths[column] = usedRange.getColumn(column).getFormat().getColumnWidth();
- }
-
- // Set the new column widths.
- for (let column = 0; column < currentWidths.length; column++) {
- usedRange.getFormat().setColumnWidth(currentWidths[column] * 2);
- }
- ```
- - name: getFill()
- uid: 'ExcelScript!ExcelScript.RangeFormat#getFill:member(1)'
- package: ExcelScript!
- fullName: getFill()
- summary: Returns the fill object defined on the overall range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFill(): RangeFill;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script gives the total row of a table a green color fill.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table in the workbook.
- let table = workbook.getTables()[0];
-
- // Get the range for the total row of the table.
- let totalRange = table.getTotalRowRange();
-
- // Set the fill color to green.
- totalRange.getFormat().getFill().setColor("green");
- }
- ```
- - name: getFont()
- uid: 'ExcelScript!ExcelScript.RangeFormat#getFont:member(1)'
- package: ExcelScript!
- fullName: getFont()
- summary: Returns the font object defined on the overall range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFont(): RangeFont;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script bolds the text of cell A1.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get A1 on the current worksheet.
- const cell = workbook.getActiveWorksheet().getCell(0,0);
-
- // Bold the font for that cell
- cell.getFormat().getFont().setBold(true);
- }
- ```
- - name: getHorizontalAlignment()
- uid: 'ExcelScript!ExcelScript.RangeFormat#getHorizontalAlignment:member(1)'
- package: ExcelScript!
- fullName: getHorizontalAlignment()
- summary: Represents the horizontal alignment for the specified object. See `ExcelScript.HorizontalAlignment` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHorizontalAlignment(): HorizontalAlignment;'
- return:
- type: ''
- description: ''
- - name: getIndentLevel()
- uid: 'ExcelScript!ExcelScript.RangeFormat#getIndentLevel:member(1)'
- package: ExcelScript!
- fullName: getIndentLevel()
- summary: An integer from 0 to 250 that indicates the indent level.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIndentLevel(): number;'
- return:
- type: number
- description: ''
- - name: getProtection()
- uid: 'ExcelScript!ExcelScript.RangeFormat#getProtection:member(1)'
- package: ExcelScript!
- fullName: getProtection()
- summary: Returns the format protection object for a range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getProtection(): FormatProtection;'
- return:
- type: ''
- description: ''
- - name: getRangeBorder(index)
- uid: 'ExcelScript!ExcelScript.RangeFormat#getRangeBorder:member(1)'
- package: ExcelScript!
- fullName: getRangeBorder(index)
- summary: Gets a border object using its name.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRangeBorder(index: BorderIndex): RangeBorder;'
- parameters:
- - id: index
- description: Index value of the border object to be retrieved. See `ExcelScript.BorderIndex` for details.
- type: ''
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a border around the outside of a range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get a range from the current worksheet.
- let range = workbook.getActiveWorksheet().getRange("B2:E15");
-
- // Add a border around the whole bounding range.
- let format = range.getFormat();
- format.getRangeBorder(ExcelScript.BorderIndex.edgeTop).setStyle(ExcelScript.BorderLineStyle.continuous); // Top border
- format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom).setStyle(ExcelScript.BorderLineStyle.continuous); // Bottom border
- format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft).setStyle(ExcelScript.BorderLineStyle.continuous); // Left border
- format.getRangeBorder(ExcelScript.BorderIndex.edgeRight).setStyle(ExcelScript.BorderLineStyle.continuous); // Right border
- }
- ```
- - name: getRangeBorderTintAndShade()
- uid: 'ExcelScript!ExcelScript.RangeFormat#getRangeBorderTintAndShade:member(1)'
- package: ExcelScript!
- fullName: getRangeBorderTintAndShade()
- summary: >-
- Specifies a double that lightens or darkens a color for range borders. The value is between -1 (darkest) and 1
- (brightest), with 0 for the original color. A `null` value indicates that the entire border collection doesn't
- have a uniform `tintAndShade` setting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRangeBorderTintAndShade(): number;'
- return:
- type: number
- description: ''
- - name: getReadingOrder()
- uid: 'ExcelScript!ExcelScript.RangeFormat#getReadingOrder:member(1)'
- package: ExcelScript!
- fullName: getReadingOrder()
- summary: The reading order for the range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getReadingOrder(): ReadingOrder;'
- return:
- type: ''
- description: ''
- - name: getRowHeight()
- uid: 'ExcelScript!ExcelScript.RangeFormat#getRowHeight:member(1)'
- package: ExcelScript!
- fullName: getRowHeight()
- summary: 'The height of all rows in the range. If the row heights are not uniform, `null` will be returned.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRowHeight(): number;'
- return:
- type: number
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script doubles the row height for every row in the active worksheet's used range.
- */
- function main(workbook: ExcelScript.Workbook) {
- const currentSheet = workbook.getActiveWorksheet();
- const usedRange = currentSheet.getUsedRange();
-
- // To optimize performance, get all the current row heights before setting them.
- let currentHeights = Array(usedRange.getRowCount());
- for (let row = 0; row < currentHeights.length; row++) {
- currentHeights[row] = usedRange.getRow(row).getFormat().getRowHeight();
- }
-
- // Set the new row heights.
- for (let row = 0; row < currentHeights.length; row++) {
- usedRange.getFormat().setRowHeight(currentHeights[row] * 2);
- }
- }
- ```
- - name: getShrinkToFit()
- uid: 'ExcelScript!ExcelScript.RangeFormat#getShrinkToFit:member(1)'
- package: ExcelScript!
- fullName: getShrinkToFit()
- summary: Specifies if text automatically shrinks to fit in the available column width.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShrinkToFit(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getTextOrientation()
- uid: 'ExcelScript!ExcelScript.RangeFormat#getTextOrientation:member(1)'
- package: ExcelScript!
- fullName: getTextOrientation()
- summary: >-
- The text orientation of all the cells within the range. The text orientation should be an integer either from -90
- to 90, or 180 for vertically-oriented text. If the orientation within a range are not uniform, then `null` will be
- returned.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTextOrientation(): number;'
- return:
- type: number
- description: ''
- - name: getUseStandardHeight()
- uid: 'ExcelScript!ExcelScript.RangeFormat#getUseStandardHeight:member(1)'
- package: ExcelScript!
- fullName: getUseStandardHeight()
- summary: >-
- Determines if the row height of the `Range` object equals the standard height of the sheet. Returns `true` if the
- row height of the `Range` object equals the standard height of the sheet. Returns `null` if the range contains
- more than one row and the rows aren't all the same height. Returns `false` otherwise.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getUseStandardHeight(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getUseStandardWidth()
- uid: 'ExcelScript!ExcelScript.RangeFormat#getUseStandardWidth:member(1)'
- package: ExcelScript!
- fullName: getUseStandardWidth()
- summary: >-
- Specifies if the column width of the `Range` object equals the standard width of the sheet. Returns `true` if the
- column width of the `Range` object equals the standard width of the sheet. Returns `null` if the range contains
- more than one column and the columns aren't all the same height. Returns `false` otherwise.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getUseStandardWidth(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getVerticalAlignment()
- uid: 'ExcelScript!ExcelScript.RangeFormat#getVerticalAlignment:member(1)'
- package: ExcelScript!
- fullName: getVerticalAlignment()
- summary: Represents the vertical alignment for the specified object. See `ExcelScript.VerticalAlignment` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVerticalAlignment(): VerticalAlignment;'
- return:
- type: ''
- description: ''
- - name: getWrapText()
- uid: 'ExcelScript!ExcelScript.RangeFormat#getWrapText:member(1)'
- package: ExcelScript!
- fullName: getWrapText()
- summary: >-
- Specifies if Excel wraps the text in the object. A `null` value indicates that the entire range doesn't have a
- uniform wrap setting
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWrapText(): boolean;'
- return:
- type: boolean
- description: ''
- - name: setAutoIndent(autoIndent)
- uid: 'ExcelScript!ExcelScript.RangeFormat#setAutoIndent:member(1)'
- package: ExcelScript!
- fullName: setAutoIndent(autoIndent)
- summary: Specifies if text is automatically indented when text alignment is set to equal distribution.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setAutoIndent(autoIndent: boolean): void;'
- parameters:
- - id: autoIndent
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setColumnWidth(columnWidth)
- uid: 'ExcelScript!ExcelScript.RangeFormat#setColumnWidth:member(1)'
- package: ExcelScript!
- fullName: setColumnWidth(columnWidth)
- summary: Specifies the width of all columns within the range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setColumnWidth(columnWidth: number): void;'
- parameters:
- - id: columnWidth
- description: ''
- type: number
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script inserts a new column and sets that column's width to 100 pixels wide.
- */
- function main(workbook: ExcelScript.Workbook) {
- const currentSheet = workbook.getActiveWorksheet();
-
- // Insert a new column between the current B and C columns.
- const bcRange = currentSheet.getRange("C:C");
- const newColumn = bcRange.insert(ExcelScript.InsertShiftDirection.right);
-
- // Set the column width of the new column to 100 pixels.
- newColumn.getFormat().setColumnWidth(100);
- }
- ```
- - name: setHorizontalAlignment(horizontalAlignment)
- uid: 'ExcelScript!ExcelScript.RangeFormat#setHorizontalAlignment:member(1)'
- package: ExcelScript!
- fullName: setHorizontalAlignment(horizontalAlignment)
- summary: Represents the horizontal alignment for the specified object. See `ExcelScript.HorizontalAlignment` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setHorizontalAlignment(horizontalAlignment: HorizontalAlignment): void;'
- parameters:
- - id: horizontalAlignment
- description: ''
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script centers the text in a table's header row cells.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table on the current worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const table = currentSheet.getTables()[0];
-
- // Get the header range.
- const headerRange = table.getHeaderRowRange();
-
- // Set the horizontal text alignment to `center`.
- headerRange.getFormat().setHorizontalAlignment(ExcelScript.HorizontalAlignment.center);
- }
- ```
- - name: setIndentLevel(indentLevel)
- uid: 'ExcelScript!ExcelScript.RangeFormat#setIndentLevel:member(1)'
- package: ExcelScript!
- fullName: setIndentLevel(indentLevel)
- summary: An integer from 0 to 250 that indicates the indent level.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setIndentLevel(indentLevel: number): void;'
- parameters:
- - id: indentLevel
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setRangeBorderTintAndShade(rangeBorderTintAndShade)
- uid: 'ExcelScript!ExcelScript.RangeFormat#setRangeBorderTintAndShade:member(1)'
- package: ExcelScript!
- fullName: setRangeBorderTintAndShade(rangeBorderTintAndShade)
- summary: >-
- Specifies a double that lightens or darkens a color for range borders. The value is between -1 (darkest) and 1
- (brightest), with 0 for the original color. A `null` value indicates that the entire border collection doesn't
- have a uniform `tintAndShade` setting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setRangeBorderTintAndShade(rangeBorderTintAndShade: number): void;'
- parameters:
- - id: rangeBorderTintAndShade
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setReadingOrder(readingOrder)
- uid: 'ExcelScript!ExcelScript.RangeFormat#setReadingOrder:member(1)'
- package: ExcelScript!
- fullName: setReadingOrder(readingOrder)
- summary: The reading order for the range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setReadingOrder(readingOrder: ReadingOrder): void;'
- parameters:
- - id: readingOrder
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setRowHeight(rowHeight)
- uid: 'ExcelScript!ExcelScript.RangeFormat#setRowHeight:member(1)'
- package: ExcelScript!
- fullName: setRowHeight(rowHeight)
- summary: Specifies the height of all rows in the range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setRowHeight(rowHeight: number): void;'
- parameters:
- - id: rowHeight
- description: ''
- type: number
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script inserts a new row and sets that row's width to 100 pixels tall.
- */
- function main(workbook: ExcelScript.Workbook) {
- const currentSheet = workbook.getActiveWorksheet();
-
- // Insert a new row between the current 2 and 3 rows.
- const bcRange = currentSheet.getRange("3:3");
- const newRow = bcRange.insert(ExcelScript.InsertShiftDirection.down);
-
- // Set the row height of the new row to 100 pixels.
- newRow.getFormat().setRowHeight(100);
- }
- ```
- - name: setShrinkToFit(shrinkToFit)
- uid: 'ExcelScript!ExcelScript.RangeFormat#setShrinkToFit:member(1)'
- package: ExcelScript!
- fullName: setShrinkToFit(shrinkToFit)
- summary: Specifies if text automatically shrinks to fit in the available column width.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShrinkToFit(shrinkToFit: boolean): void;'
- parameters:
- - id: shrinkToFit
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setTextOrientation(textOrientation)
- uid: 'ExcelScript!ExcelScript.RangeFormat#setTextOrientation:member(1)'
- package: ExcelScript!
- fullName: setTextOrientation(textOrientation)
- summary: >-
- The text orientation of all the cells within the range. The text orientation should be an integer either from -90
- to 90, or 180 for vertically-oriented text. If the orientation within a range are not uniform, then `null` will be
- returned.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTextOrientation(textOrientation: number): void;'
- parameters:
- - id: textOrientation
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setUseStandardHeight(useStandardHeight)
- uid: 'ExcelScript!ExcelScript.RangeFormat#setUseStandardHeight:member(1)'
- package: ExcelScript!
- fullName: setUseStandardHeight(useStandardHeight)
- summary: >-
- Determines if the row height of the `Range` object equals the standard height of the sheet. Note: This property is
- only intended to be set to `true`. Setting it to `false` has no effect.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setUseStandardHeight(useStandardHeight: boolean): void;'
- parameters:
- - id: useStandardHeight
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setUseStandardWidth(useStandardWidth)
- uid: 'ExcelScript!ExcelScript.RangeFormat#setUseStandardWidth:member(1)'
- package: ExcelScript!
- fullName: setUseStandardWidth(useStandardWidth)
- summary: >-
- Specifies if the column width of the `Range` object equals the standard width of the sheet. Note: This property is
- only intended to be set to `true`. Setting it to `false` has no effect.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setUseStandardWidth(useStandardWidth: boolean): void;'
- parameters:
- - id: useStandardWidth
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setVerticalAlignment(verticalAlignment)
- uid: 'ExcelScript!ExcelScript.RangeFormat#setVerticalAlignment:member(1)'
- package: ExcelScript!
- fullName: setVerticalAlignment(verticalAlignment)
- summary: Represents the vertical alignment for the specified object. See `ExcelScript.VerticalAlignment` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setVerticalAlignment(verticalAlignment: VerticalAlignment): void;'
- parameters:
- - id: verticalAlignment
- description: ''
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the vertical alignment formatting to "top"
- * for every cell in the row.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get row 1 for the current worksheet.
- const sheet = workbook.getActiveWorksheet();
- const firstRow = sheet.getRange("1:1");
-
- // Set the vertical alignment formatting on the row.
- firstRow.getFormat().setVerticalAlignment(ExcelScript.VerticalAlignment.top);
- }
- ```
- - name: setWrapText(wrapText)
- uid: 'ExcelScript!ExcelScript.RangeFormat#setWrapText:member(1)'
- package: ExcelScript!
- fullName: setWrapText(wrapText)
- summary: >-
- Specifies if Excel wraps the text in the object. A `null` value indicates that the entire range doesn't have a
- uniform wrap setting
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setWrapText(wrapText: boolean): void;'
- parameters:
- - id: wrapText
- description: ''
- type: boolean
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script turns on the text wrapping for a column.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the E column in current worksheet.
- const column = workbook.getActiveWorksheet().getRange("E:E");
-
- // Set wrap text to true for the column.
- column.getFormat().setWrapText(true);
- }
- ```
+### YamlMime:TSType
+name: ExcelScript.RangeFormat
+uid: 'ExcelScript!ExcelScript.RangeFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.RangeFormat
+summary: 'A format object encapsulating the range''s font, fill, borders, alignment, and other properties.'
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies some simple formatting to the top row of the used range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the top row of the used range in the current worksheet.
+ const selectedSheet = workbook.getActiveWorksheet();
+ const topRow = selectedSheet.getUsedRange().getRow(0);
+
+ // For the top row, set the fill to black, the font color to white, and the font to be bold.
+ const format: ExcelScript.RangeFormat = topRow.getFormat();
+ format.getFill().setColor("black");
+ format.getFont().setColor("white");
+ format.getFont().setBold(true);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: adjustIndent(amount)
+ uid: 'ExcelScript!ExcelScript.RangeFormat#adjustIndent:member(1)'
+ package: ExcelScript!
+ fullName: adjustIndent(amount)
+ summary: >-
+ Adjusts the indentation of the range formatting. The indent value ranges from 0 to 250 and is measured in
+ characters.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'adjustIndent(amount: number): void;'
+ parameters:
+ - id: amount
+ description: >-
+ The number of character spaces by which the current indent is adjusted. This value should be between -250
+ and 250. **Note**: If the amount would raise the indent level above 250, the indent level stays with
+ 250. Similarly, if the amount would lower the indent level below 0, the indent level stays 0.
+ type: number
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adjusts the indentation of a specific table column.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table in the current worksheet.
+ const selectedSheet = workbook.getActiveWorksheet();
+ const table = selectedSheet.getTables()[0];
+
+ // Get the data range of the second column.
+ const secondColumn = table.getColumn(2);
+ const data = secondColumn.getRangeBetweenHeaderAndTotal();
+
+ // Add an indentation of 1 character space to the data range.
+ data.getFormat().adjustIndent(1);
+ }
+ ```
+ - name: autofitColumns()
+ uid: 'ExcelScript!ExcelScript.RangeFormat#autofitColumns:member(1)'
+ package: ExcelScript!
+ fullName: autofitColumns()
+ summary: >-
+ Changes the width of the columns of the current range to achieve the best fit, based on the current data in the
+ columns.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'autofitColumns(): void;'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a new table from existing data and autofits the columns.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ const currentSheet = workbook.getActiveWorksheet();
+ const usedRange = currentSheet.getUsedRange();
+
+ // Create the table.
+ const table = currentSheet.addTable(usedRange, true);
+
+ // Format the table columns.
+ table.getRange().getFormat().autofitColumns();
+ }
+ ```
+ - name: autofitRows()
+ uid: 'ExcelScript!ExcelScript.RangeFormat#autofitRows:member(1)'
+ package: ExcelScript!
+ fullName: autofitRows()
+ summary: >-
+ Changes the height of the rows of the current range to achieve the best fit, based on the current data in the
+ columns.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'autofitRows(): void;'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a new table from existing data and autofits the rows.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ const currentSheet = workbook.getActiveWorksheet();
+ const usedRange = currentSheet.getUsedRange();
+
+ // Create the table.
+ const table = currentSheet.addTable(usedRange, true);
+
+ // Format the table rows.
+ table.getRange().getFormat().autofitRows();
+ }
+ ```
+ - name: getAutoIndent()
+ uid: 'ExcelScript!ExcelScript.RangeFormat#getAutoIndent:member(1)'
+ package: ExcelScript!
+ fullName: getAutoIndent()
+ summary: Specifies if text is automatically indented when text alignment is set to equal distribution.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAutoIndent(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getBorders()
+ uid: 'ExcelScript!ExcelScript.RangeFormat#getBorders:member(1)'
+ package: ExcelScript!
+ fullName: getBorders()
+ summary: Collection of border objects that apply to the overall range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBorders(): RangeBorder[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getColumnWidth()
+ uid: 'ExcelScript!ExcelScript.RangeFormat#getColumnWidth:member(1)'
+ package: ExcelScript!
+ fullName: getColumnWidth()
+ summary: >-
+ Specifies the width of all columns within the range. If the column widths are not uniform, `null` will be
+ returned.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColumnWidth(): number;'
+ return:
+ type: number
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script doubles the column width for every column in the active worksheet's used range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ const currentSheet = workbook.getActiveWorksheet();
+ const usedRange = currentSheet.getUsedRange();
+
+ // To optimize performance, get all the current row heights before setting them.
+ let currentWidths = Array(usedRange.getColumnCount());
+ for (let column = 0; column < currentWidths.length; column++) {
+ currentWidths[column] = usedRange.getColumn(column).getFormat().getColumnWidth();
+ }
+
+ // Set the new column widths.
+ for (let column = 0; column < currentWidths.length; column++) {
+ usedRange.getFormat().setColumnWidth(currentWidths[column] * 2);
+ }
+ ```
+ - name: getFill()
+ uid: 'ExcelScript!ExcelScript.RangeFormat#getFill:member(1)'
+ package: ExcelScript!
+ fullName: getFill()
+ summary: Returns the fill object defined on the overall range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFill(): RangeFill;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script gives the total row of a table a green color fill.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table in the workbook.
+ let table = workbook.getTables()[0];
+
+ // Get the range for the total row of the table.
+ let totalRange = table.getTotalRowRange();
+
+ // Set the fill color to green.
+ totalRange.getFormat().getFill().setColor("green");
+ }
+ ```
+ - name: getFont()
+ uid: 'ExcelScript!ExcelScript.RangeFormat#getFont:member(1)'
+ package: ExcelScript!
+ fullName: getFont()
+ summary: Returns the font object defined on the overall range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFont(): RangeFont;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script bolds the text of cell A1.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get A1 on the current worksheet.
+ const cell = workbook.getActiveWorksheet().getCell(0,0);
+
+ // Bold the font for that cell
+ cell.getFormat().getFont().setBold(true);
+ }
+ ```
+ - name: getHorizontalAlignment()
+ uid: 'ExcelScript!ExcelScript.RangeFormat#getHorizontalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: getHorizontalAlignment()
+ summary: Represents the horizontal alignment for the specified object. See `ExcelScript.HorizontalAlignment` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHorizontalAlignment(): HorizontalAlignment;'
+ return:
+ type: ''
+ description: ''
+ - name: getIndentLevel()
+ uid: 'ExcelScript!ExcelScript.RangeFormat#getIndentLevel:member(1)'
+ package: ExcelScript!
+ fullName: getIndentLevel()
+ summary: An integer from 0 to 250 that indicates the indent level.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIndentLevel(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getProtection()
+ uid: 'ExcelScript!ExcelScript.RangeFormat#getProtection:member(1)'
+ package: ExcelScript!
+ fullName: getProtection()
+ summary: Returns the format protection object for a range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getProtection(): FormatProtection;'
+ return:
+ type: ''
+ description: ''
+ - name: getRangeBorder(index)
+ uid: 'ExcelScript!ExcelScript.RangeFormat#getRangeBorder:member(1)'
+ package: ExcelScript!
+ fullName: getRangeBorder(index)
+ summary: Gets a border object using its name.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRangeBorder(index: BorderIndex): RangeBorder;'
+ parameters:
+ - id: index
+ description: Index value of the border object to be retrieved. See `ExcelScript.BorderIndex` for details.
+ type: ''
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a border around the outside of a range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get a range from the current worksheet.
+ let range = workbook.getActiveWorksheet().getRange("B2:E15");
+
+ // Add a border around the whole bounding range.
+ let format = range.getFormat();
+ format.getRangeBorder(ExcelScript.BorderIndex.edgeTop).setStyle(ExcelScript.BorderLineStyle.continuous); // Top border
+ format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom).setStyle(ExcelScript.BorderLineStyle.continuous); // Bottom border
+ format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft).setStyle(ExcelScript.BorderLineStyle.continuous); // Left border
+ format.getRangeBorder(ExcelScript.BorderIndex.edgeRight).setStyle(ExcelScript.BorderLineStyle.continuous); // Right border
+ }
+ ```
+ - name: getRangeBorderTintAndShade()
+ uid: 'ExcelScript!ExcelScript.RangeFormat#getRangeBorderTintAndShade:member(1)'
+ package: ExcelScript!
+ fullName: getRangeBorderTintAndShade()
+ summary: >-
+ Specifies a double that lightens or darkens a color for range borders. The value is between -1 (darkest) and 1
+ (brightest), with 0 for the original color. A `null` value indicates that the entire border collection doesn't
+ have a uniform `tintAndShade` setting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRangeBorderTintAndShade(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getReadingOrder()
+ uid: 'ExcelScript!ExcelScript.RangeFormat#getReadingOrder:member(1)'
+ package: ExcelScript!
+ fullName: getReadingOrder()
+ summary: The reading order for the range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getReadingOrder(): ReadingOrder;'
+ return:
+ type: ''
+ description: ''
+ - name: getRowHeight()
+ uid: 'ExcelScript!ExcelScript.RangeFormat#getRowHeight:member(1)'
+ package: ExcelScript!
+ fullName: getRowHeight()
+ summary: 'The height of all rows in the range. If the row heights are not uniform, `null` will be returned.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRowHeight(): number;'
+ return:
+ type: number
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script doubles the row height for every row in the active worksheet's used range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ const currentSheet = workbook.getActiveWorksheet();
+ const usedRange = currentSheet.getUsedRange();
+
+ // To optimize performance, get all the current row heights before setting them.
+ let currentHeights = Array(usedRange.getRowCount());
+ for (let row = 0; row < currentHeights.length; row++) {
+ currentHeights[row] = usedRange.getRow(row).getFormat().getRowHeight();
+ }
+
+ // Set the new row heights.
+ for (let row = 0; row < currentHeights.length; row++) {
+ usedRange.getFormat().setRowHeight(currentHeights[row] * 2);
+ }
+ }
+ ```
+ - name: getShrinkToFit()
+ uid: 'ExcelScript!ExcelScript.RangeFormat#getShrinkToFit:member(1)'
+ package: ExcelScript!
+ fullName: getShrinkToFit()
+ summary: Specifies if text automatically shrinks to fit in the available column width.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShrinkToFit(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getTextOrientation()
+ uid: 'ExcelScript!ExcelScript.RangeFormat#getTextOrientation:member(1)'
+ package: ExcelScript!
+ fullName: getTextOrientation()
+ summary: >-
+ The text orientation of all the cells within the range. The text orientation should be an integer either from -90
+ to 90, or 180 for vertically-oriented text. If the orientation within a range are not uniform, then `null` will be
+ returned.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTextOrientation(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getUseStandardHeight()
+ uid: 'ExcelScript!ExcelScript.RangeFormat#getUseStandardHeight:member(1)'
+ package: ExcelScript!
+ fullName: getUseStandardHeight()
+ summary: >-
+ Determines if the row height of the `Range` object equals the standard height of the sheet. Returns `true` if the
+ row height of the `Range` object equals the standard height of the sheet. Returns `null` if the range contains
+ more than one row and the rows aren't all the same height. Returns `false` otherwise.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getUseStandardHeight(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getUseStandardWidth()
+ uid: 'ExcelScript!ExcelScript.RangeFormat#getUseStandardWidth:member(1)'
+ package: ExcelScript!
+ fullName: getUseStandardWidth()
+ summary: >-
+ Specifies if the column width of the `Range` object equals the standard width of the sheet. Returns `true` if the
+ column width of the `Range` object equals the standard width of the sheet. Returns `null` if the range contains
+ more than one column and the columns aren't all the same height. Returns `false` otherwise.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getUseStandardWidth(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getVerticalAlignment()
+ uid: 'ExcelScript!ExcelScript.RangeFormat#getVerticalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: getVerticalAlignment()
+ summary: Represents the vertical alignment for the specified object. See `ExcelScript.VerticalAlignment` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVerticalAlignment(): VerticalAlignment;'
+ return:
+ type: ''
+ description: ''
+ - name: getWrapText()
+ uid: 'ExcelScript!ExcelScript.RangeFormat#getWrapText:member(1)'
+ package: ExcelScript!
+ fullName: getWrapText()
+ summary: >-
+ Specifies if Excel wraps the text in the object. A `null` value indicates that the entire range doesn't have a
+ uniform wrap setting
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWrapText(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: setAutoIndent(autoIndent)
+ uid: 'ExcelScript!ExcelScript.RangeFormat#setAutoIndent:member(1)'
+ package: ExcelScript!
+ fullName: setAutoIndent(autoIndent)
+ summary: Specifies if text is automatically indented when text alignment is set to equal distribution.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setAutoIndent(autoIndent: boolean): void;'
+ parameters:
+ - id: autoIndent
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setColumnWidth(columnWidth)
+ uid: 'ExcelScript!ExcelScript.RangeFormat#setColumnWidth:member(1)'
+ package: ExcelScript!
+ fullName: setColumnWidth(columnWidth)
+ summary: Specifies the width of all columns within the range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setColumnWidth(columnWidth: number): void;'
+ parameters:
+ - id: columnWidth
+ description: ''
+ type: number
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script inserts a new column and sets that column's width to 100 pixels wide.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ const currentSheet = workbook.getActiveWorksheet();
+
+ // Insert a new column between the current B and C columns.
+ const bcRange = currentSheet.getRange("C:C");
+ const newColumn = bcRange.insert(ExcelScript.InsertShiftDirection.right);
+
+ // Set the column width of the new column to 100 pixels.
+ newColumn.getFormat().setColumnWidth(100);
+ }
+ ```
+ - name: setHorizontalAlignment(horizontalAlignment)
+ uid: 'ExcelScript!ExcelScript.RangeFormat#setHorizontalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: setHorizontalAlignment(horizontalAlignment)
+ summary: Represents the horizontal alignment for the specified object. See `ExcelScript.HorizontalAlignment` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setHorizontalAlignment(horizontalAlignment: HorizontalAlignment): void;'
+ parameters:
+ - id: horizontalAlignment
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script centers the text in a table's header row cells.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table on the current worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const table = currentSheet.getTables()[0];
+
+ // Get the header range.
+ const headerRange = table.getHeaderRowRange();
+
+ // Set the horizontal text alignment to `center`.
+ headerRange.getFormat().setHorizontalAlignment(ExcelScript.HorizontalAlignment.center);
+ }
+ ```
+ - name: setIndentLevel(indentLevel)
+ uid: 'ExcelScript!ExcelScript.RangeFormat#setIndentLevel:member(1)'
+ package: ExcelScript!
+ fullName: setIndentLevel(indentLevel)
+ summary: An integer from 0 to 250 that indicates the indent level.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setIndentLevel(indentLevel: number): void;'
+ parameters:
+ - id: indentLevel
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setRangeBorderTintAndShade(rangeBorderTintAndShade)
+ uid: 'ExcelScript!ExcelScript.RangeFormat#setRangeBorderTintAndShade:member(1)'
+ package: ExcelScript!
+ fullName: setRangeBorderTintAndShade(rangeBorderTintAndShade)
+ summary: >-
+ Specifies a double that lightens or darkens a color for range borders. The value is between -1 (darkest) and 1
+ (brightest), with 0 for the original color. A `null` value indicates that the entire border collection doesn't
+ have a uniform `tintAndShade` setting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setRangeBorderTintAndShade(rangeBorderTintAndShade: number): void;'
+ parameters:
+ - id: rangeBorderTintAndShade
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setReadingOrder(readingOrder)
+ uid: 'ExcelScript!ExcelScript.RangeFormat#setReadingOrder:member(1)'
+ package: ExcelScript!
+ fullName: setReadingOrder(readingOrder)
+ summary: The reading order for the range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setReadingOrder(readingOrder: ReadingOrder): void;'
+ parameters:
+ - id: readingOrder
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setRowHeight(rowHeight)
+ uid: 'ExcelScript!ExcelScript.RangeFormat#setRowHeight:member(1)'
+ package: ExcelScript!
+ fullName: setRowHeight(rowHeight)
+ summary: Specifies the height of all rows in the range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setRowHeight(rowHeight: number): void;'
+ parameters:
+ - id: rowHeight
+ description: ''
+ type: number
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script inserts a new row and sets that row's width to 100 pixels tall.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ const currentSheet = workbook.getActiveWorksheet();
+
+ // Insert a new row between the current 2 and 3 rows.
+ const bcRange = currentSheet.getRange("3:3");
+ const newRow = bcRange.insert(ExcelScript.InsertShiftDirection.down);
+
+ // Set the row height of the new row to 100 pixels.
+ newRow.getFormat().setRowHeight(100);
+ }
+ ```
+ - name: setShrinkToFit(shrinkToFit)
+ uid: 'ExcelScript!ExcelScript.RangeFormat#setShrinkToFit:member(1)'
+ package: ExcelScript!
+ fullName: setShrinkToFit(shrinkToFit)
+ summary: Specifies if text automatically shrinks to fit in the available column width.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShrinkToFit(shrinkToFit: boolean): void;'
+ parameters:
+ - id: shrinkToFit
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setTextOrientation(textOrientation)
+ uid: 'ExcelScript!ExcelScript.RangeFormat#setTextOrientation:member(1)'
+ package: ExcelScript!
+ fullName: setTextOrientation(textOrientation)
+ summary: >-
+ The text orientation of all the cells within the range. The text orientation should be an integer either from -90
+ to 90, or 180 for vertically-oriented text. If the orientation within a range are not uniform, then `null` will be
+ returned.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTextOrientation(textOrientation: number): void;'
+ parameters:
+ - id: textOrientation
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setUseStandardHeight(useStandardHeight)
+ uid: 'ExcelScript!ExcelScript.RangeFormat#setUseStandardHeight:member(1)'
+ package: ExcelScript!
+ fullName: setUseStandardHeight(useStandardHeight)
+ summary: >-
+ Determines if the row height of the `Range` object equals the standard height of the sheet. Note: This property is
+ only intended to be set to `true`. Setting it to `false` has no effect.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setUseStandardHeight(useStandardHeight: boolean): void;'
+ parameters:
+ - id: useStandardHeight
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setUseStandardWidth(useStandardWidth)
+ uid: 'ExcelScript!ExcelScript.RangeFormat#setUseStandardWidth:member(1)'
+ package: ExcelScript!
+ fullName: setUseStandardWidth(useStandardWidth)
+ summary: >-
+ Specifies if the column width of the `Range` object equals the standard width of the sheet. Note: This property is
+ only intended to be set to `true`. Setting it to `false` has no effect.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setUseStandardWidth(useStandardWidth: boolean): void;'
+ parameters:
+ - id: useStandardWidth
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setVerticalAlignment(verticalAlignment)
+ uid: 'ExcelScript!ExcelScript.RangeFormat#setVerticalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: setVerticalAlignment(verticalAlignment)
+ summary: Represents the vertical alignment for the specified object. See `ExcelScript.VerticalAlignment` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setVerticalAlignment(verticalAlignment: VerticalAlignment): void;'
+ parameters:
+ - id: verticalAlignment
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the vertical alignment formatting to "top"
+ * for every cell in the row.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get row 1 for the current worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const firstRow = sheet.getRange("1:1");
+
+ // Set the vertical alignment formatting on the row.
+ firstRow.getFormat().setVerticalAlignment(ExcelScript.VerticalAlignment.top);
+ }
+ ```
+ - name: setWrapText(wrapText)
+ uid: 'ExcelScript!ExcelScript.RangeFormat#setWrapText:member(1)'
+ package: ExcelScript!
+ fullName: setWrapText(wrapText)
+ summary: >-
+ Specifies if Excel wraps the text in the object. A `null` value indicates that the entire range doesn't have a
+ uniform wrap setting
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setWrapText(wrapText: boolean): void;'
+ parameters:
+ - id: wrapText
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script turns on the text wrapping for a column.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the E column in current worksheet.
+ const column = workbook.getActiveWorksheet().getRange("E:E");
+
+ // Set wrap text to true for the column.
+ column.getFormat().setWrapText(true);
+ }
+ ```
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.rangehyperlink.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.rangehyperlink.yml
index 4e99fb50..3cf46f04 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.rangehyperlink.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.rangehyperlink.yml
@@ -1,106 +1,106 @@
-### YamlMime:TSType
-name: ExcelScript.RangeHyperlink
-uid: 'ExcelScript!ExcelScript.RangeHyperlink:interface'
-package: ExcelScript!
-fullName: ExcelScript.RangeHyperlink
-summary: Represents the necessary strings to get/set a hyperlink (XHL) object.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script puts a link to a webpage in a cell.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first cell in the current worksheet.
- const cell = workbook.getActiveWorksheet().getCell(0,0);
-
- // Create a link to a webpage.
- const sampleHyperlink : ExcelScript.RangeHyperlink = {
- address: "https://learn.microsoft.com/office/dev/scripts/resources/samples/table-of-contents",
- screenTip: "Sample: Create a workbook table of contents",
- textToDisplay: "Learn how to make a workbook table of contents"
- }
-
- // Put the link in the cell and format the width to fit.
- cell.setHyperlink(sampleHyperlink);
- cell.getFormat().autofitColumns();
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: address
- uid: 'ExcelScript!ExcelScript.RangeHyperlink#address:member'
- package: ExcelScript!
- fullName: address
- summary: Represents the URL target for the hyperlink.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'address?: string;'
- return:
- type: string
- - name: documentReference
- uid: 'ExcelScript!ExcelScript.RangeHyperlink#documentReference:member'
- package: ExcelScript!
- fullName: documentReference
- summary: Represents the document reference target for the hyperlink.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'documentReference?: string;'
- return:
- type: string
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a hyperlink in the current cell to a table.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the selected cell.
- const selectedCell = workbook.getActiveCell();
-
- // Create a hyperlink from the current cell to a table named "Resources".
- const link : ExcelScript.RangeHyperlink = {
- documentReference: "Resources",
- screenTip: "Resources table",
- textToDisplay: "Go to table"
- } ;
-
- selectedCell.setHyperlink(link)
- }
- ```
- - name: screenTip
- uid: 'ExcelScript!ExcelScript.RangeHyperlink#screenTip:member'
- package: ExcelScript!
- fullName: screenTip
- summary: Represents the string displayed when hovering over the hyperlink.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'screenTip?: string;'
- return:
- type: string
- - name: textToDisplay
- uid: 'ExcelScript!ExcelScript.RangeHyperlink#textToDisplay:member'
- package: ExcelScript!
- fullName: textToDisplay
- summary: Represents the string that is displayed in the top left most cell in the range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'textToDisplay?: string;'
- return:
- type: string
+### YamlMime:TSType
+name: ExcelScript.RangeHyperlink
+uid: 'ExcelScript!ExcelScript.RangeHyperlink:interface'
+package: ExcelScript!
+fullName: ExcelScript.RangeHyperlink
+summary: Represents the necessary strings to get/set a hyperlink (XHL) object.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script puts a link to a webpage in a cell.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first cell in the current worksheet.
+ const cell = workbook.getActiveWorksheet().getCell(0,0);
+
+ // Create a link to a webpage.
+ const sampleHyperlink : ExcelScript.RangeHyperlink = {
+ address: "https://learn.microsoft.com/office/dev/scripts/resources/samples/table-of-contents",
+ screenTip: "Sample: Create a workbook table of contents",
+ textToDisplay: "Learn how to make a workbook table of contents"
+ }
+
+ // Put the link in the cell and format the width to fit.
+ cell.setHyperlink(sampleHyperlink);
+ cell.getFormat().autofitColumns();
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: address
+ uid: 'ExcelScript!ExcelScript.RangeHyperlink#address:member'
+ package: ExcelScript!
+ fullName: address
+ summary: Represents the URL target for the hyperlink.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'address?: string;'
+ return:
+ type: string
+ - name: documentReference
+ uid: 'ExcelScript!ExcelScript.RangeHyperlink#documentReference:member'
+ package: ExcelScript!
+ fullName: documentReference
+ summary: Represents the document reference target for the hyperlink.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'documentReference?: string;'
+ return:
+ type: string
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a hyperlink in the current cell to a table.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the selected cell.
+ const selectedCell = workbook.getActiveCell();
+
+ // Create a hyperlink from the current cell to a table named "Resources".
+ const link : ExcelScript.RangeHyperlink = {
+ documentReference: "Resources",
+ screenTip: "Resources table",
+ textToDisplay: "Go to table"
+ } ;
+
+ selectedCell.setHyperlink(link)
+ }
+ ```
+ - name: screenTip
+ uid: 'ExcelScript!ExcelScript.RangeHyperlink#screenTip:member'
+ package: ExcelScript!
+ fullName: screenTip
+ summary: Represents the string displayed when hovering over the hyperlink.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'screenTip?: string;'
+ return:
+ type: string
+ - name: textToDisplay
+ uid: 'ExcelScript!ExcelScript.RangeHyperlink#textToDisplay:member'
+ package: ExcelScript!
+ fullName: textToDisplay
+ summary: Represents the string that is displayed in the top left most cell in the range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'textToDisplay?: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.rangesort.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.rangesort.yml
index 308459f1..c3cf5316 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.rangesort.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.rangesort.yml
@@ -1,71 +1,71 @@
-### YamlMime:TSType
-name: ExcelScript.RangeSort
-uid: 'ExcelScript!ExcelScript.RangeSort:interface'
-package: ExcelScript!
-fullName: ExcelScript.RangeSort
-summary: Manages sorting operations on `Range` objects.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: 'apply(fields, matchCase, hasHeaders, orientation, method)'
- uid: 'ExcelScript!ExcelScript.RangeSort#apply:member(1)'
- package: ExcelScript!
- fullName: 'apply(fields, matchCase, hasHeaders, orientation, method)'
- summary: Perform a sort operation.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- apply(
- fields: SortField[],
- matchCase?: boolean,
- hasHeaders?: boolean,
- orientation?: SortOrientation,
- method?: SortMethod
- ): void;
- parameters:
- - id: fields
- description: The list of conditions to sort on.
- type: '[]'
- - id: matchCase
- description: Optional. Whether to have the casing impact string ordering.
- type: boolean
- - id: hasHeaders
- description: Optional. Whether the range has a header.
- type: boolean
- - id: orientation
- description: Optional. Whether the operation is sorting rows or columns.
- type: ''
- - id: method
- description: Optional. The ordering method used for Chinese characters.
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sorts the used range of the current worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the used range of the current worksheet.
- const activeRange = workbook.getActiveWorksheet().getUsedRange();
-
- // Sort the rows in ascending order based on the last column.
- activeRange.getSort().apply(
- [{
- ascending: true,
- key: activeRange.getColumnCount() - 1
- }],
- false, /* Don't match case. */
- true, /* Treat the first row as a header row. */
- ExcelScript.SortOrientation.rows
- );
- }
- ```
+### YamlMime:TSType
+name: ExcelScript.RangeSort
+uid: 'ExcelScript!ExcelScript.RangeSort:interface'
+package: ExcelScript!
+fullName: ExcelScript.RangeSort
+summary: Manages sorting operations on `Range` objects.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: 'apply(fields, matchCase, hasHeaders, orientation, method)'
+ uid: 'ExcelScript!ExcelScript.RangeSort#apply:member(1)'
+ package: ExcelScript!
+ fullName: 'apply(fields, matchCase, hasHeaders, orientation, method)'
+ summary: Perform a sort operation.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ apply(
+ fields: SortField[],
+ matchCase?: boolean,
+ hasHeaders?: boolean,
+ orientation?: SortOrientation,
+ method?: SortMethod
+ ): void;
+ parameters:
+ - id: fields
+ description: The list of conditions to sort on.
+ type: '[]'
+ - id: matchCase
+ description: Optional. Whether to have the casing impact string ordering.
+ type: boolean
+ - id: hasHeaders
+ description: Optional. Whether the range has a header.
+ type: boolean
+ - id: orientation
+ description: Optional. Whether the operation is sorting rows or columns.
+ type: ''
+ - id: method
+ description: Optional. The ordering method used for Chinese characters.
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sorts the used range of the current worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the used range of the current worksheet.
+ const activeRange = workbook.getActiveWorksheet().getUsedRange();
+
+ // Sort the rows in ascending order based on the last column.
+ activeRange.getSort().apply(
+ [{
+ ascending: true,
+ key: activeRange.getColumnCount() - 1
+ }],
+ false, /* Don't match case. */
+ true, /* Treat the first row as a header row. */
+ ExcelScript.SortOrientation.rows
+ );
+ }
+ ```
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.rangeunderlinestyle.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.rangeunderlinestyle.yml
index abf894ae..0f707018 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.rangeunderlinestyle.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.rangeunderlinestyle.yml
@@ -1,30 +1,30 @@
-### YamlMime:TSEnum
-name: ExcelScript.RangeUnderlineStyle
-uid: 'ExcelScript!ExcelScript.RangeUnderlineStyle:enum'
-package: ExcelScript!
-fullName: ExcelScript.RangeUnderlineStyle
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: double
- uid: 'ExcelScript!ExcelScript.RangeUnderlineStyle.double:member'
- package: ExcelScript!
- summary: ''
- - name: doubleAccountant
- uid: 'ExcelScript!ExcelScript.RangeUnderlineStyle.doubleAccountant:member'
- package: ExcelScript!
- summary: ''
- - name: none
- uid: 'ExcelScript!ExcelScript.RangeUnderlineStyle.none:member'
- package: ExcelScript!
- summary: ''
- - name: single
- uid: 'ExcelScript!ExcelScript.RangeUnderlineStyle.single:member'
- package: ExcelScript!
- summary: ''
- - name: singleAccountant
- uid: 'ExcelScript!ExcelScript.RangeUnderlineStyle.singleAccountant:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.RangeUnderlineStyle
+uid: 'ExcelScript!ExcelScript.RangeUnderlineStyle:enum'
+package: ExcelScript!
+fullName: ExcelScript.RangeUnderlineStyle
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: double
+ uid: 'ExcelScript!ExcelScript.RangeUnderlineStyle.double:member'
+ package: ExcelScript!
+ summary: ''
+ - name: doubleAccountant
+ uid: 'ExcelScript!ExcelScript.RangeUnderlineStyle.doubleAccountant:member'
+ package: ExcelScript!
+ summary: ''
+ - name: none
+ uid: 'ExcelScript!ExcelScript.RangeUnderlineStyle.none:member'
+ package: ExcelScript!
+ summary: ''
+ - name: single
+ uid: 'ExcelScript!ExcelScript.RangeUnderlineStyle.single:member'
+ package: ExcelScript!
+ summary: ''
+ - name: singleAccountant
+ uid: 'ExcelScript!ExcelScript.RangeUnderlineStyle.singleAccountant:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.rangevaluetype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.rangevaluetype.yml
index dea38dbc..38f0459e 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.rangevaluetype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.rangevaluetype.yml
@@ -1,80 +1,80 @@
-### YamlMime:TSEnum
-name: ExcelScript.RangeValueType
-uid: 'ExcelScript!ExcelScript.RangeValueType:enum'
-package: ExcelScript!
-fullName: ExcelScript.RangeValueType
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script formats rows in a worksheet based on the first value in that row.
- * If it's the boolean value TRUE, the row is bolded.
- * If it's FALSE, nothing is changed.
- * If the value type isn't a boolean, the row is italicized.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the used range in the active worksheet.
- const sheet = workbook.getActiveWorksheet();
- const usedRange = sheet.getUsedRange();
-
- // Get the values in the first column.
- const firstColumnValues = usedRange.getColumn(0).getValues();
-
- // Look at the first cell in each row.
- const rowCount = usedRange.getRowCount();
- for (let i = 0; i < rowCount; i++) {
- // Get the type of the first cell to make sure it's a boolean.
- let firstValueType = usedRange.getCell(i, 0).getValueType();
-
- // Set the bold or italic of the row as described earlier.
- if (firstValueType === ExcelScript.RangeValueType.boolean) {
- if (firstColumnValues[i][0] as boolean === true) {
- usedRange.getRow(i).getFormat().getFont().setBold(true);
- } else {
- usedRange.getRow(i).getFormat().getFont().setBold(false);
- }
- } else {
- usedRange.getRow(i).getFormat().getFont().setItalic(true);
- }
- }
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: boolean
- uid: 'ExcelScript!ExcelScript.RangeValueType.boolean:member'
- package: ExcelScript!
- summary: ''
- - name: double
- uid: 'ExcelScript!ExcelScript.RangeValueType.double:member'
- package: ExcelScript!
- summary: ''
- - name: empty
- uid: 'ExcelScript!ExcelScript.RangeValueType.empty:member'
- package: ExcelScript!
- summary: ''
- - name: error
- uid: 'ExcelScript!ExcelScript.RangeValueType.error:member'
- package: ExcelScript!
- summary: ''
- - name: integer
- uid: 'ExcelScript!ExcelScript.RangeValueType.integer:member'
- package: ExcelScript!
- summary: ''
- - name: richValue
- uid: 'ExcelScript!ExcelScript.RangeValueType.richValue:member'
- package: ExcelScript!
- summary: ''
- - name: string
- uid: 'ExcelScript!ExcelScript.RangeValueType.string:member'
- package: ExcelScript!
- summary: ''
- - name: unknown
- uid: 'ExcelScript!ExcelScript.RangeValueType.unknown:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.RangeValueType
+uid: 'ExcelScript!ExcelScript.RangeValueType:enum'
+package: ExcelScript!
+fullName: ExcelScript.RangeValueType
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script formats rows in a worksheet based on the first value in that row.
+ * If it's the boolean value TRUE, the row is bolded.
+ * If it's FALSE, nothing is changed.
+ * If the value type isn't a boolean, the row is italicized.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the used range in the active worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const usedRange = sheet.getUsedRange();
+
+ // Get the values in the first column.
+ const firstColumnValues = usedRange.getColumn(0).getValues();
+
+ // Look at the first cell in each row.
+ const rowCount = usedRange.getRowCount();
+ for (let i = 0; i < rowCount; i++) {
+ // Get the type of the first cell to make sure it's a boolean.
+ let firstValueType = usedRange.getCell(i, 0).getValueType();
+
+ // Set the bold or italic of the row as described earlier.
+ if (firstValueType === ExcelScript.RangeValueType.boolean) {
+ if (firstColumnValues[i][0] as boolean === true) {
+ usedRange.getRow(i).getFormat().getFont().setBold(true);
+ } else {
+ usedRange.getRow(i).getFormat().getFont().setBold(false);
+ }
+ } else {
+ usedRange.getRow(i).getFormat().getFont().setItalic(true);
+ }
+ }
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: boolean
+ uid: 'ExcelScript!ExcelScript.RangeValueType.boolean:member'
+ package: ExcelScript!
+ summary: ''
+ - name: double
+ uid: 'ExcelScript!ExcelScript.RangeValueType.double:member'
+ package: ExcelScript!
+ summary: ''
+ - name: empty
+ uid: 'ExcelScript!ExcelScript.RangeValueType.empty:member'
+ package: ExcelScript!
+ summary: ''
+ - name: error
+ uid: 'ExcelScript!ExcelScript.RangeValueType.error:member'
+ package: ExcelScript!
+ summary: ''
+ - name: integer
+ uid: 'ExcelScript!ExcelScript.RangeValueType.integer:member'
+ package: ExcelScript!
+ summary: ''
+ - name: richValue
+ uid: 'ExcelScript!ExcelScript.RangeValueType.richValue:member'
+ package: ExcelScript!
+ summary: ''
+ - name: string
+ uid: 'ExcelScript!ExcelScript.RangeValueType.string:member'
+ package: ExcelScript!
+ summary: ''
+ - name: unknown
+ uid: 'ExcelScript!ExcelScript.RangeValueType.unknown:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.rangeview.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.rangeview.yml
index ca24e4ff..acb6c6ef 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.rangeview.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.rangeview.yml
@@ -1,321 +1,321 @@
-### YamlMime:TSType
-name: ExcelScript.RangeView
-uid: 'ExcelScript!ExcelScript.RangeView:interface'
-package: ExcelScript!
-fullName: ExcelScript.RangeView
-summary: RangeView represents a set of visible cells of the parent range.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script copies values and formatting from the
- * visible range of a table in Sheet1 into Sheet2.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the filtered data from Sheet1.
- const currentSheet = workbook.getWorksheet("Sheet1");
- const table = currentSheet.getTables()[0];
- const visibleTableRange: ExcelScript.RangeView = table.getRange().getVisibleView();
- const source = currentSheet.getRanges(visibleTableRange.getCellAddresses().toString());
-
- // Copy the data into the other sheet.
- const otherSheet = workbook.getWorksheet("Sheet2");
- const otherRangeCorner = otherSheet.getRange("A1");
- otherRangeCorner.copyFrom(source, ExcelScript.RangeCopyType.all);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getCellAddresses()
- uid: 'ExcelScript!ExcelScript.RangeView#getCellAddresses:member(1)'
- package: ExcelScript!
- fullName: getCellAddresses()
- summary: Represents the cell addresses of the `RangeView`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCellAddresses(): string[][];'
- return:
- type: 'string[][]'
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script copies values and formatting from the
- * visible range of a table in Sheet1 into Sheet2.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the filtered data from Sheet1.
- const currentSheet = workbook.getWorksheet("Sheet1");
- const table = currentSheet.getTables()[0];
- const visibleTableRange: ExcelScript.RangeView = table.getRange().getVisibleView();
- const source = currentSheet.getRanges(visibleTableRange.getCellAddresses().toString());
-
- // Copy the data into the other sheet.
- const otherSheet = workbook.getWorksheet("Sheet2");
- const otherRangeCorner = otherSheet.getRange("A1");
- otherRangeCorner.copyFrom(source, ExcelScript.RangeCopyType.all);
- }
- ```
- - name: getColumnCount()
- uid: 'ExcelScript!ExcelScript.RangeView#getColumnCount:member(1)'
- package: ExcelScript!
- fullName: getColumnCount()
- summary: The number of visible columns.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColumnCount(): number;'
- return:
- type: number
- description: ''
- - name: getFormulas()
- uid: 'ExcelScript!ExcelScript.RangeView#getFormulas:member(1)'
- package: ExcelScript!
- fullName: getFormulas()
- summary: 'Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormulas(): string[][];'
- return:
- type: 'string[][]'
- description: ''
- - name: getFormulasLocal()
- uid: 'ExcelScript!ExcelScript.RangeView#getFormulasLocal:member(1)'
- package: ExcelScript!
- fullName: getFormulasLocal()
- summary: >-
- Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the
- English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its value is
- returned instead.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormulasLocal(): string[][];'
- return:
- type: 'string[][]'
- description: ''
- - name: getFormulasR1C1()
- uid: 'ExcelScript!ExcelScript.RangeView#getFormulasR1C1:member(1)'
- package: ExcelScript!
- fullName: getFormulasR1C1()
- summary: 'Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormulasR1C1(): string[][];'
- return:
- type: 'string[][]'
- description: ''
- - name: getIndex()
- uid: 'ExcelScript!ExcelScript.RangeView#getIndex:member(1)'
- package: ExcelScript!
- fullName: getIndex()
- summary: Returns a value that represents the index of the `RangeView`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIndex(): number;'
- return:
- type: number
- description: ''
- - name: getNumberFormat()
- uid: 'ExcelScript!ExcelScript.RangeView#getNumberFormat:member(1)'
- package: ExcelScript!
- fullName: getNumberFormat()
- summary: Represents Excel's number format code for the given cell.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNumberFormat(): string[][];'
- return:
- type: 'string[][]'
- description: ''
- - name: getRange()
- uid: 'ExcelScript!ExcelScript.RangeView#getRange:member(1)'
- package: ExcelScript!
- fullName: getRange()
- summary: Gets the parent range associated with the current `RangeView`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRange(): Range;'
- return:
- type: ''
- description: ''
- - name: getRowCount()
- uid: 'ExcelScript!ExcelScript.RangeView#getRowCount:member(1)'
- package: ExcelScript!
- fullName: getRowCount()
- summary: The number of visible rows.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRowCount(): number;'
- return:
- type: number
- description: ''
- - name: getRows()
- uid: 'ExcelScript!ExcelScript.RangeView#getRows:member(1)'
- package: ExcelScript!
- fullName: getRows()
- summary: Represents a collection of range views associated with the range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRows(): RangeView[];'
- return:
- type: '[]'
- description: ''
- - name: getText()
- uid: 'ExcelScript!ExcelScript.RangeView#getText:member(1)'
- package: ExcelScript!
- fullName: getText()
- summary: >-
- Text values of the specified range. The text value will not depend on the cell width. The \# sign substitution
- that happens in Excel UI will not affect the text value returned by the API.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getText(): string[][];'
- return:
- type: 'string[][]'
- description: ''
- - name: getValues()
- uid: 'ExcelScript!ExcelScript.RangeView#getValues:member(1)'
- package: ExcelScript!
- fullName: getValues()
- summary: >-
- Represents the raw values of the specified range view. The data returned could be of type string, number, or a
- boolean. Cells that contain an error will return the error string.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getValues(): (string | number | boolean)[][];'
- return:
- type: '(string | number | boolean)[][]'
- description: ''
- - name: getValueTypes()
- uid: 'ExcelScript!ExcelScript.RangeView#getValueTypes:member(1)'
- package: ExcelScript!
- fullName: getValueTypes()
- summary: Represents the type of data of each cell.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getValueTypes(): RangeValueType[][];'
- return:
- type: '[][]'
- description: ''
- - name: setFormulas(formulas)
- uid: 'ExcelScript!ExcelScript.RangeView#setFormulas:member(1)'
- package: ExcelScript!
- fullName: setFormulas(formulas)
- summary: 'Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFormulas(formulas: string[][]): void;'
- parameters:
- - id: formulas
- description: ''
- type: 'string[][]'
- return:
- type: void
- description: ''
- - name: setFormulasLocal(formulasLocal)
- uid: 'ExcelScript!ExcelScript.RangeView#setFormulasLocal:member(1)'
- package: ExcelScript!
- fullName: setFormulasLocal(formulasLocal)
- summary: >-
- Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the
- English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its value is
- returned instead.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFormulasLocal(formulasLocal: string[][]): void;'
- parameters:
- - id: formulasLocal
- description: ''
- type: 'string[][]'
- return:
- type: void
- description: ''
- - name: setFormulasR1C1(formulasR1C1)
- uid: 'ExcelScript!ExcelScript.RangeView#setFormulasR1C1:member(1)'
- package: ExcelScript!
- fullName: setFormulasR1C1(formulasR1C1)
- summary: 'Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFormulasR1C1(formulasR1C1: string[][]): void;'
- parameters:
- - id: formulasR1C1
- description: ''
- type: 'string[][]'
- return:
- type: void
- description: ''
- - name: setNumberFormat(numberFormat)
- uid: 'ExcelScript!ExcelScript.RangeView#setNumberFormat:member(1)'
- package: ExcelScript!
- fullName: setNumberFormat(numberFormat)
- summary: Represents Excel's number format code for the given cell.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setNumberFormat(numberFormat: string[][]): void;'
- parameters:
- - id: numberFormat
- description: ''
- type: 'string[][]'
- return:
- type: void
- description: ''
- - name: setValues(values)
- uid: 'ExcelScript!ExcelScript.RangeView#setValues:member(1)'
- package: ExcelScript!
- fullName: setValues(values)
- summary: >-
- Represents the raw values of the specified range view. The data returned could be of type string, number, or a
- boolean. Cells that contain an error will return the error string.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setValues(values: (string | number | boolean)[][]): void;'
- parameters:
- - id: values
- description: ''
- type: '(string | number | boolean)[][]'
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.RangeView
+uid: 'ExcelScript!ExcelScript.RangeView:interface'
+package: ExcelScript!
+fullName: ExcelScript.RangeView
+summary: RangeView represents a set of visible cells of the parent range.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script copies values and formatting from the
+ * visible range of a table in Sheet1 into Sheet2.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the filtered data from Sheet1.
+ const currentSheet = workbook.getWorksheet("Sheet1");
+ const table = currentSheet.getTables()[0];
+ const visibleTableRange: ExcelScript.RangeView = table.getRange().getVisibleView();
+ const source = currentSheet.getRanges(visibleTableRange.getCellAddresses().toString());
+
+ // Copy the data into the other sheet.
+ const otherSheet = workbook.getWorksheet("Sheet2");
+ const otherRangeCorner = otherSheet.getRange("A1");
+ otherRangeCorner.copyFrom(source, ExcelScript.RangeCopyType.all);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getCellAddresses()
+ uid: 'ExcelScript!ExcelScript.RangeView#getCellAddresses:member(1)'
+ package: ExcelScript!
+ fullName: getCellAddresses()
+ summary: Represents the cell addresses of the `RangeView`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCellAddresses(): string[][];'
+ return:
+ type: 'string[][]'
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script copies values and formatting from the
+ * visible range of a table in Sheet1 into Sheet2.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the filtered data from Sheet1.
+ const currentSheet = workbook.getWorksheet("Sheet1");
+ const table = currentSheet.getTables()[0];
+ const visibleTableRange: ExcelScript.RangeView = table.getRange().getVisibleView();
+ const source = currentSheet.getRanges(visibleTableRange.getCellAddresses().toString());
+
+ // Copy the data into the other sheet.
+ const otherSheet = workbook.getWorksheet("Sheet2");
+ const otherRangeCorner = otherSheet.getRange("A1");
+ otherRangeCorner.copyFrom(source, ExcelScript.RangeCopyType.all);
+ }
+ ```
+ - name: getColumnCount()
+ uid: 'ExcelScript!ExcelScript.RangeView#getColumnCount:member(1)'
+ package: ExcelScript!
+ fullName: getColumnCount()
+ summary: The number of visible columns.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColumnCount(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getFormulas()
+ uid: 'ExcelScript!ExcelScript.RangeView#getFormulas:member(1)'
+ package: ExcelScript!
+ fullName: getFormulas()
+ summary: 'Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormulas(): string[][];'
+ return:
+ type: 'string[][]'
+ description: ''
+ - name: getFormulasLocal()
+ uid: 'ExcelScript!ExcelScript.RangeView#getFormulasLocal:member(1)'
+ package: ExcelScript!
+ fullName: getFormulasLocal()
+ summary: >-
+ Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the
+ English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its value is
+ returned instead.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormulasLocal(): string[][];'
+ return:
+ type: 'string[][]'
+ description: ''
+ - name: getFormulasR1C1()
+ uid: 'ExcelScript!ExcelScript.RangeView#getFormulasR1C1:member(1)'
+ package: ExcelScript!
+ fullName: getFormulasR1C1()
+ summary: 'Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormulasR1C1(): string[][];'
+ return:
+ type: 'string[][]'
+ description: ''
+ - name: getIndex()
+ uid: 'ExcelScript!ExcelScript.RangeView#getIndex:member(1)'
+ package: ExcelScript!
+ fullName: getIndex()
+ summary: Returns a value that represents the index of the `RangeView`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIndex(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getNumberFormat()
+ uid: 'ExcelScript!ExcelScript.RangeView#getNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: getNumberFormat()
+ summary: Represents Excel's number format code for the given cell.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNumberFormat(): string[][];'
+ return:
+ type: 'string[][]'
+ description: ''
+ - name: getRange()
+ uid: 'ExcelScript!ExcelScript.RangeView#getRange:member(1)'
+ package: ExcelScript!
+ fullName: getRange()
+ summary: Gets the parent range associated with the current `RangeView`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRange(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getRowCount()
+ uid: 'ExcelScript!ExcelScript.RangeView#getRowCount:member(1)'
+ package: ExcelScript!
+ fullName: getRowCount()
+ summary: The number of visible rows.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRowCount(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getRows()
+ uid: 'ExcelScript!ExcelScript.RangeView#getRows:member(1)'
+ package: ExcelScript!
+ fullName: getRows()
+ summary: Represents a collection of range views associated with the range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRows(): RangeView[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getText()
+ uid: 'ExcelScript!ExcelScript.RangeView#getText:member(1)'
+ package: ExcelScript!
+ fullName: getText()
+ summary: >-
+ Text values of the specified range. The text value will not depend on the cell width. The \# sign substitution
+ that happens in Excel UI will not affect the text value returned by the API.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getText(): string[][];'
+ return:
+ type: 'string[][]'
+ description: ''
+ - name: getValues()
+ uid: 'ExcelScript!ExcelScript.RangeView#getValues:member(1)'
+ package: ExcelScript!
+ fullName: getValues()
+ summary: >-
+ Represents the raw values of the specified range view. The data returned could be of type string, number, or a
+ boolean. Cells that contain an error will return the error string.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getValues(): (string | number | boolean)[][];'
+ return:
+ type: '(string | number | boolean)[][]'
+ description: ''
+ - name: getValueTypes()
+ uid: 'ExcelScript!ExcelScript.RangeView#getValueTypes:member(1)'
+ package: ExcelScript!
+ fullName: getValueTypes()
+ summary: Represents the type of data of each cell.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getValueTypes(): RangeValueType[][];'
+ return:
+ type: '[][]'
+ description: ''
+ - name: setFormulas(formulas)
+ uid: 'ExcelScript!ExcelScript.RangeView#setFormulas:member(1)'
+ package: ExcelScript!
+ fullName: setFormulas(formulas)
+ summary: 'Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFormulas(formulas: string[][]): void;'
+ parameters:
+ - id: formulas
+ description: ''
+ type: 'string[][]'
+ return:
+ type: void
+ description: ''
+ - name: setFormulasLocal(formulasLocal)
+ uid: 'ExcelScript!ExcelScript.RangeView#setFormulasLocal:member(1)'
+ package: ExcelScript!
+ fullName: setFormulasLocal(formulasLocal)
+ summary: >-
+ Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the
+ English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its value is
+ returned instead.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFormulasLocal(formulasLocal: string[][]): void;'
+ parameters:
+ - id: formulasLocal
+ description: ''
+ type: 'string[][]'
+ return:
+ type: void
+ description: ''
+ - name: setFormulasR1C1(formulasR1C1)
+ uid: 'ExcelScript!ExcelScript.RangeView#setFormulasR1C1:member(1)'
+ package: ExcelScript!
+ fullName: setFormulasR1C1(formulasR1C1)
+ summary: 'Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFormulasR1C1(formulasR1C1: string[][]): void;'
+ parameters:
+ - id: formulasR1C1
+ description: ''
+ type: 'string[][]'
+ return:
+ type: void
+ description: ''
+ - name: setNumberFormat(numberFormat)
+ uid: 'ExcelScript!ExcelScript.RangeView#setNumberFormat:member(1)'
+ package: ExcelScript!
+ fullName: setNumberFormat(numberFormat)
+ summary: Represents Excel's number format code for the given cell.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setNumberFormat(numberFormat: string[][]): void;'
+ parameters:
+ - id: numberFormat
+ description: ''
+ type: 'string[][]'
+ return:
+ type: void
+ description: ''
+ - name: setValues(values)
+ uid: 'ExcelScript!ExcelScript.RangeView#setValues:member(1)'
+ package: ExcelScript!
+ fullName: setValues(values)
+ summary: >-
+ Represents the raw values of the specified range view. The data returned could be of type string, number, or a
+ boolean. Cells that contain an error will return the error string.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setValues(values: (string | number | boolean)[][]): void;'
+ parameters:
+ - id: values
+ description: ''
+ type: '(string | number | boolean)[][]'
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.readingorder.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.readingorder.yml
index 744e2eaa..f6a7d6b6 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.readingorder.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.readingorder.yml
@@ -1,25 +1,25 @@
-### YamlMime:TSEnum
-name: ExcelScript.ReadingOrder
-uid: 'ExcelScript!ExcelScript.ReadingOrder:enum'
-package: ExcelScript!
-fullName: ExcelScript.ReadingOrder
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: context
- uid: 'ExcelScript!ExcelScript.ReadingOrder.context:member'
- package: ExcelScript!
- summary: >-
- Reading order is determined by the language of the first character entered. If a right-to-left language character
- is entered first, reading order is right to left. If a left-to-right language character is entered first, reading
- order is left to right.
- - name: leftToRight
- uid: 'ExcelScript!ExcelScript.ReadingOrder.leftToRight:member'
- package: ExcelScript!
- summary: Left to right reading order
- - name: rightToLeft
- uid: 'ExcelScript!ExcelScript.ReadingOrder.rightToLeft:member'
- package: ExcelScript!
- summary: Right to left reading order
+### YamlMime:TSEnum
+name: ExcelScript.ReadingOrder
+uid: 'ExcelScript!ExcelScript.ReadingOrder:enum'
+package: ExcelScript!
+fullName: ExcelScript.ReadingOrder
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: context
+ uid: 'ExcelScript!ExcelScript.ReadingOrder.context:member'
+ package: ExcelScript!
+ summary: >-
+ Reading order is determined by the language of the first character entered. If a right-to-left language character
+ is entered first, reading order is right to left. If a left-to-right language character is entered first, reading
+ order is left to right.
+ - name: leftToRight
+ uid: 'ExcelScript!ExcelScript.ReadingOrder.leftToRight:member'
+ package: ExcelScript!
+ summary: Left to right reading order
+ - name: rightToLeft
+ uid: 'ExcelScript!ExcelScript.ReadingOrder.rightToLeft:member'
+ package: ExcelScript!
+ summary: Right to left reading order
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.removeduplicatesresult.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.removeduplicatesresult.yml
index 928fb54d..26520b71 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.removeduplicatesresult.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.removeduplicatesresult.yml
@@ -1,56 +1,56 @@
-### YamlMime:TSType
-name: ExcelScript.RemoveDuplicatesResult
-uid: 'ExcelScript!ExcelScript.RemoveDuplicatesResult:interface'
-package: ExcelScript!
-fullName: ExcelScript.RemoveDuplicatesResult
-summary: Represents the results from `Range.removeDuplicates`.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script removes duplicate rows from a range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the used range of the active worksheet.
- const usedRange = workbook.getActiveWorksheet().getUsedRange();
-
- // Remove any row that has a same value in the 0-indexed column as a previous row.
- const removedResults: ExcelScript.RemoveDuplicatesResult = usedRange.removeDuplicates([0], true);
-
- // Log the count of removed rows.
- console.log(`Rows removed: ${removedResults.getRemoved()}.`);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getRemoved()
- uid: 'ExcelScript!ExcelScript.RemoveDuplicatesResult#getRemoved:member(1)'
- package: ExcelScript!
- fullName: getRemoved()
- summary: Number of duplicated rows removed by the operation.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRemoved(): number;'
- return:
- type: number
- description: ''
- - name: getUniqueRemaining()
- uid: 'ExcelScript!ExcelScript.RemoveDuplicatesResult#getUniqueRemaining:member(1)'
- package: ExcelScript!
- fullName: getUniqueRemaining()
- summary: Number of remaining unique rows present in the resulting range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getUniqueRemaining(): number;'
- return:
- type: number
- description: ''
+### YamlMime:TSType
+name: ExcelScript.RemoveDuplicatesResult
+uid: 'ExcelScript!ExcelScript.RemoveDuplicatesResult:interface'
+package: ExcelScript!
+fullName: ExcelScript.RemoveDuplicatesResult
+summary: Represents the results from `Range.removeDuplicates`.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script removes duplicate rows from a range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the used range of the active worksheet.
+ const usedRange = workbook.getActiveWorksheet().getUsedRange();
+
+ // Remove any row that has a same value in the 0-indexed column as a previous row.
+ const removedResults: ExcelScript.RemoveDuplicatesResult = usedRange.removeDuplicates([0], true);
+
+ // Log the count of removed rows.
+ console.log(`Rows removed: ${removedResults.getRemoved()}.`);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getRemoved()
+ uid: 'ExcelScript!ExcelScript.RemoveDuplicatesResult#getRemoved:member(1)'
+ package: ExcelScript!
+ fullName: getRemoved()
+ summary: Number of duplicated rows removed by the operation.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRemoved(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getUniqueRemaining()
+ uid: 'ExcelScript!ExcelScript.RemoveDuplicatesResult#getUniqueRemaining:member(1)'
+ package: ExcelScript!
+ fullName: getUniqueRemaining()
+ summary: Number of remaining unique rows present in the resulting range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getUniqueRemaining(): number;'
+ return:
+ type: number
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.replacecriteria.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.replacecriteria.yml
index 1896a969..46591c91 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.replacecriteria.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.replacecriteria.yml
@@ -1,88 +1,88 @@
-### YamlMime:TSType
-name: ExcelScript.ReplaceCriteria
-uid: 'ExcelScript!ExcelScript.ReplaceCriteria:interface'
-package: ExcelScript!
-fullName: ExcelScript.ReplaceCriteria
-summary: Represents the replace criteria to be used.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: completeMatch
- uid: 'ExcelScript!ExcelScript.ReplaceCriteria#completeMatch:member'
- package: ExcelScript!
- fullName: completeMatch
- summary: >-
- Specifies if the match needs to be complete or partial. A complete match matches the entire contents of the cell.
- A partial match matches a substring within the content of the cell (e.g., `cat` partially matches `caterpillar`
- and `scatter`). Default is `false` (partial).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'completeMatch?: boolean;'
- return:
- type: boolean
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script normalizes the text in a column so that values don't include both "OK" and "okay".
- * It replaces "OK" and all the case-based variants with "okay".
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range representing column D.
- const currentSheet = workbook.getActiveWorksheet();
- const column = currentSheet.getRange("D:D");
-
- // Create a ReplaceCriteria object for the Range.replaceAll call.
- const criteria: ExcelScript.ReplaceCriteria = {
- completeMatch: true, /* Use a complete match to skip cells that already say "okay". */
- matchCase: false /* Ignore case when comparing strings. */
- };
-
- // Replace all instances of "ok" (case-insensitive) with "okay".
- column.replaceAll("ok", "okay", criteria);
- }
- ```
- - name: matchCase
- uid: 'ExcelScript!ExcelScript.ReplaceCriteria#matchCase:member'
- package: ExcelScript!
- fullName: matchCase
- summary: Specifies if the match is case-sensitive. Default is `false` (case-insensitive).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'matchCase?: boolean;'
- return:
- type: boolean
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script replaces instances of "NA" with "North America",
- * using the casing to ignore parts of words.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the currently used range.
- const currentSheet = workbook.getActiveWorksheet();
- const usedRange = currentSheet.getUsedRange();
-
- // Create a ReplaceCriteria object for the Range.replaceAll call.
- const criteria: ExcelScript.ReplaceCriteria = {
- completeMatch: false,
- matchCase: true /* Match with "NA market", not "navigate" */
- }
-
- // Replace all instances of "NA" (case-sensitive) with "North America".
- usedRange.replaceAll("NA", "North America", criteria);
- }
- ```
+### YamlMime:TSType
+name: ExcelScript.ReplaceCriteria
+uid: 'ExcelScript!ExcelScript.ReplaceCriteria:interface'
+package: ExcelScript!
+fullName: ExcelScript.ReplaceCriteria
+summary: Represents the replace criteria to be used.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: completeMatch
+ uid: 'ExcelScript!ExcelScript.ReplaceCriteria#completeMatch:member'
+ package: ExcelScript!
+ fullName: completeMatch
+ summary: >-
+ Specifies if the match needs to be complete or partial. A complete match matches the entire contents of the cell.
+ A partial match matches a substring within the content of the cell (e.g., `cat` partially matches `caterpillar`
+ and `scatter`). Default is `false` (partial).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'completeMatch?: boolean;'
+ return:
+ type: boolean
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script normalizes the text in a column so that values don't include both "OK" and "okay".
+ * It replaces "OK" and all the case-based variants with "okay".
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range representing column D.
+ const currentSheet = workbook.getActiveWorksheet();
+ const column = currentSheet.getRange("D:D");
+
+ // Create a ReplaceCriteria object for the Range.replaceAll call.
+ const criteria: ExcelScript.ReplaceCriteria = {
+ completeMatch: true, /* Use a complete match to skip cells that already say "okay". */
+ matchCase: false /* Ignore case when comparing strings. */
+ };
+
+ // Replace all instances of "ok" (case-insensitive) with "okay".
+ column.replaceAll("ok", "okay", criteria);
+ }
+ ```
+ - name: matchCase
+ uid: 'ExcelScript!ExcelScript.ReplaceCriteria#matchCase:member'
+ package: ExcelScript!
+ fullName: matchCase
+ summary: Specifies if the match is case-sensitive. Default is `false` (case-insensitive).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'matchCase?: boolean;'
+ return:
+ type: boolean
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script replaces instances of "NA" with "North America",
+ * using the casing to ignore parts of words.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the currently used range.
+ const currentSheet = workbook.getActiveWorksheet();
+ const usedRange = currentSheet.getUsedRange();
+
+ // Create a ReplaceCriteria object for the Range.replaceAll call.
+ const criteria: ExcelScript.ReplaceCriteria = {
+ completeMatch: false,
+ matchCase: true /* Match with "NA market", not "navigate" */
+ }
+
+ // Replace all instances of "NA" (case-sensitive) with "North America".
+ usedRange.replaceAll("NA", "North America", criteria);
+ }
+ ```
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.rowcolumnpivothierarchy.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.rowcolumnpivothierarchy.yml
index 7f65291c..e6a5abce 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.rowcolumnpivothierarchy.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.rowcolumnpivothierarchy.yml
@@ -1,149 +1,149 @@
-### YamlMime:TSType
-name: ExcelScript.RowColumnPivotHierarchy
-uid: 'ExcelScript!ExcelScript.RowColumnPivotHierarchy:interface'
-package: ExcelScript!
-fullName: ExcelScript.RowColumnPivotHierarchy
-summary: Represents the Excel RowColumnPivotHierarchy.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample sorts the rows of a PivotTable.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get an existing PivotTable.
- const pivotTable = workbook.getPivotTable("Farm Sales");
-
- // Get the data hierarchy to use as the basis of the sort.
- const valueFieldToSortOn: ExcelScript.DataPivotHierarchy = pivotTable.getDataHierarchy("Sum of Crates Sold Wholesale");
-
- // Get the row to sort.
- const rowToSort: ExcelScript.RowColumnPivotHierarchy = pivotTable.getRowHierarchy("Farm");
-
- // Sort the "Farm" row's only field by the values in "Sum of Crates Sold Wholesale".
- rowToSort.getFields()[0].sortByValues(ExcelScript.SortBy.descending, valueFieldToSortOn);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getFields()
- uid: 'ExcelScript!ExcelScript.RowColumnPivotHierarchy#getFields:member(1)'
- package: ExcelScript!
- fullName: getFields()
- summary: Returns the PivotFields associated with the RowColumnPivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFields(): PivotField[];'
- return:
- type: '[]'
- description: ''
- - name: getId()
- uid: 'ExcelScript!ExcelScript.RowColumnPivotHierarchy#getId:member(1)'
- package: ExcelScript!
- fullName: getId()
- summary: ID of the RowColumnPivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getId(): string;'
- return:
- type: string
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.RowColumnPivotHierarchy#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: Name of the RowColumnPivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: getPivotField(name)
- uid: 'ExcelScript!ExcelScript.RowColumnPivotHierarchy#getPivotField:member(1)'
- package: ExcelScript!
- fullName: getPivotField(name)
- summary: 'Gets a PivotField by name. If the PivotField does not exist, then this method returns `undefined`.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPivotField(name: string): PivotField | undefined;'
- parameters:
- - id: name
- description: Name of the PivotField to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getPosition()
- uid: 'ExcelScript!ExcelScript.RowColumnPivotHierarchy#getPosition:member(1)'
- package: ExcelScript!
- fullName: getPosition()
- summary: Position of the RowColumnPivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPosition(): number;'
- return:
- type: number
- description: ''
- - name: setName(name)
- uid: 'ExcelScript!ExcelScript.RowColumnPivotHierarchy#setName:member(1)'
- package: ExcelScript!
- fullName: setName(name)
- summary: Name of the RowColumnPivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setName(name: string): void;'
- parameters:
- - id: name
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setPosition(position)
- uid: 'ExcelScript!ExcelScript.RowColumnPivotHierarchy#setPosition:member(1)'
- package: ExcelScript!
- fullName: setPosition(position)
- summary: Position of the RowColumnPivotHierarchy.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPosition(position: number): void;'
- parameters:
- - id: position
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setToDefault()
- uid: 'ExcelScript!ExcelScript.RowColumnPivotHierarchy#setToDefault:member(1)'
- package: ExcelScript!
- fullName: setToDefault()
- summary: Reset the RowColumnPivotHierarchy back to its default values.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setToDefault(): void;'
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.RowColumnPivotHierarchy
+uid: 'ExcelScript!ExcelScript.RowColumnPivotHierarchy:interface'
+package: ExcelScript!
+fullName: ExcelScript.RowColumnPivotHierarchy
+summary: Represents the Excel RowColumnPivotHierarchy.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample sorts the rows of a PivotTable.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get an existing PivotTable.
+ const pivotTable = workbook.getPivotTable("Farm Sales");
+
+ // Get the data hierarchy to use as the basis of the sort.
+ const valueFieldToSortOn: ExcelScript.DataPivotHierarchy = pivotTable.getDataHierarchy("Sum of Crates Sold Wholesale");
+
+ // Get the row to sort.
+ const rowToSort: ExcelScript.RowColumnPivotHierarchy = pivotTable.getRowHierarchy("Farm");
+
+ // Sort the "Farm" row's only field by the values in "Sum of Crates Sold Wholesale".
+ rowToSort.getFields()[0].sortByValues(ExcelScript.SortBy.descending, valueFieldToSortOn);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getFields()
+ uid: 'ExcelScript!ExcelScript.RowColumnPivotHierarchy#getFields:member(1)'
+ package: ExcelScript!
+ fullName: getFields()
+ summary: Returns the PivotFields associated with the RowColumnPivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFields(): PivotField[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getId()
+ uid: 'ExcelScript!ExcelScript.RowColumnPivotHierarchy#getId:member(1)'
+ package: ExcelScript!
+ fullName: getId()
+ summary: ID of the RowColumnPivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getId(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.RowColumnPivotHierarchy#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: Name of the RowColumnPivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getPivotField(name)
+ uid: 'ExcelScript!ExcelScript.RowColumnPivotHierarchy#getPivotField:member(1)'
+ package: ExcelScript!
+ fullName: getPivotField(name)
+ summary: 'Gets a PivotField by name. If the PivotField does not exist, then this method returns `undefined`.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPivotField(name: string): PivotField | undefined;'
+ parameters:
+ - id: name
+ description: Name of the PivotField to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getPosition()
+ uid: 'ExcelScript!ExcelScript.RowColumnPivotHierarchy#getPosition:member(1)'
+ package: ExcelScript!
+ fullName: getPosition()
+ summary: Position of the RowColumnPivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPosition(): number;'
+ return:
+ type: number
+ description: ''
+ - name: setName(name)
+ uid: 'ExcelScript!ExcelScript.RowColumnPivotHierarchy#setName:member(1)'
+ package: ExcelScript!
+ fullName: setName(name)
+ summary: Name of the RowColumnPivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setName(name: string): void;'
+ parameters:
+ - id: name
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setPosition(position)
+ uid: 'ExcelScript!ExcelScript.RowColumnPivotHierarchy#setPosition:member(1)'
+ package: ExcelScript!
+ fullName: setPosition(position)
+ summary: Position of the RowColumnPivotHierarchy.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPosition(position: number): void;'
+ parameters:
+ - id: position
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setToDefault()
+ uid: 'ExcelScript!ExcelScript.RowColumnPivotHierarchy#setToDefault:member(1)'
+ package: ExcelScript!
+ fullName: setToDefault()
+ summary: Reset the RowColumnPivotHierarchy back to its default values.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setToDefault(): void;'
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.searchcriteria.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.searchcriteria.yml
index 4d49350e..2d57c1c4 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.searchcriteria.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.searchcriteria.yml
@@ -1,77 +1,77 @@
-### YamlMime:TSType
-name: ExcelScript.SearchCriteria
-uid: 'ExcelScript!ExcelScript.SearchCriteria:interface'
-package: ExcelScript!
-fullName: ExcelScript.SearchCriteria
-summary: Represents the search criteria to be used.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script searches for the next instance of the text "TK" on the current worksheet.
- * It then selects that cell and removes "TK" and all formatting from the cell.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the used range on the current worksheet.
- let range = workbook.getActiveWorksheet().getUsedRange();
-
- // Get the next cell that contains "TK".
- let tkCell = range.find("TK", {
- completeMatch: true, /* Don't match if the cell text only contains "TK" as part of another string. */
- matchCase: false,
- searchDirection: ExcelScript.SearchDirection.forward /* Start at the beginning of the range and go to later columns and rows. */
- });
-
- // Set focus on the found cell.
- tkCell.select();
-
- // Remove the "TK" text value from the cell, as well as any formatting that may have been added.
- tkCell.clear(ExcelScript.ClearApplyTo.all);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: completeMatch
- uid: 'ExcelScript!ExcelScript.SearchCriteria#completeMatch:member'
- package: ExcelScript!
- fullName: completeMatch
- summary: >-
- Specifies if the match needs to be complete or partial. A complete match matches the entire contents of the cell.
- A partial match matches a substring within the content of the cell (e.g., `cat` partially matches `caterpillar`
- and `scatter`). Default is `false` (partial).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'completeMatch?: boolean;'
- return:
- type: boolean
- - name: matchCase
- uid: 'ExcelScript!ExcelScript.SearchCriteria#matchCase:member'
- package: ExcelScript!
- fullName: matchCase
- summary: Specifies if the match is case-sensitive. Default is `false` (case-insensitive).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'matchCase?: boolean;'
- return:
- type: boolean
- - name: searchDirection
- uid: 'ExcelScript!ExcelScript.SearchCriteria#searchDirection:member'
- package: ExcelScript!
- fullName: searchDirection
- summary: Specifies the search direction. Default is forward. See `ExcelScript.SearchDirection`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'searchDirection?: SearchDirection;'
- return:
- type: ''
+### YamlMime:TSType
+name: ExcelScript.SearchCriteria
+uid: 'ExcelScript!ExcelScript.SearchCriteria:interface'
+package: ExcelScript!
+fullName: ExcelScript.SearchCriteria
+summary: Represents the search criteria to be used.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script searches for the next instance of the text "TK" on the current worksheet.
+ * It then selects that cell and removes "TK" and all formatting from the cell.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the used range on the current worksheet.
+ let range = workbook.getActiveWorksheet().getUsedRange();
+
+ // Get the next cell that contains "TK".
+ let tkCell = range.find("TK", {
+ completeMatch: true, /* Don't match if the cell text only contains "TK" as part of another string. */
+ matchCase: false,
+ searchDirection: ExcelScript.SearchDirection.forward /* Start at the beginning of the range and go to later columns and rows. */
+ });
+
+ // Set focus on the found cell.
+ tkCell.select();
+
+ // Remove the "TK" text value from the cell, as well as any formatting that may have been added.
+ tkCell.clear(ExcelScript.ClearApplyTo.all);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: completeMatch
+ uid: 'ExcelScript!ExcelScript.SearchCriteria#completeMatch:member'
+ package: ExcelScript!
+ fullName: completeMatch
+ summary: >-
+ Specifies if the match needs to be complete or partial. A complete match matches the entire contents of the cell.
+ A partial match matches a substring within the content of the cell (e.g., `cat` partially matches `caterpillar`
+ and `scatter`). Default is `false` (partial).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'completeMatch?: boolean;'
+ return:
+ type: boolean
+ - name: matchCase
+ uid: 'ExcelScript!ExcelScript.SearchCriteria#matchCase:member'
+ package: ExcelScript!
+ fullName: matchCase
+ summary: Specifies if the match is case-sensitive. Default is `false` (case-insensitive).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'matchCase?: boolean;'
+ return:
+ type: boolean
+ - name: searchDirection
+ uid: 'ExcelScript!ExcelScript.SearchCriteria#searchDirection:member'
+ package: ExcelScript!
+ fullName: searchDirection
+ summary: Specifies the search direction. Default is forward. See `ExcelScript.SearchDirection`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'searchDirection?: SearchDirection;'
+ return:
+ type: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.searchdirection.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.searchdirection.yml
index 42ff80c0..1e72e9bc 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.searchdirection.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.searchdirection.yml
@@ -1,45 +1,45 @@
-### YamlMime:TSEnum
-name: ExcelScript.SearchDirection
-uid: 'ExcelScript!ExcelScript.SearchDirection:enum'
-package: ExcelScript!
-fullName: ExcelScript.SearchDirection
-summary: Specifies the search direction.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script searches for the next instance of the text "TK" on the current worksheet.
- * It then selects that cell and removes "TK" and all formatting from the cell.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the used range on the current worksheet.
- let range = workbook.getActiveWorksheet().getUsedRange();
-
- // Get the next cell that contains "TK".
- let tkCell = range.find("TK", {
- completeMatch: true, /* Don't match if the cell text only contains "TK" as part of another string. */
- matchCase: false,
- searchDirection: ExcelScript.SearchDirection.forward /* Start at the beginning of the range and go to later columns and rows. */
- });
-
- // Set focus on the found cell.
- tkCell.select();
-
- // Remove the "TK" text value from the cell, as well as any formatting that may have been added.
- tkCell.clear(ExcelScript.ClearApplyTo.all);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: backwards
- uid: 'ExcelScript!ExcelScript.SearchDirection.backwards:member'
- package: ExcelScript!
- summary: Search in reverse order.
- - name: forward
- uid: 'ExcelScript!ExcelScript.SearchDirection.forward:member'
- package: ExcelScript!
- summary: Search in forward order.
+### YamlMime:TSEnum
+name: ExcelScript.SearchDirection
+uid: 'ExcelScript!ExcelScript.SearchDirection:enum'
+package: ExcelScript!
+fullName: ExcelScript.SearchDirection
+summary: Specifies the search direction.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script searches for the next instance of the text "TK" on the current worksheet.
+ * It then selects that cell and removes "TK" and all formatting from the cell.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the used range on the current worksheet.
+ let range = workbook.getActiveWorksheet().getUsedRange();
+
+ // Get the next cell that contains "TK".
+ let tkCell = range.find("TK", {
+ completeMatch: true, /* Don't match if the cell text only contains "TK" as part of another string. */
+ matchCase: false,
+ searchDirection: ExcelScript.SearchDirection.forward /* Start at the beginning of the range and go to later columns and rows. */
+ });
+
+ // Set focus on the found cell.
+ tkCell.select();
+
+ // Remove the "TK" text value from the cell, as well as any formatting that may have been added.
+ tkCell.clear(ExcelScript.ClearApplyTo.all);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: backwards
+ uid: 'ExcelScript!ExcelScript.SearchDirection.backwards:member'
+ package: ExcelScript!
+ summary: Search in reverse order.
+ - name: forward
+ uid: 'ExcelScript!ExcelScript.SearchDirection.forward:member'
+ package: ExcelScript!
+ summary: Search in forward order.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.shape.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.shape.yml
index 77a754dd..b1ff2652 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.shape.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.shape.yml
@@ -1,974 +1,989 @@
-### YamlMime:TSType
-name: ExcelScript.Shape
-uid: 'ExcelScript!ExcelScript.Shape:interface'
-package: ExcelScript!
-fullName: ExcelScript.Shape
-summary: >-
- Represents a generic shape object in the worksheet. A shape could be a geometric shape, a line, a group of shapes,
- etc.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a hexagon shape on the current worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- const currentSheet = workbook.getActiveWorksheet();
- const hexagon: ExcelScript.Shape =
- currentSheet.addGeometricShape(ExcelScript.GeometricShapeType.hexagon);
-
- // Set the hexagon size to 40x40 pixels.
- hexagon.setHeight(40);
- hexagon.setWidth(40);
-
- // Position the hexagon at [100,100] pixels.
- hexagon.setLeft(100);
- hexagon.setTop(100);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: copyTo(destinationSheet)
- uid: 'ExcelScript!ExcelScript.Shape#copyTo:member(1)'
- package: ExcelScript!
- fullName: copyTo(destinationSheet)
- summary: Copies and pastes a `Shape` object. The pasted shape is copied to the same pixel location as this shape.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'copyTo(destinationSheet?: Worksheet | string): Shape;'
- parameters:
- - id: destinationSheet
- description: The sheet to which the shape object will be pasted. The default value is the copied shape's worksheet.
- type: ' | string'
- return:
- type: ''
- description: ''
- - name: delete()
- uid: 'ExcelScript!ExcelScript.Shape#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: Removes the shape from the worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script deletes all the shapes on the current worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the collection of shapes on the currently selected worksheet.
- const shapes = workbook.getActiveWorksheet().getShapes();
-
- // Remove each shape.
- shapes.forEach(shape =>{
- shape.delete();
- });
- }
- ```
- - name: getAltTextDescription()
- uid: 'ExcelScript!ExcelScript.Shape#getAltTextDescription:member(1)'
- package: ExcelScript!
- fullName: getAltTextDescription()
- summary: Specifies the alternative description text for a `Shape` object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAltTextDescription(): string;'
- return:
- type: string
- description: ''
- - name: getAltTextTitle()
- uid: 'ExcelScript!ExcelScript.Shape#getAltTextTitle:member(1)'
- package: ExcelScript!
- fullName: getAltTextTitle()
- summary: Specifies the alternative title text for a `Shape` object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAltTextTitle(): string;'
- return:
- type: string
- description: ''
- - name: getAsImage(format)
- uid: 'ExcelScript!ExcelScript.Shape#getAsImage:member(1)'
- package: ExcelScript!
- fullName: getAsImage(format)
- summary: >-
- Converts the shape to an image and returns the image as a base64-encoded string. The DPI is 96. The only supported
- formats are `ExcelScript.PictureFormat.BMP`, `ExcelScript.PictureFormat.PNG`,
- `ExcelScript.PictureFormat.JPEG`, and `ExcelScript.PictureFormat.GIF`.
- remarks: ''
- isPreview: false
- isDeprecated: true
- customDeprecatedMessage: Use `getImageAsBase64` instead.
- syntax:
- content: 'getAsImage(format: PictureFormat): string;'
- parameters:
- - id: format
- description: Specifies the format of the image.
- type: ''
- return:
- type: string
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a star shape with the value from cell A1.
- * It then returns the image as a base64-encoded string.
- * This string would be used as part of a Power Automate flow to add the image elsewhere.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the value of A1 from the worksheet named Sheet1.
- const sheet = workbook.getWorksheet("Sheet1");
- const value = sheet.getRange("A1").getValue();
-
- // Create a Shape object that looks like a 5-pointed star.
- const star = sheet.addGeometricShape(ExcelScript.GeometricShapeType.star5);
-
- // Set the text of star and make sure the shape fits the text.
- const textFrame = star.getTextFrame();
- textFrame.getTextRange().setText(value.toString());
- textFrame.setAutoSizeSetting(ExcelScript.ShapeAutoSize.autoSizeShapeToFitText);
-
- // Return the shape as a PNG image represented by a base64-encoded string.
- return star.getAsImage(ExcelScript.PictureFormat.png);
- }
- ```
- - name: getConnectionSiteCount()
- uid: 'ExcelScript!ExcelScript.Shape#getConnectionSiteCount:member(1)'
- package: ExcelScript!
- fullName: getConnectionSiteCount()
- summary: Returns the number of connection sites on this shape.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getConnectionSiteCount(): number;'
- return:
- type: number
- description: ''
- - name: getFill()
- uid: 'ExcelScript!ExcelScript.Shape#getFill:member(1)'
- package: ExcelScript!
- fullName: getFill()
- summary: Returns the fill formatting of this shape.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFill(): ShapeFill;'
- return:
- type: ''
- description: ''
- - name: getGeometricShape()
- uid: 'ExcelScript!ExcelScript.Shape#getGeometricShape:member(1)'
- package: ExcelScript!
- fullName: getGeometricShape()
- summary: >-
- Returns the geometric shape associated with the shape. An error will be thrown if the shape type is not
- "GeometricShape".
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGeometricShape(): GeometricShape;'
- return:
- type: ''
- description: ''
- - name: getGeometricShapeType()
- uid: 'ExcelScript!ExcelScript.Shape#getGeometricShapeType:member(1)'
- package: ExcelScript!
- fullName: getGeometricShapeType()
- summary: >-
- Specifies the geometric shape type of this geometric shape. See `ExcelScript.GeometricShapeType` for details.
- Returns `null` if the shape type is not "GeometricShape".
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGeometricShapeType(): GeometricShapeType;'
- return:
- type: ''
- description: ''
- - name: getGroup()
- uid: 'ExcelScript!ExcelScript.Shape#getGroup:member(1)'
- package: ExcelScript!
- fullName: getGroup()
- summary: Returns the shape group associated with the shape. An error will be thrown if the shape type is not "GroupShape".
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGroup(): ShapeGroup;'
- return:
- type: ''
- description: ''
- - name: getHeight()
- uid: 'ExcelScript!ExcelScript.Shape#getHeight:member(1)'
- package: ExcelScript!
- fullName: getHeight()
- summary: >-
- Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative
- value or zero as an input.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHeight(): number;'
- return:
- type: number
- description: ''
- - name: getId()
- uid: 'ExcelScript!ExcelScript.Shape#getId:member(1)'
- package: ExcelScript!
- fullName: getId()
- summary: Specifies the shape identifier.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getId(): string;'
- return:
- type: string
- description: ''
- - name: getImage()
- uid: 'ExcelScript!ExcelScript.Shape#getImage:member(1)'
- package: ExcelScript!
- fullName: getImage()
- summary: Returns the image associated with the shape. An error will be thrown if the shape type is not "Image".
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getImage(): Image;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script transfers an image from one worksheet to another.
- */
- function main(workbook: ExcelScript.Workbook)
- {
- // Get the worksheet with the image on it.
- let firstWorksheet = workbook.getWorksheet("FirstSheet");
-
- // Get the first image from the worksheet.
- // If a script added the image, you could add a name to make it easier to find.
- let image: ExcelScript.Image;
- firstWorksheet.getShapes().forEach((shape, index) => {
- if (shape.getType() === ExcelScript.ShapeType.image) {
- image = shape.getImage();
- return;
- }
- });
-
- // Copy the image to another worksheet.
- image.getShape().copyTo("SecondSheet");
- }
- ```
- - name: getImageAsBase64(format)
- uid: 'ExcelScript!ExcelScript.Shape#getImageAsBase64:member(1)'
- package: ExcelScript!
- fullName: getImageAsBase64(format)
- summary: >-
- Converts the shape to an image and returns the image as a base64-encoded string. The DPI is 96. The only supported
- formats are `ExcelScript.PictureFormat.BMP`, `ExcelScript.PictureFormat.PNG`,
- `ExcelScript.PictureFormat.JPEG`, and `ExcelScript.PictureFormat.GIF`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getImageAsBase64(format: PictureFormat): string;'
- parameters:
- - id: format
- description: Specifies the format of the image.
- type: ''
- return:
- type: string
- description: ''
- - name: getLeft()
- uid: 'ExcelScript!ExcelScript.Shape#getLeft:member(1)'
- package: ExcelScript!
- fullName: getLeft()
- summary: >-
- The distance, in points, from the left side of the shape to the left side of the worksheet. Throws an
- `InvalidArgument` exception when set with a negative value as an input.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLeft(): number;'
- return:
- type: number
- description: ''
- - name: getLevel()
- uid: 'ExcelScript!ExcelScript.Shape#getLevel:member(1)'
- package: ExcelScript!
- fullName: getLevel()
- summary: >-
- Specifies the level of the specified shape. For example, a level of 0 means that the shape is not part of any
- groups, a level of 1 means the shape is part of a top-level group, and a level of 2 means the shape is part of a
- sub-group of the top level.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLevel(): number;'
- return:
- type: number
- description: ''
- - name: getLine()
- uid: 'ExcelScript!ExcelScript.Shape#getLine:member(1)'
- package: ExcelScript!
- fullName: getLine()
- summary: Returns the line associated with the shape. An error will be thrown if the shape type is not "Line".
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLine(): Line;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a line that goes from cell B2 to cell F4 on the current worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- const sheet = workbook.getActiveWorksheet();
-
- // Get the ranges for the two cells.
- const b2Range = sheet.getRange("B2");
- const f4Range = sheet.getRange("F4");
-
- // Add a straight line that connects the top-left corners of both cells.
- const newShape = sheet.addLine(
- b2Range.getLeft(),
- b2Range.getTop(),
- f4Range.getLeft(),
- f4Range.getTop(),
- ExcelScript.ConnectorType.straight);
-
- // Add an open arrowhead to the end of the line, such that it points at F4.
- const line = newShape.getLine();
- line.setEndArrowheadStyle(ExcelScript.ArrowheadStyle.open);
- }
- ```
- - name: getLineFormat()
- uid: 'ExcelScript!ExcelScript.Shape#getLineFormat:member(1)'
- package: ExcelScript!
- fullName: getLineFormat()
- summary: Returns the line formatting of this shape.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLineFormat(): ShapeLineFormat;'
- return:
- type: ''
- description: ''
- - name: getLockAspectRatio()
- uid: 'ExcelScript!ExcelScript.Shape#getLockAspectRatio:member(1)'
- package: ExcelScript!
- fullName: getLockAspectRatio()
- summary: Specifies if the aspect ratio of this shape is locked.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLockAspectRatio(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.Shape#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: Specifies the name of the shape.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: getParentGroup()
- uid: 'ExcelScript!ExcelScript.Shape#getParentGroup:member(1)'
- package: ExcelScript!
- fullName: getParentGroup()
- summary: Specifies the parent group of this shape.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getParentGroup(): Shape;'
- return:
- type: ''
- description: ''
- - name: getPlacement()
- uid: 'ExcelScript!ExcelScript.Shape#getPlacement:member(1)'
- package: ExcelScript!
- fullName: getPlacement()
- summary: Represents how the object is attached to the cells below it.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPlacement(): Placement;'
- return:
- type: ''
- description: ''
- - name: getRotation()
- uid: 'ExcelScript!ExcelScript.Shape#getRotation:member(1)'
- package: ExcelScript!
- fullName: getRotation()
- summary: 'Specifies the rotation, in degrees, of the shape.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRotation(): number;'
- return:
- type: number
- description: ''
- - name: getTextFrame()
- uid: 'ExcelScript!ExcelScript.Shape#getTextFrame:member(1)'
- package: ExcelScript!
- fullName: getTextFrame()
- summary: Returns the text frame object of this shape.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTextFrame(): TextFrame;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a star shape with the value from cell A1.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the value of A1 from the worksheet named Sheet1.
- const sheet = workbook.getWorksheet("Sheet1");
- const value = sheet.getRange("A1").getValue();
-
- // Create a Shape object that looks like a 5-pointed star.
- const star = sheet.addGeometricShape(ExcelScript.GeometricShapeType.star5);
-
- // Set the text of star and make sure the shape fits the text.
- const textFrame = star.getTextFrame();
- textFrame.getTextRange().setText(value.toString());
- textFrame.setAutoSizeSetting(ExcelScript.ShapeAutoSize.autoSizeShapeToFitText);
- }
- ```
- - name: getTop()
- uid: 'ExcelScript!ExcelScript.Shape#getTop:member(1)'
- package: ExcelScript!
- fullName: getTop()
- summary: >-
- The distance, in points, from the top edge of the shape to the top edge of the worksheet. Throws an
- `InvalidArgument` exception when set with a negative value as an input.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTop(): number;'
- return:
- type: number
- description: ''
- - name: getType()
- uid: 'ExcelScript!ExcelScript.Shape#getType:member(1)'
- package: ExcelScript!
- fullName: getType()
- summary: Returns the type of this shape. See `ExcelScript.ShapeType` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getType(): ShapeType;'
- return:
- type: ''
- description: ''
- - name: getVisible()
- uid: 'ExcelScript!ExcelScript.Shape#getVisible:member(1)'
- package: ExcelScript!
- fullName: getVisible()
- summary: Specifies if the shape is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVisible(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getWidth()
- uid: 'ExcelScript!ExcelScript.Shape#getWidth:member(1)'
- package: ExcelScript!
- fullName: getWidth()
- summary: >-
- Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value
- or zero as an input.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWidth(): number;'
- return:
- type: number
- description: ''
- - name: getZOrderPosition()
- uid: 'ExcelScript!ExcelScript.Shape#getZOrderPosition:member(1)'
- package: ExcelScript!
- fullName: getZOrderPosition()
- summary: 'Returns the position of the specified shape in the z-order, with 0 representing the bottom of the order stack.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getZOrderPosition(): number;'
- return:
- type: number
- description: ''
- - name: incrementLeft(increment)
- uid: 'ExcelScript!ExcelScript.Shape#incrementLeft:member(1)'
- package: ExcelScript!
- fullName: incrementLeft(increment)
- summary: Moves the shape horizontally by the specified number of points.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'incrementLeft(increment: number): void;'
- parameters:
- - id: increment
- description: >-
- The increment, in points, the shape will be horizontally moved. A positive value moves the shape to the
- right and a negative value moves it to the left. If the sheet is right-to-left oriented, this is reversed:
- positive values will move the shape to the left and negative values will move it to the right.
- type: number
- return:
- type: void
- description: ''
- - name: incrementRotation(increment)
- uid: 'ExcelScript!ExcelScript.Shape#incrementRotation:member(1)'
- package: ExcelScript!
- fullName: incrementRotation(increment)
- summary: >-
- Rotates the shape clockwise around the z-axis by the specified number of degrees. Use the `rotation` property to
- set the absolute rotation of the shape.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'incrementRotation(increment: number): void;'
- parameters:
- - id: increment
- description: >-
- How many degrees the shape will be rotated. A positive value rotates the shape clockwise and a negative
- value rotates it counterclockwise.
- type: number
- return:
- type: void
- description: ''
- - name: incrementTop(increment)
- uid: 'ExcelScript!ExcelScript.Shape#incrementTop:member(1)'
- package: ExcelScript!
- fullName: incrementTop(increment)
- summary: Moves the shape vertically by the specified number of points.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'incrementTop(increment: number): void;'
- parameters:
- - id: increment
- description: >-
- The increment, in points, the shape will be vertically moved. A positive value moves the shape down and a
- negative value moves it up.
- type: number
- return:
- type: void
- description: ''
- - name: 'scaleHeight(scaleFactor, scaleType, scaleFrom)'
- uid: 'ExcelScript!ExcelScript.Shape#scaleHeight:member(1)'
- package: ExcelScript!
- fullName: 'scaleHeight(scaleFactor, scaleType, scaleFrom)'
- summary: >-
- Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the
- shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their
- current height.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- scaleHeight(
- scaleFactor: number,
- scaleType: ShapeScaleType,
- scaleFrom?: ShapeScaleFrom
- ): void;
- parameters:
- - id: scaleFactor
- description: Specifies the ratio between the height of the shape after you resize it and the current or original height.
- type: number
- - id: scaleType
- description: >-
- Specifies whether the shape is scaled relative to its original or current size. The original size scaling
- option only works for images.
- type: ''
- - id: scaleFrom
- description: >-
- Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it
- represents the shape's upper left corner retains its position.
- type: ''
- return:
- type: void
- description: ''
- - name: 'scaleWidth(scaleFactor, scaleType, scaleFrom)'
- uid: 'ExcelScript!ExcelScript.Shape#scaleWidth:member(1)'
- package: ExcelScript!
- fullName: 'scaleWidth(scaleFactor, scaleType, scaleFrom)'
- summary: >-
- Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the
- shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their
- current width.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- scaleWidth(
- scaleFactor: number,
- scaleType: ShapeScaleType,
- scaleFrom?: ShapeScaleFrom
- ): void;
- parameters:
- - id: scaleFactor
- description: Specifies the ratio between the width of the shape after you resize it and the current or original width.
- type: number
- - id: scaleType
- description: >-
- Specifies whether the shape is scaled relative to its original or current size. The original size scaling
- option only works for images.
- type: ''
- - id: scaleFrom
- description: >-
- Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it
- represents the shape's upper left corner retains its position.
- type: ''
- return:
- type: void
- description: ''
- - name: setAltTextDescription(altTextDescription)
- uid: 'ExcelScript!ExcelScript.Shape#setAltTextDescription:member(1)'
- package: ExcelScript!
- fullName: setAltTextDescription(altTextDescription)
- summary: Specifies the alternative description text for a `Shape` object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setAltTextDescription(altTextDescription: string): void;'
- parameters:
- - id: altTextDescription
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setAltTextTitle(altTextTitle)
- uid: 'ExcelScript!ExcelScript.Shape#setAltTextTitle:member(1)'
- package: ExcelScript!
- fullName: setAltTextTitle(altTextTitle)
- summary: Specifies the alternative title text for a `Shape` object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setAltTextTitle(altTextTitle: string): void;'
- parameters:
- - id: altTextTitle
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setGeometricShapeType(geometricShapeType)
- uid: 'ExcelScript!ExcelScript.Shape#setGeometricShapeType:member(1)'
- package: ExcelScript!
- fullName: setGeometricShapeType(geometricShapeType)
- summary: >-
- Specifies the geometric shape type of this geometric shape. See `ExcelScript.GeometricShapeType` for details.
- Returns `null` if the shape type is not "GeometricShape".
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setGeometricShapeType(geometricShapeType: GeometricShapeType): void;'
- parameters:
- - id: geometricShapeType
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setHeight(height)
- uid: 'ExcelScript!ExcelScript.Shape#setHeight:member(1)'
- package: ExcelScript!
- fullName: setHeight(height)
- summary: >-
- Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative
- value or zero as an input.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setHeight(height: number): void;'
- parameters:
- - id: height
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setLeft(left)
- uid: 'ExcelScript!ExcelScript.Shape#setLeft:member(1)'
- package: ExcelScript!
- fullName: setLeft(left)
- summary: >-
- The distance, in points, from the left side of the shape to the left side of the worksheet. Throws an
- `InvalidArgument` exception when set with a negative value as an input.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLeft(left: number): void;'
- parameters:
- - id: left
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setLockAspectRatio(lockAspectRatio)
- uid: 'ExcelScript!ExcelScript.Shape#setLockAspectRatio:member(1)'
- package: ExcelScript!
- fullName: setLockAspectRatio(lockAspectRatio)
- summary: Specifies if the aspect ratio of this shape is locked.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLockAspectRatio(lockAspectRatio: boolean): void;'
- parameters:
- - id: lockAspectRatio
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setName(name)
- uid: 'ExcelScript!ExcelScript.Shape#setName:member(1)'
- package: ExcelScript!
- fullName: setName(name)
- summary: Specifies the name of the shape.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setName(name: string): void;'
- parameters:
- - id: name
- description: ''
- type: string
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a triangle shape on the current worksheet and names it "TRI".
- */
- function main(workbook: ExcelScript.Workbook) {
- const currentSheet = workbook.getActiveWorksheet();
- const triangle: ExcelScript.Shape =
- currentSheet.addGeometricShape(ExcelScript.GeometricShapeType.triangle);
-
- triangle.setName("TRI");
- }
- ```
- - name: setPlacement(placement)
- uid: 'ExcelScript!ExcelScript.Shape#setPlacement:member(1)'
- package: ExcelScript!
- fullName: setPlacement(placement)
- summary: Represents how the object is attached to the cells below it.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPlacement(placement: Placement): void;'
- parameters:
- - id: placement
- description: ''
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a diamond shape at cell C3.
- * The shape moves and resizes as the grid underneath it changes.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get cell C3 in the current worksheet.
- const sheet = workbook.getActiveWorksheet();
- const cell = sheet.getRange("C3");
-
- // Create a diamond that slightly overlaps the cell C3.
- const diamond = sheet.addGeometricShape(ExcelScript.GeometricShapeType.diamond);
- // Set each dimension so that the shape extends 5 pixels beyond the cell borders.
- diamond.setLeft(cell.getLeft() - 5);
- diamond.setTop(cell.getTop() - 5);
- diamond.setHeight(cell.getHeight() + 10);
- diamond.setWidth(cell.getWidth() + 10);
-
- // Set the placement of the shape so that it resizes and moves with the grid.
- diamond.setPlacement(ExcelScript.Placement.twoCell);
- }
- ```
- - name: setRotation(rotation)
- uid: 'ExcelScript!ExcelScript.Shape#setRotation:member(1)'
- package: ExcelScript!
- fullName: setRotation(rotation)
- summary: 'Specifies the rotation, in degrees, of the shape.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setRotation(rotation: number): void;'
- parameters:
- - id: rotation
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setTop(top)
- uid: 'ExcelScript!ExcelScript.Shape#setTop:member(1)'
- package: ExcelScript!
- fullName: setTop(top)
- summary: >-
- The distance, in points, from the top edge of the shape to the top edge of the worksheet. Throws an
- `InvalidArgument` exception when set with a negative value as an input.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTop(top: number): void;'
- parameters:
- - id: top
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setVisible(visible)
- uid: 'ExcelScript!ExcelScript.Shape#setVisible:member(1)'
- package: ExcelScript!
- fullName: setVisible(visible)
- summary: Specifies if the shape is visible.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setVisible(visible: boolean): void;'
- parameters:
- - id: visible
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setWidth(width)
- uid: 'ExcelScript!ExcelScript.Shape#setWidth:member(1)'
- package: ExcelScript!
- fullName: setWidth(width)
- summary: >-
- Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value
- or zero as an input.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setWidth(width: number): void;'
- parameters:
- - id: width
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setZOrder(position)
- uid: 'ExcelScript!ExcelScript.Shape#setZOrder:member(1)'
- package: ExcelScript!
- fullName: setZOrder(position)
- summary: 'Moves the specified shape up or down the collection''s z-order, which shifts it in front of or behind other shapes.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setZOrder(position: ShapeZOrder): void;'
- parameters:
- - id: position
- description: >-
- Where to move the shape in the z-order stack relative to the other shapes. See `ExcelScript.ShapeZOrder` for
- details.
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.Shape
+uid: 'ExcelScript!ExcelScript.Shape:interface'
+package: ExcelScript!
+fullName: ExcelScript.Shape
+summary: >-
+ Represents a generic shape object in the worksheet. A shape could be a geometric shape, a line, a group of shapes,
+ etc.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a hexagon shape on the current worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ const currentSheet = workbook.getActiveWorksheet();
+ const hexagon: ExcelScript.Shape =
+ currentSheet.addGeometricShape(ExcelScript.GeometricShapeType.hexagon);
+
+ // Set the hexagon size to 40x40 pixels.
+ hexagon.setHeight(40);
+ hexagon.setWidth(40);
+
+ // Position the hexagon at [100,100] pixels.
+ hexagon.setLeft(100);
+ hexagon.setTop(100);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: copyTo(destinationSheet)
+ uid: 'ExcelScript!ExcelScript.Shape#copyTo:member(1)'
+ package: ExcelScript!
+ fullName: copyTo(destinationSheet)
+ summary: Copies and pastes a `Shape` object. The pasted shape is copied to the same pixel location as this shape.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'copyTo(destinationSheet?: Worksheet | string): Shape;'
+ parameters:
+ - id: destinationSheet
+ description: The sheet to which the shape object will be pasted. The default value is the copied shape's worksheet.
+ type: ' | string'
+ return:
+ type: ''
+ description: ''
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.Shape#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: Removes the shape from the worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script deletes all the shapes on the current worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the collection of shapes on the currently selected worksheet.
+ const shapes = workbook.getActiveWorksheet().getShapes();
+
+ // Remove each shape.
+ shapes.forEach(shape =>{
+ shape.delete();
+ });
+ }
+ ```
+ - name: getAltTextDescription()
+ uid: 'ExcelScript!ExcelScript.Shape#getAltTextDescription:member(1)'
+ package: ExcelScript!
+ fullName: getAltTextDescription()
+ summary: Specifies the alternative description text for a `Shape` object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAltTextDescription(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getAltTextTitle()
+ uid: 'ExcelScript!ExcelScript.Shape#getAltTextTitle:member(1)'
+ package: ExcelScript!
+ fullName: getAltTextTitle()
+ summary: Specifies the alternative title text for a `Shape` object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAltTextTitle(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getAsImage(format)
+ uid: 'ExcelScript!ExcelScript.Shape#getAsImage:member(1)'
+ package: ExcelScript!
+ fullName: getAsImage(format)
+ summary: >-
+ Converts the shape to an image and returns the image as a base64-encoded string. The DPI is 96. The only supported
+ formats are `ExcelScript.PictureFormat.BMP`, `ExcelScript.PictureFormat.PNG`,
+ `ExcelScript.PictureFormat.JPEG`, and `ExcelScript.PictureFormat.GIF`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: true
+ customDeprecatedMessage: Use `getImageAsBase64` instead.
+ syntax:
+ content: 'getAsImage(format: PictureFormat): string;'
+ parameters:
+ - id: format
+ description: Specifies the format of the image.
+ type: ''
+ return:
+ type: string
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a star shape with the value from cell A1.
+ * It then returns the image as a base64-encoded string.
+ * This string would be used as part of a Power Automate flow to add the image elsewhere.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the value of A1 from the worksheet named Sheet1.
+ const sheet = workbook.getWorksheet("Sheet1");
+ const value = sheet.getRange("A1").getValue();
+
+ // Create a Shape object that looks like a 5-pointed star.
+ const star = sheet.addGeometricShape(ExcelScript.GeometricShapeType.star5);
+
+ // Set the text of star and make sure the shape fits the text.
+ const textFrame = star.getTextFrame();
+ textFrame.getTextRange().setText(value.toString());
+ textFrame.setAutoSizeSetting(ExcelScript.ShapeAutoSize.autoSizeShapeToFitText);
+
+ // Return the shape as a PNG image represented by a base64-encoded string.
+ return star.getAsImage(ExcelScript.PictureFormat.png);
+ }
+ ```
+ - name: getConnectionSiteCount()
+ uid: 'ExcelScript!ExcelScript.Shape#getConnectionSiteCount:member(1)'
+ package: ExcelScript!
+ fullName: getConnectionSiteCount()
+ summary: Returns the number of connection sites on this shape.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getConnectionSiteCount(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getDisplayName()
+ uid: 'ExcelScript!ExcelScript.Shape#getDisplayName:member(1)'
+ package: ExcelScript!
+ fullName: getDisplayName()
+ summary: >-
+ Gets the display name of the shape. A newly created shape has a generated name that is localized and may not match
+ its `name`. In this scenario, you can use this API to get the name that is displayed in the UI.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDisplayName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getFill()
+ uid: 'ExcelScript!ExcelScript.Shape#getFill:member(1)'
+ package: ExcelScript!
+ fullName: getFill()
+ summary: Returns the fill formatting of this shape.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFill(): ShapeFill;'
+ return:
+ type: ''
+ description: ''
+ - name: getGeometricShape()
+ uid: 'ExcelScript!ExcelScript.Shape#getGeometricShape:member(1)'
+ package: ExcelScript!
+ fullName: getGeometricShape()
+ summary: >-
+ Returns the geometric shape associated with the shape. An error will be thrown if the shape type is not
+ "GeometricShape".
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGeometricShape(): GeometricShape;'
+ return:
+ type: ''
+ description: ''
+ - name: getGeometricShapeType()
+ uid: 'ExcelScript!ExcelScript.Shape#getGeometricShapeType:member(1)'
+ package: ExcelScript!
+ fullName: getGeometricShapeType()
+ summary: >-
+ Specifies the geometric shape type of this geometric shape. See `ExcelScript.GeometricShapeType` for details.
+ Returns `null` if the shape type is not "GeometricShape".
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGeometricShapeType(): GeometricShapeType;'
+ return:
+ type: ''
+ description: ''
+ - name: getGroup()
+ uid: 'ExcelScript!ExcelScript.Shape#getGroup:member(1)'
+ package: ExcelScript!
+ fullName: getGroup()
+ summary: Returns the shape group associated with the shape. An error will be thrown if the shape type is not "GroupShape".
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGroup(): ShapeGroup;'
+ return:
+ type: ''
+ description: ''
+ - name: getHeight()
+ uid: 'ExcelScript!ExcelScript.Shape#getHeight:member(1)'
+ package: ExcelScript!
+ fullName: getHeight()
+ summary: >-
+ Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative
+ value or zero as an input.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHeight(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getId()
+ uid: 'ExcelScript!ExcelScript.Shape#getId:member(1)'
+ package: ExcelScript!
+ fullName: getId()
+ summary: Specifies the shape identifier.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getId(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getImage()
+ uid: 'ExcelScript!ExcelScript.Shape#getImage:member(1)'
+ package: ExcelScript!
+ fullName: getImage()
+ summary: Returns the image associated with the shape. An error will be thrown if the shape type is not "Image".
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getImage(): Image;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script transfers an image from one worksheet to another.
+ */
+ function main(workbook: ExcelScript.Workbook)
+ {
+ // Get the worksheet with the image on it.
+ let firstWorksheet = workbook.getWorksheet("FirstSheet");
+
+ // Get the first image from the worksheet.
+ // If a script added the image, you could add a name to make it easier to find.
+ let image: ExcelScript.Image;
+ firstWorksheet.getShapes().forEach((shape, index) => {
+ if (shape.getType() === ExcelScript.ShapeType.image) {
+ image = shape.getImage();
+ return;
+ }
+ });
+
+ // Copy the image to another worksheet.
+ image.getShape().copyTo("SecondSheet");
+ }
+ ```
+ - name: getImageAsBase64(format)
+ uid: 'ExcelScript!ExcelScript.Shape#getImageAsBase64:member(1)'
+ package: ExcelScript!
+ fullName: getImageAsBase64(format)
+ summary: >-
+ Converts the shape to an image and returns the image as a Base64-encoded string. The DPI is 96. The only supported
+ formats are `ExcelScript.PictureFormat.BMP`, `ExcelScript.PictureFormat.PNG`,
+ `ExcelScript.PictureFormat.JPEG`, and `ExcelScript.PictureFormat.GIF`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getImageAsBase64(format: PictureFormat): string;'
+ parameters:
+ - id: format
+ description: Specifies the format of the image.
+ type: ''
+ return:
+ type: string
+ description: ''
+ - name: getLeft()
+ uid: 'ExcelScript!ExcelScript.Shape#getLeft:member(1)'
+ package: ExcelScript!
+ fullName: getLeft()
+ summary: >-
+ The distance, in points, from the left side of the shape to the left side of the worksheet. Throws an
+ `InvalidArgument` exception when set with a negative value as an input.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLeft(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getLevel()
+ uid: 'ExcelScript!ExcelScript.Shape#getLevel:member(1)'
+ package: ExcelScript!
+ fullName: getLevel()
+ summary: >-
+ Specifies the level of the specified shape. For example, a level of 0 means that the shape is not part of any
+ groups, a level of 1 means the shape is part of a top-level group, and a level of 2 means the shape is part of a
+ sub-group of the top level.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLevel(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getLine()
+ uid: 'ExcelScript!ExcelScript.Shape#getLine:member(1)'
+ package: ExcelScript!
+ fullName: getLine()
+ summary: Returns the line associated with the shape. An error will be thrown if the shape type is not "Line".
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLine(): Line;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a line that goes from cell B2 to cell F4 on the current worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ const sheet = workbook.getActiveWorksheet();
+
+ // Get the ranges for the two cells.
+ const b2Range = sheet.getRange("B2");
+ const f4Range = sheet.getRange("F4");
+
+ // Add a straight line that connects the top-left corners of both cells.
+ const newShape = sheet.addLine(
+ b2Range.getLeft(),
+ b2Range.getTop(),
+ f4Range.getLeft(),
+ f4Range.getTop(),
+ ExcelScript.ConnectorType.straight);
+
+ // Add an open arrowhead to the end of the line, such that it points at F4.
+ const line = newShape.getLine();
+ line.setEndArrowheadStyle(ExcelScript.ArrowheadStyle.open);
+ }
+ ```
+ - name: getLineFormat()
+ uid: 'ExcelScript!ExcelScript.Shape#getLineFormat:member(1)'
+ package: ExcelScript!
+ fullName: getLineFormat()
+ summary: Returns the line formatting of this shape.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLineFormat(): ShapeLineFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getLockAspectRatio()
+ uid: 'ExcelScript!ExcelScript.Shape#getLockAspectRatio:member(1)'
+ package: ExcelScript!
+ fullName: getLockAspectRatio()
+ summary: Specifies if the aspect ratio of this shape is locked.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLockAspectRatio(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.Shape#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: Specifies the name of the shape.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getParentGroup()
+ uid: 'ExcelScript!ExcelScript.Shape#getParentGroup:member(1)'
+ package: ExcelScript!
+ fullName: getParentGroup()
+ summary: Specifies the parent group of this shape.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getParentGroup(): Shape;'
+ return:
+ type: ''
+ description: ''
+ - name: getPlacement()
+ uid: 'ExcelScript!ExcelScript.Shape#getPlacement:member(1)'
+ package: ExcelScript!
+ fullName: getPlacement()
+ summary: Represents how the object is attached to the cells below it.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPlacement(): Placement;'
+ return:
+ type: ''
+ description: ''
+ - name: getRotation()
+ uid: 'ExcelScript!ExcelScript.Shape#getRotation:member(1)'
+ package: ExcelScript!
+ fullName: getRotation()
+ summary: 'Specifies the rotation, in degrees, of the shape.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRotation(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getTextFrame()
+ uid: 'ExcelScript!ExcelScript.Shape#getTextFrame:member(1)'
+ package: ExcelScript!
+ fullName: getTextFrame()
+ summary: Returns the text frame object of this shape.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTextFrame(): TextFrame;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a star shape with the value from cell A1.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the value of A1 from the worksheet named Sheet1.
+ const sheet = workbook.getWorksheet("Sheet1");
+ const value = sheet.getRange("A1").getValue();
+
+ // Create a Shape object that looks like a 5-pointed star.
+ const star = sheet.addGeometricShape(ExcelScript.GeometricShapeType.star5);
+
+ // Set the text of star and make sure the shape fits the text.
+ const textFrame = star.getTextFrame();
+ textFrame.getTextRange().setText(value.toString());
+ textFrame.setAutoSizeSetting(ExcelScript.ShapeAutoSize.autoSizeShapeToFitText);
+ }
+ ```
+ - name: getTop()
+ uid: 'ExcelScript!ExcelScript.Shape#getTop:member(1)'
+ package: ExcelScript!
+ fullName: getTop()
+ summary: >-
+ The distance, in points, from the top edge of the shape to the top edge of the worksheet. Throws an
+ `InvalidArgument` exception when set with a negative value as an input.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTop(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getType()
+ uid: 'ExcelScript!ExcelScript.Shape#getType:member(1)'
+ package: ExcelScript!
+ fullName: getType()
+ summary: Returns the type of this shape. See `ExcelScript.ShapeType` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getType(): ShapeType;'
+ return:
+ type: ''
+ description: ''
+ - name: getVisible()
+ uid: 'ExcelScript!ExcelScript.Shape#getVisible:member(1)'
+ package: ExcelScript!
+ fullName: getVisible()
+ summary: Specifies if the shape is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVisible(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getWidth()
+ uid: 'ExcelScript!ExcelScript.Shape#getWidth:member(1)'
+ package: ExcelScript!
+ fullName: getWidth()
+ summary: >-
+ Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value
+ or zero as an input.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWidth(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getZOrderPosition()
+ uid: 'ExcelScript!ExcelScript.Shape#getZOrderPosition:member(1)'
+ package: ExcelScript!
+ fullName: getZOrderPosition()
+ summary: 'Returns the position of the specified shape in the z-order, with 0 representing the bottom of the order stack.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getZOrderPosition(): number;'
+ return:
+ type: number
+ description: ''
+ - name: incrementLeft(increment)
+ uid: 'ExcelScript!ExcelScript.Shape#incrementLeft:member(1)'
+ package: ExcelScript!
+ fullName: incrementLeft(increment)
+ summary: Moves the shape horizontally by the specified number of points.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'incrementLeft(increment: number): void;'
+ parameters:
+ - id: increment
+ description: >-
+ The increment, in points, the shape will be horizontally moved. A positive value moves the shape to the
+ right and a negative value moves it to the left. If the sheet is right-to-left oriented, this is reversed:
+ positive values will move the shape to the left and negative values will move it to the right.
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: incrementRotation(increment)
+ uid: 'ExcelScript!ExcelScript.Shape#incrementRotation:member(1)'
+ package: ExcelScript!
+ fullName: incrementRotation(increment)
+ summary: >-
+ Rotates the shape clockwise around the z-axis by the specified number of degrees. Use the `rotation` property to
+ set the absolute rotation of the shape.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'incrementRotation(increment: number): void;'
+ parameters:
+ - id: increment
+ description: >-
+ How many degrees the shape will be rotated. A positive value rotates the shape clockwise and a negative
+ value rotates it counterclockwise.
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: incrementTop(increment)
+ uid: 'ExcelScript!ExcelScript.Shape#incrementTop:member(1)'
+ package: ExcelScript!
+ fullName: incrementTop(increment)
+ summary: Moves the shape vertically by the specified number of points.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'incrementTop(increment: number): void;'
+ parameters:
+ - id: increment
+ description: >-
+ The increment, in points, the shape will be vertically moved. A positive value moves the shape down and a
+ negative value moves it up.
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: 'scaleHeight(scaleFactor, scaleType, scaleFrom)'
+ uid: 'ExcelScript!ExcelScript.Shape#scaleHeight:member(1)'
+ package: ExcelScript!
+ fullName: 'scaleHeight(scaleFactor, scaleType, scaleFrom)'
+ summary: >-
+ Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the
+ shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their
+ current height.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ scaleHeight(
+ scaleFactor: number,
+ scaleType: ShapeScaleType,
+ scaleFrom?: ShapeScaleFrom
+ ): void;
+ parameters:
+ - id: scaleFactor
+ description: Specifies the ratio between the height of the shape after you resize it and the current or original height.
+ type: number
+ - id: scaleType
+ description: >-
+ Specifies whether the shape is scaled relative to its original or current size. The original size scaling
+ option only works for images.
+ type: ''
+ - id: scaleFrom
+ description: >-
+ Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it
+ represents the shape's upper left corner retains its position.
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: 'scaleWidth(scaleFactor, scaleType, scaleFrom)'
+ uid: 'ExcelScript!ExcelScript.Shape#scaleWidth:member(1)'
+ package: ExcelScript!
+ fullName: 'scaleWidth(scaleFactor, scaleType, scaleFrom)'
+ summary: >-
+ Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the
+ shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their
+ current width.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ scaleWidth(
+ scaleFactor: number,
+ scaleType: ShapeScaleType,
+ scaleFrom?: ShapeScaleFrom
+ ): void;
+ parameters:
+ - id: scaleFactor
+ description: Specifies the ratio between the width of the shape after you resize it and the current or original width.
+ type: number
+ - id: scaleType
+ description: >-
+ Specifies whether the shape is scaled relative to its original or current size. The original size scaling
+ option only works for images.
+ type: ''
+ - id: scaleFrom
+ description: >-
+ Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it
+ represents the shape's upper left corner retains its position.
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setAltTextDescription(altTextDescription)
+ uid: 'ExcelScript!ExcelScript.Shape#setAltTextDescription:member(1)'
+ package: ExcelScript!
+ fullName: setAltTextDescription(altTextDescription)
+ summary: Specifies the alternative description text for a `Shape` object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setAltTextDescription(altTextDescription: string): void;'
+ parameters:
+ - id: altTextDescription
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setAltTextTitle(altTextTitle)
+ uid: 'ExcelScript!ExcelScript.Shape#setAltTextTitle:member(1)'
+ package: ExcelScript!
+ fullName: setAltTextTitle(altTextTitle)
+ summary: Specifies the alternative title text for a `Shape` object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setAltTextTitle(altTextTitle: string): void;'
+ parameters:
+ - id: altTextTitle
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setGeometricShapeType(geometricShapeType)
+ uid: 'ExcelScript!ExcelScript.Shape#setGeometricShapeType:member(1)'
+ package: ExcelScript!
+ fullName: setGeometricShapeType(geometricShapeType)
+ summary: >-
+ Specifies the geometric shape type of this geometric shape. See `ExcelScript.GeometricShapeType` for details.
+ Returns `null` if the shape type is not "GeometricShape".
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setGeometricShapeType(geometricShapeType: GeometricShapeType): void;'
+ parameters:
+ - id: geometricShapeType
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setHeight(height)
+ uid: 'ExcelScript!ExcelScript.Shape#setHeight:member(1)'
+ package: ExcelScript!
+ fullName: setHeight(height)
+ summary: >-
+ Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative
+ value or zero as an input.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setHeight(height: number): void;'
+ parameters:
+ - id: height
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setLeft(left)
+ uid: 'ExcelScript!ExcelScript.Shape#setLeft:member(1)'
+ package: ExcelScript!
+ fullName: setLeft(left)
+ summary: >-
+ The distance, in points, from the left side of the shape to the left side of the worksheet. Throws an
+ `InvalidArgument` exception when set with a negative value as an input.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLeft(left: number): void;'
+ parameters:
+ - id: left
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setLockAspectRatio(lockAspectRatio)
+ uid: 'ExcelScript!ExcelScript.Shape#setLockAspectRatio:member(1)'
+ package: ExcelScript!
+ fullName: setLockAspectRatio(lockAspectRatio)
+ summary: Specifies if the aspect ratio of this shape is locked.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLockAspectRatio(lockAspectRatio: boolean): void;'
+ parameters:
+ - id: lockAspectRatio
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setName(name)
+ uid: 'ExcelScript!ExcelScript.Shape#setName:member(1)'
+ package: ExcelScript!
+ fullName: setName(name)
+ summary: Specifies the name of the shape.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setName(name: string): void;'
+ parameters:
+ - id: name
+ description: ''
+ type: string
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a triangle shape on the current worksheet and names it "TRI".
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ const currentSheet = workbook.getActiveWorksheet();
+ const triangle: ExcelScript.Shape =
+ currentSheet.addGeometricShape(ExcelScript.GeometricShapeType.triangle);
+
+ triangle.setName("TRI");
+ }
+ ```
+ - name: setPlacement(placement)
+ uid: 'ExcelScript!ExcelScript.Shape#setPlacement:member(1)'
+ package: ExcelScript!
+ fullName: setPlacement(placement)
+ summary: Represents how the object is attached to the cells below it.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPlacement(placement: Placement): void;'
+ parameters:
+ - id: placement
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a diamond shape at cell C3.
+ * The shape moves and resizes as the grid underneath it changes.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get cell C3 in the current worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const cell = sheet.getRange("C3");
+
+ // Create a diamond that slightly overlaps the cell C3.
+ const diamond = sheet.addGeometricShape(ExcelScript.GeometricShapeType.diamond);
+ // Set each dimension so that the shape extends 5 pixels beyond the cell borders.
+ diamond.setLeft(cell.getLeft() - 5);
+ diamond.setTop(cell.getTop() - 5);
+ diamond.setHeight(cell.getHeight() + 10);
+ diamond.setWidth(cell.getWidth() + 10);
+
+ // Set the placement of the shape so that it resizes and moves with the grid.
+ diamond.setPlacement(ExcelScript.Placement.twoCell);
+ }
+ ```
+ - name: setRotation(rotation)
+ uid: 'ExcelScript!ExcelScript.Shape#setRotation:member(1)'
+ package: ExcelScript!
+ fullName: setRotation(rotation)
+ summary: 'Specifies the rotation, in degrees, of the shape.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setRotation(rotation: number): void;'
+ parameters:
+ - id: rotation
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setTop(top)
+ uid: 'ExcelScript!ExcelScript.Shape#setTop:member(1)'
+ package: ExcelScript!
+ fullName: setTop(top)
+ summary: >-
+ The distance, in points, from the top edge of the shape to the top edge of the worksheet. Throws an
+ `InvalidArgument` exception when set with a negative value as an input.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTop(top: number): void;'
+ parameters:
+ - id: top
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setVisible(visible)
+ uid: 'ExcelScript!ExcelScript.Shape#setVisible:member(1)'
+ package: ExcelScript!
+ fullName: setVisible(visible)
+ summary: Specifies if the shape is visible.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setVisible(visible: boolean): void;'
+ parameters:
+ - id: visible
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setWidth(width)
+ uid: 'ExcelScript!ExcelScript.Shape#setWidth:member(1)'
+ package: ExcelScript!
+ fullName: setWidth(width)
+ summary: >-
+ Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value
+ or zero as an input.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setWidth(width: number): void;'
+ parameters:
+ - id: width
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setZOrder(position)
+ uid: 'ExcelScript!ExcelScript.Shape#setZOrder:member(1)'
+ package: ExcelScript!
+ fullName: setZOrder(position)
+ summary: 'Moves the specified shape up or down the collection''s z-order, which shifts it in front of or behind other shapes.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setZOrder(position: ShapeZOrder): void;'
+ parameters:
+ - id: position
+ description: >-
+ Where to move the shape in the z-order stack relative to the other shapes. See `ExcelScript.ShapeZOrder` for
+ details.
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapeautosize.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapeautosize.yml
index 4c656c9d..b480f47b 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapeautosize.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapeautosize.yml
@@ -1,48 +1,48 @@
-### YamlMime:TSEnum
-name: ExcelScript.ShapeAutoSize
-uid: 'ExcelScript!ExcelScript.ShapeAutoSize:enum'
-package: ExcelScript!
-fullName: ExcelScript.ShapeAutoSize
-summary: Determines the type of automatic sizing allowed.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a star shape with the value from cell A1.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the value of A1 from the worksheet named Sheet1.
- const sheet = workbook.getWorksheet("Sheet1");
- const value = sheet.getRange("A1").getValue();
-
- // Create a Shape object that looks like a 5-pointed star.
- const star = sheet.addGeometricShape(ExcelScript.GeometricShapeType.star5);
-
- // Set the text of star and make sure the shape fits the text.
- const textFrame = star.getTextFrame();
- textFrame.getTextRange().setText(value.toString());
- textFrame.setAutoSizeSetting(ExcelScript.ShapeAutoSize.autoSizeShapeToFitText);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: autoSizeMixed
- uid: 'ExcelScript!ExcelScript.ShapeAutoSize.autoSizeMixed:member'
- package: ExcelScript!
- summary: A combination of automatic sizing schemes are used.
- - name: autoSizeNone
- uid: 'ExcelScript!ExcelScript.ShapeAutoSize.autoSizeNone:member'
- package: ExcelScript!
- summary: No autosizing.
- - name: autoSizeShapeToFitText
- uid: 'ExcelScript!ExcelScript.ShapeAutoSize.autoSizeShapeToFitText:member'
- package: ExcelScript!
- summary: The shape is adjusted to fit the text.
- - name: autoSizeTextToFitShape
- uid: 'ExcelScript!ExcelScript.ShapeAutoSize.autoSizeTextToFitShape:member'
- package: ExcelScript!
- summary: The text is adjusted to fit the shape.
+### YamlMime:TSEnum
+name: ExcelScript.ShapeAutoSize
+uid: 'ExcelScript!ExcelScript.ShapeAutoSize:enum'
+package: ExcelScript!
+fullName: ExcelScript.ShapeAutoSize
+summary: Determines the type of automatic sizing allowed.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a star shape with the value from cell A1.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the value of A1 from the worksheet named Sheet1.
+ const sheet = workbook.getWorksheet("Sheet1");
+ const value = sheet.getRange("A1").getValue();
+
+ // Create a Shape object that looks like a 5-pointed star.
+ const star = sheet.addGeometricShape(ExcelScript.GeometricShapeType.star5);
+
+ // Set the text of star and make sure the shape fits the text.
+ const textFrame = star.getTextFrame();
+ textFrame.getTextRange().setText(value.toString());
+ textFrame.setAutoSizeSetting(ExcelScript.ShapeAutoSize.autoSizeShapeToFitText);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: autoSizeMixed
+ uid: 'ExcelScript!ExcelScript.ShapeAutoSize.autoSizeMixed:member'
+ package: ExcelScript!
+ summary: A combination of automatic sizing schemes are used.
+ - name: autoSizeNone
+ uid: 'ExcelScript!ExcelScript.ShapeAutoSize.autoSizeNone:member'
+ package: ExcelScript!
+ summary: No autosizing.
+ - name: autoSizeShapeToFitText
+ uid: 'ExcelScript!ExcelScript.ShapeAutoSize.autoSizeShapeToFitText:member'
+ package: ExcelScript!
+ summary: The shape is adjusted to fit the text.
+ - name: autoSizeTextToFitShape
+ uid: 'ExcelScript!ExcelScript.ShapeAutoSize.autoSizeTextToFitShape:member'
+ package: ExcelScript!
+ summary: The text is adjusted to fit the shape.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapefill.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapefill.yml
index bb350842..8b198011 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapefill.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapefill.yml
@@ -1,126 +1,126 @@
-### YamlMime:TSType
-name: ExcelScript.ShapeFill
-uid: 'ExcelScript!ExcelScript.ShapeFill:interface'
-package: ExcelScript!
-fullName: ExcelScript.ShapeFill
-summary: Represents the fill formatting of a shape object.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: clear()
- uid: 'ExcelScript!ExcelScript.ShapeFill#clear:member(1)'
- package: ExcelScript!
- fullName: clear()
- summary: Clears the fill formatting of this shape.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'clear(): void;'
- return:
- type: void
- description: ''
- - name: getForegroundColor()
- uid: 'ExcelScript!ExcelScript.ShapeFill#getForegroundColor:member(1)'
- package: ExcelScript!
- fullName: getForegroundColor()
- summary: >-
- Represents the shape fill foreground color in HTML color format, in the form \#RRGGBB (e.g., "FFA500") or as a
- named HTML color (e.g., "orange")
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getForegroundColor(): string;'
- return:
- type: string
- description: ''
- - name: getTransparency()
- uid: 'ExcelScript!ExcelScript.ShapeFill#getTransparency:member(1)'
- package: ExcelScript!
- fullName: getTransparency()
- summary: >-
- Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null`
- if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a
- gradient fill type.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTransparency(): number;'
- return:
- type: number
- description: ''
- - name: getType()
- uid: 'ExcelScript!ExcelScript.ShapeFill#getType:member(1)'
- package: ExcelScript!
- fullName: getType()
- summary: Returns the fill type of the shape. See `ExcelScript.ShapeFillType` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getType(): ShapeFillType;'
- return:
- type: ''
- description: ''
- - name: setForegroundColor(foregroundColor)
- uid: 'ExcelScript!ExcelScript.ShapeFill#setForegroundColor:member(1)'
- package: ExcelScript!
- fullName: setForegroundColor(foregroundColor)
- summary: >-
- Represents the shape fill foreground color in HTML color format, in the form \#RRGGBB (e.g., "FFA500") or as a
- named HTML color (e.g., "orange")
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setForegroundColor(foregroundColor: string): void;'
- parameters:
- - id: foregroundColor
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setSolidColor(color)
- uid: 'ExcelScript!ExcelScript.ShapeFill#setSolidColor:member(1)'
- package: ExcelScript!
- fullName: setSolidColor(color)
- summary: Sets the fill formatting of the shape to a uniform color. This changes the fill type to "Solid".
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setSolidColor(color: string): void;'
- parameters:
- - id: color
- description: >-
- A string that represents the fill color in HTML color format, in the form \#RRGGBB (e.g., "FFA500") or as a
- named HTML color (e.g., "orange").
- type: string
- return:
- type: void
- description: ''
- - name: setTransparency(transparency)
- uid: 'ExcelScript!ExcelScript.ShapeFill#setTransparency:member(1)'
- package: ExcelScript!
- fullName: setTransparency(transparency)
- summary: >-
- Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null`
- if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a
- gradient fill type.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTransparency(transparency: number): void;'
- parameters:
- - id: transparency
- description: ''
- type: number
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ShapeFill
+uid: 'ExcelScript!ExcelScript.ShapeFill:interface'
+package: ExcelScript!
+fullName: ExcelScript.ShapeFill
+summary: Represents the fill formatting of a shape object.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: clear()
+ uid: 'ExcelScript!ExcelScript.ShapeFill#clear:member(1)'
+ package: ExcelScript!
+ fullName: clear()
+ summary: Clears the fill formatting of this shape.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clear(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getForegroundColor()
+ uid: 'ExcelScript!ExcelScript.ShapeFill#getForegroundColor:member(1)'
+ package: ExcelScript!
+ fullName: getForegroundColor()
+ summary: >-
+ Represents the shape fill foreground color in HTML color format, in the form \#RRGGBB (e.g., "FFA500") or as a
+ named HTML color (e.g., "orange")
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getForegroundColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getTransparency()
+ uid: 'ExcelScript!ExcelScript.ShapeFill#getTransparency:member(1)'
+ package: ExcelScript!
+ fullName: getTransparency()
+ summary: >-
+ Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null`
+ if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a
+ gradient fill type.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTransparency(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getType()
+ uid: 'ExcelScript!ExcelScript.ShapeFill#getType:member(1)'
+ package: ExcelScript!
+ fullName: getType()
+ summary: Returns the fill type of the shape. See `ExcelScript.ShapeFillType` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getType(): ShapeFillType;'
+ return:
+ type: ''
+ description: ''
+ - name: setForegroundColor(foregroundColor)
+ uid: 'ExcelScript!ExcelScript.ShapeFill#setForegroundColor:member(1)'
+ package: ExcelScript!
+ fullName: setForegroundColor(foregroundColor)
+ summary: >-
+ Represents the shape fill foreground color in HTML color format, in the form \#RRGGBB (e.g., "FFA500") or as a
+ named HTML color (e.g., "orange")
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setForegroundColor(foregroundColor: string): void;'
+ parameters:
+ - id: foregroundColor
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setSolidColor(color)
+ uid: 'ExcelScript!ExcelScript.ShapeFill#setSolidColor:member(1)'
+ package: ExcelScript!
+ fullName: setSolidColor(color)
+ summary: Sets the fill formatting of the shape to a uniform color. This changes the fill type to "Solid".
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSolidColor(color: string): void;'
+ parameters:
+ - id: color
+ description: >-
+ A string that represents the fill color in HTML color format, in the form \#RRGGBB (e.g., "FFA500") or as a
+ named HTML color (e.g., "orange").
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setTransparency(transparency)
+ uid: 'ExcelScript!ExcelScript.ShapeFill#setTransparency:member(1)'
+ package: ExcelScript!
+ fullName: setTransparency(transparency)
+ summary: >-
+ Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null`
+ if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a
+ gradient fill type.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTransparency(transparency: number): void;'
+ parameters:
+ - id: transparency
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapefilltype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapefilltype.yml
index 3bfa44b0..d730182f 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapefilltype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapefilltype.yml
@@ -1,34 +1,34 @@
-### YamlMime:TSEnum
-name: ExcelScript.ShapeFillType
-uid: 'ExcelScript!ExcelScript.ShapeFillType:enum'
-package: ExcelScript!
-fullName: ExcelScript.ShapeFillType
-summary: Specifies a shape's fill type.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: gradient
- uid: 'ExcelScript!ExcelScript.ShapeFillType.gradient:member'
- package: ExcelScript!
- summary: Gradient fill.
- - name: mixed
- uid: 'ExcelScript!ExcelScript.ShapeFillType.mixed:member'
- package: ExcelScript!
- summary: Mixed fill.
- - name: noFill
- uid: 'ExcelScript!ExcelScript.ShapeFillType.noFill:member'
- package: ExcelScript!
- summary: No fill.
- - name: pattern
- uid: 'ExcelScript!ExcelScript.ShapeFillType.pattern:member'
- package: ExcelScript!
- summary: Pattern fill.
- - name: pictureAndTexture
- uid: 'ExcelScript!ExcelScript.ShapeFillType.pictureAndTexture:member'
- package: ExcelScript!
- summary: Picture and texture fill.
- - name: solid
- uid: 'ExcelScript!ExcelScript.ShapeFillType.solid:member'
- package: ExcelScript!
- summary: Solid fill.
+### YamlMime:TSEnum
+name: ExcelScript.ShapeFillType
+uid: 'ExcelScript!ExcelScript.ShapeFillType:enum'
+package: ExcelScript!
+fullName: ExcelScript.ShapeFillType
+summary: Specifies a shape's fill type.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: gradient
+ uid: 'ExcelScript!ExcelScript.ShapeFillType.gradient:member'
+ package: ExcelScript!
+ summary: Gradient fill.
+ - name: mixed
+ uid: 'ExcelScript!ExcelScript.ShapeFillType.mixed:member'
+ package: ExcelScript!
+ summary: Mixed fill.
+ - name: noFill
+ uid: 'ExcelScript!ExcelScript.ShapeFillType.noFill:member'
+ package: ExcelScript!
+ summary: No fill.
+ - name: pattern
+ uid: 'ExcelScript!ExcelScript.ShapeFillType.pattern:member'
+ package: ExcelScript!
+ summary: Pattern fill.
+ - name: pictureAndTexture
+ uid: 'ExcelScript!ExcelScript.ShapeFillType.pictureAndTexture:member'
+ package: ExcelScript!
+ summary: Picture and texture fill.
+ - name: solid
+ uid: 'ExcelScript!ExcelScript.ShapeFillType.solid:member'
+ package: ExcelScript!
+ summary: Solid fill.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapefont.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapefont.yml
index f6208e63..2341d2f5 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapefont.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapefont.yml
@@ -1,236 +1,236 @@
-### YamlMime:TSType
-name: ExcelScript.ShapeFont
-uid: 'ExcelScript!ExcelScript.ShapeFont:interface'
-package: ExcelScript!
-fullName: ExcelScript.ShapeFont
-summary: 'Represents the font attributes, such as font name, font size, and color, for a shape''s `TextRange` object.'
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample sets the font of a shape to be bold.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first shape in the current worksheet.
- const sheet = workbook.getActiveWorksheet();
- const shape = sheet.getShapes()[0];
-
- // Get the text font from the shape.
- const text: ExcelScript.TextRange = shape.getTextFrame().getTextRange();
- const shapeTextFont: ExcelScript.ShapeFont = text.getFont();
-
- // Set the font to be bold.
- shapeTextFont.setBold(true);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getBold()
- uid: 'ExcelScript!ExcelScript.ShapeFont#getBold:member(1)'
- package: ExcelScript!
- fullName: getBold()
- summary: >-
- Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text
- fragments.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBold(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getColor()
- uid: 'ExcelScript!ExcelScript.ShapeFont#getColor:member(1)'
- package: ExcelScript!
- fullName: getColor()
- summary: >-
- HTML color code representation of the text color (e.g., "\#FF0000" represents red). Returns `null` if the
- `TextRange` includes text fragments with different colors.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColor(): string;'
- return:
- type: string
- description: ''
- - name: getItalic()
- uid: 'ExcelScript!ExcelScript.ShapeFont#getItalic:member(1)'
- package: ExcelScript!
- fullName: getItalic()
- summary: >-
- Represents the italic status of font. Returns `null` if the `TextRange` includes both italic and non-italic text
- fragments.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getItalic(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.ShapeFont#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: >-
- Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the
- corresponding font name; otherwise it is the Latin font name.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: getSize()
- uid: 'ExcelScript!ExcelScript.ShapeFont#getSize:member(1)'
- package: ExcelScript!
- fullName: getSize()
- summary: >-
- Represents font size in points (e.g., 11). Returns `null` if the `TextRange` includes text fragments with
- different font sizes.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSize(): number;'
- return:
- type: number
- description: ''
- - name: getUnderline()
- uid: 'ExcelScript!ExcelScript.ShapeFont#getUnderline:member(1)'
- package: ExcelScript!
- fullName: getUnderline()
- summary: >-
- Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different
- underline styles. See `ExcelScript.ShapeFontUnderlineStyle` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getUnderline(): ShapeFontUnderlineStyle;'
- return:
- type: ''
- description: ''
- - name: setBold(bold)
- uid: 'ExcelScript!ExcelScript.ShapeFont#setBold:member(1)'
- package: ExcelScript!
- fullName: setBold(bold)
- summary: >-
- Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text
- fragments.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setBold(bold: boolean): void;'
- parameters:
- - id: bold
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setColor(color)
- uid: 'ExcelScript!ExcelScript.ShapeFont#setColor:member(1)'
- package: ExcelScript!
- fullName: setColor(color)
- summary: >-
- HTML color code representation of the text color (e.g., "\#FF0000" represents red). Returns `null` if the
- `TextRange` includes text fragments with different colors.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setColor(color: string): void;'
- parameters:
- - id: color
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setItalic(italic)
- uid: 'ExcelScript!ExcelScript.ShapeFont#setItalic:member(1)'
- package: ExcelScript!
- fullName: setItalic(italic)
- summary: >-
- Represents the italic status of font. Returns `null` if the `TextRange` includes both italic and non-italic text
- fragments.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setItalic(italic: boolean): void;'
- parameters:
- - id: italic
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setName(name)
- uid: 'ExcelScript!ExcelScript.ShapeFont#setName:member(1)'
- package: ExcelScript!
- fullName: setName(name)
- summary: >-
- Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the
- corresponding font name; otherwise it is the Latin font name.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setName(name: string): void;'
- parameters:
- - id: name
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setSize(size)
- uid: 'ExcelScript!ExcelScript.ShapeFont#setSize:member(1)'
- package: ExcelScript!
- fullName: setSize(size)
- summary: >-
- Represents font size in points (e.g., 11). Returns `null` if the `TextRange` includes text fragments with
- different font sizes.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setSize(size: number): void;'
- parameters:
- - id: size
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setUnderline(underline)
- uid: 'ExcelScript!ExcelScript.ShapeFont#setUnderline:member(1)'
- package: ExcelScript!
- fullName: setUnderline(underline)
- summary: >-
- Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different
- underline styles. See `ExcelScript.ShapeFontUnderlineStyle` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setUnderline(underline: ShapeFontUnderlineStyle): void;'
- parameters:
- - id: underline
- description: ''
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ShapeFont
+uid: 'ExcelScript!ExcelScript.ShapeFont:interface'
+package: ExcelScript!
+fullName: ExcelScript.ShapeFont
+summary: 'Represents the font attributes, such as font name, font size, and color, for a shape''s `TextRange` object.'
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample sets the font of a shape to be bold.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first shape in the current worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const shape = sheet.getShapes()[0];
+
+ // Get the text font from the shape.
+ const text: ExcelScript.TextRange = shape.getTextFrame().getTextRange();
+ const shapeTextFont: ExcelScript.ShapeFont = text.getFont();
+
+ // Set the font to be bold.
+ shapeTextFont.setBold(true);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getBold()
+ uid: 'ExcelScript!ExcelScript.ShapeFont#getBold:member(1)'
+ package: ExcelScript!
+ fullName: getBold()
+ summary: >-
+ Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text
+ fragments.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBold(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getColor()
+ uid: 'ExcelScript!ExcelScript.ShapeFont#getColor:member(1)'
+ package: ExcelScript!
+ fullName: getColor()
+ summary: >-
+ HTML color code representation of the text color (e.g., "\#FF0000" represents red). Returns `null` if the
+ `TextRange` includes text fragments with different colors.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getItalic()
+ uid: 'ExcelScript!ExcelScript.ShapeFont#getItalic:member(1)'
+ package: ExcelScript!
+ fullName: getItalic()
+ summary: >-
+ Represents the italic status of font. Returns `null` if the `TextRange` includes both italic and non-italic text
+ fragments.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItalic(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.ShapeFont#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: >-
+ Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the
+ corresponding font name; otherwise it is the Latin font name.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getSize()
+ uid: 'ExcelScript!ExcelScript.ShapeFont#getSize:member(1)'
+ package: ExcelScript!
+ fullName: getSize()
+ summary: >-
+ Represents font size in points (e.g., 11). Returns `null` if the `TextRange` includes text fragments with
+ different font sizes.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSize(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getUnderline()
+ uid: 'ExcelScript!ExcelScript.ShapeFont#getUnderline:member(1)'
+ package: ExcelScript!
+ fullName: getUnderline()
+ summary: >-
+ Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different
+ underline styles. See `ExcelScript.ShapeFontUnderlineStyle` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getUnderline(): ShapeFontUnderlineStyle;'
+ return:
+ type: ''
+ description: ''
+ - name: setBold(bold)
+ uid: 'ExcelScript!ExcelScript.ShapeFont#setBold:member(1)'
+ package: ExcelScript!
+ fullName: setBold(bold)
+ summary: >-
+ Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text
+ fragments.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setBold(bold: boolean): void;'
+ parameters:
+ - id: bold
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setColor(color)
+ uid: 'ExcelScript!ExcelScript.ShapeFont#setColor:member(1)'
+ package: ExcelScript!
+ fullName: setColor(color)
+ summary: >-
+ HTML color code representation of the text color (e.g., "\#FF0000" represents red). Returns `null` if the
+ `TextRange` includes text fragments with different colors.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setColor(color: string): void;'
+ parameters:
+ - id: color
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setItalic(italic)
+ uid: 'ExcelScript!ExcelScript.ShapeFont#setItalic:member(1)'
+ package: ExcelScript!
+ fullName: setItalic(italic)
+ summary: >-
+ Represents the italic status of font. Returns `null` if the `TextRange` includes both italic and non-italic text
+ fragments.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setItalic(italic: boolean): void;'
+ parameters:
+ - id: italic
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setName(name)
+ uid: 'ExcelScript!ExcelScript.ShapeFont#setName:member(1)'
+ package: ExcelScript!
+ fullName: setName(name)
+ summary: >-
+ Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the
+ corresponding font name; otherwise it is the Latin font name.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setName(name: string): void;'
+ parameters:
+ - id: name
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setSize(size)
+ uid: 'ExcelScript!ExcelScript.ShapeFont#setSize:member(1)'
+ package: ExcelScript!
+ fullName: setSize(size)
+ summary: >-
+ Represents font size in points (e.g., 11). Returns `null` if the `TextRange` includes text fragments with
+ different font sizes.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSize(size: number): void;'
+ parameters:
+ - id: size
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setUnderline(underline)
+ uid: 'ExcelScript!ExcelScript.ShapeFont#setUnderline:member(1)'
+ package: ExcelScript!
+ fullName: setUnderline(underline)
+ summary: >-
+ Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different
+ underline styles. See `ExcelScript.ShapeFontUnderlineStyle` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setUnderline(underline: ShapeFontUnderlineStyle): void;'
+ parameters:
+ - id: underline
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapefontunderlinestyle.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapefontunderlinestyle.yml
index f39bd8a7..fcab41a8 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapefontunderlinestyle.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapefontunderlinestyle.yml
@@ -1,78 +1,78 @@
-### YamlMime:TSEnum
-name: ExcelScript.ShapeFontUnderlineStyle
-uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle:enum'
-package: ExcelScript!
-fullName: ExcelScript.ShapeFontUnderlineStyle
-summary: The type of underline applied to a font.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: dash
- uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.dash:member'
- package: ExcelScript!
- summary: ''
- - name: dashHeavy
- uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.dashHeavy:member'
- package: ExcelScript!
- summary: ''
- - name: dashLong
- uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.dashLong:member'
- package: ExcelScript!
- summary: ''
- - name: dashLongHeavy
- uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.dashLongHeavy:member'
- package: ExcelScript!
- summary: ''
- - name: dotDash
- uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.dotDash:member'
- package: ExcelScript!
- summary: ''
- - name: dotDashHeavy
- uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.dotDashHeavy:member'
- package: ExcelScript!
- summary: ''
- - name: dotDotDash
- uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.dotDotDash:member'
- package: ExcelScript!
- summary: ''
- - name: dotDotDashHeavy
- uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.dotDotDashHeavy:member'
- package: ExcelScript!
- summary: ''
- - name: dotted
- uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.dotted:member'
- package: ExcelScript!
- summary: ''
- - name: dottedHeavy
- uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.dottedHeavy:member'
- package: ExcelScript!
- summary: ''
- - name: double
- uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.double:member'
- package: ExcelScript!
- summary: ''
- - name: heavy
- uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.heavy:member'
- package: ExcelScript!
- summary: ''
- - name: none
- uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.none:member'
- package: ExcelScript!
- summary: ''
- - name: single
- uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.single:member'
- package: ExcelScript!
- summary: ''
- - name: wavy
- uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.wavy:member'
- package: ExcelScript!
- summary: ''
- - name: wavyDouble
- uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.wavyDouble:member'
- package: ExcelScript!
- summary: ''
- - name: wavyHeavy
- uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.wavyHeavy:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ShapeFontUnderlineStyle
+uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle:enum'
+package: ExcelScript!
+fullName: ExcelScript.ShapeFontUnderlineStyle
+summary: The type of underline applied to a font.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: dash
+ uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.dash:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dashHeavy
+ uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.dashHeavy:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dashLong
+ uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.dashLong:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dashLongHeavy
+ uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.dashLongHeavy:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dotDash
+ uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.dotDash:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dotDashHeavy
+ uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.dotDashHeavy:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dotDotDash
+ uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.dotDotDash:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dotDotDashHeavy
+ uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.dotDotDashHeavy:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dotted
+ uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.dotted:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dottedHeavy
+ uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.dottedHeavy:member'
+ package: ExcelScript!
+ summary: ''
+ - name: double
+ uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.double:member'
+ package: ExcelScript!
+ summary: ''
+ - name: heavy
+ uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.heavy:member'
+ package: ExcelScript!
+ summary: ''
+ - name: none
+ uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.none:member'
+ package: ExcelScript!
+ summary: ''
+ - name: single
+ uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.single:member'
+ package: ExcelScript!
+ summary: ''
+ - name: wavy
+ uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.wavy:member'
+ package: ExcelScript!
+ summary: ''
+ - name: wavyDouble
+ uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.wavyDouble:member'
+ package: ExcelScript!
+ summary: ''
+ - name: wavyHeavy
+ uid: 'ExcelScript!ExcelScript.ShapeFontUnderlineStyle.wavyHeavy:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapegroup.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapegroup.yml
index cd61f39c..14913e6a 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapegroup.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapegroup.yml
@@ -1,82 +1,82 @@
-### YamlMime:TSType
-name: ExcelScript.ShapeGroup
-uid: 'ExcelScript!ExcelScript.ShapeGroup:interface'
-package: ExcelScript!
-fullName: ExcelScript.ShapeGroup
-summary: 'Represents a shape group inside a worksheet. To get the corresponding `Shape` object, use `ShapeGroup.shape`.'
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getGroupShape()
- uid: 'ExcelScript!ExcelScript.ShapeGroup#getGroupShape:member(1)'
- package: ExcelScript!
- fullName: getGroupShape()
- summary: Returns the `Shape` object associated with the group.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGroupShape(): Shape;'
- return:
- type: ''
- description: ''
- - name: getId()
- uid: 'ExcelScript!ExcelScript.ShapeGroup#getId:member(1)'
- package: ExcelScript!
- fullName: getId()
- summary: Specifies the shape identifier.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getId(): string;'
- return:
- type: string
- description: ''
- - name: getShape(key)
- uid: 'ExcelScript!ExcelScript.ShapeGroup#getShape:member(1)'
- package: ExcelScript!
- fullName: getShape(key)
- summary: >-
- Gets a shape using its name or ID. If the shape object does not exist, then this method returns `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShape(key: string): Shape | undefined;'
- parameters:
- - id: key
- description: The name or ID of the shape to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getShapes()
- uid: 'ExcelScript!ExcelScript.ShapeGroup#getShapes:member(1)'
- package: ExcelScript!
- fullName: getShapes()
- summary: Returns the collection of `Shape` objects.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShapes(): Shape[];'
- return:
- type: '[]'
- description: ''
- - name: ungroup()
- uid: 'ExcelScript!ExcelScript.ShapeGroup#ungroup:member(1)'
- package: ExcelScript!
- fullName: ungroup()
- summary: Ungroups any grouped shapes in the specified shape group.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'ungroup(): void;'
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ShapeGroup
+uid: 'ExcelScript!ExcelScript.ShapeGroup:interface'
+package: ExcelScript!
+fullName: ExcelScript.ShapeGroup
+summary: 'Represents a shape group inside a worksheet. To get the corresponding `Shape` object, use `ShapeGroup.shape`.'
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getGroupShape()
+ uid: 'ExcelScript!ExcelScript.ShapeGroup#getGroupShape:member(1)'
+ package: ExcelScript!
+ fullName: getGroupShape()
+ summary: Returns the `Shape` object associated with the group.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGroupShape(): Shape;'
+ return:
+ type: ''
+ description: ''
+ - name: getId()
+ uid: 'ExcelScript!ExcelScript.ShapeGroup#getId:member(1)'
+ package: ExcelScript!
+ fullName: getId()
+ summary: Specifies the shape identifier.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getId(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getShape(key)
+ uid: 'ExcelScript!ExcelScript.ShapeGroup#getShape:member(1)'
+ package: ExcelScript!
+ fullName: getShape(key)
+ summary: >-
+ Gets a shape using its name or ID. If the shape object does not exist, then this method returns `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShape(key: string): Shape | undefined;'
+ parameters:
+ - id: key
+ description: The name or ID of the shape to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getShapes()
+ uid: 'ExcelScript!ExcelScript.ShapeGroup#getShapes:member(1)'
+ package: ExcelScript!
+ fullName: getShapes()
+ summary: Returns the collection of `Shape` objects.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShapes(): Shape[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: ungroup()
+ uid: 'ExcelScript!ExcelScript.ShapeGroup#ungroup:member(1)'
+ package: ExcelScript!
+ fullName: ungroup()
+ summary: Ungroups any grouped shapes in the specified shape group.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'ungroup(): void;'
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapelinedashstyle.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapelinedashstyle.yml
index 2c2b4400..d747190b 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapelinedashstyle.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapelinedashstyle.yml
@@ -1,58 +1,58 @@
-### YamlMime:TSEnum
-name: ExcelScript.ShapeLineDashStyle
-uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle:enum'
-package: ExcelScript!
-fullName: ExcelScript.ShapeLineDashStyle
-summary: The dash style for a line.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: dash
- uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.dash:member'
- package: ExcelScript!
- summary: ''
- - name: dashDot
- uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.dashDot:member'
- package: ExcelScript!
- summary: ''
- - name: dashDotDot
- uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.dashDotDot:member'
- package: ExcelScript!
- summary: ''
- - name: longDash
- uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.longDash:member'
- package: ExcelScript!
- summary: ''
- - name: longDashDot
- uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.longDashDot:member'
- package: ExcelScript!
- summary: ''
- - name: longDashDotDot
- uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.longDashDotDot:member'
- package: ExcelScript!
- summary: ''
- - name: roundDot
- uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.roundDot:member'
- package: ExcelScript!
- summary: ''
- - name: solid
- uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.solid:member'
- package: ExcelScript!
- summary: ''
- - name: squareDot
- uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.squareDot:member'
- package: ExcelScript!
- summary: ''
- - name: systemDash
- uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.systemDash:member'
- package: ExcelScript!
- summary: ''
- - name: systemDashDot
- uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.systemDashDot:member'
- package: ExcelScript!
- summary: ''
- - name: systemDot
- uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.systemDot:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ShapeLineDashStyle
+uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle:enum'
+package: ExcelScript!
+fullName: ExcelScript.ShapeLineDashStyle
+summary: The dash style for a line.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: dash
+ uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.dash:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dashDot
+ uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.dashDot:member'
+ package: ExcelScript!
+ summary: ''
+ - name: dashDotDot
+ uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.dashDotDot:member'
+ package: ExcelScript!
+ summary: ''
+ - name: longDash
+ uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.longDash:member'
+ package: ExcelScript!
+ summary: ''
+ - name: longDashDot
+ uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.longDashDot:member'
+ package: ExcelScript!
+ summary: ''
+ - name: longDashDotDot
+ uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.longDashDotDot:member'
+ package: ExcelScript!
+ summary: ''
+ - name: roundDot
+ uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.roundDot:member'
+ package: ExcelScript!
+ summary: ''
+ - name: solid
+ uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.solid:member'
+ package: ExcelScript!
+ summary: ''
+ - name: squareDot
+ uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.squareDot:member'
+ package: ExcelScript!
+ summary: ''
+ - name: systemDash
+ uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.systemDash:member'
+ package: ExcelScript!
+ summary: ''
+ - name: systemDashDot
+ uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.systemDashDot:member'
+ package: ExcelScript!
+ summary: ''
+ - name: systemDot
+ uid: 'ExcelScript!ExcelScript.ShapeLineDashStyle.systemDot:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapelineformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapelineformat.yml
index 11066bc7..41a873d6 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapelineformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapelineformat.yml
@@ -1,217 +1,217 @@
-### YamlMime:TSType
-name: ExcelScript.ShapeLineFormat
-uid: 'ExcelScript!ExcelScript.ShapeLineFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.ShapeLineFormat
-summary: >-
- Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the
- border of the shape.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getColor()
- uid: 'ExcelScript!ExcelScript.ShapeLineFormat#getColor:member(1)'
- package: ExcelScript!
- fullName: getColor()
- summary: >-
- Represents the line color in HTML color format, in the form \#RRGGBB (e.g., "FFA500") or as a named HTML color
- (e.g., "orange").
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColor(): string;'
- return:
- type: string
- description: ''
- - name: getDashStyle()
- uid: 'ExcelScript!ExcelScript.ShapeLineFormat#getDashStyle:member(1)'
- package: ExcelScript!
- fullName: getDashStyle()
- summary: >-
- Represents the line style of the shape. Returns `null` when the line is not visible or there are inconsistent dash
- styles. See `ExcelScript.ShapeLineDashStyle` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDashStyle(): ShapeLineDashStyle;'
- return:
- type: ''
- description: ''
- - name: getStyle()
- uid: 'ExcelScript!ExcelScript.ShapeLineFormat#getStyle:member(1)'
- package: ExcelScript!
- fullName: getStyle()
- summary: >-
- Represents the line style of the shape. Returns `null` when the line is not visible or there are inconsistent
- styles. See `ExcelScript.ShapeLineStyle` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getStyle(): ShapeLineStyle;'
- return:
- type: ''
- description: ''
- - name: getTransparency()
- uid: 'ExcelScript!ExcelScript.ShapeLineFormat#getTransparency:member(1)'
- package: ExcelScript!
- fullName: getTransparency()
- summary: >-
- Represents the degree of transparency of the specified line as a value from 0.0 (opaque) through 1.0 (clear).
- Returns `null` when the shape has inconsistent transparencies.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTransparency(): number;'
- return:
- type: number
- description: ''
- - name: getVisible()
- uid: 'ExcelScript!ExcelScript.ShapeLineFormat#getVisible:member(1)'
- package: ExcelScript!
- fullName: getVisible()
- summary: >-
- Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent
- visibilities.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVisible(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getWeight()
- uid: 'ExcelScript!ExcelScript.ShapeLineFormat#getWeight:member(1)'
- package: ExcelScript!
- fullName: getWeight()
- summary: >-
- Represents the weight of the line, in points. Returns `null` when the line is not visible or there are
- inconsistent line weights.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWeight(): number;'
- return:
- type: number
- description: ''
- - name: setColor(color)
- uid: 'ExcelScript!ExcelScript.ShapeLineFormat#setColor:member(1)'
- package: ExcelScript!
- fullName: setColor(color)
- summary: >-
- Represents the line color in HTML color format, in the form \#RRGGBB (e.g., "FFA500") or as a named HTML color
- (e.g., "orange").
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setColor(color: string): void;'
- parameters:
- - id: color
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setDashStyle(dashStyle)
- uid: 'ExcelScript!ExcelScript.ShapeLineFormat#setDashStyle:member(1)'
- package: ExcelScript!
- fullName: setDashStyle(dashStyle)
- summary: >-
- Represents the line style of the shape. Returns `null` when the line is not visible or there are inconsistent dash
- styles. See `ExcelScript.ShapeLineDashStyle` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setDashStyle(dashStyle: ShapeLineDashStyle): void;'
- parameters:
- - id: dashStyle
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setStyle(style)
- uid: 'ExcelScript!ExcelScript.ShapeLineFormat#setStyle:member(1)'
- package: ExcelScript!
- fullName: setStyle(style)
- summary: >-
- Represents the line style of the shape. Returns `null` when the line is not visible or there are inconsistent
- styles. See `ExcelScript.ShapeLineStyle` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setStyle(style: ShapeLineStyle): void;'
- parameters:
- - id: style
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setTransparency(transparency)
- uid: 'ExcelScript!ExcelScript.ShapeLineFormat#setTransparency:member(1)'
- package: ExcelScript!
- fullName: setTransparency(transparency)
- summary: >-
- Represents the degree of transparency of the specified line as a value from 0.0 (opaque) through 1.0 (clear).
- Returns `null` when the shape has inconsistent transparencies.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTransparency(transparency: number): void;'
- parameters:
- - id: transparency
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setVisible(visible)
- uid: 'ExcelScript!ExcelScript.ShapeLineFormat#setVisible:member(1)'
- package: ExcelScript!
- fullName: setVisible(visible)
- summary: >-
- Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent
- visibilities.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setVisible(visible: boolean): void;'
- parameters:
- - id: visible
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setWeight(weight)
- uid: 'ExcelScript!ExcelScript.ShapeLineFormat#setWeight:member(1)'
- package: ExcelScript!
- fullName: setWeight(weight)
- summary: >-
- Represents the weight of the line, in points. Returns `null` when the line is not visible or there are
- inconsistent line weights.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setWeight(weight: number): void;'
- parameters:
- - id: weight
- description: ''
- type: number
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.ShapeLineFormat
+uid: 'ExcelScript!ExcelScript.ShapeLineFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.ShapeLineFormat
+summary: >-
+ Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the
+ border of the shape.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getColor()
+ uid: 'ExcelScript!ExcelScript.ShapeLineFormat#getColor:member(1)'
+ package: ExcelScript!
+ fullName: getColor()
+ summary: >-
+ Represents the line color in HTML color format, in the form \#RRGGBB (e.g., "FFA500") or as a named HTML color
+ (e.g., "orange").
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getDashStyle()
+ uid: 'ExcelScript!ExcelScript.ShapeLineFormat#getDashStyle:member(1)'
+ package: ExcelScript!
+ fullName: getDashStyle()
+ summary: >-
+ Represents the line style of the shape. Returns `null` when the line is not visible or there are inconsistent dash
+ styles. See `ExcelScript.ShapeLineDashStyle` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDashStyle(): ShapeLineDashStyle;'
+ return:
+ type: ''
+ description: ''
+ - name: getStyle()
+ uid: 'ExcelScript!ExcelScript.ShapeLineFormat#getStyle:member(1)'
+ package: ExcelScript!
+ fullName: getStyle()
+ summary: >-
+ Represents the line style of the shape. Returns `null` when the line is not visible or there are inconsistent
+ styles. See `ExcelScript.ShapeLineStyle` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getStyle(): ShapeLineStyle;'
+ return:
+ type: ''
+ description: ''
+ - name: getTransparency()
+ uid: 'ExcelScript!ExcelScript.ShapeLineFormat#getTransparency:member(1)'
+ package: ExcelScript!
+ fullName: getTransparency()
+ summary: >-
+ Represents the degree of transparency of the specified line as a value from 0.0 (opaque) through 1.0 (clear).
+ Returns `null` when the shape has inconsistent transparencies.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTransparency(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getVisible()
+ uid: 'ExcelScript!ExcelScript.ShapeLineFormat#getVisible:member(1)'
+ package: ExcelScript!
+ fullName: getVisible()
+ summary: >-
+ Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent
+ visibilities.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVisible(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getWeight()
+ uid: 'ExcelScript!ExcelScript.ShapeLineFormat#getWeight:member(1)'
+ package: ExcelScript!
+ fullName: getWeight()
+ summary: >-
+ Represents the weight of the line, in points. Returns `null` when the line is not visible or there are
+ inconsistent line weights.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWeight(): number;'
+ return:
+ type: number
+ description: ''
+ - name: setColor(color)
+ uid: 'ExcelScript!ExcelScript.ShapeLineFormat#setColor:member(1)'
+ package: ExcelScript!
+ fullName: setColor(color)
+ summary: >-
+ Represents the line color in HTML color format, in the form \#RRGGBB (e.g., "FFA500") or as a named HTML color
+ (e.g., "orange").
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setColor(color: string): void;'
+ parameters:
+ - id: color
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setDashStyle(dashStyle)
+ uid: 'ExcelScript!ExcelScript.ShapeLineFormat#setDashStyle:member(1)'
+ package: ExcelScript!
+ fullName: setDashStyle(dashStyle)
+ summary: >-
+ Represents the line style of the shape. Returns `null` when the line is not visible or there are inconsistent dash
+ styles. See `ExcelScript.ShapeLineDashStyle` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setDashStyle(dashStyle: ShapeLineDashStyle): void;'
+ parameters:
+ - id: dashStyle
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setStyle(style)
+ uid: 'ExcelScript!ExcelScript.ShapeLineFormat#setStyle:member(1)'
+ package: ExcelScript!
+ fullName: setStyle(style)
+ summary: >-
+ Represents the line style of the shape. Returns `null` when the line is not visible or there are inconsistent
+ styles. See `ExcelScript.ShapeLineStyle` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setStyle(style: ShapeLineStyle): void;'
+ parameters:
+ - id: style
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setTransparency(transparency)
+ uid: 'ExcelScript!ExcelScript.ShapeLineFormat#setTransparency:member(1)'
+ package: ExcelScript!
+ fullName: setTransparency(transparency)
+ summary: >-
+ Represents the degree of transparency of the specified line as a value from 0.0 (opaque) through 1.0 (clear).
+ Returns `null` when the shape has inconsistent transparencies.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTransparency(transparency: number): void;'
+ parameters:
+ - id: transparency
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setVisible(visible)
+ uid: 'ExcelScript!ExcelScript.ShapeLineFormat#setVisible:member(1)'
+ package: ExcelScript!
+ fullName: setVisible(visible)
+ summary: >-
+ Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent
+ visibilities.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setVisible(visible: boolean): void;'
+ parameters:
+ - id: visible
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setWeight(weight)
+ uid: 'ExcelScript!ExcelScript.ShapeLineFormat#setWeight:member(1)'
+ package: ExcelScript!
+ fullName: setWeight(weight)
+ summary: >-
+ Represents the weight of the line, in points. Returns `null` when the line is not visible or there are
+ inconsistent line weights.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setWeight(weight: number): void;'
+ parameters:
+ - id: weight
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapelinestyle.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapelinestyle.yml
index d0b96856..e780fc3e 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapelinestyle.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapelinestyle.yml
@@ -1,34 +1,34 @@
-### YamlMime:TSEnum
-name: ExcelScript.ShapeLineStyle
-uid: 'ExcelScript!ExcelScript.ShapeLineStyle:enum'
-package: ExcelScript!
-fullName: ExcelScript.ShapeLineStyle
-summary: The style for a line.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: single
- uid: 'ExcelScript!ExcelScript.ShapeLineStyle.single:member'
- package: ExcelScript!
- summary: Single line.
- - name: thickBetweenThin
- uid: 'ExcelScript!ExcelScript.ShapeLineStyle.thickBetweenThin:member'
- package: ExcelScript!
- summary: Thick line with a thin line on each side.
- - name: thickThin
- uid: 'ExcelScript!ExcelScript.ShapeLineStyle.thickThin:member'
- package: ExcelScript!
- summary: >-
- Thick line next to thin line. For horizontal lines, the thick line is above the thin line. For vertical lines, the
- thick line is to the left of the thin line.
- - name: thinThick
- uid: 'ExcelScript!ExcelScript.ShapeLineStyle.thinThick:member'
- package: ExcelScript!
- summary: >-
- Thick line next to thin line. For horizontal lines, the thick line is below the thin line. For vertical lines, the
- thick line is to the right of the thin line.
- - name: thinThin
- uid: 'ExcelScript!ExcelScript.ShapeLineStyle.thinThin:member'
- package: ExcelScript!
- summary: Two thin lines.
+### YamlMime:TSEnum
+name: ExcelScript.ShapeLineStyle
+uid: 'ExcelScript!ExcelScript.ShapeLineStyle:enum'
+package: ExcelScript!
+fullName: ExcelScript.ShapeLineStyle
+summary: The style for a line.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: single
+ uid: 'ExcelScript!ExcelScript.ShapeLineStyle.single:member'
+ package: ExcelScript!
+ summary: Single line.
+ - name: thickBetweenThin
+ uid: 'ExcelScript!ExcelScript.ShapeLineStyle.thickBetweenThin:member'
+ package: ExcelScript!
+ summary: Thick line with a thin line on each side.
+ - name: thickThin
+ uid: 'ExcelScript!ExcelScript.ShapeLineStyle.thickThin:member'
+ package: ExcelScript!
+ summary: >-
+ Thick line next to thin line. For horizontal lines, the thick line is above the thin line. For vertical lines, the
+ thick line is to the left of the thin line.
+ - name: thinThick
+ uid: 'ExcelScript!ExcelScript.ShapeLineStyle.thinThick:member'
+ package: ExcelScript!
+ summary: >-
+ Thick line next to thin line. For horizontal lines, the thick line is below the thin line. For vertical lines, the
+ thick line is to the right of the thin line.
+ - name: thinThin
+ uid: 'ExcelScript!ExcelScript.ShapeLineStyle.thinThin:member'
+ package: ExcelScript!
+ summary: Two thin lines.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapescalefrom.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapescalefrom.yml
index d5aed6d0..9f03487e 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapescalefrom.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapescalefrom.yml
@@ -1,22 +1,22 @@
-### YamlMime:TSEnum
-name: ExcelScript.ShapeScaleFrom
-uid: 'ExcelScript!ExcelScript.ShapeScaleFrom:enum'
-package: ExcelScript!
-fullName: ExcelScript.ShapeScaleFrom
-summary: Specifies which part of the shape retains its position when the shape is scaled.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: scaleFromBottomRight
- uid: 'ExcelScript!ExcelScript.ShapeScaleFrom.scaleFromBottomRight:member'
- package: ExcelScript!
- summary: ''
- - name: scaleFromMiddle
- uid: 'ExcelScript!ExcelScript.ShapeScaleFrom.scaleFromMiddle:member'
- package: ExcelScript!
- summary: ''
- - name: scaleFromTopLeft
- uid: 'ExcelScript!ExcelScript.ShapeScaleFrom.scaleFromTopLeft:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ShapeScaleFrom
+uid: 'ExcelScript!ExcelScript.ShapeScaleFrom:enum'
+package: ExcelScript!
+fullName: ExcelScript.ShapeScaleFrom
+summary: Specifies which part of the shape retains its position when the shape is scaled.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: scaleFromBottomRight
+ uid: 'ExcelScript!ExcelScript.ShapeScaleFrom.scaleFromBottomRight:member'
+ package: ExcelScript!
+ summary: ''
+ - name: scaleFromMiddle
+ uid: 'ExcelScript!ExcelScript.ShapeScaleFrom.scaleFromMiddle:member'
+ package: ExcelScript!
+ summary: ''
+ - name: scaleFromTopLeft
+ uid: 'ExcelScript!ExcelScript.ShapeScaleFrom.scaleFromTopLeft:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapescaletype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapescaletype.yml
index dd547e5e..f91dee44 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapescaletype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapescaletype.yml
@@ -1,18 +1,18 @@
-### YamlMime:TSEnum
-name: ExcelScript.ShapeScaleType
-uid: 'ExcelScript!ExcelScript.ShapeScaleType:enum'
-package: ExcelScript!
-fullName: ExcelScript.ShapeScaleType
-summary: Specifies whether the shape is scaled relative to its original or current size.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: currentSize
- uid: 'ExcelScript!ExcelScript.ShapeScaleType.currentSize:member'
- package: ExcelScript!
- summary: ''
- - name: originalSize
- uid: 'ExcelScript!ExcelScript.ShapeScaleType.originalSize:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ShapeScaleType
+uid: 'ExcelScript!ExcelScript.ShapeScaleType:enum'
+package: ExcelScript!
+fullName: ExcelScript.ShapeScaleType
+summary: Specifies whether the shape is scaled relative to its original or current size.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: currentSize
+ uid: 'ExcelScript!ExcelScript.ShapeScaleType.currentSize:member'
+ package: ExcelScript!
+ summary: ''
+ - name: originalSize
+ uid: 'ExcelScript!ExcelScript.ShapeScaleType.originalSize:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetexthorizontalalignment.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetexthorizontalalignment.yml
index 928c5448..9e7ebe2d 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetexthorizontalalignment.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetexthorizontalalignment.yml
@@ -1,38 +1,38 @@
-### YamlMime:TSEnum
-name: ExcelScript.ShapeTextHorizontalAlignment
-uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment:enum'
-package: ExcelScript!
-fullName: ExcelScript.ShapeTextHorizontalAlignment
-summary: Specifies the horizontal alignment for the text frame in a shape.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: center
- uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment.center:member'
- package: ExcelScript!
- summary: ''
- - name: distributed
- uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment.distributed:member'
- package: ExcelScript!
- summary: ''
- - name: justify
- uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment.justify:member'
- package: ExcelScript!
- summary: ''
- - name: justifyLow
- uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment.justifyLow:member'
- package: ExcelScript!
- summary: ''
- - name: left
- uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment.left:member'
- package: ExcelScript!
- summary: ''
- - name: right
- uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment.right:member'
- package: ExcelScript!
- summary: ''
- - name: thaiDistributed
- uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment.thaiDistributed:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ShapeTextHorizontalAlignment
+uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment:enum'
+package: ExcelScript!
+fullName: ExcelScript.ShapeTextHorizontalAlignment
+summary: Specifies the horizontal alignment for the text frame in a shape.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: center
+ uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment.center:member'
+ package: ExcelScript!
+ summary: ''
+ - name: distributed
+ uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment.distributed:member'
+ package: ExcelScript!
+ summary: ''
+ - name: justify
+ uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment.justify:member'
+ package: ExcelScript!
+ summary: ''
+ - name: justifyLow
+ uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment.justifyLow:member'
+ package: ExcelScript!
+ summary: ''
+ - name: left
+ uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment.left:member'
+ package: ExcelScript!
+ summary: ''
+ - name: right
+ uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment.right:member'
+ package: ExcelScript!
+ summary: ''
+ - name: thaiDistributed
+ uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalAlignment.thaiDistributed:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetexthorizontaloverflow.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetexthorizontaloverflow.yml
index 61d34b4a..b606d57f 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetexthorizontaloverflow.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetexthorizontaloverflow.yml
@@ -1,18 +1,18 @@
-### YamlMime:TSEnum
-name: ExcelScript.ShapeTextHorizontalOverflow
-uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalOverflow:enum'
-package: ExcelScript!
-fullName: ExcelScript.ShapeTextHorizontalOverflow
-summary: Specifies the horizontal overflow for the text frame in a shape.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: clip
- uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalOverflow.clip:member'
- package: ExcelScript!
- summary: ''
- - name: overflow
- uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalOverflow.overflow:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ShapeTextHorizontalOverflow
+uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalOverflow:enum'
+package: ExcelScript!
+fullName: ExcelScript.ShapeTextHorizontalOverflow
+summary: Specifies the horizontal overflow for the text frame in a shape.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: clip
+ uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalOverflow.clip:member'
+ package: ExcelScript!
+ summary: ''
+ - name: overflow
+ uid: 'ExcelScript!ExcelScript.ShapeTextHorizontalOverflow.overflow:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetextorientation.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetextorientation.yml
index e7a9df09..a702fa0f 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetextorientation.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetextorientation.yml
@@ -1,38 +1,38 @@
-### YamlMime:TSEnum
-name: ExcelScript.ShapeTextOrientation
-uid: 'ExcelScript!ExcelScript.ShapeTextOrientation:enum'
-package: ExcelScript!
-fullName: ExcelScript.ShapeTextOrientation
-summary: Specifies the orientation for the text frame in a shape.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: eastAsianVertical
- uid: 'ExcelScript!ExcelScript.ShapeTextOrientation.eastAsianVertical:member'
- package: ExcelScript!
- summary: ''
- - name: horizontal
- uid: 'ExcelScript!ExcelScript.ShapeTextOrientation.horizontal:member'
- package: ExcelScript!
- summary: ''
- - name: mongolianVertical
- uid: 'ExcelScript!ExcelScript.ShapeTextOrientation.mongolianVertical:member'
- package: ExcelScript!
- summary: ''
- - name: vertical
- uid: 'ExcelScript!ExcelScript.ShapeTextOrientation.vertical:member'
- package: ExcelScript!
- summary: ''
- - name: vertical270
- uid: 'ExcelScript!ExcelScript.ShapeTextOrientation.vertical270:member'
- package: ExcelScript!
- summary: ''
- - name: wordArtVertical
- uid: 'ExcelScript!ExcelScript.ShapeTextOrientation.wordArtVertical:member'
- package: ExcelScript!
- summary: ''
- - name: wordArtVerticalRTL
- uid: 'ExcelScript!ExcelScript.ShapeTextOrientation.wordArtVerticalRTL:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ShapeTextOrientation
+uid: 'ExcelScript!ExcelScript.ShapeTextOrientation:enum'
+package: ExcelScript!
+fullName: ExcelScript.ShapeTextOrientation
+summary: Specifies the orientation for the text frame in a shape.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: eastAsianVertical
+ uid: 'ExcelScript!ExcelScript.ShapeTextOrientation.eastAsianVertical:member'
+ package: ExcelScript!
+ summary: ''
+ - name: horizontal
+ uid: 'ExcelScript!ExcelScript.ShapeTextOrientation.horizontal:member'
+ package: ExcelScript!
+ summary: ''
+ - name: mongolianVertical
+ uid: 'ExcelScript!ExcelScript.ShapeTextOrientation.mongolianVertical:member'
+ package: ExcelScript!
+ summary: ''
+ - name: vertical
+ uid: 'ExcelScript!ExcelScript.ShapeTextOrientation.vertical:member'
+ package: ExcelScript!
+ summary: ''
+ - name: vertical270
+ uid: 'ExcelScript!ExcelScript.ShapeTextOrientation.vertical270:member'
+ package: ExcelScript!
+ summary: ''
+ - name: wordArtVertical
+ uid: 'ExcelScript!ExcelScript.ShapeTextOrientation.wordArtVertical:member'
+ package: ExcelScript!
+ summary: ''
+ - name: wordArtVerticalRTL
+ uid: 'ExcelScript!ExcelScript.ShapeTextOrientation.wordArtVerticalRTL:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetextreadingorder.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetextreadingorder.yml
index da08b138..c89f8e35 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetextreadingorder.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetextreadingorder.yml
@@ -1,18 +1,18 @@
-### YamlMime:TSEnum
-name: ExcelScript.ShapeTextReadingOrder
-uid: 'ExcelScript!ExcelScript.ShapeTextReadingOrder:enum'
-package: ExcelScript!
-fullName: ExcelScript.ShapeTextReadingOrder
-summary: Specifies the reading order for the text frame in a shape.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: leftToRight
- uid: 'ExcelScript!ExcelScript.ShapeTextReadingOrder.leftToRight:member'
- package: ExcelScript!
- summary: ''
- - name: rightToLeft
- uid: 'ExcelScript!ExcelScript.ShapeTextReadingOrder.rightToLeft:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ShapeTextReadingOrder
+uid: 'ExcelScript!ExcelScript.ShapeTextReadingOrder:enum'
+package: ExcelScript!
+fullName: ExcelScript.ShapeTextReadingOrder
+summary: Specifies the reading order for the text frame in a shape.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: leftToRight
+ uid: 'ExcelScript!ExcelScript.ShapeTextReadingOrder.leftToRight:member'
+ package: ExcelScript!
+ summary: ''
+ - name: rightToLeft
+ uid: 'ExcelScript!ExcelScript.ShapeTextReadingOrder.rightToLeft:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetextverticalalignment.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetextverticalalignment.yml
index a2691e5e..2c21f1ca 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetextverticalalignment.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetextverticalalignment.yml
@@ -1,30 +1,30 @@
-### YamlMime:TSEnum
-name: ExcelScript.ShapeTextVerticalAlignment
-uid: 'ExcelScript!ExcelScript.ShapeTextVerticalAlignment:enum'
-package: ExcelScript!
-fullName: ExcelScript.ShapeTextVerticalAlignment
-summary: Specifies the vertical alignment for the text frame in a shape.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: bottom
- uid: 'ExcelScript!ExcelScript.ShapeTextVerticalAlignment.bottom:member'
- package: ExcelScript!
- summary: ''
- - name: distributed
- uid: 'ExcelScript!ExcelScript.ShapeTextVerticalAlignment.distributed:member'
- package: ExcelScript!
- summary: ''
- - name: justified
- uid: 'ExcelScript!ExcelScript.ShapeTextVerticalAlignment.justified:member'
- package: ExcelScript!
- summary: ''
- - name: middle
- uid: 'ExcelScript!ExcelScript.ShapeTextVerticalAlignment.middle:member'
- package: ExcelScript!
- summary: ''
- - name: top
- uid: 'ExcelScript!ExcelScript.ShapeTextVerticalAlignment.top:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ShapeTextVerticalAlignment
+uid: 'ExcelScript!ExcelScript.ShapeTextVerticalAlignment:enum'
+package: ExcelScript!
+fullName: ExcelScript.ShapeTextVerticalAlignment
+summary: Specifies the vertical alignment for the text frame in a shape.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: bottom
+ uid: 'ExcelScript!ExcelScript.ShapeTextVerticalAlignment.bottom:member'
+ package: ExcelScript!
+ summary: ''
+ - name: distributed
+ uid: 'ExcelScript!ExcelScript.ShapeTextVerticalAlignment.distributed:member'
+ package: ExcelScript!
+ summary: ''
+ - name: justified
+ uid: 'ExcelScript!ExcelScript.ShapeTextVerticalAlignment.justified:member'
+ package: ExcelScript!
+ summary: ''
+ - name: middle
+ uid: 'ExcelScript!ExcelScript.ShapeTextVerticalAlignment.middle:member'
+ package: ExcelScript!
+ summary: ''
+ - name: top
+ uid: 'ExcelScript!ExcelScript.ShapeTextVerticalAlignment.top:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetextverticaloverflow.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetextverticaloverflow.yml
index d1eb1206..4387bdac 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetextverticaloverflow.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetextverticaloverflow.yml
@@ -1,26 +1,26 @@
-### YamlMime:TSEnum
-name: ExcelScript.ShapeTextVerticalOverflow
-uid: 'ExcelScript!ExcelScript.ShapeTextVerticalOverflow:enum'
-package: ExcelScript!
-fullName: ExcelScript.ShapeTextVerticalOverflow
-summary: Specifies the vertical overflow for the text frame in a shape.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: clip
- uid: 'ExcelScript!ExcelScript.ShapeTextVerticalOverflow.clip:member'
- package: ExcelScript!
- summary: Hide text that does not fit vertically within the text frame.
- - name: ellipsis
- uid: 'ExcelScript!ExcelScript.ShapeTextVerticalOverflow.ellipsis:member'
- package: ExcelScript!
- summary: >-
- Hide text that does not fit vertically within the text frame, and add an ellipsis (...) at the end of the visible
- text.
- - name: overflow
- uid: 'ExcelScript!ExcelScript.ShapeTextVerticalOverflow.overflow:member'
- package: ExcelScript!
- summary: >-
- Allow text to overflow the text frame vertically (can be from the top, bottom, or both depending on the text
- alignment).
+### YamlMime:TSEnum
+name: ExcelScript.ShapeTextVerticalOverflow
+uid: 'ExcelScript!ExcelScript.ShapeTextVerticalOverflow:enum'
+package: ExcelScript!
+fullName: ExcelScript.ShapeTextVerticalOverflow
+summary: Specifies the vertical overflow for the text frame in a shape.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: clip
+ uid: 'ExcelScript!ExcelScript.ShapeTextVerticalOverflow.clip:member'
+ package: ExcelScript!
+ summary: Hide text that does not fit vertically within the text frame.
+ - name: ellipsis
+ uid: 'ExcelScript!ExcelScript.ShapeTextVerticalOverflow.ellipsis:member'
+ package: ExcelScript!
+ summary: >-
+ Hide text that does not fit vertically within the text frame, and add an ellipsis (...) at the end of the visible
+ text.
+ - name: overflow
+ uid: 'ExcelScript!ExcelScript.ShapeTextVerticalOverflow.overflow:member'
+ package: ExcelScript!
+ summary: >-
+ Allow text to overflow the text frame vertically (can be from the top, bottom, or both depending on the text
+ alignment).
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetype.yml
index b684dd0c..f995df96 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapetype.yml
@@ -1,30 +1,30 @@
-### YamlMime:TSEnum
-name: ExcelScript.ShapeType
-uid: 'ExcelScript!ExcelScript.ShapeType:enum'
-package: ExcelScript!
-fullName: ExcelScript.ShapeType
-summary: Specifies the type of a shape.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: geometricShape
- uid: 'ExcelScript!ExcelScript.ShapeType.geometricShape:member'
- package: ExcelScript!
- summary: ''
- - name: group
- uid: 'ExcelScript!ExcelScript.ShapeType.group:member'
- package: ExcelScript!
- summary: ''
- - name: image
- uid: 'ExcelScript!ExcelScript.ShapeType.image:member'
- package: ExcelScript!
- summary: ''
- - name: line
- uid: 'ExcelScript!ExcelScript.ShapeType.line:member'
- package: ExcelScript!
- summary: ''
- - name: unsupported
- uid: 'ExcelScript!ExcelScript.ShapeType.unsupported:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ShapeType
+uid: 'ExcelScript!ExcelScript.ShapeType:enum'
+package: ExcelScript!
+fullName: ExcelScript.ShapeType
+summary: Specifies the type of a shape.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: geometricShape
+ uid: 'ExcelScript!ExcelScript.ShapeType.geometricShape:member'
+ package: ExcelScript!
+ summary: ''
+ - name: group
+ uid: 'ExcelScript!ExcelScript.ShapeType.group:member'
+ package: ExcelScript!
+ summary: ''
+ - name: image
+ uid: 'ExcelScript!ExcelScript.ShapeType.image:member'
+ package: ExcelScript!
+ summary: ''
+ - name: line
+ uid: 'ExcelScript!ExcelScript.ShapeType.line:member'
+ package: ExcelScript!
+ summary: ''
+ - name: unsupported
+ uid: 'ExcelScript!ExcelScript.ShapeType.unsupported:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapezorder.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapezorder.yml
index c0b77abb..874df501 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.shapezorder.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.shapezorder.yml
@@ -1,26 +1,26 @@
-### YamlMime:TSEnum
-name: ExcelScript.ShapeZOrder
-uid: 'ExcelScript!ExcelScript.ShapeZOrder:enum'
-package: ExcelScript!
-fullName: ExcelScript.ShapeZOrder
-summary: Specifies where in the z-order a shape should be moved relative to other shapes.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: bringForward
- uid: 'ExcelScript!ExcelScript.ShapeZOrder.bringForward:member'
- package: ExcelScript!
- summary: ''
- - name: bringToFront
- uid: 'ExcelScript!ExcelScript.ShapeZOrder.bringToFront:member'
- package: ExcelScript!
- summary: ''
- - name: sendBackward
- uid: 'ExcelScript!ExcelScript.ShapeZOrder.sendBackward:member'
- package: ExcelScript!
- summary: ''
- - name: sendToBack
- uid: 'ExcelScript!ExcelScript.ShapeZOrder.sendToBack:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.ShapeZOrder
+uid: 'ExcelScript!ExcelScript.ShapeZOrder:enum'
+package: ExcelScript!
+fullName: ExcelScript.ShapeZOrder
+summary: Specifies where in the z-order a shape should be moved relative to other shapes.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: bringForward
+ uid: 'ExcelScript!ExcelScript.ShapeZOrder.bringForward:member'
+ package: ExcelScript!
+ summary: ''
+ - name: bringToFront
+ uid: 'ExcelScript!ExcelScript.ShapeZOrder.bringToFront:member'
+ package: ExcelScript!
+ summary: ''
+ - name: sendBackward
+ uid: 'ExcelScript!ExcelScript.ShapeZOrder.sendBackward:member'
+ package: ExcelScript!
+ summary: ''
+ - name: sendToBack
+ uid: 'ExcelScript!ExcelScript.ShapeZOrder.sendToBack:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.sheetvisibility.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.sheetvisibility.yml
index ee76f724..a3be02a7 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.sheetvisibility.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.sheetvisibility.yml
@@ -1,38 +1,38 @@
-### YamlMime:TSEnum
-name: ExcelScript.SheetVisibility
-uid: 'ExcelScript!ExcelScript.SheetVisibility:enum'
-package: ExcelScript!
-fullName: ExcelScript.SheetVisibility
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script unhides all the worksheets in the workbook.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Iterate over each worksheet.
- workbook.getWorksheets().forEach((worksheet) => {
- // Set the worksheet visibility to visible.
- worksheet.setVisibility(ExcelScript.SheetVisibility.visible);
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: hidden
- uid: 'ExcelScript!ExcelScript.SheetVisibility.hidden:member'
- package: ExcelScript!
- summary: ''
- - name: veryHidden
- uid: 'ExcelScript!ExcelScript.SheetVisibility.veryHidden:member'
- package: ExcelScript!
- summary: ''
- - name: visible
- uid: 'ExcelScript!ExcelScript.SheetVisibility.visible:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.SheetVisibility
+uid: 'ExcelScript!ExcelScript.SheetVisibility:enum'
+package: ExcelScript!
+fullName: ExcelScript.SheetVisibility
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script unhides all the worksheets in the workbook.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Iterate over each worksheet.
+ workbook.getWorksheets().forEach((worksheet) => {
+ // Set the worksheet visibility to visible.
+ worksheet.setVisibility(ExcelScript.SheetVisibility.visible);
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: hidden
+ uid: 'ExcelScript!ExcelScript.SheetVisibility.hidden:member'
+ package: ExcelScript!
+ summary: ''
+ - name: veryHidden
+ uid: 'ExcelScript!ExcelScript.SheetVisibility.veryHidden:member'
+ package: ExcelScript!
+ summary: ''
+ - name: visible
+ uid: 'ExcelScript!ExcelScript.SheetVisibility.visible:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.showascalculation.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.showascalculation.yml
index a6ec1f51..d92b27b8 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.showascalculation.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.showascalculation.yml
@@ -1,99 +1,99 @@
-### YamlMime:TSEnum
-name: ExcelScript.ShowAsCalculation
-uid: 'ExcelScript!ExcelScript.ShowAsCalculation:enum'
-package: ExcelScript!
-fullName: ExcelScript.ShowAsCalculation
-summary: The ShowAs calculation function for the DataPivotField.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * The script changes the display for "Crates Sold at Farm".
- * It shows the percentage of the grand total,
- * instead of the default sum.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the PivotTable named "Farm Pivot".
- const farmPivot = workbook.getPivotTable("Farm Pivot");
-
- // Get the data hierarchy "Sum of Crates Sold at Farm".
- const farmSales = farmPivot.getDataHierarchy("Sum of Crates Sold at Farm");
-
- // Show the data as a percentage of the grand total.
- farmSales.setShowAs({
- calculation: ExcelScript.ShowAsCalculation.percentOfGrandTotal
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: differenceFrom
- uid: 'ExcelScript!ExcelScript.ShowAsCalculation.differenceFrom:member'
- package: ExcelScript!
- summary: Difference from the specified Base field and Base item.
- - name: index
- uid: 'ExcelScript!ExcelScript.ShowAsCalculation.index:member'
- package: ExcelScript!
- summary: >-
- Calculates the values as follows: ((value in cell) x (Grand Total of Grand Totals)) / ((Grand Row Total) x (Grand
- Column Total))
- - name: none
- uid: 'ExcelScript!ExcelScript.ShowAsCalculation.none:member'
- package: ExcelScript!
- summary: No calculation is applied.
- - name: percentDifferenceFrom
- uid: 'ExcelScript!ExcelScript.ShowAsCalculation.percentDifferenceFrom:member'
- package: ExcelScript!
- summary: Difference from the specified Base field and Base item.
- - name: percentOf
- uid: 'ExcelScript!ExcelScript.ShowAsCalculation.percentOf:member'
- package: ExcelScript!
- summary: Percent of the specified Base field and Base item.
- - name: percentOfColumnTotal
- uid: 'ExcelScript!ExcelScript.ShowAsCalculation.percentOfColumnTotal:member'
- package: ExcelScript!
- summary: Percent of the column total.
- - name: percentOfGrandTotal
- uid: 'ExcelScript!ExcelScript.ShowAsCalculation.percentOfGrandTotal:member'
- package: ExcelScript!
- summary: Percent of the grand total.
- - name: percentOfParentColumnTotal
- uid: 'ExcelScript!ExcelScript.ShowAsCalculation.percentOfParentColumnTotal:member'
- package: ExcelScript!
- summary: Percent of the column total for the specified Base field.
- - name: percentOfParentRowTotal
- uid: 'ExcelScript!ExcelScript.ShowAsCalculation.percentOfParentRowTotal:member'
- package: ExcelScript!
- summary: Percent of the row total for the specified Base field.
- - name: percentOfParentTotal
- uid: 'ExcelScript!ExcelScript.ShowAsCalculation.percentOfParentTotal:member'
- package: ExcelScript!
- summary: Percent of the grand total for the specified Base field.
- - name: percentOfRowTotal
- uid: 'ExcelScript!ExcelScript.ShowAsCalculation.percentOfRowTotal:member'
- package: ExcelScript!
- summary: Percent of the row total.
- - name: percentRunningTotal
- uid: 'ExcelScript!ExcelScript.ShowAsCalculation.percentRunningTotal:member'
- package: ExcelScript!
- summary: Percent running total of the specified Base field.
- - name: rankAscending
- uid: 'ExcelScript!ExcelScript.ShowAsCalculation.rankAscending:member'
- package: ExcelScript!
- summary: Ascending rank of the specified Base field.
- - name: rankDecending
- uid: 'ExcelScript!ExcelScript.ShowAsCalculation.rankDecending:member'
- package: ExcelScript!
- summary: Descending rank of the specified Base field.
- - name: runningTotal
- uid: 'ExcelScript!ExcelScript.ShowAsCalculation.runningTotal:member'
- package: ExcelScript!
- summary: Running total of the specified Base field.
- - name: unknown
- uid: 'ExcelScript!ExcelScript.ShowAsCalculation.unknown:member'
- package: ExcelScript!
- summary: Calculation is unknown or unsupported.
+### YamlMime:TSEnum
+name: ExcelScript.ShowAsCalculation
+uid: 'ExcelScript!ExcelScript.ShowAsCalculation:enum'
+package: ExcelScript!
+fullName: ExcelScript.ShowAsCalculation
+summary: The ShowAs calculation function for the DataPivotField.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * The script changes the display for "Crates Sold at Farm".
+ * It shows the percentage of the grand total,
+ * instead of the default sum.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the PivotTable named "Farm Pivot".
+ const farmPivot = workbook.getPivotTable("Farm Pivot");
+
+ // Get the data hierarchy "Sum of Crates Sold at Farm".
+ const farmSales = farmPivot.getDataHierarchy("Sum of Crates Sold at Farm");
+
+ // Show the data as a percentage of the grand total.
+ farmSales.setShowAs({
+ calculation: ExcelScript.ShowAsCalculation.percentOfGrandTotal
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: differenceFrom
+ uid: 'ExcelScript!ExcelScript.ShowAsCalculation.differenceFrom:member'
+ package: ExcelScript!
+ summary: Difference from the specified Base field and Base item.
+ - name: index
+ uid: 'ExcelScript!ExcelScript.ShowAsCalculation.index:member'
+ package: ExcelScript!
+ summary: >-
+ Calculates the values as follows: ((value in cell) x (Grand Total of Grand Totals)) / ((Grand Row Total) x (Grand
+ Column Total))
+ - name: none
+ uid: 'ExcelScript!ExcelScript.ShowAsCalculation.none:member'
+ package: ExcelScript!
+ summary: No calculation is applied.
+ - name: percentDifferenceFrom
+ uid: 'ExcelScript!ExcelScript.ShowAsCalculation.percentDifferenceFrom:member'
+ package: ExcelScript!
+ summary: Difference from the specified Base field and Base item.
+ - name: percentOf
+ uid: 'ExcelScript!ExcelScript.ShowAsCalculation.percentOf:member'
+ package: ExcelScript!
+ summary: Percent of the specified Base field and Base item.
+ - name: percentOfColumnTotal
+ uid: 'ExcelScript!ExcelScript.ShowAsCalculation.percentOfColumnTotal:member'
+ package: ExcelScript!
+ summary: Percent of the column total.
+ - name: percentOfGrandTotal
+ uid: 'ExcelScript!ExcelScript.ShowAsCalculation.percentOfGrandTotal:member'
+ package: ExcelScript!
+ summary: Percent of the grand total.
+ - name: percentOfParentColumnTotal
+ uid: 'ExcelScript!ExcelScript.ShowAsCalculation.percentOfParentColumnTotal:member'
+ package: ExcelScript!
+ summary: Percent of the column total for the specified Base field.
+ - name: percentOfParentRowTotal
+ uid: 'ExcelScript!ExcelScript.ShowAsCalculation.percentOfParentRowTotal:member'
+ package: ExcelScript!
+ summary: Percent of the row total for the specified Base field.
+ - name: percentOfParentTotal
+ uid: 'ExcelScript!ExcelScript.ShowAsCalculation.percentOfParentTotal:member'
+ package: ExcelScript!
+ summary: Percent of the grand total for the specified Base field.
+ - name: percentOfRowTotal
+ uid: 'ExcelScript!ExcelScript.ShowAsCalculation.percentOfRowTotal:member'
+ package: ExcelScript!
+ summary: Percent of the row total.
+ - name: percentRunningTotal
+ uid: 'ExcelScript!ExcelScript.ShowAsCalculation.percentRunningTotal:member'
+ package: ExcelScript!
+ summary: Percent running total of the specified Base field.
+ - name: rankAscending
+ uid: 'ExcelScript!ExcelScript.ShowAsCalculation.rankAscending:member'
+ package: ExcelScript!
+ summary: Ascending rank of the specified Base field.
+ - name: rankDecending
+ uid: 'ExcelScript!ExcelScript.ShowAsCalculation.rankDecending:member'
+ package: ExcelScript!
+ summary: Descending rank of the specified Base field.
+ - name: runningTotal
+ uid: 'ExcelScript!ExcelScript.ShowAsCalculation.runningTotal:member'
+ package: ExcelScript!
+ summary: Running total of the specified Base field.
+ - name: unknown
+ uid: 'ExcelScript!ExcelScript.ShowAsCalculation.unknown:member'
+ package: ExcelScript!
+ summary: Calculation is unknown or unsupported.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.showasrule.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.showasrule.yml
index d6b69e91..c3052832 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.showasrule.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.showasrule.yml
@@ -1,85 +1,85 @@
-### YamlMime:TSType
-name: ExcelScript.ShowAsRule
-uid: 'ExcelScript!ExcelScript.ShowAsRule:interface'
-package: ExcelScript!
-fullName: ExcelScript.ShowAsRule
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * The script changes the display for "Crates Sold at Farm".
- * The field shows each value's difference
- * from the value of the "Lemon" in the same row.
- * If the row has no value for "Lemon", the field shows "#N/A".
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the PivotTable named "Farm Pivot".
- const farmPivot = workbook.getPivotTable("Farm Pivot");
-
- // Get the data hierarchy "Sum of Crates Sold at Farm".
- const farmSales = farmPivot.getDataHierarchy("Sum of Crates Sold at Farm");
-
- // Get the row hierarchy "Type".
- const typeField = farmPivot.getRowHierarchy("Type").getFields()[0];
-
- // Change the data hierarchy to show each value as the difference
- // from the value of the "Lemon" in that row.
- const rule: ExcelScript.ShowAsRule = {
- calculation: ExcelScript.ShowAsCalculation.differenceFrom,
- baseField: typeField,
- baseItem: typeField.getPivotItem("Lemon")
- }
- farmSales.setShowAs(rule);
-
- // Set the name of the field to match the new behavior.
- farmSales.setName("Difference from Lemons of Crates Sold at Farm");
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: baseField
- uid: 'ExcelScript!ExcelScript.ShowAsRule#baseField:member'
- package: ExcelScript!
- fullName: baseField
- summary: >-
- The PivotField to base the `ShowAs` calculation on, if applicable according to the `ShowAsCalculation` type, else
- `null`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'baseField?: PivotField;'
- return:
- type: ''
- - name: baseItem
- uid: 'ExcelScript!ExcelScript.ShowAsRule#baseItem:member'
- package: ExcelScript!
- fullName: baseItem
- summary: >-
- The item to base the `ShowAs` calculation on, if applicable according to the `ShowAsCalculation` type, else
- `null`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'baseItem?: PivotItem;'
- return:
- type: ''
- - name: calculation
- uid: 'ExcelScript!ExcelScript.ShowAsRule#calculation:member'
- package: ExcelScript!
- fullName: calculation
- summary: The `ShowAs` calculation to use for the PivotField. See `ExcelScript.ShowAsCalculation` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'calculation: ShowAsCalculation;'
- return:
- type: ''
+### YamlMime:TSType
+name: ExcelScript.ShowAsRule
+uid: 'ExcelScript!ExcelScript.ShowAsRule:interface'
+package: ExcelScript!
+fullName: ExcelScript.ShowAsRule
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * The script changes the display for "Crates Sold at Farm".
+ * The field shows each value's difference
+ * from the value of the "Lemon" in the same row.
+ * If the row has no value for "Lemon", the field shows "#N/A".
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the PivotTable named "Farm Pivot".
+ const farmPivot = workbook.getPivotTable("Farm Pivot");
+
+ // Get the data hierarchy "Sum of Crates Sold at Farm".
+ const farmSales = farmPivot.getDataHierarchy("Sum of Crates Sold at Farm");
+
+ // Get the row hierarchy "Type".
+ const typeField = farmPivot.getRowHierarchy("Type").getFields()[0];
+
+ // Change the data hierarchy to show each value as the difference
+ // from the value of the "Lemon" in that row.
+ const rule: ExcelScript.ShowAsRule = {
+ calculation: ExcelScript.ShowAsCalculation.differenceFrom,
+ baseField: typeField,
+ baseItem: typeField.getPivotItem("Lemon")
+ }
+ farmSales.setShowAs(rule);
+
+ // Set the name of the field to match the new behavior.
+ farmSales.setName("Difference from Lemons of Crates Sold at Farm");
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: baseField
+ uid: 'ExcelScript!ExcelScript.ShowAsRule#baseField:member'
+ package: ExcelScript!
+ fullName: baseField
+ summary: >-
+ The PivotField to base the `ShowAs` calculation on, if applicable according to the `ShowAsCalculation` type, else
+ `null`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'baseField?: PivotField;'
+ return:
+ type: ''
+ - name: baseItem
+ uid: 'ExcelScript!ExcelScript.ShowAsRule#baseItem:member'
+ package: ExcelScript!
+ fullName: baseItem
+ summary: >-
+ The item to base the `ShowAs` calculation on, if applicable according to the `ShowAsCalculation` type, else
+ `null`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'baseItem?: PivotItem;'
+ return:
+ type: ''
+ - name: calculation
+ uid: 'ExcelScript!ExcelScript.ShowAsRule#calculation:member'
+ package: ExcelScript!
+ fullName: calculation
+ summary: The `ShowAs` calculation to use for the PivotField. See `ExcelScript.ShowAsCalculation` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'calculation: ShowAsCalculation;'
+ return:
+ type: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.slicer.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.slicer.yml
index a6081266..4b11d484 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.slicer.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.slicer.yml
@@ -1,432 +1,432 @@
-### YamlMime:TSType
-name: ExcelScript.Slicer
-uid: 'ExcelScript!ExcelScript.Slicer:interface'
-package: ExcelScript!
-fullName: ExcelScript.Slicer
-summary: Represents a `Slicer` object in the workbook.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a slicer for an existing PivotTable.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the PivotTable named "Farm Pivot".
- const farmPivot = workbook.getPivotTable("Farm Pivot");
-
- // Create the slicer.
- // Note that this assumes "Type" is already added as a hierarchy to the PivotTable.
- const fruitSlicer: ExcelScript.Slicer = workbook.addSlicer(
- farmPivot, /* The table or PivotTale to be sliced. */
- farmPivot.getHierarchy("Type").getFields()[0] /* What source field to use as the slicer options. */
- );
-
- // Select the items to display.
- fruitSlicer.selectItems(["Lemon", "Lime"]);
-
- // Set the left margin of the slicer.
- fruitSlicer.setLeft(400);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: clearFilters()
- uid: 'ExcelScript!ExcelScript.Slicer#clearFilters:member(1)'
- package: ExcelScript!
- fullName: clearFilters()
- summary: Clears all the filters currently applied on the slicer.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'clearFilters(): void;'
- return:
- type: void
- description: ''
- - name: delete()
- uid: 'ExcelScript!ExcelScript.Slicer#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: Deletes the slicer.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: ''
- - name: getCaption()
- uid: 'ExcelScript!ExcelScript.Slicer#getCaption:member(1)'
- package: ExcelScript!
- fullName: getCaption()
- summary: Represents the caption of the slicer.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCaption(): string;'
- return:
- type: string
- description: ''
- - name: getHeight()
- uid: 'ExcelScript!ExcelScript.Slicer#getHeight:member(1)'
- package: ExcelScript!
- fullName: getHeight()
- summary: >-
- Represents the height, in points, of the slicer. Throws an `InvalidArgument` exception when set with a negative
- value or zero as an input.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHeight(): number;'
- return:
- type: number
- description: ''
- - name: getId()
- uid: 'ExcelScript!ExcelScript.Slicer#getId:member(1)'
- package: ExcelScript!
- fullName: getId()
- summary: Represents the unique ID of the slicer.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getId(): string;'
- return:
- type: string
- description: ''
- - name: getIsFilterCleared()
- uid: 'ExcelScript!ExcelScript.Slicer#getIsFilterCleared:member(1)'
- package: ExcelScript!
- fullName: getIsFilterCleared()
- summary: Value is `true` if all filters currently applied on the slicer are cleared.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIsFilterCleared(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getLeft()
- uid: 'ExcelScript!ExcelScript.Slicer#getLeft:member(1)'
- package: ExcelScript!
- fullName: getLeft()
- summary: >-
- Represents the distance, in points, from the left side of the slicer to the left of the worksheet. Throws an
- `InvalidArgument` error when set with a negative value as an input.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLeft(): number;'
- return:
- type: number
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.Slicer#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: Represents the name of the slicer.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: getSelectedItems()
- uid: 'ExcelScript!ExcelScript.Slicer#getSelectedItems:member(1)'
- package: ExcelScript!
- fullName: getSelectedItems()
- summary: Returns an array of selected items' keys.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSelectedItems(): string[];'
- return:
- type: 'string[]'
- description: ''
- - name: getSlicerItem(key)
- uid: 'ExcelScript!ExcelScript.Slicer#getSlicerItem:member(1)'
- package: ExcelScript!
- fullName: getSlicerItem(key)
- summary: >-
- Gets a slicer item using its key or name. If the slicer item doesn't exist, then this method returns
- `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSlicerItem(key: string): SlicerItem | undefined;'
- parameters:
- - id: key
- description: Key or name of the slicer to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getSlicerItems()
- uid: 'ExcelScript!ExcelScript.Slicer#getSlicerItems:member(1)'
- package: ExcelScript!
- fullName: getSlicerItems()
- summary: Represents the collection of slicer items that are part of the slicer.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSlicerItems(): SlicerItem[];'
- return:
- type: '[]'
- description: ''
- - name: getSortBy()
- uid: 'ExcelScript!ExcelScript.Slicer#getSortBy:member(1)'
- package: ExcelScript!
- fullName: getSortBy()
- summary: >-
- Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending",
- "Descending".
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSortBy(): SlicerSortType;'
- return:
- type: ''
- description: ''
- - name: getStyle()
- uid: 'ExcelScript!ExcelScript.Slicer#getStyle:member(1)'
- package: ExcelScript!
- fullName: getStyle()
- summary: >-
- Constant value that represents the slicer style. Possible values are: "SlicerStyleLight1" through
- "SlicerStyleLight6", "TableStyleOther1" through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6".
- A custom user-defined style present in the workbook can also be specified.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getStyle(): string;'
- return:
- type: string
- description: ''
- - name: getTop()
- uid: 'ExcelScript!ExcelScript.Slicer#getTop:member(1)'
- package: ExcelScript!
- fullName: getTop()
- summary: >-
- Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. Throws an
- `InvalidArgument` error when set with a negative value as an input.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTop(): number;'
- return:
- type: number
- description: ''
- - name: getWidth()
- uid: 'ExcelScript!ExcelScript.Slicer#getWidth:member(1)'
- package: ExcelScript!
- fullName: getWidth()
- summary: >-
- Represents the width, in points, of the slicer. Throws an `InvalidArgument` error when set with a negative value
- or zero as an input.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWidth(): number;'
- return:
- type: number
- description: ''
- - name: getWorksheet()
- uid: 'ExcelScript!ExcelScript.Slicer#getWorksheet:member(1)'
- package: ExcelScript!
- fullName: getWorksheet()
- summary: Represents the worksheet containing the slicer.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWorksheet(): Worksheet;'
- return:
- type: ''
- description: ''
- - name: selectItems(items)
- uid: 'ExcelScript!ExcelScript.Slicer#selectItems:member(1)'
- package: ExcelScript!
- fullName: selectItems(items)
- summary: >-
- Selects slicer items based on their keys. The previous selections are cleared. All items will be selected by
- default if the array is empty.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'selectItems(items?: string[]): void;'
- parameters:
- - id: items
- description: Optional. The specified slicer item names to be selected.
- type: 'string[]'
- return:
- type: void
- description: ''
- - name: setCaption(caption)
- uid: 'ExcelScript!ExcelScript.Slicer#setCaption:member(1)'
- package: ExcelScript!
- fullName: setCaption(caption)
- summary: Represents the caption of the slicer.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setCaption(caption: string): void;'
- parameters:
- - id: caption
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setHeight(height)
- uid: 'ExcelScript!ExcelScript.Slicer#setHeight:member(1)'
- package: ExcelScript!
- fullName: setHeight(height)
- summary: >-
- Represents the height, in points, of the slicer. Throws an `InvalidArgument` exception when set with a negative
- value or zero as an input.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setHeight(height: number): void;'
- parameters:
- - id: height
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setLeft(left)
- uid: 'ExcelScript!ExcelScript.Slicer#setLeft:member(1)'
- package: ExcelScript!
- fullName: setLeft(left)
- summary: >-
- Represents the distance, in points, from the left side of the slicer to the left of the worksheet. Throws an
- `InvalidArgument` error when set with a negative value as an input.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLeft(left: number): void;'
- parameters:
- - id: left
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setName(name)
- uid: 'ExcelScript!ExcelScript.Slicer#setName:member(1)'
- package: ExcelScript!
- fullName: setName(name)
- summary: Represents the name of the slicer.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setName(name: string): void;'
- parameters:
- - id: name
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setSortBy(sortBy)
- uid: 'ExcelScript!ExcelScript.Slicer#setSortBy:member(1)'
- package: ExcelScript!
- fullName: setSortBy(sortBy)
- summary: >-
- Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending",
- "Descending".
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setSortBy(sortBy: SlicerSortType): void;'
- parameters:
- - id: sortBy
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setStyle(style)
- uid: 'ExcelScript!ExcelScript.Slicer#setStyle:member(1)'
- package: ExcelScript!
- fullName: setStyle(style)
- summary: >-
- Constant value that represents the slicer style. Possible values are: "SlicerStyleLight1" through
- "SlicerStyleLight6", "TableStyleOther1" through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6".
- A custom user-defined style present in the workbook can also be specified.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setStyle(style: string): void;'
- parameters:
- - id: style
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setTop(top)
- uid: 'ExcelScript!ExcelScript.Slicer#setTop:member(1)'
- package: ExcelScript!
- fullName: setTop(top)
- summary: >-
- Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. Throws an
- `InvalidArgument` error when set with a negative value as an input.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTop(top: number): void;'
- parameters:
- - id: top
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setWidth(width)
- uid: 'ExcelScript!ExcelScript.Slicer#setWidth:member(1)'
- package: ExcelScript!
- fullName: setWidth(width)
- summary: >-
- Represents the width, in points, of the slicer. Throws an `InvalidArgument` error when set with a negative value
- or zero as an input.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setWidth(width: number): void;'
- parameters:
- - id: width
- description: ''
- type: number
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.Slicer
+uid: 'ExcelScript!ExcelScript.Slicer:interface'
+package: ExcelScript!
+fullName: ExcelScript.Slicer
+summary: Represents a `Slicer` object in the workbook.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a slicer for an existing PivotTable.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the PivotTable named "Farm Pivot".
+ const farmPivot = workbook.getPivotTable("Farm Pivot");
+
+ // Create the slicer.
+ // Note that this assumes "Type" is already added as a hierarchy to the PivotTable.
+ const fruitSlicer: ExcelScript.Slicer = workbook.addSlicer(
+ farmPivot, /* The table or PivotTale to be sliced. */
+ farmPivot.getHierarchy("Type").getFields()[0] /* What source field to use as the slicer options. */
+ );
+
+ // Select the items to display.
+ fruitSlicer.selectItems(["Lemon", "Lime"]);
+
+ // Set the left margin of the slicer.
+ fruitSlicer.setLeft(400);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: clearFilters()
+ uid: 'ExcelScript!ExcelScript.Slicer#clearFilters:member(1)'
+ package: ExcelScript!
+ fullName: clearFilters()
+ summary: Clears all the filters currently applied on the slicer.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clearFilters(): void;'
+ return:
+ type: void
+ description: ''
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.Slicer#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: Deletes the slicer.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getCaption()
+ uid: 'ExcelScript!ExcelScript.Slicer#getCaption:member(1)'
+ package: ExcelScript!
+ fullName: getCaption()
+ summary: Represents the caption of the slicer.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCaption(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getHeight()
+ uid: 'ExcelScript!ExcelScript.Slicer#getHeight:member(1)'
+ package: ExcelScript!
+ fullName: getHeight()
+ summary: >-
+ Represents the height, in points, of the slicer. Throws an `InvalidArgument` exception when set with a negative
+ value or zero as an input.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHeight(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getId()
+ uid: 'ExcelScript!ExcelScript.Slicer#getId:member(1)'
+ package: ExcelScript!
+ fullName: getId()
+ summary: Represents the unique ID of the slicer.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getId(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getIsFilterCleared()
+ uid: 'ExcelScript!ExcelScript.Slicer#getIsFilterCleared:member(1)'
+ package: ExcelScript!
+ fullName: getIsFilterCleared()
+ summary: Value is `true` if all filters currently applied on the slicer are cleared.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIsFilterCleared(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getLeft()
+ uid: 'ExcelScript!ExcelScript.Slicer#getLeft:member(1)'
+ package: ExcelScript!
+ fullName: getLeft()
+ summary: >-
+ Represents the distance, in points, from the left side of the slicer to the left of the worksheet. Throws an
+ `InvalidArgument` error when set with a negative value as an input.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLeft(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.Slicer#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: Represents the name of the slicer.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getSelectedItems()
+ uid: 'ExcelScript!ExcelScript.Slicer#getSelectedItems:member(1)'
+ package: ExcelScript!
+ fullName: getSelectedItems()
+ summary: Returns an array of selected items' keys.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSelectedItems(): string[];'
+ return:
+ type: 'string[]'
+ description: ''
+ - name: getSlicerItem(key)
+ uid: 'ExcelScript!ExcelScript.Slicer#getSlicerItem:member(1)'
+ package: ExcelScript!
+ fullName: getSlicerItem(key)
+ summary: >-
+ Gets a slicer item using its key or name. If the slicer item doesn't exist, then this method returns
+ `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSlicerItem(key: string): SlicerItem | undefined;'
+ parameters:
+ - id: key
+ description: Key or name of the slicer to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getSlicerItems()
+ uid: 'ExcelScript!ExcelScript.Slicer#getSlicerItems:member(1)'
+ package: ExcelScript!
+ fullName: getSlicerItems()
+ summary: Represents the collection of slicer items that are part of the slicer.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSlicerItems(): SlicerItem[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getSortBy()
+ uid: 'ExcelScript!ExcelScript.Slicer#getSortBy:member(1)'
+ package: ExcelScript!
+ fullName: getSortBy()
+ summary: >-
+ Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending",
+ "Descending".
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSortBy(): SlicerSortType;'
+ return:
+ type: ''
+ description: ''
+ - name: getStyle()
+ uid: 'ExcelScript!ExcelScript.Slicer#getStyle:member(1)'
+ package: ExcelScript!
+ fullName: getStyle()
+ summary: >-
+ Constant value that represents the slicer style. Possible values are: "SlicerStyleLight1" through
+ "SlicerStyleLight6", "TableStyleOther1" through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6".
+ A custom user-defined style present in the workbook can also be specified.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getStyle(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getTop()
+ uid: 'ExcelScript!ExcelScript.Slicer#getTop:member(1)'
+ package: ExcelScript!
+ fullName: getTop()
+ summary: >-
+ Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. Throws an
+ `InvalidArgument` error when set with a negative value as an input.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTop(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getWidth()
+ uid: 'ExcelScript!ExcelScript.Slicer#getWidth:member(1)'
+ package: ExcelScript!
+ fullName: getWidth()
+ summary: >-
+ Represents the width, in points, of the slicer. Throws an `InvalidArgument` error when set with a negative value
+ or zero as an input.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWidth(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getWorksheet()
+ uid: 'ExcelScript!ExcelScript.Slicer#getWorksheet:member(1)'
+ package: ExcelScript!
+ fullName: getWorksheet()
+ summary: Represents the worksheet containing the slicer.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWorksheet(): Worksheet;'
+ return:
+ type: ''
+ description: ''
+ - name: selectItems(items)
+ uid: 'ExcelScript!ExcelScript.Slicer#selectItems:member(1)'
+ package: ExcelScript!
+ fullName: selectItems(items)
+ summary: >-
+ Selects slicer items based on their keys. The previous selections are cleared. All items will be selected by
+ default if the array is empty.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'selectItems(items?: string[]): void;'
+ parameters:
+ - id: items
+ description: Optional. The specified slicer item names to be selected.
+ type: 'string[]'
+ return:
+ type: void
+ description: ''
+ - name: setCaption(caption)
+ uid: 'ExcelScript!ExcelScript.Slicer#setCaption:member(1)'
+ package: ExcelScript!
+ fullName: setCaption(caption)
+ summary: Represents the caption of the slicer.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setCaption(caption: string): void;'
+ parameters:
+ - id: caption
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setHeight(height)
+ uid: 'ExcelScript!ExcelScript.Slicer#setHeight:member(1)'
+ package: ExcelScript!
+ fullName: setHeight(height)
+ summary: >-
+ Represents the height, in points, of the slicer. Throws an `InvalidArgument` exception when set with a negative
+ value or zero as an input.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setHeight(height: number): void;'
+ parameters:
+ - id: height
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setLeft(left)
+ uid: 'ExcelScript!ExcelScript.Slicer#setLeft:member(1)'
+ package: ExcelScript!
+ fullName: setLeft(left)
+ summary: >-
+ Represents the distance, in points, from the left side of the slicer to the left of the worksheet. Throws an
+ `InvalidArgument` error when set with a negative value as an input.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLeft(left: number): void;'
+ parameters:
+ - id: left
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setName(name)
+ uid: 'ExcelScript!ExcelScript.Slicer#setName:member(1)'
+ package: ExcelScript!
+ fullName: setName(name)
+ summary: Represents the name of the slicer.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setName(name: string): void;'
+ parameters:
+ - id: name
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setSortBy(sortBy)
+ uid: 'ExcelScript!ExcelScript.Slicer#setSortBy:member(1)'
+ package: ExcelScript!
+ fullName: setSortBy(sortBy)
+ summary: >-
+ Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending",
+ "Descending".
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSortBy(sortBy: SlicerSortType): void;'
+ parameters:
+ - id: sortBy
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setStyle(style)
+ uid: 'ExcelScript!ExcelScript.Slicer#setStyle:member(1)'
+ package: ExcelScript!
+ fullName: setStyle(style)
+ summary: >-
+ Constant value that represents the slicer style. Possible values are: "SlicerStyleLight1" through
+ "SlicerStyleLight6", "TableStyleOther1" through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6".
+ A custom user-defined style present in the workbook can also be specified.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setStyle(style: string): void;'
+ parameters:
+ - id: style
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setTop(top)
+ uid: 'ExcelScript!ExcelScript.Slicer#setTop:member(1)'
+ package: ExcelScript!
+ fullName: setTop(top)
+ summary: >-
+ Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. Throws an
+ `InvalidArgument` error when set with a negative value as an input.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTop(top: number): void;'
+ parameters:
+ - id: top
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setWidth(width)
+ uid: 'ExcelScript!ExcelScript.Slicer#setWidth:member(1)'
+ package: ExcelScript!
+ fullName: setWidth(width)
+ summary: >-
+ Represents the width, in points, of the slicer. Throws an `InvalidArgument` error when set with a negative value
+ or zero as an input.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setWidth(width: number): void;'
+ parameters:
+ - id: width
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.sliceritem.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.sliceritem.yml
index 7473354b..6a42c330 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.sliceritem.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.sliceritem.yml
@@ -1,86 +1,86 @@
-### YamlMime:TSType
-name: ExcelScript.SlicerItem
-uid: 'ExcelScript!ExcelScript.SlicerItem:interface'
-package: ExcelScript!
-fullName: ExcelScript.SlicerItem
-summary: Represents a slicer item in a slicer.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getHasData()
- uid: 'ExcelScript!ExcelScript.SlicerItem#getHasData:member(1)'
- package: ExcelScript!
- fullName: getHasData()
- summary: Value is `true` if the slicer item has data.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHasData(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getIsSelected()
- uid: 'ExcelScript!ExcelScript.SlicerItem#getIsSelected:member(1)'
- package: ExcelScript!
- fullName: getIsSelected()
- summary: >-
- Value is `true` if the slicer item is selected. Setting this value will not clear the selected state of other
- slicer items. By default, if the slicer item is the only one selected, when it is deselected, all items will be
- selected.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIsSelected(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getKey()
- uid: 'ExcelScript!ExcelScript.SlicerItem#getKey:member(1)'
- package: ExcelScript!
- fullName: getKey()
- summary: Represents the unique value representing the slicer item.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getKey(): string;'
- return:
- type: string
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.SlicerItem#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: Represents the title displayed in the Excel UI.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: setIsSelected(isSelected)
- uid: 'ExcelScript!ExcelScript.SlicerItem#setIsSelected:member(1)'
- package: ExcelScript!
- fullName: setIsSelected(isSelected)
- summary: >-
- Value is `true` if the slicer item is selected. Setting this value will not clear the selected state of other
- slicer items. By default, if the slicer item is the only one selected, when it is deselected, all items will be
- selected.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setIsSelected(isSelected: boolean): void;'
- parameters:
- - id: isSelected
- description: ''
- type: boolean
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.SlicerItem
+uid: 'ExcelScript!ExcelScript.SlicerItem:interface'
+package: ExcelScript!
+fullName: ExcelScript.SlicerItem
+summary: Represents a slicer item in a slicer.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getHasData()
+ uid: 'ExcelScript!ExcelScript.SlicerItem#getHasData:member(1)'
+ package: ExcelScript!
+ fullName: getHasData()
+ summary: Value is `true` if the slicer item has data.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHasData(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getIsSelected()
+ uid: 'ExcelScript!ExcelScript.SlicerItem#getIsSelected:member(1)'
+ package: ExcelScript!
+ fullName: getIsSelected()
+ summary: >-
+ Value is `true` if the slicer item is selected. Setting this value will not clear the selected state of other
+ slicer items. By default, if the slicer item is the only one selected, when it is deselected, all items will be
+ selected.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIsSelected(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getKey()
+ uid: 'ExcelScript!ExcelScript.SlicerItem#getKey:member(1)'
+ package: ExcelScript!
+ fullName: getKey()
+ summary: Represents the unique value representing the slicer item.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getKey(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.SlicerItem#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: Represents the title displayed in the Excel UI.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: setIsSelected(isSelected)
+ uid: 'ExcelScript!ExcelScript.SlicerItem#setIsSelected:member(1)'
+ package: ExcelScript!
+ fullName: setIsSelected(isSelected)
+ summary: >-
+ Value is `true` if the slicer item is selected. Setting this value will not clear the selected state of other
+ slicer items. By default, if the slicer item is the only one selected, when it is deselected, all items will be
+ selected.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setIsSelected(isSelected: boolean): void;'
+ parameters:
+ - id: isSelected
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.slicersorttype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.slicersorttype.yml
index 220ff1ce..85e62a38 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.slicersorttype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.slicersorttype.yml
@@ -1,22 +1,22 @@
-### YamlMime:TSEnum
-name: ExcelScript.SlicerSortType
-uid: 'ExcelScript!ExcelScript.SlicerSortType:enum'
-package: ExcelScript!
-fullName: ExcelScript.SlicerSortType
-summary: Specifies the slicer sort behavior for `Slicer.sortBy`.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: ascending
- uid: 'ExcelScript!ExcelScript.SlicerSortType.ascending:member'
- package: ExcelScript!
- summary: Sort slicer items in ascending order by item captions.
- - name: dataSourceOrder
- uid: 'ExcelScript!ExcelScript.SlicerSortType.dataSourceOrder:member'
- package: ExcelScript!
- summary: Sort slicer items in the order provided by the data source.
- - name: descending
- uid: 'ExcelScript!ExcelScript.SlicerSortType.descending:member'
- package: ExcelScript!
- summary: Sort slicer items in descending order by item captions.
+### YamlMime:TSEnum
+name: ExcelScript.SlicerSortType
+uid: 'ExcelScript!ExcelScript.SlicerSortType:enum'
+package: ExcelScript!
+fullName: ExcelScript.SlicerSortType
+summary: Specifies the slicer sort behavior for `Slicer.sortBy`.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: ascending
+ uid: 'ExcelScript!ExcelScript.SlicerSortType.ascending:member'
+ package: ExcelScript!
+ summary: Sort slicer items in ascending order by item captions.
+ - name: dataSourceOrder
+ uid: 'ExcelScript!ExcelScript.SlicerSortType.dataSourceOrder:member'
+ package: ExcelScript!
+ summary: Sort slicer items in the order provided by the data source.
+ - name: descending
+ uid: 'ExcelScript!ExcelScript.SlicerSortType.descending:member'
+ package: ExcelScript!
+ summary: Sort slicer items in descending order by item captions.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.slicerstyle.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.slicerstyle.yml
index ae7b0e38..b63d654c 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.slicerstyle.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.slicerstyle.yml
@@ -1,80 +1,80 @@
-### YamlMime:TSType
-name: ExcelScript.SlicerStyle
-uid: 'ExcelScript!ExcelScript.SlicerStyle:interface'
-package: ExcelScript!
-fullName: ExcelScript.SlicerStyle
-summary: 'Represents a slicer style, which defines style elements by region of the slicer.'
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: delete()
- uid: 'ExcelScript!ExcelScript.SlicerStyle#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: Deletes the slicer style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: ''
- - name: duplicate()
- uid: 'ExcelScript!ExcelScript.SlicerStyle#duplicate:member(1)'
- package: ExcelScript!
- fullName: duplicate()
- summary: Creates a duplicate of this slicer style with copies of all the style elements.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'duplicate(): SlicerStyle;'
- return:
- type: ''
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.SlicerStyle#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: Specifies the name of the slicer style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: getReadOnly()
- uid: 'ExcelScript!ExcelScript.SlicerStyle#getReadOnly:member(1)'
- package: ExcelScript!
- fullName: getReadOnly()
- summary: Specifies if this `SlicerStyle` object is read-only.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getReadOnly(): boolean;'
- return:
- type: boolean
- description: ''
- - name: setName(name)
- uid: 'ExcelScript!ExcelScript.SlicerStyle#setName:member(1)'
- package: ExcelScript!
- fullName: setName(name)
- summary: Specifies the name of the slicer style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setName(name: string): void;'
- parameters:
- - id: name
- description: ''
- type: string
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.SlicerStyle
+uid: 'ExcelScript!ExcelScript.SlicerStyle:interface'
+package: ExcelScript!
+fullName: ExcelScript.SlicerStyle
+summary: 'Represents a slicer style, which defines style elements by region of the slicer.'
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.SlicerStyle#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: Deletes the slicer style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: duplicate()
+ uid: 'ExcelScript!ExcelScript.SlicerStyle#duplicate:member(1)'
+ package: ExcelScript!
+ fullName: duplicate()
+ summary: Creates a duplicate of this slicer style with copies of all the style elements.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'duplicate(): SlicerStyle;'
+ return:
+ type: ''
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.SlicerStyle#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: Specifies the name of the slicer style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getReadOnly()
+ uid: 'ExcelScript!ExcelScript.SlicerStyle#getReadOnly:member(1)'
+ package: ExcelScript!
+ fullName: getReadOnly()
+ summary: Specifies if this `SlicerStyle` object is read-only.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getReadOnly(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: setName(name)
+ uid: 'ExcelScript!ExcelScript.SlicerStyle#setName:member(1)'
+ package: ExcelScript!
+ fullName: setName(name)
+ summary: Specifies the name of the slicer style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setName(name: string): void;'
+ parameters:
+ - id: name
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.sortby.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.sortby.yml
index a9e01546..b877cdce 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.sortby.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.sortby.yml
@@ -1,18 +1,18 @@
-### YamlMime:TSEnum
-name: ExcelScript.SortBy
-uid: 'ExcelScript!ExcelScript.SortBy:enum'
-package: ExcelScript!
-fullName: ExcelScript.SortBy
-summary: Represents the sort direction.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: ascending
- uid: 'ExcelScript!ExcelScript.SortBy.ascending:member'
- package: ExcelScript!
- summary: Ascending sort. Smallest to largest or A to Z.
- - name: descending
- uid: 'ExcelScript!ExcelScript.SortBy.descending:member'
- package: ExcelScript!
- summary: Descending sort. Largest to smallest or Z to A.
+### YamlMime:TSEnum
+name: ExcelScript.SortBy
+uid: 'ExcelScript!ExcelScript.SortBy:enum'
+package: ExcelScript!
+fullName: ExcelScript.SortBy
+summary: Represents the sort direction.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: ascending
+ uid: 'ExcelScript!ExcelScript.SortBy.ascending:member'
+ package: ExcelScript!
+ summary: Ascending sort. Smallest to largest or A to Z.
+ - name: descending
+ uid: 'ExcelScript!ExcelScript.SortBy.descending:member'
+ package: ExcelScript!
+ summary: Descending sort. Largest to smallest or Z to A.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.sortdataoption.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.sortdataoption.yml
index 99b6767a..a165b125 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.sortdataoption.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.sortdataoption.yml
@@ -1,46 +1,46 @@
-### YamlMime:TSEnum
-name: ExcelScript.SortDataOption
-uid: 'ExcelScript!ExcelScript.SortDataOption:enum'
-package: ExcelScript!
-fullName: ExcelScript.SortDataOption
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sorts a table based on the values in column 1.
- * If the text of a column-1 value can be treated as a number,
- * it will be sorted in numerical order, rather than Unicode order
- * (so 123 will come before 12.3).
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table on the current worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const table = currentSheet.getTables()[0];
-
- // Create the sorting parameters.
- const countSortField: ExcelScript.SortField = {
- key: 1,
- ascending: true,
- dataOption: ExcelScript.SortDataOption.textAsNumber
- };
-
- // Apply the sort to the table.
- const sort = table.getSort();
- sort.apply([countSortField]);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: normal
- uid: 'ExcelScript!ExcelScript.SortDataOption.normal:member'
- package: ExcelScript!
- summary: ''
- - name: textAsNumber
- uid: 'ExcelScript!ExcelScript.SortDataOption.textAsNumber:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.SortDataOption
+uid: 'ExcelScript!ExcelScript.SortDataOption:enum'
+package: ExcelScript!
+fullName: ExcelScript.SortDataOption
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sorts a table based on the values in column 1.
+ * If the text of a column-1 value can be treated as a number,
+ * it will be sorted in numerical order, rather than Unicode order
+ * (so 123 will come before 12.3).
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table on the current worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const table = currentSheet.getTables()[0];
+
+ // Create the sorting parameters.
+ const countSortField: ExcelScript.SortField = {
+ key: 1,
+ ascending: true,
+ dataOption: ExcelScript.SortDataOption.textAsNumber
+ };
+
+ // Apply the sort to the table.
+ const sort = table.getSort();
+ sort.apply([countSortField]);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: normal
+ uid: 'ExcelScript!ExcelScript.SortDataOption.normal:member'
+ package: ExcelScript!
+ summary: ''
+ - name: textAsNumber
+ uid: 'ExcelScript!ExcelScript.SortDataOption.textAsNumber:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.sortfield.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.sortfield.yml
index eeaa9abf..3d6e65b3 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.sortfield.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.sortfield.yml
@@ -1,179 +1,179 @@
-### YamlMime:TSType
-name: ExcelScript.SortField
-uid: 'ExcelScript!ExcelScript.SortField:interface'
-package: ExcelScript!
-fullName: ExcelScript.SortField
-summary: Represents a condition in a sorting operation.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: ascending
- uid: 'ExcelScript!ExcelScript.SortField#ascending:member'
- package: ExcelScript!
- fullName: ascending
- summary: Specifies if the sorting is done in an ascending fashion.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'ascending?: boolean;'
- return:
- type: boolean
- - name: color
- uid: 'ExcelScript!ExcelScript.SortField#color:member'
- package: ExcelScript!
- fullName: color
- summary: Specifies the color that is the target of the condition if the sorting is on font or cell color.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'color?: string;'
- return:
- type: string
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sorts a range based on the color of the cells.
- * It brings all red cells to the top of the range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range (A1:D8) to sort from the current worksheet.
- const worksheet = workbook.getActiveWorksheet();
- const rangeToSort = worksheet.getRange("A1:D8");
-
- // Create a SortField for color sorting.
- // This sorts the rows based on the fill color of each row's cell in the first column.
- let colorSort: ExcelScript.SortField = {
- ascending: true,
- color: "FF0000", /* red */
- key: 0,
- sortOn: ExcelScript.SortOn.cellColor
- };
-
- // Apply the SortField to the range.
- rangeToSort.getSort().apply([colorSort]);
- }
- ```
- - name: dataOption
- uid: 'ExcelScript!ExcelScript.SortField#dataOption:member'
- package: ExcelScript!
- fullName: dataOption
- summary: Represents additional sorting options for this field.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'dataOption?: SortDataOption;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sorts a table based on the values in column 1.
- * If the text of a column-1 value can be treated as a number,
- * it will be sorted in numerical order, rather than Unicode order
- * (so 123 will come before 12.3).
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table on the current worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const table = currentSheet.getTables()[0];
-
- // Create the sorting parameters.
- const countSortField: ExcelScript.SortField = {
- key: 1,
- ascending: true,
- dataOption: ExcelScript.SortDataOption.textAsNumber
- };
-
- // Apply the sort to the table.
- const sort = table.getSort();
- sort.apply([countSortField]);
- }
- ```
- - name: icon
- uid: 'ExcelScript!ExcelScript.SortField#icon:member'
- package: ExcelScript!
- fullName: icon
- summary: 'Specifies the icon that is the target of the condition, if the sorting is on the cell''s icon.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'icon?: Icon;'
- return:
- type: ''
- - name: key
- uid: 'ExcelScript!ExcelScript.SortField#key:member'
- package: ExcelScript!
- fullName: key
- summary: >-
- Specifies the column (or row, depending on the sort orientation) that the condition is on. Represented as an
- offset from the first column (or row).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'key: number;'
- return:
- type: number
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sorts the used range of the current worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the used range of the current worksheet.
- const activeRange = workbook.getActiveWorksheet().getUsedRange();
-
- // Sort the rows in ascending order based on the last column.
- activeRange.getSort().apply(
- [{
- ascending: true,
- key: activeRange.getColumnCount() - 1
- }],
- false, /* Don't match case. */
- true, /* Treat the first row as a header rows. */
- ExcelScript.SortOrientation.rows
- );
- }
- ```
- - name: sortOn
- uid: 'ExcelScript!ExcelScript.SortField#sortOn:member'
- package: ExcelScript!
- fullName: sortOn
- summary: Specifies the type of sorting of this condition.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'sortOn?: SortOn;'
- return:
- type: ''
- - name: subField
- uid: 'ExcelScript!ExcelScript.SortField#subField:member'
- package: ExcelScript!
- fullName: subField
- summary: Specifies the subfield that is the target property name of a rich value to sort on.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'subField?: string;'
- return:
- type: string
+### YamlMime:TSType
+name: ExcelScript.SortField
+uid: 'ExcelScript!ExcelScript.SortField:interface'
+package: ExcelScript!
+fullName: ExcelScript.SortField
+summary: Represents a condition in a sorting operation.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: ascending
+ uid: 'ExcelScript!ExcelScript.SortField#ascending:member'
+ package: ExcelScript!
+ fullName: ascending
+ summary: Specifies if the sorting is done in an ascending fashion.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'ascending?: boolean;'
+ return:
+ type: boolean
+ - name: color
+ uid: 'ExcelScript!ExcelScript.SortField#color:member'
+ package: ExcelScript!
+ fullName: color
+ summary: Specifies the color that is the target of the condition if the sorting is on font or cell color.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'color?: string;'
+ return:
+ type: string
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sorts a range based on the color of the cells.
+ * It brings all red cells to the top of the range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range (A1:D8) to sort from the current worksheet.
+ const worksheet = workbook.getActiveWorksheet();
+ const rangeToSort = worksheet.getRange("A1:D8");
+
+ // Create a SortField for color sorting.
+ // This sorts the rows based on the fill color of each row's cell in the first column.
+ let colorSort: ExcelScript.SortField = {
+ ascending: true,
+ color: "FF0000", /* red */
+ key: 0,
+ sortOn: ExcelScript.SortOn.cellColor
+ };
+
+ // Apply the SortField to the range.
+ rangeToSort.getSort().apply([colorSort]);
+ }
+ ```
+ - name: dataOption
+ uid: 'ExcelScript!ExcelScript.SortField#dataOption:member'
+ package: ExcelScript!
+ fullName: dataOption
+ summary: Represents additional sorting options for this field.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'dataOption?: SortDataOption;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sorts a table based on the values in column 1.
+ * If the text of a column-1 value can be treated as a number,
+ * it will be sorted in numerical order, rather than Unicode order
+ * (so 123 will come before 12.3).
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table on the current worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const table = currentSheet.getTables()[0];
+
+ // Create the sorting parameters.
+ const countSortField: ExcelScript.SortField = {
+ key: 1,
+ ascending: true,
+ dataOption: ExcelScript.SortDataOption.textAsNumber
+ };
+
+ // Apply the sort to the table.
+ const sort = table.getSort();
+ sort.apply([countSortField]);
+ }
+ ```
+ - name: icon
+ uid: 'ExcelScript!ExcelScript.SortField#icon:member'
+ package: ExcelScript!
+ fullName: icon
+ summary: 'Specifies the icon that is the target of the condition, if the sorting is on the cell''s icon.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'icon?: Icon;'
+ return:
+ type: ''
+ - name: key
+ uid: 'ExcelScript!ExcelScript.SortField#key:member'
+ package: ExcelScript!
+ fullName: key
+ summary: >-
+ Specifies the column (or row, depending on the sort orientation) that the condition is on. Represented as an
+ offset from the first column (or row).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'key: number;'
+ return:
+ type: number
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sorts the used range of the current worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the used range of the current worksheet.
+ const activeRange = workbook.getActiveWorksheet().getUsedRange();
+
+ // Sort the rows in ascending order based on the last column.
+ activeRange.getSort().apply(
+ [{
+ ascending: true,
+ key: activeRange.getColumnCount() - 1
+ }],
+ false, /* Don't match case. */
+ true, /* Treat the first row as a header rows. */
+ ExcelScript.SortOrientation.rows
+ );
+ }
+ ```
+ - name: sortOn
+ uid: 'ExcelScript!ExcelScript.SortField#sortOn:member'
+ package: ExcelScript!
+ fullName: sortOn
+ summary: Specifies the type of sorting of this condition.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'sortOn?: SortOn;'
+ return:
+ type: ''
+ - name: subField
+ uid: 'ExcelScript!ExcelScript.SortField#subField:member'
+ package: ExcelScript!
+ fullName: subField
+ summary: Specifies the subfield that is the target property name of a rich value to sort on.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'subField?: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.sortmethod.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.sortmethod.yml
index 9eb1d11f..1c1e25d5 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.sortmethod.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.sortmethod.yml
@@ -1,48 +1,48 @@
-### YamlMime:TSEnum
-name: ExcelScript.SortMethod
-uid: 'ExcelScript!ExcelScript.SortMethod:enum'
-package: ExcelScript!
-fullName: ExcelScript.SortMethod
-summary: Represents the ordering method to be used when sorting Chinese characters.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sorts a range using the values in the first column.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range (A1:D8) to sort from the current worksheet.
- const worksheet = workbook.getActiveWorksheet();
- const rangeToSort = worksheet.getRange("A1:D8");
-
- // Create a SortField for text sorting.
- let valueSort: ExcelScript.SortField = {
- ascending: true,
- key: 0, /* First column */
- sortOn: ExcelScript.SortOn.value
- };
-
- // Apply the SortField to the range.
- rangeToSort.getSort().apply(
- [valueSort],
- false, /* Don't let casing have an impact of sorting. */
- true, /* The range has headers. */
- ExcelScript.SortOrientation.rows,
- ExcelScript.SortMethod.pinYin /* Use phonetic sorting for Chinese characters. */
- );
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: pinYin
- uid: 'ExcelScript!ExcelScript.SortMethod.pinYin:member'
- package: ExcelScript!
- summary: ''
- - name: strokeCount
- uid: 'ExcelScript!ExcelScript.SortMethod.strokeCount:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.SortMethod
+uid: 'ExcelScript!ExcelScript.SortMethod:enum'
+package: ExcelScript!
+fullName: ExcelScript.SortMethod
+summary: Represents the ordering method to be used when sorting Chinese characters.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sorts a range using the values in the first column.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range (A1:D8) to sort from the current worksheet.
+ const worksheet = workbook.getActiveWorksheet();
+ const rangeToSort = worksheet.getRange("A1:D8");
+
+ // Create a SortField for text sorting.
+ let valueSort: ExcelScript.SortField = {
+ ascending: true,
+ key: 0, /* First column */
+ sortOn: ExcelScript.SortOn.value
+ };
+
+ // Apply the SortField to the range.
+ rangeToSort.getSort().apply(
+ [valueSort],
+ false, /* Don't let casing have an impact of sorting. */
+ true, /* The range has headers. */
+ ExcelScript.SortOrientation.rows,
+ ExcelScript.SortMethod.pinYin /* Use phonetic sorting for Chinese characters. */
+ );
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: pinYin
+ uid: 'ExcelScript!ExcelScript.SortMethod.pinYin:member'
+ package: ExcelScript!
+ summary: ''
+ - name: strokeCount
+ uid: 'ExcelScript!ExcelScript.SortMethod.strokeCount:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.sorton.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.sorton.yml
index b5a522a8..94e70c26 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.sorton.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.sorton.yml
@@ -1,53 +1,53 @@
-### YamlMime:TSEnum
-name: ExcelScript.SortOn
-uid: 'ExcelScript!ExcelScript.SortOn:enum'
-package: ExcelScript!
-fullName: ExcelScript.SortOn
-summary: Represents the part of the cell used as the sorting criteria.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sorts a range based on the color of the cells.
- * It brings all red cells to the top of the range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range (A1:D8) to sort from the current worksheet.
- const worksheet = workbook.getActiveWorksheet();
- const rangeToSort = worksheet.getRange("A1:D8");
-
- // Create a SortField for color sorting.
- // This sorts the rows based on the fill color of each row's cell in the first column.
- let colorSort: ExcelScript.SortField = {
- ascending: true,
- color: "FF0000", /* red */
- key: 0,
- sortOn: ExcelScript.SortOn.cellColor
- };
-
- // Apply the SortField to the range.
- rangeToSort.getSort().apply([colorSort]);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: cellColor
- uid: 'ExcelScript!ExcelScript.SortOn.cellColor:member'
- package: ExcelScript!
- summary: ''
- - name: fontColor
- uid: 'ExcelScript!ExcelScript.SortOn.fontColor:member'
- package: ExcelScript!
- summary: ''
- - name: icon
- uid: 'ExcelScript!ExcelScript.SortOn.icon:member'
- package: ExcelScript!
- summary: ''
- - name: value
- uid: 'ExcelScript!ExcelScript.SortOn.value:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.SortOn
+uid: 'ExcelScript!ExcelScript.SortOn:enum'
+package: ExcelScript!
+fullName: ExcelScript.SortOn
+summary: Represents the part of the cell used as the sorting criteria.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sorts a range based on the color of the cells.
+ * It brings all red cells to the top of the range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range (A1:D8) to sort from the current worksheet.
+ const worksheet = workbook.getActiveWorksheet();
+ const rangeToSort = worksheet.getRange("A1:D8");
+
+ // Create a SortField for color sorting.
+ // This sorts the rows based on the fill color of each row's cell in the first column.
+ let colorSort: ExcelScript.SortField = {
+ ascending: true,
+ color: "FF0000", /* red */
+ key: 0,
+ sortOn: ExcelScript.SortOn.cellColor
+ };
+
+ // Apply the SortField to the range.
+ rangeToSort.getSort().apply([colorSort]);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: cellColor
+ uid: 'ExcelScript!ExcelScript.SortOn.cellColor:member'
+ package: ExcelScript!
+ summary: ''
+ - name: fontColor
+ uid: 'ExcelScript!ExcelScript.SortOn.fontColor:member'
+ package: ExcelScript!
+ summary: ''
+ - name: icon
+ uid: 'ExcelScript!ExcelScript.SortOn.icon:member'
+ package: ExcelScript!
+ summary: ''
+ - name: value
+ uid: 'ExcelScript!ExcelScript.SortOn.value:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.sortorientation.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.sortorientation.yml
index 841c08c4..19c2c970 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.sortorientation.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.sortorientation.yml
@@ -1,18 +1,18 @@
-### YamlMime:TSEnum
-name: ExcelScript.SortOrientation
-uid: 'ExcelScript!ExcelScript.SortOrientation:enum'
-package: ExcelScript!
-fullName: ExcelScript.SortOrientation
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: columns
- uid: 'ExcelScript!ExcelScript.SortOrientation.columns:member'
- package: ExcelScript!
- summary: ''
- - name: rows
- uid: 'ExcelScript!ExcelScript.SortOrientation.rows:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.SortOrientation
+uid: 'ExcelScript!ExcelScript.SortOrientation:enum'
+package: ExcelScript!
+fullName: ExcelScript.SortOrientation
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: columns
+ uid: 'ExcelScript!ExcelScript.SortOrientation.columns:member'
+ package: ExcelScript!
+ summary: ''
+ - name: rows
+ uid: 'ExcelScript!ExcelScript.SortOrientation.rows:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.specialcelltype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.specialcelltype.yml
index a0b17cc4..f9563605 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.specialcelltype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.specialcelltype.yml
@@ -1,62 +1,62 @@
-### YamlMime:TSEnum
-name: ExcelScript.SpecialCellType
-uid: 'ExcelScript!ExcelScript.SpecialCellType:enum'
-package: ExcelScript!
-fullName: ExcelScript.SpecialCellType
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script finds and highlights all the cells in the current worksheet that contain a formula.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the used range on the current sheet.
- const currentSheet = workbook.getActiveWorksheet();
- const usedRange = currentSheet.getUsedRange();
-
- // Get the RangeAreas object for each cell with a formula.
- const formulaCells = usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas);
-
- // Add a light blue background to the cells containing formulas.
- formulaCells.getFormat().getFill().setColor("#ADD8E6");
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: blanks
- uid: 'ExcelScript!ExcelScript.SpecialCellType.blanks:member'
- package: ExcelScript!
- summary: Cells with no content.
- - name: conditionalFormats
- uid: 'ExcelScript!ExcelScript.SpecialCellType.conditionalFormats:member'
- package: ExcelScript!
- summary: All cells with conditional formats.
- - name: constants
- uid: 'ExcelScript!ExcelScript.SpecialCellType.constants:member'
- package: ExcelScript!
- summary: Cells containing constants.
- - name: dataValidations
- uid: 'ExcelScript!ExcelScript.SpecialCellType.dataValidations:member'
- package: ExcelScript!
- summary: Cells with validation criteria.
- - name: formulas
- uid: 'ExcelScript!ExcelScript.SpecialCellType.formulas:member'
- package: ExcelScript!
- summary: Cells containing formulas.
- - name: sameConditionalFormat
- uid: 'ExcelScript!ExcelScript.SpecialCellType.sameConditionalFormat:member'
- package: ExcelScript!
- summary: Cells with the same conditional format as the first cell in the range.
- - name: sameDataValidation
- uid: 'ExcelScript!ExcelScript.SpecialCellType.sameDataValidation:member'
- package: ExcelScript!
- summary: Cells with the same data validation criteria as the first cell in the range.
- - name: visible
- uid: 'ExcelScript!ExcelScript.SpecialCellType.visible:member'
- package: ExcelScript!
- summary: Cells that are visible.
+### YamlMime:TSEnum
+name: ExcelScript.SpecialCellType
+uid: 'ExcelScript!ExcelScript.SpecialCellType:enum'
+package: ExcelScript!
+fullName: ExcelScript.SpecialCellType
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script finds and highlights all the cells in the current worksheet that contain a formula.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the used range on the current sheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const usedRange = currentSheet.getUsedRange();
+
+ // Get the RangeAreas object for each cell with a formula.
+ const formulaCells = usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas);
+
+ // Add a light blue background to the cells containing formulas.
+ formulaCells.getFormat().getFill().setColor("#ADD8E6");
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: blanks
+ uid: 'ExcelScript!ExcelScript.SpecialCellType.blanks:member'
+ package: ExcelScript!
+ summary: Cells with no content.
+ - name: conditionalFormats
+ uid: 'ExcelScript!ExcelScript.SpecialCellType.conditionalFormats:member'
+ package: ExcelScript!
+ summary: All cells with conditional formats.
+ - name: constants
+ uid: 'ExcelScript!ExcelScript.SpecialCellType.constants:member'
+ package: ExcelScript!
+ summary: Cells containing constants.
+ - name: dataValidations
+ uid: 'ExcelScript!ExcelScript.SpecialCellType.dataValidations:member'
+ package: ExcelScript!
+ summary: Cells with validation criteria.
+ - name: formulas
+ uid: 'ExcelScript!ExcelScript.SpecialCellType.formulas:member'
+ package: ExcelScript!
+ summary: Cells containing formulas.
+ - name: sameConditionalFormat
+ uid: 'ExcelScript!ExcelScript.SpecialCellType.sameConditionalFormat:member'
+ package: ExcelScript!
+ summary: Cells with the same conditional format as the first cell in the range.
+ - name: sameDataValidation
+ uid: 'ExcelScript!ExcelScript.SpecialCellType.sameDataValidation:member'
+ package: ExcelScript!
+ summary: Cells with the same data validation criteria as the first cell in the range.
+ - name: visible
+ uid: 'ExcelScript!ExcelScript.SpecialCellType.visible:member'
+ package: ExcelScript!
+ summary: Cells that are visible.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.specialcellvaluetype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.specialcellvaluetype.yml
index 5ce3981c..d046d1ee 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.specialcellvaluetype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.specialcellvaluetype.yml
@@ -1,92 +1,92 @@
-### YamlMime:TSEnum
-name: ExcelScript.SpecialCellValueType
-uid: 'ExcelScript!ExcelScript.SpecialCellValueType:enum'
-package: ExcelScript!
-fullName: ExcelScript.SpecialCellValueType
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script finds and bolds the text of cells containing strings (not numbers or formulas).
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the used range on the current sheet.
- const currentSheet = workbook.getActiveWorksheet();
- const usedRange = currentSheet.getUsedRange();
-
- // Get the RangeAreas object for each cell with only text.
- const textCells = usedRange.getSpecialCells(
- ExcelScript.SpecialCellType.constants,
- ExcelScript.SpecialCellValueType.text);
-
- // Bold the text of those cells.
- textCells.getFormat().getFont().setBold(true);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: all
- uid: 'ExcelScript!ExcelScript.SpecialCellValueType.all:member'
- package: ExcelScript!
- summary: 'Cells that have errors, boolean, numeric, or string values.'
- - name: errors
- uid: 'ExcelScript!ExcelScript.SpecialCellValueType.errors:member'
- package: ExcelScript!
- summary: Cells that have errors.
- - name: errorsLogical
- uid: 'ExcelScript!ExcelScript.SpecialCellValueType.errorsLogical:member'
- package: ExcelScript!
- summary: Cells that have errors or boolean values.
- - name: errorsLogicalNumber
- uid: 'ExcelScript!ExcelScript.SpecialCellValueType.errorsLogicalNumber:member'
- package: ExcelScript!
- summary: 'Cells that have errors, boolean, or numeric values.'
- - name: errorsLogicalText
- uid: 'ExcelScript!ExcelScript.SpecialCellValueType.errorsLogicalText:member'
- package: ExcelScript!
- summary: 'Cells that have errors, boolean, or string values.'
- - name: errorsNumbers
- uid: 'ExcelScript!ExcelScript.SpecialCellValueType.errorsNumbers:member'
- package: ExcelScript!
- summary: Cells that have errors or numeric values.
- - name: errorsNumberText
- uid: 'ExcelScript!ExcelScript.SpecialCellValueType.errorsNumberText:member'
- package: ExcelScript!
- summary: 'Cells that have errors, numeric, or string values.'
- - name: errorsText
- uid: 'ExcelScript!ExcelScript.SpecialCellValueType.errorsText:member'
- package: ExcelScript!
- summary: Cells that have errors or string values.
- - name: logical
- uid: 'ExcelScript!ExcelScript.SpecialCellValueType.logical:member'
- package: ExcelScript!
- summary: Cells that have a boolean value.
- - name: logicalNumbers
- uid: 'ExcelScript!ExcelScript.SpecialCellValueType.logicalNumbers:member'
- package: ExcelScript!
- summary: Cells that have a boolean or numeric value.
- - name: logicalNumbersText
- uid: 'ExcelScript!ExcelScript.SpecialCellValueType.logicalNumbersText:member'
- package: ExcelScript!
- summary: 'Cells that have a boolean, numeric, or string value.'
- - name: logicalText
- uid: 'ExcelScript!ExcelScript.SpecialCellValueType.logicalText:member'
- package: ExcelScript!
- summary: Cells that have a boolean or string value.
- - name: numbers
- uid: 'ExcelScript!ExcelScript.SpecialCellValueType.numbers:member'
- package: ExcelScript!
- summary: Cells that have a numeric value.
- - name: numbersText
- uid: 'ExcelScript!ExcelScript.SpecialCellValueType.numbersText:member'
- package: ExcelScript!
- summary: Cells that have a numeric or string value.
- - name: text
- uid: 'ExcelScript!ExcelScript.SpecialCellValueType.text:member'
- package: ExcelScript!
- summary: Cells that have a string value.
+### YamlMime:TSEnum
+name: ExcelScript.SpecialCellValueType
+uid: 'ExcelScript!ExcelScript.SpecialCellValueType:enum'
+package: ExcelScript!
+fullName: ExcelScript.SpecialCellValueType
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script finds and bolds the text of cells containing strings (not numbers or formulas).
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the used range on the current sheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const usedRange = currentSheet.getUsedRange();
+
+ // Get the RangeAreas object for each cell with only text.
+ const textCells = usedRange.getSpecialCells(
+ ExcelScript.SpecialCellType.constants,
+ ExcelScript.SpecialCellValueType.text);
+
+ // Bold the text of those cells.
+ textCells.getFormat().getFont().setBold(true);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: all
+ uid: 'ExcelScript!ExcelScript.SpecialCellValueType.all:member'
+ package: ExcelScript!
+ summary: 'Cells that have errors, boolean, numeric, or string values.'
+ - name: errors
+ uid: 'ExcelScript!ExcelScript.SpecialCellValueType.errors:member'
+ package: ExcelScript!
+ summary: Cells that have errors.
+ - name: errorsLogical
+ uid: 'ExcelScript!ExcelScript.SpecialCellValueType.errorsLogical:member'
+ package: ExcelScript!
+ summary: Cells that have errors or boolean values.
+ - name: errorsLogicalNumber
+ uid: 'ExcelScript!ExcelScript.SpecialCellValueType.errorsLogicalNumber:member'
+ package: ExcelScript!
+ summary: 'Cells that have errors, boolean, or numeric values.'
+ - name: errorsLogicalText
+ uid: 'ExcelScript!ExcelScript.SpecialCellValueType.errorsLogicalText:member'
+ package: ExcelScript!
+ summary: 'Cells that have errors, boolean, or string values.'
+ - name: errorsNumbers
+ uid: 'ExcelScript!ExcelScript.SpecialCellValueType.errorsNumbers:member'
+ package: ExcelScript!
+ summary: Cells that have errors or numeric values.
+ - name: errorsNumberText
+ uid: 'ExcelScript!ExcelScript.SpecialCellValueType.errorsNumberText:member'
+ package: ExcelScript!
+ summary: 'Cells that have errors, numeric, or string values.'
+ - name: errorsText
+ uid: 'ExcelScript!ExcelScript.SpecialCellValueType.errorsText:member'
+ package: ExcelScript!
+ summary: Cells that have errors or string values.
+ - name: logical
+ uid: 'ExcelScript!ExcelScript.SpecialCellValueType.logical:member'
+ package: ExcelScript!
+ summary: Cells that have a boolean value.
+ - name: logicalNumbers
+ uid: 'ExcelScript!ExcelScript.SpecialCellValueType.logicalNumbers:member'
+ package: ExcelScript!
+ summary: Cells that have a boolean or numeric value.
+ - name: logicalNumbersText
+ uid: 'ExcelScript!ExcelScript.SpecialCellValueType.logicalNumbersText:member'
+ package: ExcelScript!
+ summary: 'Cells that have a boolean, numeric, or string value.'
+ - name: logicalText
+ uid: 'ExcelScript!ExcelScript.SpecialCellValueType.logicalText:member'
+ package: ExcelScript!
+ summary: Cells that have a boolean or string value.
+ - name: numbers
+ uid: 'ExcelScript!ExcelScript.SpecialCellValueType.numbers:member'
+ package: ExcelScript!
+ summary: Cells that have a numeric value.
+ - name: numbersText
+ uid: 'ExcelScript!ExcelScript.SpecialCellValueType.numbersText:member'
+ package: ExcelScript!
+ summary: Cells that have a numeric or string value.
+ - name: text
+ uid: 'ExcelScript!ExcelScript.SpecialCellValueType.text:member'
+ package: ExcelScript!
+ summary: Cells that have a string value.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.subtotallocationtype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.subtotallocationtype.yml
index 3fd80b1b..0816a24d 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.subtotallocationtype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.subtotallocationtype.yml
@@ -1,41 +1,41 @@
-### YamlMime:TSEnum
-name: ExcelScript.SubtotalLocationType
-uid: 'ExcelScript!ExcelScript.SubtotalLocationType:enum'
-package: ExcelScript!
-fullName: ExcelScript.SubtotalLocationType
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script displays group subtotals of the "Farms Sales" PivotTable.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the PivotTable named "Farm Sales".
- const pivot = workbook.getPivotTable("Farm Sales");
-
- // Get the PivotLayout object.
- const layout = pivot.getLayout();
-
- // Show all the subtotals at the bottom of each group.
- layout.setSubtotalLocation(ExcelScript.SubtotalLocationType.atBottom);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: atBottom
- uid: 'ExcelScript!ExcelScript.SubtotalLocationType.atBottom:member'
- package: ExcelScript!
- summary: Subtotals are at the bottom.
- - name: atTop
- uid: 'ExcelScript!ExcelScript.SubtotalLocationType.atTop:member'
- package: ExcelScript!
- summary: Subtotals are at the top.
- - name: 'off'
- uid: 'ExcelScript!ExcelScript.SubtotalLocationType.off:member'
- package: ExcelScript!
- summary: Subtotals are off.
+### YamlMime:TSEnum
+name: ExcelScript.SubtotalLocationType
+uid: 'ExcelScript!ExcelScript.SubtotalLocationType:enum'
+package: ExcelScript!
+fullName: ExcelScript.SubtotalLocationType
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script displays group subtotals of the "Farms Sales" PivotTable.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the PivotTable named "Farm Sales".
+ const pivot = workbook.getPivotTable("Farm Sales");
+
+ // Get the PivotLayout object.
+ const layout = pivot.getLayout();
+
+ // Show all the subtotals at the bottom of each group.
+ layout.setSubtotalLocation(ExcelScript.SubtotalLocationType.atBottom);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: atBottom
+ uid: 'ExcelScript!ExcelScript.SubtotalLocationType.atBottom:member'
+ package: ExcelScript!
+ summary: Subtotals are at the bottom.
+ - name: atTop
+ uid: 'ExcelScript!ExcelScript.SubtotalLocationType.atTop:member'
+ package: ExcelScript!
+ summary: Subtotals are at the top.
+ - name: 'off'
+ uid: 'ExcelScript!ExcelScript.SubtotalLocationType.off:member'
+ package: ExcelScript!
+ summary: Subtotals are off.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.subtotals.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.subtotals.yml
index 4bfeee2d..c7bb0bf6 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.subtotals.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.subtotals.yml
@@ -1,157 +1,157 @@
-### YamlMime:TSType
-name: ExcelScript.Subtotals
-uid: 'ExcelScript!ExcelScript.Subtotals:interface'
-package: ExcelScript!
-fullName: ExcelScript.Subtotals
-summary: Subtotals for the Pivot Field.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: automatic
- uid: 'ExcelScript!ExcelScript.Subtotals#automatic:member'
- package: ExcelScript!
- fullName: automatic
- summary: >-
- If `Automatic` is set to `true`, then all other values will be ignored when setting the `Subtotals`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'automatic?: boolean;'
- return:
- type: boolean
- - name: average
- uid: 'ExcelScript!ExcelScript.Subtotals#average:member'
- package: ExcelScript!
- fullName: average
- summary: Average
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'average?: boolean;'
- return:
- type: boolean
- - name: count
- uid: 'ExcelScript!ExcelScript.Subtotals#count:member'
- package: ExcelScript!
- fullName: count
- summary: Count
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'count?: boolean;'
- return:
- type: boolean
- - name: countNumbers
- uid: 'ExcelScript!ExcelScript.Subtotals#countNumbers:member'
- package: ExcelScript!
- fullName: countNumbers
- summary: CountNumbers
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'countNumbers?: boolean;'
- return:
- type: boolean
- - name: max
- uid: 'ExcelScript!ExcelScript.Subtotals#max:member'
- package: ExcelScript!
- fullName: max
- summary: Max
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'max?: boolean;'
- return:
- type: boolean
- - name: min
- uid: 'ExcelScript!ExcelScript.Subtotals#min:member'
- package: ExcelScript!
- fullName: min
- summary: Min
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'min?: boolean;'
- return:
- type: boolean
- - name: product
- uid: 'ExcelScript!ExcelScript.Subtotals#product:member'
- package: ExcelScript!
- fullName: product
- summary: Product
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'product?: boolean;'
- return:
- type: boolean
- - name: standardDeviation
- uid: 'ExcelScript!ExcelScript.Subtotals#standardDeviation:member'
- package: ExcelScript!
- fullName: standardDeviation
- summary: StandardDeviation
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'standardDeviation?: boolean;'
- return:
- type: boolean
- - name: standardDeviationP
- uid: 'ExcelScript!ExcelScript.Subtotals#standardDeviationP:member'
- package: ExcelScript!
- fullName: standardDeviationP
- summary: StandardDeviationP
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'standardDeviationP?: boolean;'
- return:
- type: boolean
- - name: sum
- uid: 'ExcelScript!ExcelScript.Subtotals#sum:member'
- package: ExcelScript!
- fullName: sum
- summary: Sum
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'sum?: boolean;'
- return:
- type: boolean
- - name: variance
- uid: 'ExcelScript!ExcelScript.Subtotals#variance:member'
- package: ExcelScript!
- fullName: variance
- summary: Variance
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'variance?: boolean;'
- return:
- type: boolean
- - name: varianceP
- uid: 'ExcelScript!ExcelScript.Subtotals#varianceP:member'
- package: ExcelScript!
- fullName: varianceP
- summary: VarianceP
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'varianceP?: boolean;'
- return:
- type: boolean
+### YamlMime:TSType
+name: ExcelScript.Subtotals
+uid: 'ExcelScript!ExcelScript.Subtotals:interface'
+package: ExcelScript!
+fullName: ExcelScript.Subtotals
+summary: Subtotals for the Pivot Field.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: automatic
+ uid: 'ExcelScript!ExcelScript.Subtotals#automatic:member'
+ package: ExcelScript!
+ fullName: automatic
+ summary: >-
+ If `Automatic` is set to `true`, then all other values will be ignored when setting the `Subtotals`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'automatic?: boolean;'
+ return:
+ type: boolean
+ - name: average
+ uid: 'ExcelScript!ExcelScript.Subtotals#average:member'
+ package: ExcelScript!
+ fullName: average
+ summary: Average
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'average?: boolean;'
+ return:
+ type: boolean
+ - name: count
+ uid: 'ExcelScript!ExcelScript.Subtotals#count:member'
+ package: ExcelScript!
+ fullName: count
+ summary: Count
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'count?: boolean;'
+ return:
+ type: boolean
+ - name: countNumbers
+ uid: 'ExcelScript!ExcelScript.Subtotals#countNumbers:member'
+ package: ExcelScript!
+ fullName: countNumbers
+ summary: CountNumbers
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'countNumbers?: boolean;'
+ return:
+ type: boolean
+ - name: max
+ uid: 'ExcelScript!ExcelScript.Subtotals#max:member'
+ package: ExcelScript!
+ fullName: max
+ summary: Max
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'max?: boolean;'
+ return:
+ type: boolean
+ - name: min
+ uid: 'ExcelScript!ExcelScript.Subtotals#min:member'
+ package: ExcelScript!
+ fullName: min
+ summary: Min
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'min?: boolean;'
+ return:
+ type: boolean
+ - name: product
+ uid: 'ExcelScript!ExcelScript.Subtotals#product:member'
+ package: ExcelScript!
+ fullName: product
+ summary: Product
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'product?: boolean;'
+ return:
+ type: boolean
+ - name: standardDeviation
+ uid: 'ExcelScript!ExcelScript.Subtotals#standardDeviation:member'
+ package: ExcelScript!
+ fullName: standardDeviation
+ summary: StandardDeviation
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'standardDeviation?: boolean;'
+ return:
+ type: boolean
+ - name: standardDeviationP
+ uid: 'ExcelScript!ExcelScript.Subtotals#standardDeviationP:member'
+ package: ExcelScript!
+ fullName: standardDeviationP
+ summary: StandardDeviationP
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'standardDeviationP?: boolean;'
+ return:
+ type: boolean
+ - name: sum
+ uid: 'ExcelScript!ExcelScript.Subtotals#sum:member'
+ package: ExcelScript!
+ fullName: sum
+ summary: Sum
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'sum?: boolean;'
+ return:
+ type: boolean
+ - name: variance
+ uid: 'ExcelScript!ExcelScript.Subtotals#variance:member'
+ package: ExcelScript!
+ fullName: variance
+ summary: Variance
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'variance?: boolean;'
+ return:
+ type: boolean
+ - name: varianceP
+ uid: 'ExcelScript!ExcelScript.Subtotals#varianceP:member'
+ package: ExcelScript!
+ fullName: varianceP
+ summary: VarianceP
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'varianceP?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.table.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.table.yml
index 5ab4e6e9..1b19a9a7 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.table.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.table.yml
@@ -1,981 +1,981 @@
-### YamlMime:TSType
-name: ExcelScript.Table
-uid: 'ExcelScript!ExcelScript.Table:interface'
-package: ExcelScript!
-fullName: ExcelScript.Table
-summary: Represents an Excel table.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a table from the current sheet's used range.
- * It then adds a total row to the table with the SUM of the last column.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the used range of the current worksheet.
- const sheet = workbook.getActiveWorksheet();
- const range = sheet.getUsedRange();
-
- // Create a table that has headers from that range.
- const table = sheet.addTable(range, true);
-
- // Have the table display the SUM for the last column.
- table.setShowTotals(true);
- const lastColumn = table.getColumn(table.getColumns().length);
- lastColumn.getTotalRowRange().setFormula(`=SUBTOTAL(109,[${lastColumn.getName()}])`);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: 'addColumn(index, values, name)'
- uid: 'ExcelScript!ExcelScript.Table#addColumn:member(1)'
- package: ExcelScript!
- fullName: 'addColumn(index, values, name)'
- summary: Adds a new column to the table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- addColumn(
- index?: number,
- values?: (boolean | string | number)[],
- name?: string
- ): TableColumn;
- parameters:
- - id: index
- description: >-
- Optional. Specifies the relative position of the new column. If null or -1, the addition happens at the end.
- Columns with a higher index will be shifted to the side. Zero-indexed.
- type: number
- - id: values
- description: Optional. A 1-dimensional array of unformatted values of the table column.
- type: '(boolean | string | number)[]'
- - id: name
- description: 'Optional. Specifies the name of the new column. If null, the default name will be used.'
- type: string
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a new column to a table.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table in the workbook.
- const table = workbook.getTables()[0];
-
- // Append an empty column to the table with the header "Total".
- table.addColumn(-1, null, "Total");
- }
- ```
- - name: 'addRow(index, values)'
- uid: 'ExcelScript!ExcelScript.Table#addRow:member(1)'
- package: ExcelScript!
- fullName: 'addRow(index, values)'
- summary: Adds one row to the table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addRow(index?: number, values?: (boolean | string | number)[]): void;'
- parameters:
- - id: index
- description: >-
- Optional. Specifies the relative position of the new row. If null or -1, the addition happens at the end.
- Any rows below the inserted row are shifted downwards. Zero-indexed.
- type: number
- - id: values
- description: Optional. A 1-dimensional array of unformatted values of the table row.
- type: '(boolean | string | number)[]'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a row to an existing table.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table in the current worksheet.
- const selectedSheet = workbook.getActiveWorksheet();
- const table = selectedSheet.getTables()[0];
-
- // Initialize the data to be added as a table row.
- // Note that length of the array must match the number of columns in the table.
- let rowData = ["Carrots", "Vegetable", 750];
-
- // Add a row to the end of the table.
- table.addRow(-1, rowData);
- }
- ```
- - name: 'addRows(index, values)'
- uid: 'ExcelScript!ExcelScript.Table#addRows:member(1)'
- package: ExcelScript!
- fullName: 'addRows(index, values)'
- summary: Adds one or more rows to the table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addRows(index?: number, values?: (boolean | string | number)[][]): void;'
- parameters:
- - id: index
- description: >-
- Optional. Specifies the relative position of the new row. If null or -1, the addition happens at the end.
- Any rows below the inserted row are shifted downwards. Zero-indexed.
- type: number
- - id: values
- description: Optional. A 2-dimensional array of unformatted values of the table row.
- type: '(boolean | string | number)[][]'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds multiple rows to an existing table.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table in the current worksheet.
- const selectedSheet = workbook.getActiveWorksheet();
- const table = selectedSheet.getTables()[0];
-
- // Initialize the data to be added as table rows.
- // Note that length of the array must match the number of columns in the table.
- let rowData = [["Apples", "Fruit", 5000],
- ["Celery", "Vegetable", 600],
- ["Onions", "Vegetable", 1500]];
-
- // Add the rows to the end of the table.
- table.addRows(-1, rowData);
- }
- ```
- - name: clearFilters()
- uid: 'ExcelScript!ExcelScript.Table#clearFilters:member(1)'
- package: ExcelScript!
- fullName: clearFilters()
- summary: Clears all the filters currently applied on the table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'clearFilters(): void;'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script clears the filters from all tables in the workbook.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get all the tables in the workbook.
- const tables = workbook.getTables();
-
- // Remove any active filters from each table.
- tables.forEach((table) => {
- table.clearFilters();
- });
- }
- ```
- - name: convertToRange()
- uid: 'ExcelScript!ExcelScript.Table#convertToRange:member(1)'
- package: ExcelScript!
- fullName: convertToRange()
- summary: Converts the table into a normal range of cells. All data is preserved.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'convertToRange(): Range;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script converts a table to a range and removes the formatting.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table in the current worksheet.
- const selectedSheet = workbook.getActiveWorksheet();
- const table = selectedSheet.getTables()[0];
-
- // Convert the table to a range.
- const formerTable = table.convertToRange();
-
- // Remove the formatting from the table
- formerTable.clear(ExcelScript.ClearApplyTo.formats);
- }
- ```
- - name: delete()
- uid: 'ExcelScript!ExcelScript.Table#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: Deletes the table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script deletes a table.
- * This removes all associated data and formatting.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the table named "Inventory".
- const table = workbook.getTable("Inventory");
-
- // Delete the table.
- table.delete();
- }
- ```
- - name: 'deleteRowsAt(index, count)'
- uid: 'ExcelScript!ExcelScript.Table#deleteRowsAt:member(1)'
- package: ExcelScript!
- fullName: 'deleteRowsAt(index, count)'
- summary: Delete a specified number of rows at a given index.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'deleteRowsAt(index: number, count?: number): void;'
- parameters:
- - id: index
- description: >-
- The index value of the row to be deleted. Caution: the index of the row may have moved from the time you
- determined the value to use for removal.
- type: number
- - id: count
- description: >-
- Number of rows to delete. By default, a single row will be deleted. Note: Deleting more than 1000 rows at
- the same time could result in a Power Automate timeout.
- type: number
- return:
- type: void
- description: ''
- - name: getAutoFilter()
- uid: 'ExcelScript!ExcelScript.Table#getAutoFilter:member(1)'
- package: ExcelScript!
- fullName: getAutoFilter()
- summary: Represents the `AutoFilter` object of the table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAutoFilter(): AutoFilter;'
- return:
- type: ''
- description: ''
- - name: getColumn(key)
- uid: 'ExcelScript!ExcelScript.Table#getColumn:member(1)'
- package: ExcelScript!
- fullName: getColumn(key)
- summary: 'Gets a column object by name or ID. If the column doesn''t exist, then this method returns `undefined`.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColumn(key: number | string): TableColumn | undefined;'
- parameters:
- - id: key
- description: Column name or ID.
- type: number | string
- return:
- type: ' | undefined'
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adjusts the indentation of a specific table column.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table in the current worksheet.
- const selectedSheet = workbook.getActiveWorksheet();
- const table = selectedSheet.getTables()[0];
-
- // Get the data range of the second column.
- const secondColumn = table.getColumn(2);
- const data = secondColumn.getRangeBetweenHeaderAndTotal();
-
- // Add an indentation of 1 character space to the data range.
- data.getFormat().adjustIndent(1);
- }
- ```
- - name: getColumnById(key)
- uid: 'ExcelScript!ExcelScript.Table#getColumnById:member(1)'
- package: ExcelScript!
- fullName: getColumnById(key)
- summary: 'Gets a column object by ID. If the column does not exist, will return undefined.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColumnById(key: number): TableColumn | undefined;'
- parameters:
- - id: key
- description: Column ID.
- type: number
- return:
- type: ' | undefined'
- description: ''
- - name: getColumnByName(key)
- uid: 'ExcelScript!ExcelScript.Table#getColumnByName:member(1)'
- package: ExcelScript!
- fullName: getColumnByName(key)
- summary: 'Gets a column object by Name. If the column does not exist, will return undefined.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColumnByName(key: string): TableColumn | undefined;'
- parameters:
- - id: key
- description: Column Name.
- type: string
- return:
- type: ' | undefined'
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script removes a specific column from a table.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the table named "Inventory".
- const table = workbook.getTable("Inventory");
-
- // If it exists, remove the column named "Category".
- let categoryColumn = table.getColumnByName("Category");
- if (categoryColumn) {
- categoryColumn.delete();
- }
- }
- ```
- - name: getColumns()
- uid: 'ExcelScript!ExcelScript.Table#getColumns:member(1)'
- package: ExcelScript!
- fullName: getColumns()
- summary: Represents a collection of all the columns in the table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getColumns(): TableColumn[];'
- return:
- type: '[]'
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a new column to a table.
- * It then sets the formulas in the new column to be the product
- * of the values in the two preceding columns.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table in the workbook.
- const table = workbook.getTables()[0];
-
- // Append an empty column to the table with the header "Total".
- const totalColumn = table.addColumn(-1, null, "Total");
-
- // Get the names of the two preceding columns.
- const productColumnName1 = table.getColumns()[totalColumn.getIndex() - 1].getName();
- const productColumnName2 = table.getColumns()[totalColumn.getIndex() - 2].getName();
-
- // Set the formulas in the "Total" column to be the product of the two preceding columns.
- totalColumn.getRangeBetweenHeaderAndTotal().setFormula(
- `=[@[${productColumnName1}]]*[@[${productColumnName2}]]`
- );
- }
- ```
- - name: getHeaderRowRange()
- uid: 'ExcelScript!ExcelScript.Table#getHeaderRowRange:member(1)'
- package: ExcelScript!
- fullName: getHeaderRowRange()
- summary: Gets the range object associated with the header row of the table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHeaderRowRange(): Range;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script centers the text in a table's header row cells.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table on the current worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const table = currentSheet.getTables()[0];
-
- // Get the header range.
- const headerRange = table.getHeaderRowRange();
-
- // Set the horizontal text alignment to `center`.
- headerRange.getFormat().setHorizontalAlignment(ExcelScript.HorizontalAlignment.center);
- }
- ```
- - name: getHighlightFirstColumn()
- uid: 'ExcelScript!ExcelScript.Table#getHighlightFirstColumn:member(1)'
- package: ExcelScript!
- fullName: getHighlightFirstColumn()
- summary: Specifies if the first column contains special formatting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHighlightFirstColumn(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getHighlightLastColumn()
- uid: 'ExcelScript!ExcelScript.Table#getHighlightLastColumn:member(1)'
- package: ExcelScript!
- fullName: getHighlightLastColumn()
- summary: Specifies if the last column contains special formatting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHighlightLastColumn(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getId()
- uid: 'ExcelScript!ExcelScript.Table#getId:member(1)'
- package: ExcelScript!
- fullName: getId()
- summary: >-
- Returns a value that uniquely identifies the table in a given workbook. The value of the identifier remains the
- same even when the table is renamed.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getId(): string;'
- return:
- type: string
- description: ''
- - name: getLegacyId()
- uid: 'ExcelScript!ExcelScript.Table#getLegacyId:member(1)'
- package: ExcelScript!
- fullName: getLegacyId()
- summary: Returns a numeric ID.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLegacyId(): string;'
- return:
- type: string
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.Table#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: Name of the table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: getPredefinedTableStyle()
- uid: 'ExcelScript!ExcelScript.Table#getPredefinedTableStyle:member(1)'
- package: ExcelScript!
- fullName: getPredefinedTableStyle()
- summary: >-
- Constant value that represents the table style. Possible values are: "TableStyleLight1" through
- "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through
- "TableStyleDark11". A custom user-defined style present in the workbook can also be specified.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPredefinedTableStyle(): string;'
- return:
- type: string
- description: ''
- - name: getRange()
- uid: 'ExcelScript!ExcelScript.Table#getRange:member(1)'
- package: ExcelScript!
- fullName: getRange()
- summary: Gets the range object associated with the entire table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRange(): Range;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script removes any extra formatting that's been applied to a table.
- * This leaves only the base table style effects.
- * Any formatting outside of the table will be left as is.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table on the current worksheet.
- let worksheet = workbook.getActiveWorksheet();
- let table = worksheet.getTables()[0];
-
- // Get the range used by the table.
- let range = table.getRange();
-
- // Clear all the formatting that is not applied by the table and the table style.
- range.clear(ExcelScript.ClearApplyTo.formats);
- }
- ```
- - name: getRangeBetweenHeaderAndTotal()
- uid: 'ExcelScript!ExcelScript.Table#getRangeBetweenHeaderAndTotal:member(1)'
- package: ExcelScript!
- fullName: getRangeBetweenHeaderAndTotal()
- summary: Gets the range object associated with the data body of the table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRangeBetweenHeaderAndTotal(): Range;'
- return:
- type: ''
- description: ''
- - name: getRowCount()
- uid: 'ExcelScript!ExcelScript.Table#getRowCount:member(1)'
- package: ExcelScript!
- fullName: getRowCount()
- summary: Gets the number of rows in the table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRowCount(): number;'
- return:
- type: number
- description: ''
- - name: getShowBandedColumns()
- uid: 'ExcelScript!ExcelScript.Table#getShowBandedColumns:member(1)'
- package: ExcelScript!
- fullName: getShowBandedColumns()
- summary: >-
- Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones,
- to make reading the table easier.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowBandedColumns(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowBandedRows()
- uid: 'ExcelScript!ExcelScript.Table#getShowBandedRows:member(1)'
- package: ExcelScript!
- fullName: getShowBandedRows()
- summary: >-
- Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make
- reading the table easier.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowBandedRows(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowFilterButton()
- uid: 'ExcelScript!ExcelScript.Table#getShowFilterButton:member(1)'
- package: ExcelScript!
- fullName: getShowFilterButton()
- summary: >-
- Specifies if the filter buttons are visible at the top of each column header. Setting this is only allowed if the
- table contains a header row.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowFilterButton(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowHeaders()
- uid: 'ExcelScript!ExcelScript.Table#getShowHeaders:member(1)'
- package: ExcelScript!
- fullName: getShowHeaders()
- summary: Specifies if the header row is visible. This value can be set to show or remove the header row.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowHeaders(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowTotals()
- uid: 'ExcelScript!ExcelScript.Table#getShowTotals:member(1)'
- package: ExcelScript!
- fullName: getShowTotals()
- summary: Specifies if the total row is visible. This value can be set to show or remove the total row.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowTotals(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getSort()
- uid: 'ExcelScript!ExcelScript.Table#getSort:member(1)'
- package: ExcelScript!
- fullName: getSort()
- summary: Represents the sorting for the table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSort(): TableSort;'
- return:
- type: ''
- description: ''
- - name: getTotalRowRange()
- uid: 'ExcelScript!ExcelScript.Table#getTotalRowRange:member(1)'
- package: ExcelScript!
- fullName: getTotalRowRange()
- summary: Gets the range object associated with the totals row of the table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTotalRowRange(): Range;'
- return:
- type: ''
- description: ''
- - name: getWorksheet()
- uid: 'ExcelScript!ExcelScript.Table#getWorksheet:member(1)'
- package: ExcelScript!
- fullName: getWorksheet()
- summary: The worksheet containing the current table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWorksheet(): Worksheet;'
- return:
- type: ''
- description: ''
- - name: reapplyFilters()
- uid: 'ExcelScript!ExcelScript.Table#reapplyFilters:member(1)'
- package: ExcelScript!
- fullName: reapplyFilters()
- summary: Reapplies all the filters currently on the table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'reapplyFilters(): void;'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script reapplies the filters on every table in the workbook.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get all the tables.
- const tables = workbook.getTables();
-
- // Iterate over every table.
- tables.forEach((table) => {
- // Reapply the filters to account for new table entries.
- table.reapplyFilters();
- });
- }
- ```
- - name: resize(newRange)
- uid: 'ExcelScript!ExcelScript.Table#resize:member(1)'
- package: ExcelScript!
- fullName: resize(newRange)
- summary: >-
- Resize the table to the new range. The new range must overlap with the original table range and the headers (or
- the top of the table) must be in the same row.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'resize(newRange: Range | string): void;'
- parameters:
- - id: newRange
- description: The range object or range address that will be used to determine the new size of the table.
- type: ' | string'
- return:
- type: void
- description: ''
- - name: setHighlightFirstColumn(highlightFirstColumn)
- uid: 'ExcelScript!ExcelScript.Table#setHighlightFirstColumn:member(1)'
- package: ExcelScript!
- fullName: setHighlightFirstColumn(highlightFirstColumn)
- summary: Specifies if the first column contains special formatting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setHighlightFirstColumn(highlightFirstColumn: boolean): void;'
- parameters:
- - id: highlightFirstColumn
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setHighlightLastColumn(highlightLastColumn)
- uid: 'ExcelScript!ExcelScript.Table#setHighlightLastColumn:member(1)'
- package: ExcelScript!
- fullName: setHighlightLastColumn(highlightLastColumn)
- summary: Specifies if the last column contains special formatting.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setHighlightLastColumn(highlightLastColumn: boolean): void;'
- parameters:
- - id: highlightLastColumn
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setName(name)
- uid: 'ExcelScript!ExcelScript.Table#setName:member(1)'
- package: ExcelScript!
- fullName: setName(name)
- summary: Name of the table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setName(name: string): void;'
- parameters:
- - id: name
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setPredefinedTableStyle(predefinedTableStyle)
- uid: 'ExcelScript!ExcelScript.Table#setPredefinedTableStyle:member(1)'
- package: ExcelScript!
- fullName: setPredefinedTableStyle(predefinedTableStyle)
- summary: >-
- Constant value that represents the table style. Possible values are: "TableStyleLight1" through
- "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through
- "TableStyleDark11". A custom user-defined style present in the workbook can also be specified.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPredefinedTableStyle(predefinedTableStyle: string): void;'
- parameters:
- - id: predefinedTableStyle
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setShowBandedColumns(showBandedColumns)
- uid: 'ExcelScript!ExcelScript.Table#setShowBandedColumns:member(1)'
- package: ExcelScript!
- fullName: setShowBandedColumns(showBandedColumns)
- summary: >-
- Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones,
- to make reading the table easier.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowBandedColumns(showBandedColumns: boolean): void;'
- parameters:
- - id: showBandedColumns
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowBandedRows(showBandedRows)
- uid: 'ExcelScript!ExcelScript.Table#setShowBandedRows:member(1)'
- package: ExcelScript!
- fullName: setShowBandedRows(showBandedRows)
- summary: >-
- Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make
- reading the table easier.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowBandedRows(showBandedRows: boolean): void;'
- parameters:
- - id: showBandedRows
- description: ''
- type: boolean
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets all the tables in the workbook to have banded rows.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get all the tables.
- const tables = workbook.getTables();
-
- // For each table, set the banded row formatting to true.
- tables.forEach((table) => {
- table.setShowBandedRows(true);
- });
- }
- ```
- - name: setShowFilterButton(showFilterButton)
- uid: 'ExcelScript!ExcelScript.Table#setShowFilterButton:member(1)'
- package: ExcelScript!
- fullName: setShowFilterButton(showFilterButton)
- summary: >-
- Specifies if the filter buttons are visible at the top of each column header. Setting this is only allowed if the
- table contains a header row.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowFilterButton(showFilterButton: boolean): void;'
- parameters:
- - id: showFilterButton
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowHeaders(showHeaders)
- uid: 'ExcelScript!ExcelScript.Table#setShowHeaders:member(1)'
- package: ExcelScript!
- fullName: setShowHeaders(showHeaders)
- summary: Specifies if the header row is visible. This value can be set to show or remove the header row.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowHeaders(showHeaders: boolean): void;'
- parameters:
- - id: showHeaders
- description: ''
- type: boolean
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script makes a table's headers not visible in the grid.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the table named "CoverageTable".
- const coverageTable = workbook.getTable("CoverageTable");
-
- // Make the header row not visible.
- coverageTable.setShowHeaders(false);
- }
- ```
- - name: setShowTotals(showTotals)
- uid: 'ExcelScript!ExcelScript.Table#setShowTotals:member(1)'
- package: ExcelScript!
- fullName: setShowTotals(showTotals)
- summary: Specifies if the total row is visible. This value can be set to show or remove the total row.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowTotals(showTotals: boolean): void;'
- parameters:
- - id: showTotals
- description: ''
- type: boolean
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds the Total Row to an existing table.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table in the current worksheet.
- const selectedSheet = workbook.getActiveWorksheet();
- const table = selectedSheet.getTables()[0];
-
- // Set the Total Row to show.
- table.setShowTotals(true);
- }
- ```
+### YamlMime:TSType
+name: ExcelScript.Table
+uid: 'ExcelScript!ExcelScript.Table:interface'
+package: ExcelScript!
+fullName: ExcelScript.Table
+summary: Represents an Excel table.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a table from the current sheet's used range.
+ * It then adds a total row to the table with the SUM of the last column.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the used range of the current worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const range = sheet.getUsedRange();
+
+ // Create a table that has headers from that range.
+ const table = sheet.addTable(range, true);
+
+ // Have the table display the SUM for the last column.
+ table.setShowTotals(true);
+ const lastColumn = table.getColumn(table.getColumns().length);
+ lastColumn.getTotalRowRange().setFormula(`=SUBTOTAL(109,[${lastColumn.getName()}])`);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: 'addColumn(index, values, name)'
+ uid: 'ExcelScript!ExcelScript.Table#addColumn:member(1)'
+ package: ExcelScript!
+ fullName: 'addColumn(index, values, name)'
+ summary: Adds a new column to the table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ addColumn(
+ index?: number,
+ values?: (boolean | string | number)[],
+ name?: string
+ ): TableColumn;
+ parameters:
+ - id: index
+ description: >-
+ Optional. Specifies the relative position of the new column. If null or -1, the addition happens at the end.
+ Columns with a higher index will be shifted to the side. Zero-indexed.
+ type: number
+ - id: values
+ description: Optional. A 1-dimensional array of unformatted values of the table column.
+ type: '(boolean | string | number)[]'
+ - id: name
+ description: 'Optional. Specifies the name of the new column. If null, the default name will be used.'
+ type: string
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a new column to a table.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table in the workbook.
+ const table = workbook.getTables()[0];
+
+ // Append an empty column to the table with the header "Total".
+ table.addColumn(-1, null, "Total");
+ }
+ ```
+ - name: 'addRow(index, values)'
+ uid: 'ExcelScript!ExcelScript.Table#addRow:member(1)'
+ package: ExcelScript!
+ fullName: 'addRow(index, values)'
+ summary: Adds one row to the table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addRow(index?: number, values?: (boolean | string | number)[]): void;'
+ parameters:
+ - id: index
+ description: >-
+ Optional. Specifies the relative position of the new row. If null or -1, the addition happens at the end.
+ Any rows below the inserted row are shifted downwards. Zero-indexed.
+ type: number
+ - id: values
+ description: Optional. A 1-dimensional array of unformatted values of the table row.
+ type: '(boolean | string | number)[]'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a row to an existing table.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table in the current worksheet.
+ const selectedSheet = workbook.getActiveWorksheet();
+ const table = selectedSheet.getTables()[0];
+
+ // Initialize the data to be added as a table row.
+ // Note that length of the array must match the number of columns in the table.
+ let rowData = ["Carrots", "Vegetable", 750];
+
+ // Add a row to the end of the table.
+ table.addRow(-1, rowData);
+ }
+ ```
+ - name: 'addRows(index, values)'
+ uid: 'ExcelScript!ExcelScript.Table#addRows:member(1)'
+ package: ExcelScript!
+ fullName: 'addRows(index, values)'
+ summary: Adds one or more rows to the table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addRows(index?: number, values?: (boolean | string | number)[][]): void;'
+ parameters:
+ - id: index
+ description: >-
+ Optional. Specifies the relative position of the new row. If null or -1, the addition happens at the end.
+ Any rows below the inserted row are shifted downwards. Zero-indexed.
+ type: number
+ - id: values
+ description: Optional. A 2-dimensional array of unformatted values of the table row.
+ type: '(boolean | string | number)[][]'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds multiple rows to an existing table.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table in the current worksheet.
+ const selectedSheet = workbook.getActiveWorksheet();
+ const table = selectedSheet.getTables()[0];
+
+ // Initialize the data to be added as table rows.
+ // Note that length of the array must match the number of columns in the table.
+ let rowData = [["Apples", "Fruit", 5000],
+ ["Celery", "Vegetable", 600],
+ ["Onions", "Vegetable", 1500]];
+
+ // Add the rows to the end of the table.
+ table.addRows(-1, rowData);
+ }
+ ```
+ - name: clearFilters()
+ uid: 'ExcelScript!ExcelScript.Table#clearFilters:member(1)'
+ package: ExcelScript!
+ fullName: clearFilters()
+ summary: Clears all the filters currently applied on the table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clearFilters(): void;'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script clears the filters from all tables in the workbook.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get all the tables in the workbook.
+ const tables = workbook.getTables();
+
+ // Remove any active filters from each table.
+ tables.forEach((table) => {
+ table.clearFilters();
+ });
+ }
+ ```
+ - name: convertToRange()
+ uid: 'ExcelScript!ExcelScript.Table#convertToRange:member(1)'
+ package: ExcelScript!
+ fullName: convertToRange()
+ summary: Converts the table into a normal range of cells. All data is preserved.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'convertToRange(): Range;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script converts a table to a range and removes the formatting.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table in the current worksheet.
+ const selectedSheet = workbook.getActiveWorksheet();
+ const table = selectedSheet.getTables()[0];
+
+ // Convert the table to a range.
+ const formerTable = table.convertToRange();
+
+ // Remove the formatting from the table
+ formerTable.clear(ExcelScript.ClearApplyTo.formats);
+ }
+ ```
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.Table#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: Deletes the table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script deletes a table.
+ * This removes all associated data and formatting.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the table named "Inventory".
+ const table = workbook.getTable("Inventory");
+
+ // Delete the table.
+ table.delete();
+ }
+ ```
+ - name: 'deleteRowsAt(index, count)'
+ uid: 'ExcelScript!ExcelScript.Table#deleteRowsAt:member(1)'
+ package: ExcelScript!
+ fullName: 'deleteRowsAt(index, count)'
+ summary: Delete a specified number of rows at a given index.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'deleteRowsAt(index: number, count?: number): void;'
+ parameters:
+ - id: index
+ description: >-
+ The index value of the row to be deleted. Caution: the index of the row may have moved from the time you
+ determined the value to use for removal.
+ type: number
+ - id: count
+ description: >-
+ Number of rows to delete. By default, a single row will be deleted. Note: Deleting more than 1000 rows at
+ the same time could result in a Power Automate timeout.
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: getAutoFilter()
+ uid: 'ExcelScript!ExcelScript.Table#getAutoFilter:member(1)'
+ package: ExcelScript!
+ fullName: getAutoFilter()
+ summary: Represents the `AutoFilter` object of the table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAutoFilter(): AutoFilter;'
+ return:
+ type: ''
+ description: ''
+ - name: getColumn(key)
+ uid: 'ExcelScript!ExcelScript.Table#getColumn:member(1)'
+ package: ExcelScript!
+ fullName: getColumn(key)
+ summary: 'Gets a column object by name or ID. If the column doesn''t exist, then this method returns `undefined`.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColumn(key: number | string): TableColumn | undefined;'
+ parameters:
+ - id: key
+ description: Column name or ID.
+ type: number | string
+ return:
+ type: ' | undefined'
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adjusts the indentation of a specific table column.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table in the current worksheet.
+ const selectedSheet = workbook.getActiveWorksheet();
+ const table = selectedSheet.getTables()[0];
+
+ // Get the data range of the second column.
+ const secondColumn = table.getColumn(2);
+ const data = secondColumn.getRangeBetweenHeaderAndTotal();
+
+ // Add an indentation of 1 character space to the data range.
+ data.getFormat().adjustIndent(1);
+ }
+ ```
+ - name: getColumnById(key)
+ uid: 'ExcelScript!ExcelScript.Table#getColumnById:member(1)'
+ package: ExcelScript!
+ fullName: getColumnById(key)
+ summary: 'Gets a column object by ID. If the column does not exist, will return undefined.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColumnById(key: number): TableColumn | undefined;'
+ parameters:
+ - id: key
+ description: Column ID.
+ type: number
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getColumnByName(key)
+ uid: 'ExcelScript!ExcelScript.Table#getColumnByName:member(1)'
+ package: ExcelScript!
+ fullName: getColumnByName(key)
+ summary: 'Gets a column object by Name. If the column does not exist, will return undefined.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColumnByName(key: string): TableColumn | undefined;'
+ parameters:
+ - id: key
+ description: Column Name.
+ type: string
+ return:
+ type: ' | undefined'
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script removes a specific column from a table.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the table named "Inventory".
+ const table = workbook.getTable("Inventory");
+
+ // If it exists, remove the column named "Category".
+ let categoryColumn = table.getColumnByName("Category");
+ if (categoryColumn) {
+ categoryColumn.delete();
+ }
+ }
+ ```
+ - name: getColumns()
+ uid: 'ExcelScript!ExcelScript.Table#getColumns:member(1)'
+ package: ExcelScript!
+ fullName: getColumns()
+ summary: Represents a collection of all the columns in the table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getColumns(): TableColumn[];'
+ return:
+ type: '[]'
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a new column to a table.
+ * It then sets the formulas in the new column to be the product
+ * of the values in the two preceding columns.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table in the workbook.
+ const table = workbook.getTables()[0];
+
+ // Append an empty column to the table with the header "Total".
+ const totalColumn = table.addColumn(-1, null, "Total");
+
+ // Get the names of the two preceding columns.
+ const productColumnName1 = table.getColumns()[totalColumn.getIndex() - 1].getName();
+ const productColumnName2 = table.getColumns()[totalColumn.getIndex() - 2].getName();
+
+ // Set the formulas in the "Total" column to be the product of the two preceding columns.
+ totalColumn.getRangeBetweenHeaderAndTotal().setFormula(
+ `=[@[${productColumnName1}]]*[@[${productColumnName2}]]`
+ );
+ }
+ ```
+ - name: getHeaderRowRange()
+ uid: 'ExcelScript!ExcelScript.Table#getHeaderRowRange:member(1)'
+ package: ExcelScript!
+ fullName: getHeaderRowRange()
+ summary: Gets the range object associated with the header row of the table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHeaderRowRange(): Range;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script centers the text in a table's header row cells.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table on the current worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const table = currentSheet.getTables()[0];
+
+ // Get the header range.
+ const headerRange = table.getHeaderRowRange();
+
+ // Set the horizontal text alignment to `center`.
+ headerRange.getFormat().setHorizontalAlignment(ExcelScript.HorizontalAlignment.center);
+ }
+ ```
+ - name: getHighlightFirstColumn()
+ uid: 'ExcelScript!ExcelScript.Table#getHighlightFirstColumn:member(1)'
+ package: ExcelScript!
+ fullName: getHighlightFirstColumn()
+ summary: Specifies if the first column contains special formatting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHighlightFirstColumn(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getHighlightLastColumn()
+ uid: 'ExcelScript!ExcelScript.Table#getHighlightLastColumn:member(1)'
+ package: ExcelScript!
+ fullName: getHighlightLastColumn()
+ summary: Specifies if the last column contains special formatting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHighlightLastColumn(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getId()
+ uid: 'ExcelScript!ExcelScript.Table#getId:member(1)'
+ package: ExcelScript!
+ fullName: getId()
+ summary: >-
+ Returns a value that uniquely identifies the table in a given workbook. The value of the identifier remains the
+ same even when the table is renamed.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getId(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getLegacyId()
+ uid: 'ExcelScript!ExcelScript.Table#getLegacyId:member(1)'
+ package: ExcelScript!
+ fullName: getLegacyId()
+ summary: Returns a numeric ID.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLegacyId(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.Table#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: Name of the table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getPredefinedTableStyle()
+ uid: 'ExcelScript!ExcelScript.Table#getPredefinedTableStyle:member(1)'
+ package: ExcelScript!
+ fullName: getPredefinedTableStyle()
+ summary: >-
+ Constant value that represents the table style. Possible values are: "TableStyleLight1" through
+ "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through
+ "TableStyleDark11". A custom user-defined style present in the workbook can also be specified.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPredefinedTableStyle(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getRange()
+ uid: 'ExcelScript!ExcelScript.Table#getRange:member(1)'
+ package: ExcelScript!
+ fullName: getRange()
+ summary: Gets the range object associated with the entire table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRange(): Range;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script removes any extra formatting that's been applied to a table.
+ * This leaves only the base table style effects.
+ * Any formatting outside of the table will be left as is.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table on the current worksheet.
+ let worksheet = workbook.getActiveWorksheet();
+ let table = worksheet.getTables()[0];
+
+ // Get the range used by the table.
+ let range = table.getRange();
+
+ // Clear all the formatting that is not applied by the table and the table style.
+ range.clear(ExcelScript.ClearApplyTo.formats);
+ }
+ ```
+ - name: getRangeBetweenHeaderAndTotal()
+ uid: 'ExcelScript!ExcelScript.Table#getRangeBetweenHeaderAndTotal:member(1)'
+ package: ExcelScript!
+ fullName: getRangeBetweenHeaderAndTotal()
+ summary: Gets the range object associated with the data body of the table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRangeBetweenHeaderAndTotal(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getRowCount()
+ uid: 'ExcelScript!ExcelScript.Table#getRowCount:member(1)'
+ package: ExcelScript!
+ fullName: getRowCount()
+ summary: Gets the number of rows in the table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRowCount(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getShowBandedColumns()
+ uid: 'ExcelScript!ExcelScript.Table#getShowBandedColumns:member(1)'
+ package: ExcelScript!
+ fullName: getShowBandedColumns()
+ summary: >-
+ Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones,
+ to make reading the table easier.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowBandedColumns(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowBandedRows()
+ uid: 'ExcelScript!ExcelScript.Table#getShowBandedRows:member(1)'
+ package: ExcelScript!
+ fullName: getShowBandedRows()
+ summary: >-
+ Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make
+ reading the table easier.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowBandedRows(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowFilterButton()
+ uid: 'ExcelScript!ExcelScript.Table#getShowFilterButton:member(1)'
+ package: ExcelScript!
+ fullName: getShowFilterButton()
+ summary: >-
+ Specifies if the filter buttons are visible at the top of each column header. Setting this is only allowed if the
+ table contains a header row.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowFilterButton(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowHeaders()
+ uid: 'ExcelScript!ExcelScript.Table#getShowHeaders:member(1)'
+ package: ExcelScript!
+ fullName: getShowHeaders()
+ summary: Specifies if the header row is visible. This value can be set to show or remove the header row.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowHeaders(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowTotals()
+ uid: 'ExcelScript!ExcelScript.Table#getShowTotals:member(1)'
+ package: ExcelScript!
+ fullName: getShowTotals()
+ summary: Specifies if the total row is visible. This value can be set to show or remove the total row.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowTotals(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getSort()
+ uid: 'ExcelScript!ExcelScript.Table#getSort:member(1)'
+ package: ExcelScript!
+ fullName: getSort()
+ summary: Represents the sorting for the table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSort(): TableSort;'
+ return:
+ type: ''
+ description: ''
+ - name: getTotalRowRange()
+ uid: 'ExcelScript!ExcelScript.Table#getTotalRowRange:member(1)'
+ package: ExcelScript!
+ fullName: getTotalRowRange()
+ summary: Gets the range object associated with the totals row of the table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTotalRowRange(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getWorksheet()
+ uid: 'ExcelScript!ExcelScript.Table#getWorksheet:member(1)'
+ package: ExcelScript!
+ fullName: getWorksheet()
+ summary: The worksheet containing the current table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWorksheet(): Worksheet;'
+ return:
+ type: ''
+ description: ''
+ - name: reapplyFilters()
+ uid: 'ExcelScript!ExcelScript.Table#reapplyFilters:member(1)'
+ package: ExcelScript!
+ fullName: reapplyFilters()
+ summary: Reapplies all the filters currently on the table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'reapplyFilters(): void;'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script reapplies the filters on every table in the workbook.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get all the tables.
+ const tables = workbook.getTables();
+
+ // Iterate over every table.
+ tables.forEach((table) => {
+ // Reapply the filters to account for new table entries.
+ table.reapplyFilters();
+ });
+ }
+ ```
+ - name: resize(newRange)
+ uid: 'ExcelScript!ExcelScript.Table#resize:member(1)'
+ package: ExcelScript!
+ fullName: resize(newRange)
+ summary: >-
+ Resize the table to the new range. The new range must overlap with the original table range and the headers (or
+ the top of the table) must be in the same row.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'resize(newRange: Range | string): void;'
+ parameters:
+ - id: newRange
+ description: The range object or range address that will be used to determine the new size of the table.
+ type: ' | string'
+ return:
+ type: void
+ description: ''
+ - name: setHighlightFirstColumn(highlightFirstColumn)
+ uid: 'ExcelScript!ExcelScript.Table#setHighlightFirstColumn:member(1)'
+ package: ExcelScript!
+ fullName: setHighlightFirstColumn(highlightFirstColumn)
+ summary: Specifies if the first column contains special formatting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setHighlightFirstColumn(highlightFirstColumn: boolean): void;'
+ parameters:
+ - id: highlightFirstColumn
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setHighlightLastColumn(highlightLastColumn)
+ uid: 'ExcelScript!ExcelScript.Table#setHighlightLastColumn:member(1)'
+ package: ExcelScript!
+ fullName: setHighlightLastColumn(highlightLastColumn)
+ summary: Specifies if the last column contains special formatting.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setHighlightLastColumn(highlightLastColumn: boolean): void;'
+ parameters:
+ - id: highlightLastColumn
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setName(name)
+ uid: 'ExcelScript!ExcelScript.Table#setName:member(1)'
+ package: ExcelScript!
+ fullName: setName(name)
+ summary: Name of the table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setName(name: string): void;'
+ parameters:
+ - id: name
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setPredefinedTableStyle(predefinedTableStyle)
+ uid: 'ExcelScript!ExcelScript.Table#setPredefinedTableStyle:member(1)'
+ package: ExcelScript!
+ fullName: setPredefinedTableStyle(predefinedTableStyle)
+ summary: >-
+ Constant value that represents the table style. Possible values are: "TableStyleLight1" through
+ "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through
+ "TableStyleDark11". A custom user-defined style present in the workbook can also be specified.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPredefinedTableStyle(predefinedTableStyle: string): void;'
+ parameters:
+ - id: predefinedTableStyle
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setShowBandedColumns(showBandedColumns)
+ uid: 'ExcelScript!ExcelScript.Table#setShowBandedColumns:member(1)'
+ package: ExcelScript!
+ fullName: setShowBandedColumns(showBandedColumns)
+ summary: >-
+ Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones,
+ to make reading the table easier.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowBandedColumns(showBandedColumns: boolean): void;'
+ parameters:
+ - id: showBandedColumns
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowBandedRows(showBandedRows)
+ uid: 'ExcelScript!ExcelScript.Table#setShowBandedRows:member(1)'
+ package: ExcelScript!
+ fullName: setShowBandedRows(showBandedRows)
+ summary: >-
+ Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make
+ reading the table easier.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowBandedRows(showBandedRows: boolean): void;'
+ parameters:
+ - id: showBandedRows
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets all the tables in the workbook to have banded rows.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get all the tables.
+ const tables = workbook.getTables();
+
+ // For each table, set the banded row formatting to true.
+ tables.forEach((table) => {
+ table.setShowBandedRows(true);
+ });
+ }
+ ```
+ - name: setShowFilterButton(showFilterButton)
+ uid: 'ExcelScript!ExcelScript.Table#setShowFilterButton:member(1)'
+ package: ExcelScript!
+ fullName: setShowFilterButton(showFilterButton)
+ summary: >-
+ Specifies if the filter buttons are visible at the top of each column header. Setting this is only allowed if the
+ table contains a header row.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowFilterButton(showFilterButton: boolean): void;'
+ parameters:
+ - id: showFilterButton
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowHeaders(showHeaders)
+ uid: 'ExcelScript!ExcelScript.Table#setShowHeaders:member(1)'
+ package: ExcelScript!
+ fullName: setShowHeaders(showHeaders)
+ summary: Specifies if the header row is visible. This value can be set to show or remove the header row.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowHeaders(showHeaders: boolean): void;'
+ parameters:
+ - id: showHeaders
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script makes a table's headers not visible in the grid.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the table named "CoverageTable".
+ const coverageTable = workbook.getTable("CoverageTable");
+
+ // Make the header row not visible.
+ coverageTable.setShowHeaders(false);
+ }
+ ```
+ - name: setShowTotals(showTotals)
+ uid: 'ExcelScript!ExcelScript.Table#setShowTotals:member(1)'
+ package: ExcelScript!
+ fullName: setShowTotals(showTotals)
+ summary: Specifies if the total row is visible. This value can be set to show or remove the total row.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowTotals(showTotals: boolean): void;'
+ parameters:
+ - id: showTotals
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds the Total Row to an existing table.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table in the current worksheet.
+ const selectedSheet = workbook.getActiveWorksheet();
+ const table = selectedSheet.getTables()[0];
+
+ // Set the Total Row to show.
+ table.setShowTotals(true);
+ }
+ ```
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.tablecolumn.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.tablecolumn.yml
index 2a6345ea..bbb299df 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.tablecolumn.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.tablecolumn.yml
@@ -1,267 +1,267 @@
-### YamlMime:TSType
-name: ExcelScript.TableColumn
-uid: 'ExcelScript!ExcelScript.TableColumn:interface'
-package: ExcelScript!
-fullName: ExcelScript.TableColumn
-summary: Represents a column in a table.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script shows how to get the range of a table column.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table in the workbook.
- const table = workbook.getTables()[0];
-
- // Get the range of the table column named "Type".
- const typeColumn : ExcelScript.TableColumn = table.getColumn("Type");
- const range = typeColumn.getRange();
-
- // Do something with the range...
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: delete()
- uid: 'ExcelScript!ExcelScript.TableColumn#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: Deletes the column from the table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script removes a specific column from a table.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the table named "Inventory".
- const table = workbook.getTable("Inventory");
-
- // If it exists, remove the column named "Category".
- let categoryColumn = table.getColumnByName("Category");
- if (categoryColumn) {
- categoryColumn.delete();
- }
- }
- ```
- - name: getFilter()
- uid: 'ExcelScript!ExcelScript.TableColumn#getFilter:member(1)'
- package: ExcelScript!
- fullName: getFilter()
- summary: Retrieves the filter applied to the column.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFilter(): Filter;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a table filter to only show the top 10% of values
- * belonging to a particular column.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table on the current worksheet.
- const table = workbook.getActiveWorksheet().getTables()[0];
-
- // Get the filter for the "PageViews" table column.
- const pageViewFilter = table.getColumnByName("PageViews").getFilter();
-
- // Apply a filter to only show the rows with the top 10% of values in this column.
- pageViewFilter.applyTopPercentFilter(10);
- }
- ```
- - name: getHeaderRowRange()
- uid: 'ExcelScript!ExcelScript.TableColumn#getHeaderRowRange:member(1)'
- package: ExcelScript!
- fullName: getHeaderRowRange()
- summary: Gets the range object associated with the header row of the column.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHeaderRowRange(): Range;'
- return:
- type: ''
- description: ''
- - name: getId()
- uid: 'ExcelScript!ExcelScript.TableColumn#getId:member(1)'
- package: ExcelScript!
- fullName: getId()
- summary: Returns a unique key that identifies the column within the table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getId(): number;'
- return:
- type: number
- description: ''
- - name: getIndex()
- uid: 'ExcelScript!ExcelScript.TableColumn#getIndex:member(1)'
- package: ExcelScript!
- fullName: getIndex()
- summary: Returns the index number of the column within the columns collection of the table. Zero-indexed.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIndex(): number;'
- return:
- type: number
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.TableColumn#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: Specifies the name of the table column.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: getRange()
- uid: 'ExcelScript!ExcelScript.TableColumn#getRange:member(1)'
- package: ExcelScript!
- fullName: getRange()
- summary: Gets the range object associated with the entire column.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRange(): Range;'
- return:
- type: ''
- description: ''
- - name: getRangeBetweenHeaderAndTotal()
- uid: 'ExcelScript!ExcelScript.TableColumn#getRangeBetweenHeaderAndTotal:member(1)'
- package: ExcelScript!
- fullName: getRangeBetweenHeaderAndTotal()
- summary: Gets the range object associated with the data body of the column.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRangeBetweenHeaderAndTotal(): Range;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a new column to a table.
- * It then sets the formulas in the new column to be the product
- * of the values in the two preceding columns.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first table in the workbook.
- const table = workbook.getTables()[0];
-
- // Append an empty column to the table with the header "Total".
- const totalColumn = table.addColumn(-1, null, "Total");
-
- // Get the names of the two preceding columns.
- const productColumnName1 = table.getColumns()[totalColumn.getIndex() - 1].getName();
- const productColumnName2 = table.getColumns()[totalColumn.getIndex() - 2].getName();
-
- // Set the formulas in the "Total" column to be the product of the two preceding columns.
- totalColumn.getRangeBetweenHeaderAndTotal().setFormula(
- `=[@[${productColumnName1}]]*[@[${productColumnName2}]]`
- );
- }
- ```
- - name: getTotalRowRange()
- uid: 'ExcelScript!ExcelScript.TableColumn#getTotalRowRange:member(1)'
- package: ExcelScript!
- fullName: getTotalRowRange()
- summary: Gets the range object associated with the totals row of the column.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTotalRowRange(): Range;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script logs the value in the total row of a table column.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the table named "Cities".
- const table = workbook.getTable("Cities");
-
- // Get the total row from the "Population" column.
- const column = table.getColumn("Population");
- const totalRange = column.getTotalRowRange();
-
- // Log the total value.
- console.log(totalRange.getValue());
- }
- ```
- - name: setName(name)
- uid: 'ExcelScript!ExcelScript.TableColumn#setName:member(1)'
- package: ExcelScript!
- fullName: setName(name)
- summary: Specifies the name of the table column.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setName(name: string): void;'
- parameters:
- - id: name
- description: ''
- type: string
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script renames a column in an existing table.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the "Employee" table.
- const employeeTable = workbook.getTable("Employee");
-
- // Rename a column from "EmplID" to "Employee ID".
- const idColumn = employeeTable.getColumnByName("EmplID");
- idColumn.setName("Employee ID");
- }
- ```
+### YamlMime:TSType
+name: ExcelScript.TableColumn
+uid: 'ExcelScript!ExcelScript.TableColumn:interface'
+package: ExcelScript!
+fullName: ExcelScript.TableColumn
+summary: Represents a column in a table.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script shows how to get the range of a table column.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table in the workbook.
+ const table = workbook.getTables()[0];
+
+ // Get the range of the table column named "Type".
+ const typeColumn : ExcelScript.TableColumn = table.getColumn("Type");
+ const range = typeColumn.getRange();
+
+ // Do something with the range...
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.TableColumn#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: Deletes the column from the table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script removes a specific column from a table.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the table named "Inventory".
+ const table = workbook.getTable("Inventory");
+
+ // If it exists, remove the column named "Category".
+ let categoryColumn = table.getColumnByName("Category");
+ if (categoryColumn) {
+ categoryColumn.delete();
+ }
+ }
+ ```
+ - name: getFilter()
+ uid: 'ExcelScript!ExcelScript.TableColumn#getFilter:member(1)'
+ package: ExcelScript!
+ fullName: getFilter()
+ summary: Retrieves the filter applied to the column.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFilter(): Filter;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a table filter to only show the top 10% of values
+ * belonging to a particular column.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table on the current worksheet.
+ const table = workbook.getActiveWorksheet().getTables()[0];
+
+ // Get the filter for the "PageViews" table column.
+ const pageViewFilter = table.getColumnByName("PageViews").getFilter();
+
+ // Apply a filter to only show the rows with the top 10% of values in this column.
+ pageViewFilter.applyTopPercentFilter(10);
+ }
+ ```
+ - name: getHeaderRowRange()
+ uid: 'ExcelScript!ExcelScript.TableColumn#getHeaderRowRange:member(1)'
+ package: ExcelScript!
+ fullName: getHeaderRowRange()
+ summary: Gets the range object associated with the header row of the column.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHeaderRowRange(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getId()
+ uid: 'ExcelScript!ExcelScript.TableColumn#getId:member(1)'
+ package: ExcelScript!
+ fullName: getId()
+ summary: Returns a unique key that identifies the column within the table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getId(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getIndex()
+ uid: 'ExcelScript!ExcelScript.TableColumn#getIndex:member(1)'
+ package: ExcelScript!
+ fullName: getIndex()
+ summary: Returns the index number of the column within the columns collection of the table. Zero-indexed.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIndex(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.TableColumn#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: Specifies the name of the table column.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getRange()
+ uid: 'ExcelScript!ExcelScript.TableColumn#getRange:member(1)'
+ package: ExcelScript!
+ fullName: getRange()
+ summary: Gets the range object associated with the entire column.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRange(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getRangeBetweenHeaderAndTotal()
+ uid: 'ExcelScript!ExcelScript.TableColumn#getRangeBetweenHeaderAndTotal:member(1)'
+ package: ExcelScript!
+ fullName: getRangeBetweenHeaderAndTotal()
+ summary: Gets the range object associated with the data body of the column.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRangeBetweenHeaderAndTotal(): Range;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a new column to a table.
+ * It then sets the formulas in the new column to be the product
+ * of the values in the two preceding columns.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first table in the workbook.
+ const table = workbook.getTables()[0];
+
+ // Append an empty column to the table with the header "Total".
+ const totalColumn = table.addColumn(-1, null, "Total");
+
+ // Get the names of the two preceding columns.
+ const productColumnName1 = table.getColumns()[totalColumn.getIndex() - 1].getName();
+ const productColumnName2 = table.getColumns()[totalColumn.getIndex() - 2].getName();
+
+ // Set the formulas in the "Total" column to be the product of the two preceding columns.
+ totalColumn.getRangeBetweenHeaderAndTotal().setFormula(
+ `=[@[${productColumnName1}]]*[@[${productColumnName2}]]`
+ );
+ }
+ ```
+ - name: getTotalRowRange()
+ uid: 'ExcelScript!ExcelScript.TableColumn#getTotalRowRange:member(1)'
+ package: ExcelScript!
+ fullName: getTotalRowRange()
+ summary: Gets the range object associated with the totals row of the column.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTotalRowRange(): Range;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script logs the value in the total row of a table column.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the table named "Cities".
+ const table = workbook.getTable("Cities");
+
+ // Get the total row from the "Population" column.
+ const column = table.getColumn("Population");
+ const totalRange = column.getTotalRowRange();
+
+ // Log the total value.
+ console.log(totalRange.getValue());
+ }
+ ```
+ - name: setName(name)
+ uid: 'ExcelScript!ExcelScript.TableColumn#setName:member(1)'
+ package: ExcelScript!
+ fullName: setName(name)
+ summary: Specifies the name of the table column.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setName(name: string): void;'
+ parameters:
+ - id: name
+ description: ''
+ type: string
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script renames a column in an existing table.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the "Employee" table.
+ const employeeTable = workbook.getTable("Employee");
+
+ // Rename a column from "EmplID" to "Employee ID".
+ const idColumn = employeeTable.getColumnByName("EmplID");
+ idColumn.setName("Employee ID");
+ }
+ ```
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.tablesort.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.tablesort.yml
index d4fb50de..680eb8ab 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.tablesort.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.tablesort.yml
@@ -1,145 +1,145 @@
-### YamlMime:TSType
-name: ExcelScript.TableSort
-uid: 'ExcelScript!ExcelScript.TableSort:interface'
-package: ExcelScript!
-fullName: ExcelScript.TableSort
-summary: Manages sorting operations on `Table` objects.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: 'apply(fields, matchCase, method)'
- uid: 'ExcelScript!ExcelScript.TableSort#apply:member(1)'
- package: ExcelScript!
- fullName: 'apply(fields, matchCase, method)'
- summary: Perform a sort operation.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- apply(
- fields: SortField[],
- matchCase?: boolean,
- method?: SortMethod
- ): void;
- parameters:
- - id: fields
- description: The list of conditions to sort on.
- type: '[]'
- - id: matchCase
- description: Optional. Whether to have the casing impact string ordering.
- type: boolean
- - id: method
- description: Optional. The ordering method used for Chinese characters.
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample creates a table from the current worksheet's used range, then sorts it based on the first column.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Create a table with the used cells.
- let usedRange = selectedSheet.getUsedRange();
- let newTable = selectedSheet.addTable(usedRange, true);
-
- // Sort the table using the first column.
- newTable.getSort().apply([{ key: 0, ascending: true }]);
- }
- ```
- - name: clear()
- uid: 'ExcelScript!ExcelScript.TableSort#clear:member(1)'
- package: ExcelScript!
- fullName: clear()
- summary: >-
- Clears the sorting that is currently on the table. While this doesn't modify the table's ordering, it clears the
- state of the header buttons.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'clear(): void;'
- return:
- type: void
- description: ''
- - name: getFields()
- uid: 'ExcelScript!ExcelScript.TableSort#getFields:member(1)'
- package: ExcelScript!
- fullName: getFields()
- summary: Specifies the current conditions used to last sort the table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFields(): SortField[];'
- return:
- type: '[]'
- description: ''
- - name: getMatchCase()
- uid: 'ExcelScript!ExcelScript.TableSort#getMatchCase:member(1)'
- package: ExcelScript!
- fullName: getMatchCase()
- summary: Specifies if the casing impacts the last sort of the table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMatchCase(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getMethod()
- uid: 'ExcelScript!ExcelScript.TableSort#getMethod:member(1)'
- package: ExcelScript!
- fullName: getMethod()
- summary: Represents the Chinese character ordering method last used to sort the table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMethod(): SortMethod;'
- return:
- type: ''
- description: ''
- - name: reapply()
- uid: 'ExcelScript!ExcelScript.TableSort#reapply:member(1)'
- package: ExcelScript!
- fullName: reapply()
- summary: Reapplies the current sorting parameters to the table.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'reapply(): void;'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script reapplies all the current sorting criteria to existing tables.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get all the tables.
- const tables = workbook.getTables();
-
- // For each table, reapply that table's current sorting parameters.
- tables.forEach((table) => {
- const sort: ExcelScript.TableSort = table.getSort();
- sort.reapply();
- });
- }
- ```
+### YamlMime:TSType
+name: ExcelScript.TableSort
+uid: 'ExcelScript!ExcelScript.TableSort:interface'
+package: ExcelScript!
+fullName: ExcelScript.TableSort
+summary: Manages sorting operations on `Table` objects.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: 'apply(fields, matchCase, method)'
+ uid: 'ExcelScript!ExcelScript.TableSort#apply:member(1)'
+ package: ExcelScript!
+ fullName: 'apply(fields, matchCase, method)'
+ summary: Perform a sort operation.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ apply(
+ fields: SortField[],
+ matchCase?: boolean,
+ method?: SortMethod
+ ): void;
+ parameters:
+ - id: fields
+ description: The list of conditions to sort on.
+ type: '[]'
+ - id: matchCase
+ description: Optional. Whether to have the casing impact string ordering.
+ type: boolean
+ - id: method
+ description: Optional. The ordering method used for Chinese characters.
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample creates a table from the current worksheet's used range, then sorts it based on the first column.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Create a table with the used cells.
+ let usedRange = selectedSheet.getUsedRange();
+ let newTable = selectedSheet.addTable(usedRange, true);
+
+ // Sort the table using the first column.
+ newTable.getSort().apply([{ key: 0, ascending: true }]);
+ }
+ ```
+ - name: clear()
+ uid: 'ExcelScript!ExcelScript.TableSort#clear:member(1)'
+ package: ExcelScript!
+ fullName: clear()
+ summary: >-
+ Clears the sorting that is currently on the table. While this doesn't modify the table's ordering, it clears the
+ state of the header buttons.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clear(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getFields()
+ uid: 'ExcelScript!ExcelScript.TableSort#getFields:member(1)'
+ package: ExcelScript!
+ fullName: getFields()
+ summary: Specifies the current conditions used to last sort the table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFields(): SortField[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getMatchCase()
+ uid: 'ExcelScript!ExcelScript.TableSort#getMatchCase:member(1)'
+ package: ExcelScript!
+ fullName: getMatchCase()
+ summary: Specifies if the casing impacts the last sort of the table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMatchCase(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getMethod()
+ uid: 'ExcelScript!ExcelScript.TableSort#getMethod:member(1)'
+ package: ExcelScript!
+ fullName: getMethod()
+ summary: Represents the Chinese character ordering method last used to sort the table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMethod(): SortMethod;'
+ return:
+ type: ''
+ description: ''
+ - name: reapply()
+ uid: 'ExcelScript!ExcelScript.TableSort#reapply:member(1)'
+ package: ExcelScript!
+ fullName: reapply()
+ summary: Reapplies the current sorting parameters to the table.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'reapply(): void;'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script reapplies all the current sorting criteria to existing tables.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get all the tables.
+ const tables = workbook.getTables();
+
+ // For each table, reapply that table's current sorting parameters.
+ tables.forEach((table) => {
+ const sort: ExcelScript.TableSort = table.getSort();
+ sort.reapply();
+ });
+ }
+ ```
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.tablestyle.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.tablestyle.yml
index d9d0c413..b1fca9ea 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.tablestyle.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.tablestyle.yml
@@ -1,80 +1,80 @@
-### YamlMime:TSType
-name: ExcelScript.TableStyle
-uid: 'ExcelScript!ExcelScript.TableStyle:interface'
-package: ExcelScript!
-fullName: ExcelScript.TableStyle
-summary: 'Represents a table style, which defines the style elements by region of the table.'
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: delete()
- uid: 'ExcelScript!ExcelScript.TableStyle#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: Deletes the table style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: ''
- - name: duplicate()
- uid: 'ExcelScript!ExcelScript.TableStyle#duplicate:member(1)'
- package: ExcelScript!
- fullName: duplicate()
- summary: Creates a duplicate of this table style with copies of all the style elements.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'duplicate(): TableStyle;'
- return:
- type: ''
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.TableStyle#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: Specifies the name of the table style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: getReadOnly()
- uid: 'ExcelScript!ExcelScript.TableStyle#getReadOnly:member(1)'
- package: ExcelScript!
- fullName: getReadOnly()
- summary: Specifies if this `TableStyle` object is read-only.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getReadOnly(): boolean;'
- return:
- type: boolean
- description: ''
- - name: setName(name)
- uid: 'ExcelScript!ExcelScript.TableStyle#setName:member(1)'
- package: ExcelScript!
- fullName: setName(name)
- summary: Specifies the name of the table style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setName(name: string): void;'
- parameters:
- - id: name
- description: ''
- type: string
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.TableStyle
+uid: 'ExcelScript!ExcelScript.TableStyle:interface'
+package: ExcelScript!
+fullName: ExcelScript.TableStyle
+summary: 'Represents a table style, which defines the style elements by region of the table.'
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.TableStyle#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: Deletes the table style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: duplicate()
+ uid: 'ExcelScript!ExcelScript.TableStyle#duplicate:member(1)'
+ package: ExcelScript!
+ fullName: duplicate()
+ summary: Creates a duplicate of this table style with copies of all the style elements.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'duplicate(): TableStyle;'
+ return:
+ type: ''
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.TableStyle#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: Specifies the name of the table style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getReadOnly()
+ uid: 'ExcelScript!ExcelScript.TableStyle#getReadOnly:member(1)'
+ package: ExcelScript!
+ fullName: getReadOnly()
+ summary: Specifies if this `TableStyle` object is read-only.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getReadOnly(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: setName(name)
+ uid: 'ExcelScript!ExcelScript.TableStyle#setName:member(1)'
+ package: ExcelScript!
+ fullName: setName(name)
+ summary: Specifies the name of the table style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setName(name: string): void;'
+ parameters:
+ - id: name
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.textconditionalformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.textconditionalformat.yml
index 57fe0a45..5a8be71c 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.textconditionalformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.textconditionalformat.yml
@@ -1,83 +1,83 @@
-### YamlMime:TSType
-name: ExcelScript.TextConditionalFormat
-uid: 'ExcelScript!ExcelScript.TextConditionalFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.TextConditionalFormat
-summary: Represents a specific text conditional format.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds conditional formatting to the first column in the worksheet.
- * This formatting gives the cells a green fill if they have text starting with "Excel".
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first column in the current worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const firstColumn = currentSheet.getRange("A:A");
-
- // Add conditional formatting based on the text in the cells.
- const textConditionFormat: ExcelScript.TextConditionalFormat =
- firstColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.containsText).getTextComparison();
-
- // Set the conditional format to provide a green fill.
- textConditionFormat.getFormat().getFill().setColor("green");
-
- // Apply the condition rule that the text begins with "Excel".
- const textRule: ExcelScript.ConditionalTextComparisonRule = {
- operator: ExcelScript.ConditionalTextOperator.beginsWith,
- text: "Excel"
- };
- textConditionFormat.setRule(textRule);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getFormat()
- uid: 'ExcelScript!ExcelScript.TextConditionalFormat#getFormat:member(1)'
- package: ExcelScript!
- fullName: getFormat()
- summary: 'Returns a format object, encapsulating the conditional format''s font, fill, borders, and other properties.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormat(): ConditionalRangeFormat;'
- return:
- type: ''
- description: ''
- - name: getRule()
- uid: 'ExcelScript!ExcelScript.TextConditionalFormat#getRule:member(1)'
- package: ExcelScript!
- fullName: getRule()
- summary: The rule of the conditional format.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRule(): ConditionalTextComparisonRule;'
- return:
- type: ''
- description: ''
- - name: setRule(rule)
- uid: 'ExcelScript!ExcelScript.TextConditionalFormat#setRule:member(1)'
- package: ExcelScript!
- fullName: setRule(rule)
- summary: The rule of the conditional format.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setRule(rule: ConditionalTextComparisonRule): void;'
- parameters:
- - id: rule
- description: ''
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.TextConditionalFormat
+uid: 'ExcelScript!ExcelScript.TextConditionalFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.TextConditionalFormat
+summary: Represents a specific text conditional format.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds conditional formatting to the first column in the worksheet.
+ * This formatting gives the cells a green fill if they have text starting with "Excel".
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first column in the current worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const firstColumn = currentSheet.getRange("A:A");
+
+ // Add conditional formatting based on the text in the cells.
+ const textConditionFormat: ExcelScript.TextConditionalFormat =
+ firstColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.containsText).getTextComparison();
+
+ // Set the conditional format to provide a green fill.
+ textConditionFormat.getFormat().getFill().setColor("green");
+
+ // Apply the condition rule that the text begins with "Excel".
+ const textRule: ExcelScript.ConditionalTextComparisonRule = {
+ operator: ExcelScript.ConditionalTextOperator.beginsWith,
+ text: "Excel"
+ };
+ textConditionFormat.setRule(textRule);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getFormat()
+ uid: 'ExcelScript!ExcelScript.TextConditionalFormat#getFormat:member(1)'
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: 'Returns a format object, encapsulating the conditional format''s font, fill, borders, and other properties.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): ConditionalRangeFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getRule()
+ uid: 'ExcelScript!ExcelScript.TextConditionalFormat#getRule:member(1)'
+ package: ExcelScript!
+ fullName: getRule()
+ summary: The rule of the conditional format.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRule(): ConditionalTextComparisonRule;'
+ return:
+ type: ''
+ description: ''
+ - name: setRule(rule)
+ uid: 'ExcelScript!ExcelScript.TextConditionalFormat#setRule:member(1)'
+ package: ExcelScript!
+ fullName: setRule(rule)
+ summary: The rule of the conditional format.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setRule(rule: ConditionalTextComparisonRule): void;'
+ parameters:
+ - id: rule
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.textframe.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.textframe.yml
index c22bf5b1..0d1777d4 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.textframe.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.textframe.yml
@@ -1,433 +1,433 @@
-### YamlMime:TSType
-name: ExcelScript.TextFrame
-uid: 'ExcelScript!ExcelScript.TextFrame:interface'
-package: ExcelScript!
-fullName: ExcelScript.TextFrame
-summary: Represents the text frame of a shape object.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a star shape with the value from cell A1.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the value of A1 from the worksheet named Sheet1.
- const sheet = workbook.getWorksheet("Sheet1");
- const value = sheet.getRange("A1").getValue();
-
- // Create a Shape object that looks like a 5-pointed star.
- const star = sheet.addGeometricShape(ExcelScript.GeometricShapeType.star5);
-
- // Set the text of star and make sure the shape fits the text.
- const textFrame: ExcelScript.TextFrame = star.getTextFrame();
- textFrame.getTextRange().setText(value.toString());
- textFrame.setAutoSizeSetting(ExcelScript.ShapeAutoSize.autoSizeShapeToFitText);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: deleteText()
- uid: 'ExcelScript!ExcelScript.TextFrame#deleteText:member(1)'
- package: ExcelScript!
- fullName: deleteText()
- summary: Deletes all the text in the text frame.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'deleteText(): void;'
- return:
- type: void
- description: ''
- - name: getAutoSizeSetting()
- uid: 'ExcelScript!ExcelScript.TextFrame#getAutoSizeSetting:member(1)'
- package: ExcelScript!
- fullName: getAutoSizeSetting()
- summary: >-
- The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the
- text frame, to automatically fit the text frame to the text, or not perform any automatic sizing.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAutoSizeSetting(): ShapeAutoSize;'
- return:
- type: ''
- description: ''
- - name: getBottomMargin()
- uid: 'ExcelScript!ExcelScript.TextFrame#getBottomMargin:member(1)'
- package: ExcelScript!
- fullName: getBottomMargin()
- summary: 'Represents the bottom margin, in points, of the text frame.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBottomMargin(): number;'
- return:
- type: number
- description: ''
- - name: getHasText()
- uid: 'ExcelScript!ExcelScript.TextFrame#getHasText:member(1)'
- package: ExcelScript!
- fullName: getHasText()
- summary: Specifies if the text frame contains text.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHasText(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getHorizontalAlignment()
- uid: 'ExcelScript!ExcelScript.TextFrame#getHorizontalAlignment:member(1)'
- package: ExcelScript!
- fullName: getHorizontalAlignment()
- summary: Represents the horizontal alignment of the text frame. See `ExcelScript.ShapeTextHorizontalAlignment` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHorizontalAlignment(): ShapeTextHorizontalAlignment;'
- return:
- type: ''
- description: ''
- - name: getHorizontalOverflow()
- uid: 'ExcelScript!ExcelScript.TextFrame#getHorizontalOverflow:member(1)'
- package: ExcelScript!
- fullName: getHorizontalOverflow()
- summary: >-
- Represents the horizontal overflow behavior of the text frame. See `ExcelScript.ShapeTextHorizontalOverflow` for
- details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHorizontalOverflow(): ShapeTextHorizontalOverflow;'
- return:
- type: ''
- description: ''
- - name: getLeftMargin()
- uid: 'ExcelScript!ExcelScript.TextFrame#getLeftMargin:member(1)'
- package: ExcelScript!
- fullName: getLeftMargin()
- summary: 'Represents the left margin, in points, of the text frame.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLeftMargin(): number;'
- return:
- type: number
- description: ''
- - name: getOrientation()
- uid: 'ExcelScript!ExcelScript.TextFrame#getOrientation:member(1)'
- package: ExcelScript!
- fullName: getOrientation()
- summary: >-
- Represents the angle to which the text is oriented for the text frame. See `ExcelScript.ShapeTextOrientation` for
- details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getOrientation(): ShapeTextOrientation;'
- return:
- type: ''
- description: ''
- - name: getReadingOrder()
- uid: 'ExcelScript!ExcelScript.TextFrame#getReadingOrder:member(1)'
- package: ExcelScript!
- fullName: getReadingOrder()
- summary: >-
- Represents the reading order of the text frame, either left-to-right or right-to-left. See
- `ExcelScript.ShapeTextReadingOrder` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getReadingOrder(): ShapeTextReadingOrder;'
- return:
- type: ''
- description: ''
- - name: getRightMargin()
- uid: 'ExcelScript!ExcelScript.TextFrame#getRightMargin:member(1)'
- package: ExcelScript!
- fullName: getRightMargin()
- summary: 'Represents the right margin, in points, of the text frame.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRightMargin(): number;'
- return:
- type: number
- description: ''
- - name: getTextRange()
- uid: 'ExcelScript!ExcelScript.TextFrame#getTextRange:member(1)'
- package: ExcelScript!
- fullName: getTextRange()
- summary: >-
- Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the
- text. See `ExcelScript.TextRange` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTextRange(): TextRange;'
- return:
- type: ''
- description: ''
- - name: getTopMargin()
- uid: 'ExcelScript!ExcelScript.TextFrame#getTopMargin:member(1)'
- package: ExcelScript!
- fullName: getTopMargin()
- summary: 'Represents the top margin, in points, of the text frame.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTopMargin(): number;'
- return:
- type: number
- description: ''
- - name: getVerticalAlignment()
- uid: 'ExcelScript!ExcelScript.TextFrame#getVerticalAlignment:member(1)'
- package: ExcelScript!
- fullName: getVerticalAlignment()
- summary: Represents the vertical alignment of the text frame. See `ExcelScript.ShapeTextVerticalAlignment` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVerticalAlignment(): ShapeTextVerticalAlignment;'
- return:
- type: ''
- description: ''
- - name: getVerticalOverflow()
- uid: 'ExcelScript!ExcelScript.TextFrame#getVerticalOverflow:member(1)'
- package: ExcelScript!
- fullName: getVerticalOverflow()
- summary: >-
- Represents the vertical overflow behavior of the text frame. See `ExcelScript.ShapeTextVerticalOverflow` for
- details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVerticalOverflow(): ShapeTextVerticalOverflow;'
- return:
- type: ''
- description: ''
- - name: setAutoSizeSetting(autoSizeSetting)
- uid: 'ExcelScript!ExcelScript.TextFrame#setAutoSizeSetting:member(1)'
- package: ExcelScript!
- fullName: setAutoSizeSetting(autoSizeSetting)
- summary: >-
- The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the
- text frame, to automatically fit the text frame to the text, or not perform any automatic sizing.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setAutoSizeSetting(autoSizeSetting: ShapeAutoSize): void;'
- parameters:
- - id: autoSizeSetting
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setBottomMargin(bottomMargin)
- uid: 'ExcelScript!ExcelScript.TextFrame#setBottomMargin:member(1)'
- package: ExcelScript!
- fullName: setBottomMargin(bottomMargin)
- summary: 'Represents the bottom margin, in points, of the text frame.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setBottomMargin(bottomMargin: number): void;'
- parameters:
- - id: bottomMargin
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setHorizontalAlignment(horizontalAlignment)
- uid: 'ExcelScript!ExcelScript.TextFrame#setHorizontalAlignment:member(1)'
- package: ExcelScript!
- fullName: setHorizontalAlignment(horizontalAlignment)
- summary: Represents the horizontal alignment of the text frame. See `ExcelScript.ShapeTextHorizontalAlignment` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setHorizontalAlignment(
- horizontalAlignment: ShapeTextHorizontalAlignment
- ): void;
- parameters:
- - id: horizontalAlignment
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setHorizontalOverflow(horizontalOverflow)
- uid: 'ExcelScript!ExcelScript.TextFrame#setHorizontalOverflow:member(1)'
- package: ExcelScript!
- fullName: setHorizontalOverflow(horizontalOverflow)
- summary: >-
- Represents the horizontal overflow behavior of the text frame. See `ExcelScript.ShapeTextHorizontalOverflow` for
- details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setHorizontalOverflow(
- horizontalOverflow: ShapeTextHorizontalOverflow
- ): void;
- parameters:
- - id: horizontalOverflow
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setLeftMargin(leftMargin)
- uid: 'ExcelScript!ExcelScript.TextFrame#setLeftMargin:member(1)'
- package: ExcelScript!
- fullName: setLeftMargin(leftMargin)
- summary: 'Represents the left margin, in points, of the text frame.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setLeftMargin(leftMargin: number): void;'
- parameters:
- - id: leftMargin
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setOrientation(orientation)
- uid: 'ExcelScript!ExcelScript.TextFrame#setOrientation:member(1)'
- package: ExcelScript!
- fullName: setOrientation(orientation)
- summary: >-
- Represents the angle to which the text is oriented for the text frame. See `ExcelScript.ShapeTextOrientation` for
- details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setOrientation(orientation: ShapeTextOrientation): void;'
- parameters:
- - id: orientation
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setReadingOrder(readingOrder)
- uid: 'ExcelScript!ExcelScript.TextFrame#setReadingOrder:member(1)'
- package: ExcelScript!
- fullName: setReadingOrder(readingOrder)
- summary: >-
- Represents the reading order of the text frame, either left-to-right or right-to-left. See
- `ExcelScript.ShapeTextReadingOrder` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setReadingOrder(readingOrder: ShapeTextReadingOrder): void;'
- parameters:
- - id: readingOrder
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setRightMargin(rightMargin)
- uid: 'ExcelScript!ExcelScript.TextFrame#setRightMargin:member(1)'
- package: ExcelScript!
- fullName: setRightMargin(rightMargin)
- summary: 'Represents the right margin, in points, of the text frame.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setRightMargin(rightMargin: number): void;'
- parameters:
- - id: rightMargin
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setTopMargin(topMargin)
- uid: 'ExcelScript!ExcelScript.TextFrame#setTopMargin:member(1)'
- package: ExcelScript!
- fullName: setTopMargin(topMargin)
- summary: 'Represents the top margin, in points, of the text frame.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTopMargin(topMargin: number): void;'
- parameters:
- - id: topMargin
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setVerticalAlignment(verticalAlignment)
- uid: 'ExcelScript!ExcelScript.TextFrame#setVerticalAlignment:member(1)'
- package: ExcelScript!
- fullName: setVerticalAlignment(verticalAlignment)
- summary: Represents the vertical alignment of the text frame. See `ExcelScript.ShapeTextVerticalAlignment` for details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setVerticalAlignment(
- verticalAlignment: ShapeTextVerticalAlignment
- ): void;
- parameters:
- - id: verticalAlignment
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setVerticalOverflow(verticalOverflow)
- uid: 'ExcelScript!ExcelScript.TextFrame#setVerticalOverflow:member(1)'
- package: ExcelScript!
- fullName: setVerticalOverflow(verticalOverflow)
- summary: >-
- Represents the vertical overflow behavior of the text frame. See `ExcelScript.ShapeTextVerticalOverflow` for
- details.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setVerticalOverflow(verticalOverflow: ShapeTextVerticalOverflow): void;'
- parameters:
- - id: verticalOverflow
- description: ''
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.TextFrame
+uid: 'ExcelScript!ExcelScript.TextFrame:interface'
+package: ExcelScript!
+fullName: ExcelScript.TextFrame
+summary: Represents the text frame of a shape object.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a star shape with the value from cell A1.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the value of A1 from the worksheet named Sheet1.
+ const sheet = workbook.getWorksheet("Sheet1");
+ const value = sheet.getRange("A1").getValue();
+
+ // Create a Shape object that looks like a 5-pointed star.
+ const star = sheet.addGeometricShape(ExcelScript.GeometricShapeType.star5);
+
+ // Set the text of star and make sure the shape fits the text.
+ const textFrame: ExcelScript.TextFrame = star.getTextFrame();
+ textFrame.getTextRange().setText(value.toString());
+ textFrame.setAutoSizeSetting(ExcelScript.ShapeAutoSize.autoSizeShapeToFitText);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: deleteText()
+ uid: 'ExcelScript!ExcelScript.TextFrame#deleteText:member(1)'
+ package: ExcelScript!
+ fullName: deleteText()
+ summary: Deletes all the text in the text frame.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'deleteText(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getAutoSizeSetting()
+ uid: 'ExcelScript!ExcelScript.TextFrame#getAutoSizeSetting:member(1)'
+ package: ExcelScript!
+ fullName: getAutoSizeSetting()
+ summary: >-
+ The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the
+ text frame, to automatically fit the text frame to the text, or not perform any automatic sizing.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAutoSizeSetting(): ShapeAutoSize;'
+ return:
+ type: ''
+ description: ''
+ - name: getBottomMargin()
+ uid: 'ExcelScript!ExcelScript.TextFrame#getBottomMargin:member(1)'
+ package: ExcelScript!
+ fullName: getBottomMargin()
+ summary: 'Represents the bottom margin, in points, of the text frame.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBottomMargin(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getHasText()
+ uid: 'ExcelScript!ExcelScript.TextFrame#getHasText:member(1)'
+ package: ExcelScript!
+ fullName: getHasText()
+ summary: Specifies if the text frame contains text.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHasText(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getHorizontalAlignment()
+ uid: 'ExcelScript!ExcelScript.TextFrame#getHorizontalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: getHorizontalAlignment()
+ summary: Represents the horizontal alignment of the text frame. See `ExcelScript.ShapeTextHorizontalAlignment` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHorizontalAlignment(): ShapeTextHorizontalAlignment;'
+ return:
+ type: ''
+ description: ''
+ - name: getHorizontalOverflow()
+ uid: 'ExcelScript!ExcelScript.TextFrame#getHorizontalOverflow:member(1)'
+ package: ExcelScript!
+ fullName: getHorizontalOverflow()
+ summary: >-
+ Represents the horizontal overflow behavior of the text frame. See `ExcelScript.ShapeTextHorizontalOverflow` for
+ details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHorizontalOverflow(): ShapeTextHorizontalOverflow;'
+ return:
+ type: ''
+ description: ''
+ - name: getLeftMargin()
+ uid: 'ExcelScript!ExcelScript.TextFrame#getLeftMargin:member(1)'
+ package: ExcelScript!
+ fullName: getLeftMargin()
+ summary: 'Represents the left margin, in points, of the text frame.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLeftMargin(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getOrientation()
+ uid: 'ExcelScript!ExcelScript.TextFrame#getOrientation:member(1)'
+ package: ExcelScript!
+ fullName: getOrientation()
+ summary: >-
+ Represents the angle to which the text is oriented for the text frame. See `ExcelScript.ShapeTextOrientation` for
+ details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getOrientation(): ShapeTextOrientation;'
+ return:
+ type: ''
+ description: ''
+ - name: getReadingOrder()
+ uid: 'ExcelScript!ExcelScript.TextFrame#getReadingOrder:member(1)'
+ package: ExcelScript!
+ fullName: getReadingOrder()
+ summary: >-
+ Represents the reading order of the text frame, either left-to-right or right-to-left. See
+ `ExcelScript.ShapeTextReadingOrder` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getReadingOrder(): ShapeTextReadingOrder;'
+ return:
+ type: ''
+ description: ''
+ - name: getRightMargin()
+ uid: 'ExcelScript!ExcelScript.TextFrame#getRightMargin:member(1)'
+ package: ExcelScript!
+ fullName: getRightMargin()
+ summary: 'Represents the right margin, in points, of the text frame.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRightMargin(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getTextRange()
+ uid: 'ExcelScript!ExcelScript.TextFrame#getTextRange:member(1)'
+ package: ExcelScript!
+ fullName: getTextRange()
+ summary: >-
+ Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the
+ text. See `ExcelScript.TextRange` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTextRange(): TextRange;'
+ return:
+ type: ''
+ description: ''
+ - name: getTopMargin()
+ uid: 'ExcelScript!ExcelScript.TextFrame#getTopMargin:member(1)'
+ package: ExcelScript!
+ fullName: getTopMargin()
+ summary: 'Represents the top margin, in points, of the text frame.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTopMargin(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getVerticalAlignment()
+ uid: 'ExcelScript!ExcelScript.TextFrame#getVerticalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: getVerticalAlignment()
+ summary: Represents the vertical alignment of the text frame. See `ExcelScript.ShapeTextVerticalAlignment` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVerticalAlignment(): ShapeTextVerticalAlignment;'
+ return:
+ type: ''
+ description: ''
+ - name: getVerticalOverflow()
+ uid: 'ExcelScript!ExcelScript.TextFrame#getVerticalOverflow:member(1)'
+ package: ExcelScript!
+ fullName: getVerticalOverflow()
+ summary: >-
+ Represents the vertical overflow behavior of the text frame. See `ExcelScript.ShapeTextVerticalOverflow` for
+ details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVerticalOverflow(): ShapeTextVerticalOverflow;'
+ return:
+ type: ''
+ description: ''
+ - name: setAutoSizeSetting(autoSizeSetting)
+ uid: 'ExcelScript!ExcelScript.TextFrame#setAutoSizeSetting:member(1)'
+ package: ExcelScript!
+ fullName: setAutoSizeSetting(autoSizeSetting)
+ summary: >-
+ The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the
+ text frame, to automatically fit the text frame to the text, or not perform any automatic sizing.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setAutoSizeSetting(autoSizeSetting: ShapeAutoSize): void;'
+ parameters:
+ - id: autoSizeSetting
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setBottomMargin(bottomMargin)
+ uid: 'ExcelScript!ExcelScript.TextFrame#setBottomMargin:member(1)'
+ package: ExcelScript!
+ fullName: setBottomMargin(bottomMargin)
+ summary: 'Represents the bottom margin, in points, of the text frame.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setBottomMargin(bottomMargin: number): void;'
+ parameters:
+ - id: bottomMargin
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setHorizontalAlignment(horizontalAlignment)
+ uid: 'ExcelScript!ExcelScript.TextFrame#setHorizontalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: setHorizontalAlignment(horizontalAlignment)
+ summary: Represents the horizontal alignment of the text frame. See `ExcelScript.ShapeTextHorizontalAlignment` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setHorizontalAlignment(
+ horizontalAlignment: ShapeTextHorizontalAlignment
+ ): void;
+ parameters:
+ - id: horizontalAlignment
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setHorizontalOverflow(horizontalOverflow)
+ uid: 'ExcelScript!ExcelScript.TextFrame#setHorizontalOverflow:member(1)'
+ package: ExcelScript!
+ fullName: setHorizontalOverflow(horizontalOverflow)
+ summary: >-
+ Represents the horizontal overflow behavior of the text frame. See `ExcelScript.ShapeTextHorizontalOverflow` for
+ details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setHorizontalOverflow(
+ horizontalOverflow: ShapeTextHorizontalOverflow
+ ): void;
+ parameters:
+ - id: horizontalOverflow
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setLeftMargin(leftMargin)
+ uid: 'ExcelScript!ExcelScript.TextFrame#setLeftMargin:member(1)'
+ package: ExcelScript!
+ fullName: setLeftMargin(leftMargin)
+ summary: 'Represents the left margin, in points, of the text frame.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setLeftMargin(leftMargin: number): void;'
+ parameters:
+ - id: leftMargin
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setOrientation(orientation)
+ uid: 'ExcelScript!ExcelScript.TextFrame#setOrientation:member(1)'
+ package: ExcelScript!
+ fullName: setOrientation(orientation)
+ summary: >-
+ Represents the angle to which the text is oriented for the text frame. See `ExcelScript.ShapeTextOrientation` for
+ details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setOrientation(orientation: ShapeTextOrientation): void;'
+ parameters:
+ - id: orientation
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setReadingOrder(readingOrder)
+ uid: 'ExcelScript!ExcelScript.TextFrame#setReadingOrder:member(1)'
+ package: ExcelScript!
+ fullName: setReadingOrder(readingOrder)
+ summary: >-
+ Represents the reading order of the text frame, either left-to-right or right-to-left. See
+ `ExcelScript.ShapeTextReadingOrder` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setReadingOrder(readingOrder: ShapeTextReadingOrder): void;'
+ parameters:
+ - id: readingOrder
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setRightMargin(rightMargin)
+ uid: 'ExcelScript!ExcelScript.TextFrame#setRightMargin:member(1)'
+ package: ExcelScript!
+ fullName: setRightMargin(rightMargin)
+ summary: 'Represents the right margin, in points, of the text frame.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setRightMargin(rightMargin: number): void;'
+ parameters:
+ - id: rightMargin
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setTopMargin(topMargin)
+ uid: 'ExcelScript!ExcelScript.TextFrame#setTopMargin:member(1)'
+ package: ExcelScript!
+ fullName: setTopMargin(topMargin)
+ summary: 'Represents the top margin, in points, of the text frame.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTopMargin(topMargin: number): void;'
+ parameters:
+ - id: topMargin
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setVerticalAlignment(verticalAlignment)
+ uid: 'ExcelScript!ExcelScript.TextFrame#setVerticalAlignment:member(1)'
+ package: ExcelScript!
+ fullName: setVerticalAlignment(verticalAlignment)
+ summary: Represents the vertical alignment of the text frame. See `ExcelScript.ShapeTextVerticalAlignment` for details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setVerticalAlignment(
+ verticalAlignment: ShapeTextVerticalAlignment
+ ): void;
+ parameters:
+ - id: verticalAlignment
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setVerticalOverflow(verticalOverflow)
+ uid: 'ExcelScript!ExcelScript.TextFrame#setVerticalOverflow:member(1)'
+ package: ExcelScript!
+ fullName: setVerticalOverflow(verticalOverflow)
+ summary: >-
+ Represents the vertical overflow behavior of the text frame. See `ExcelScript.ShapeTextVerticalOverflow` for
+ details.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setVerticalOverflow(verticalOverflow: ShapeTextVerticalOverflow): void;'
+ parameters:
+ - id: verticalOverflow
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.textrange.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.textrange.yml
index 302d5f4d..cf5dd000 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.textrange.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.textrange.yml
@@ -1,148 +1,148 @@
-### YamlMime:TSType
-name: ExcelScript.TextRange
-uid: 'ExcelScript!ExcelScript.TextRange:interface'
-package: ExcelScript!
-fullName: ExcelScript.TextRange
-summary: 'Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.'
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds text to a shape.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Create a hexagon shape in the current worksheet.
- const sheet = workbook.getActiveWorksheet();
- const hexagon = sheet.addGeometricShape(ExcelScript.GeometricShapeType.hexagon);
-
- // Set the text of the shape.
- const hexText: ExcelScript.TextRange = hexagon.getTextFrame().getTextRange();
- hexText.setText("Forest");
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getFont()
- uid: 'ExcelScript!ExcelScript.TextRange#getFont:member(1)'
- package: ExcelScript!
- fullName: getFont()
- summary: Returns a `ShapeFont` object that represents the font attributes for the text range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFont(): ShapeFont;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample sets the font of a shape to be bold.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first shape in the current worksheet.
- const sheet = workbook.getActiveWorksheet();
- const shape = sheet.getShapes()[0];
-
- // Get the text font from the shape.
- const text: ExcelScript.TextRange = shape.getTextFrame().getTextRange();
- const shapeTextFont: ExcelScript.ShapeFont = text.getFont();
-
- // Set the font to be bold.
- shapeTextFont.setBold(true);
- }
- ```
- - name: 'getSubstring(start, length)'
- uid: 'ExcelScript!ExcelScript.TextRange#getSubstring:member(1)'
- package: ExcelScript!
- fullName: 'getSubstring(start, length)'
- summary: Returns a TextRange object for the substring in the given range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSubstring(start: number, length?: number): TextRange;'
- parameters:
- - id: start
- description: The zero-based index of the first character to get from the text range.
- type: number
- - id: length
- description: >-
- Optional. The number of characters to be returned in the new text range. If length is omitted, all the
- characters from start to the end of the text range's last paragraph will be returned.
- type: number
- return:
- type: ''
- description: ''
- - name: getText()
- uid: 'ExcelScript!ExcelScript.TextRange#getText:member(1)'
- package: ExcelScript!
- fullName: getText()
- summary: Represents the plain text content of the text range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getText(): string;'
- return:
- type: string
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script writes all the text from the workbook's geometric shapes in a new worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Create a new worksheet.
- const shapeTextSheet = workbook.addWorksheet("ShapeText");
- let shapeTextValues: string[][] = [];
-
- // Get the text from every geometric shape in every worksheet.
- workbook.getWorksheets().forEach((sheet) => {
- sheet.getShapes().forEach((shape) => {
- if (shape.getType() === ExcelScript.ShapeType.geometricShape)
- shapeTextValues.push([
- sheet.getName(),
- shape.getGeometricShapeType().toString(),
- shape.getTextFrame().getTextRange().getText()]);
- });
- });
-
- // Add the text to the new worksheet.
- const range = shapeTextSheet.getRangeByIndexes(
- 0,
- 0,
- shapeTextValues.length,
- shapeTextValues[0].length);
- range.setValues(shapeTextValues);
- }
- ```
- - name: setText(text)
- uid: 'ExcelScript!ExcelScript.TextRange#setText:member(1)'
- package: ExcelScript!
- fullName: setText(text)
- summary: Represents the plain text content of the text range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setText(text: string): void;'
- parameters:
- - id: text
- description: ''
- type: string
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.TextRange
+uid: 'ExcelScript!ExcelScript.TextRange:interface'
+package: ExcelScript!
+fullName: ExcelScript.TextRange
+summary: 'Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.'
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds text to a shape.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Create a hexagon shape in the current worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const hexagon = sheet.addGeometricShape(ExcelScript.GeometricShapeType.hexagon);
+
+ // Set the text of the shape.
+ const hexText: ExcelScript.TextRange = hexagon.getTextFrame().getTextRange();
+ hexText.setText("Forest");
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getFont()
+ uid: 'ExcelScript!ExcelScript.TextRange#getFont:member(1)'
+ package: ExcelScript!
+ fullName: getFont()
+ summary: Returns a `ShapeFont` object that represents the font attributes for the text range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFont(): ShapeFont;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample sets the font of a shape to be bold.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first shape in the current worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const shape = sheet.getShapes()[0];
+
+ // Get the text font from the shape.
+ const text: ExcelScript.TextRange = shape.getTextFrame().getTextRange();
+ const shapeTextFont: ExcelScript.ShapeFont = text.getFont();
+
+ // Set the font to be bold.
+ shapeTextFont.setBold(true);
+ }
+ ```
+ - name: 'getSubstring(start, length)'
+ uid: 'ExcelScript!ExcelScript.TextRange#getSubstring:member(1)'
+ package: ExcelScript!
+ fullName: 'getSubstring(start, length)'
+ summary: Returns a TextRange object for the substring in the given range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSubstring(start: number, length?: number): TextRange;'
+ parameters:
+ - id: start
+ description: The zero-based index of the first character to get from the text range.
+ type: number
+ - id: length
+ description: >-
+ Optional. The number of characters to be returned in the new text range. If length is omitted, all the
+ characters from start to the end of the text range's last paragraph will be returned.
+ type: number
+ return:
+ type: ''
+ description: ''
+ - name: getText()
+ uid: 'ExcelScript!ExcelScript.TextRange#getText:member(1)'
+ package: ExcelScript!
+ fullName: getText()
+ summary: Represents the plain text content of the text range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getText(): string;'
+ return:
+ type: string
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script writes all the text from the workbook's geometric shapes in a new worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Create a new worksheet.
+ const shapeTextSheet = workbook.addWorksheet("ShapeText");
+ let shapeTextValues: string[][] = [];
+
+ // Get the text from every geometric shape in every worksheet.
+ workbook.getWorksheets().forEach((sheet) => {
+ sheet.getShapes().forEach((shape) => {
+ if (shape.getType() === ExcelScript.ShapeType.geometricShape)
+ shapeTextValues.push([
+ sheet.getName(),
+ shape.getGeometricShapeType().toString(),
+ shape.getTextFrame().getTextRange().getText()]);
+ });
+ });
+
+ // Add the text to the new worksheet.
+ const range = shapeTextSheet.getRangeByIndexes(
+ 0,
+ 0,
+ shapeTextValues.length,
+ shapeTextValues[0].length);
+ range.setValues(shapeTextValues);
+ }
+ ```
+ - name: setText(text)
+ uid: 'ExcelScript!ExcelScript.TextRange#setText:member(1)'
+ package: ExcelScript!
+ fullName: setText(text)
+ summary: Represents the plain text content of the text range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setText(text: string): void;'
+ parameters:
+ - id: text
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.timelinestyle.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.timelinestyle.yml
index f8d5aad7..a0da66f3 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.timelinestyle.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.timelinestyle.yml
@@ -1,80 +1,80 @@
-### YamlMime:TSType
-name: ExcelScript.TimelineStyle
-uid: 'ExcelScript!ExcelScript.TimelineStyle:interface'
-package: ExcelScript!
-fullName: ExcelScript.TimelineStyle
-summary: 'Represents a `TimelineStyle`, which defines style elements by region in the timeline.'
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: delete()
- uid: 'ExcelScript!ExcelScript.TimelineStyle#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: Deletes the table style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: ''
- - name: duplicate()
- uid: 'ExcelScript!ExcelScript.TimelineStyle#duplicate:member(1)'
- package: ExcelScript!
- fullName: duplicate()
- summary: Creates a duplicate of this timeline style with copies of all the style elements.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'duplicate(): TimelineStyle;'
- return:
- type: ''
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.TimelineStyle#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: Specifies the name of the timeline style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: ''
- - name: getReadOnly()
- uid: 'ExcelScript!ExcelScript.TimelineStyle#getReadOnly:member(1)'
- package: ExcelScript!
- fullName: getReadOnly()
- summary: Specifies if this `TimelineStyle` object is read-only.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getReadOnly(): boolean;'
- return:
- type: boolean
- description: ''
- - name: setName(name)
- uid: 'ExcelScript!ExcelScript.TimelineStyle#setName:member(1)'
- package: ExcelScript!
- fullName: setName(name)
- summary: Specifies the name of the timeline style.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setName(name: string): void;'
- parameters:
- - id: name
- description: ''
- type: string
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.TimelineStyle
+uid: 'ExcelScript!ExcelScript.TimelineStyle:interface'
+package: ExcelScript!
+fullName: ExcelScript.TimelineStyle
+summary: 'Represents a `TimelineStyle`, which defines style elements by region in the timeline.'
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.TimelineStyle#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: Deletes the table style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: duplicate()
+ uid: 'ExcelScript!ExcelScript.TimelineStyle#duplicate:member(1)'
+ package: ExcelScript!
+ fullName: duplicate()
+ summary: Creates a duplicate of this timeline style with copies of all the style elements.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'duplicate(): TimelineStyle;'
+ return:
+ type: ''
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.TimelineStyle#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: Specifies the name of the timeline style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getReadOnly()
+ uid: 'ExcelScript!ExcelScript.TimelineStyle#getReadOnly:member(1)'
+ package: ExcelScript!
+ fullName: getReadOnly()
+ summary: Specifies if this `TimelineStyle` object is read-only.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getReadOnly(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: setName(name)
+ uid: 'ExcelScript!ExcelScript.TimelineStyle#setName:member(1)'
+ package: ExcelScript!
+ fullName: setName(name)
+ summary: Specifies the name of the timeline style.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setName(name: string): void;'
+ parameters:
+ - id: name
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.topbottomconditionalformat.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.topbottomconditionalformat.yml
index 4334db1d..ab382217 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.topbottomconditionalformat.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.topbottomconditionalformat.yml
@@ -1,79 +1,79 @@
-### YamlMime:TSType
-name: ExcelScript.TopBottomConditionalFormat
-uid: 'ExcelScript!ExcelScript.TopBottomConditionalFormat:interface'
-package: ExcelScript!
-fullName: ExcelScript.TopBottomConditionalFormat
-summary: Represents a top/bottom conditional format.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample applies conditional formatting to the currently used range in the worksheet.
- * The conditional formatting is a green fill for the top 10% of values.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Get the used range in the worksheet.
- let range = selectedSheet.getUsedRange();
-
- // Set the fill color to green for the top 10% of values in the range.
- let conditionalFormat = range.addConditionalFormat(ExcelScript.ConditionalFormatType.topBottom)
- conditionalFormat.getTopBottom().getFormat().getFill().setColor("green");
- conditionalFormat.getTopBottom().setRule({
- rank: 10, /* The percentage threshold. */
- type: ExcelScript.ConditionalTopBottomCriterionType.topPercent /* The type of the top/bottom condition. */
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getFormat()
- uid: 'ExcelScript!ExcelScript.TopBottomConditionalFormat#getFormat:member(1)'
- package: ExcelScript!
- fullName: getFormat()
- summary: 'Returns a format object, encapsulating the conditional format''s font, fill, borders, and other properties.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormat(): ConditionalRangeFormat;'
- return:
- type: ''
- description: ''
- - name: getRule()
- uid: 'ExcelScript!ExcelScript.TopBottomConditionalFormat#getRule:member(1)'
- package: ExcelScript!
- fullName: getRule()
- summary: The criteria of the top/bottom conditional format.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRule(): ConditionalTopBottomRule;'
- return:
- type: ''
- description: ''
- - name: setRule(rule)
- uid: 'ExcelScript!ExcelScript.TopBottomConditionalFormat#setRule:member(1)'
- package: ExcelScript!
- fullName: setRule(rule)
- summary: The criteria of the top/bottom conditional format.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setRule(rule: ConditionalTopBottomRule): void;'
- parameters:
- - id: rule
- description: ''
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.TopBottomConditionalFormat
+uid: 'ExcelScript!ExcelScript.TopBottomConditionalFormat:interface'
+package: ExcelScript!
+fullName: ExcelScript.TopBottomConditionalFormat
+summary: Represents a top/bottom conditional format.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample applies conditional formatting to the currently used range in the worksheet.
+ * The conditional formatting is a green fill for the top 10% of values.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Get the used range in the worksheet.
+ let range = selectedSheet.getUsedRange();
+
+ // Set the fill color to green for the top 10% of values in the range.
+ let conditionalFormat = range.addConditionalFormat(ExcelScript.ConditionalFormatType.topBottom)
+ conditionalFormat.getTopBottom().getFormat().getFill().setColor("green");
+ conditionalFormat.getTopBottom().setRule({
+ rank: 10, /* The percentage threshold. */
+ type: ExcelScript.ConditionalTopBottomCriterionType.topPercent /* The type of the top/bottom condition. */
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getFormat()
+ uid: 'ExcelScript!ExcelScript.TopBottomConditionalFormat#getFormat:member(1)'
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: 'Returns a format object, encapsulating the conditional format''s font, fill, borders, and other properties.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): ConditionalRangeFormat;'
+ return:
+ type: ''
+ description: ''
+ - name: getRule()
+ uid: 'ExcelScript!ExcelScript.TopBottomConditionalFormat#getRule:member(1)'
+ package: ExcelScript!
+ fullName: getRule()
+ summary: The criteria of the top/bottom conditional format.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRule(): ConditionalTopBottomRule;'
+ return:
+ type: ''
+ description: ''
+ - name: setRule(rule)
+ uid: 'ExcelScript!ExcelScript.TopBottomConditionalFormat#setRule:member(1)'
+ package: ExcelScript!
+ fullName: setRule(rule)
+ summary: The criteria of the top/bottom conditional format.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setRule(rule: ConditionalTopBottomRule): void;'
+ parameters:
+ - id: rule
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.topbottomselectiontype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.topbottomselectiontype.yml
index 5285ecd0..d2fc59f7 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.topbottomselectiontype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.topbottomselectiontype.yml
@@ -1,24 +1,24 @@
-### YamlMime:TSEnum
-name: ExcelScript.TopBottomSelectionType
-uid: 'ExcelScript!ExcelScript.TopBottomSelectionType:enum'
-package: ExcelScript!
-fullName: ExcelScript.TopBottomSelectionType
-summary: >-
- 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.
-remarks: ''
-isPreview: false
-isDeprecated: false
-fields:
- - name: items
- uid: 'ExcelScript!ExcelScript.TopBottomSelectionType.items:member'
- package: ExcelScript!
- summary: Filter the top/bottom N number of items as measured by the chosen value.
- - name: percent
- uid: 'ExcelScript!ExcelScript.TopBottomSelectionType.percent:member'
- package: ExcelScript!
- summary: Filter the top/bottom N percent of items as measured by the chosen value.
- - name: sum
- uid: 'ExcelScript!ExcelScript.TopBottomSelectionType.sum:member'
- package: ExcelScript!
- summary: Filter the top/bottom N sum as measured by the chosen value.
+### YamlMime:TSEnum
+name: ExcelScript.TopBottomSelectionType
+uid: 'ExcelScript!ExcelScript.TopBottomSelectionType:enum'
+package: ExcelScript!
+fullName: ExcelScript.TopBottomSelectionType
+summary: >-
+ 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.
+remarks: ''
+isPreview: false
+isDeprecated: false
+fields:
+ - name: items
+ uid: 'ExcelScript!ExcelScript.TopBottomSelectionType.items:member'
+ package: ExcelScript!
+ summary: Filter the top/bottom N number of items as measured by the chosen value.
+ - name: percent
+ uid: 'ExcelScript!ExcelScript.TopBottomSelectionType.percent:member'
+ package: ExcelScript!
+ summary: Filter the top/bottom N percent of items as measured by the chosen value.
+ - name: sum
+ uid: 'ExcelScript!ExcelScript.TopBottomSelectionType.sum:member'
+ package: ExcelScript!
+ summary: Filter the top/bottom N sum as measured by the chosen value.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.unknowncellcontrol.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.unknowncellcontrol.yml
new file mode 100644
index 00000000..1735f76a
--- /dev/null
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.unknowncellcontrol.yml
@@ -0,0 +1,25 @@
+### YamlMime:TSType
+name: ExcelScript.UnknownCellControl
+uid: 'ExcelScript!ExcelScript.UnknownCellControl:interface'
+package: ExcelScript!
+fullName: ExcelScript.UnknownCellControl
+summary: >-
+ Represents an unknown cell control. This represents a control that was added in a future version of Excel, and the
+ current version of Excel doesn't know how to display this control.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: type
+ uid: 'ExcelScript!ExcelScript.UnknownCellControl#type:member'
+ package: ExcelScript!
+ fullName: type
+ summary: ''
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'type: CellControlType.unknown;'
+ return:
+ type: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.valuefiltercondition.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.valuefiltercondition.yml
index 977f37e8..79c596e7 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.valuefiltercondition.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.valuefiltercondition.yml
@@ -1,109 +1,109 @@
-### YamlMime:TSEnum
-name: ExcelScript.ValueFilterCondition
-uid: 'ExcelScript!ExcelScript.ValueFilterCondition:enum'
-package: ExcelScript!
-fullName: ExcelScript.ValueFilterCondition
-summary: >-
- 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.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script applies a PivotValueFilter to the first row hierarchy in the PivotTable.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the PivotTable on the current worksheet.
- let sheet = workbook.getActiveWorksheet();
- let pivotTable = sheet.getPivotTables()[0];
-
- // Get the first row hierarchy to use as the field which gets filtered.
- let rowHierarchy = pivotTable.getRowHierarchies()[0];
-
- // Get the first data hierarchy to use as the values for filtering the rows.
- let dataHierarchy = pivotTable.getDataHierarchies()[0];
-
- // Create a filter that excludes values greater than 500.
- let filter: ExcelScript.PivotValueFilter = {
- condition: ExcelScript.ValueFilterCondition.greaterThan,
- comparator: 500,
- value: dataHierarchy.getName()
- };
-
- // Apply the filter.
- rowHierarchy.getPivotField(rowHierarchy.getName()).applyFilter({
- valueFilter: filter
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: between
- uid: 'ExcelScript!ExcelScript.ValueFilterCondition.between:member'
- package: ExcelScript!
- summary: >-
- Between `lowerBound` and `upperBound` criteria.
-
-
- Required Criteria: {`value`, `lowerBound`, `upperBound`}. Optional Criteria:
- {`exclusive`}.
- - name: bottomN
- uid: 'ExcelScript!ExcelScript.ValueFilterCondition.bottomN:member'
- package: ExcelScript!
- summary: |-
- In bottom N (`threshold`) \[items, percent, sum\] of value category.
-
- Required Criteria: {`value`, `threshold`, `selectionType`}.
- - name: equals
- uid: 'ExcelScript!ExcelScript.ValueFilterCondition.equals:member'
- package: ExcelScript!
- summary: >-
- Equals comparator criterion.
-
-
- Required Criteria: {`value`, `comparator`}. Optional Criteria: {`exclusive`}.
- - name: greaterThan
- uid: 'ExcelScript!ExcelScript.ValueFilterCondition.greaterThan:member'
- package: ExcelScript!
- summary: |-
- Greater than comparator criterion.
-
- Required Criteria: {`value`, `comparator`}.
- - name: greaterThanOrEqualTo
- uid: 'ExcelScript!ExcelScript.ValueFilterCondition.greaterThanOrEqualTo:member'
- package: ExcelScript!
- summary: |-
- Greater than or equal to comparator criterion.
-
- Required Criteria: {`value`, `comparator`}.
- - name: lessThan
- uid: 'ExcelScript!ExcelScript.ValueFilterCondition.lessThan:member'
- package: ExcelScript!
- summary: |-
- Less than comparator criterion.
-
- Required Criteria: {`value`, `comparator`}.
- - name: lessThanOrEqualTo
- uid: 'ExcelScript!ExcelScript.ValueFilterCondition.lessThanOrEqualTo:member'
- package: ExcelScript!
- summary: |-
- Less than or equal to comparator criterion.
-
- Required Criteria: {`value`, `comparator`}.
- - name: topN
- uid: 'ExcelScript!ExcelScript.ValueFilterCondition.topN:member'
- package: ExcelScript!
- summary: |-
- In top N (`threshold`) \[items, percent, sum\] of value category.
-
- Required Criteria: {`value`, `threshold`, `selectionType`}.
- - name: unknown
- uid: 'ExcelScript!ExcelScript.ValueFilterCondition.unknown:member'
- package: ExcelScript!
- summary: '`ValueFilterCondition` is unknown or unsupported.'
+### YamlMime:TSEnum
+name: ExcelScript.ValueFilterCondition
+uid: 'ExcelScript!ExcelScript.ValueFilterCondition:enum'
+package: ExcelScript!
+fullName: ExcelScript.ValueFilterCondition
+summary: >-
+ 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.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script applies a PivotValueFilter to the first row hierarchy in the PivotTable.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the PivotTable on the current worksheet.
+ let sheet = workbook.getActiveWorksheet();
+ let pivotTable = sheet.getPivotTables()[0];
+
+ // Get the first row hierarchy to use as the field which gets filtered.
+ let rowHierarchy = pivotTable.getRowHierarchies()[0];
+
+ // Get the first data hierarchy to use as the values for filtering the rows.
+ let dataHierarchy = pivotTable.getDataHierarchies()[0];
+
+ // Create a filter that excludes values greater than 500.
+ let filter: ExcelScript.PivotValueFilter = {
+ condition: ExcelScript.ValueFilterCondition.greaterThan,
+ comparator: 500,
+ value: dataHierarchy.getName()
+ };
+
+ // Apply the filter.
+ rowHierarchy.getPivotField(rowHierarchy.getName()).applyFilter({
+ valueFilter: filter
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: between
+ uid: 'ExcelScript!ExcelScript.ValueFilterCondition.between:member'
+ package: ExcelScript!
+ summary: >-
+ Between `lowerBound` and `upperBound` criteria.
+
+
+ Required Criteria: {`value`, `lowerBound`, `upperBound`}. Optional Criteria:
+ {`exclusive`}.
+ - name: bottomN
+ uid: 'ExcelScript!ExcelScript.ValueFilterCondition.bottomN:member'
+ package: ExcelScript!
+ summary: |-
+ In bottom N (`threshold`) \[items, percent, sum\] of value category.
+
+ Required Criteria: {`value`, `threshold`, `selectionType`}.
+ - name: equals
+ uid: 'ExcelScript!ExcelScript.ValueFilterCondition.equals:member'
+ package: ExcelScript!
+ summary: >-
+ Equals comparator criterion.
+
+
+ Required Criteria: {`value`, `comparator`}. Optional Criteria: {`exclusive`}.
+ - name: greaterThan
+ uid: 'ExcelScript!ExcelScript.ValueFilterCondition.greaterThan:member'
+ package: ExcelScript!
+ summary: |-
+ Greater than comparator criterion.
+
+ Required Criteria: {`value`, `comparator`}.
+ - name: greaterThanOrEqualTo
+ uid: 'ExcelScript!ExcelScript.ValueFilterCondition.greaterThanOrEqualTo:member'
+ package: ExcelScript!
+ summary: |-
+ Greater than or equal to comparator criterion.
+
+ Required Criteria: {`value`, `comparator`}.
+ - name: lessThan
+ uid: 'ExcelScript!ExcelScript.ValueFilterCondition.lessThan:member'
+ package: ExcelScript!
+ summary: |-
+ Less than comparator criterion.
+
+ Required Criteria: {`value`, `comparator`}.
+ - name: lessThanOrEqualTo
+ uid: 'ExcelScript!ExcelScript.ValueFilterCondition.lessThanOrEqualTo:member'
+ package: ExcelScript!
+ summary: |-
+ Less than or equal to comparator criterion.
+
+ Required Criteria: {`value`, `comparator`}.
+ - name: topN
+ uid: 'ExcelScript!ExcelScript.ValueFilterCondition.topN:member'
+ package: ExcelScript!
+ summary: |-
+ In top N (`threshold`) \[items, percent, sum\] of value category.
+
+ Required Criteria: {`value`, `threshold`, `selectionType`}.
+ - name: unknown
+ uid: 'ExcelScript!ExcelScript.ValueFilterCondition.unknown:member'
+ package: ExcelScript!
+ summary: '`ValueFilterCondition` is unknown or unsupported.'
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.verticalalignment.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.verticalalignment.yml
index 214eb341..3b2ced35 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.verticalalignment.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.verticalalignment.yml
@@ -1,48 +1,48 @@
-### YamlMime:TSEnum
-name: ExcelScript.VerticalAlignment
-uid: 'ExcelScript!ExcelScript.VerticalAlignment:enum'
-package: ExcelScript!
-fullName: ExcelScript.VerticalAlignment
-summary: ''
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the vertical alignment formatting to "top"
- * for every cell in the row.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get row 1 for the current worksheet.
- const sheet = workbook.getActiveWorksheet();
- const firstRow = sheet.getRange("1:1");
-
- // Set the vertical alignment formatting on the row.
- firstRow.getFormat().setVerticalAlignment(ExcelScript.VerticalAlignment.top);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: bottom
- uid: 'ExcelScript!ExcelScript.VerticalAlignment.bottom:member'
- package: ExcelScript!
- summary: ''
- - name: center
- uid: 'ExcelScript!ExcelScript.VerticalAlignment.center:member'
- package: ExcelScript!
- summary: ''
- - name: distributed
- uid: 'ExcelScript!ExcelScript.VerticalAlignment.distributed:member'
- package: ExcelScript!
- summary: ''
- - name: justify
- uid: 'ExcelScript!ExcelScript.VerticalAlignment.justify:member'
- package: ExcelScript!
- summary: ''
- - name: top
- uid: 'ExcelScript!ExcelScript.VerticalAlignment.top:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.VerticalAlignment
+uid: 'ExcelScript!ExcelScript.VerticalAlignment:enum'
+package: ExcelScript!
+fullName: ExcelScript.VerticalAlignment
+summary: ''
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the vertical alignment formatting to "top"
+ * for every cell in the row.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get row 1 for the current worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const firstRow = sheet.getRange("1:1");
+
+ // Set the vertical alignment formatting on the row.
+ firstRow.getFormat().setVerticalAlignment(ExcelScript.VerticalAlignment.top);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: bottom
+ uid: 'ExcelScript!ExcelScript.VerticalAlignment.bottom:member'
+ package: ExcelScript!
+ summary: ''
+ - name: center
+ uid: 'ExcelScript!ExcelScript.VerticalAlignment.center:member'
+ package: ExcelScript!
+ summary: ''
+ - name: distributed
+ uid: 'ExcelScript!ExcelScript.VerticalAlignment.distributed:member'
+ package: ExcelScript!
+ summary: ''
+ - name: justify
+ uid: 'ExcelScript!ExcelScript.VerticalAlignment.justify:member'
+ package: ExcelScript!
+ summary: ''
+ - name: top
+ uid: 'ExcelScript!ExcelScript.VerticalAlignment.top:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.workbook.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.workbook.yml
index 286a8141..fc983056 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.workbook.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.workbook.yml
@@ -1,1801 +1,1801 @@
-### YamlMime:TSType
-name: ExcelScript.Workbook
-uid: 'ExcelScript!ExcelScript.Workbook:interface'
-package: ExcelScript!
-fullName: ExcelScript.Workbook
-summary: 'Workbook is the top level object which contains related workbook objects such as worksheets, tables, and ranges.'
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a new worksheet to the workbook, then switches to it.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Add a new worksheet with the default name.
- let worksheet = workbook.addWorksheet();
-
- // Switch focus to the new worksheet.
- worksheet.activate();
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: 'addBinding(range, bindingType, id)'
- uid: 'ExcelScript!ExcelScript.Workbook#addBinding:member(1)'
- package: ExcelScript!
- fullName: 'addBinding(range, bindingType, id)'
- summary: Add a new binding to a particular Range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- addBinding(
- range: Range | string,
- bindingType: BindingType,
- id: string
- ): Binding;
- parameters:
- - id: range
- description: >-
- Range to bind the binding to. May be a `Range` object or a string. If string, must contain the full address,
- including the sheet name
- type: ' | string'
- - id: bindingType
- description: Type of binding. See `ExcelScript.BindingType`.
- type: ''
- - id: id
- description: Name of the binding.
- type: string
- return:
- type: ''
- description: ''
- - name: 'addBindingFromNamedItem(name, bindingType, id)'
- uid: 'ExcelScript!ExcelScript.Workbook#addBindingFromNamedItem:member(1)'
- package: ExcelScript!
- fullName: 'addBindingFromNamedItem(name, bindingType, id)'
- summary: >-
- Add a new binding based on a named item in the workbook. If the named item references to multiple areas, the
- `InvalidReference` error will be returned.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- addBindingFromNamedItem(
- name: string,
- bindingType: BindingType,
- id: string
- ): Binding;
- parameters:
- - id: name
- description: Name from which to create binding.
- type: string
- - id: bindingType
- description: Type of binding. See `ExcelScript.BindingType`.
- type: ''
- - id: id
- description: Name of the binding.
- type: string
- return:
- type: ''
- description: ''
- - name: 'addBindingFromSelection(bindingType, id)'
- uid: 'ExcelScript!ExcelScript.Workbook#addBindingFromSelection:member(1)'
- package: ExcelScript!
- fullName: 'addBindingFromSelection(bindingType, id)'
- summary: >-
- Add a new binding based on the current selection. If the selection has multiple areas, the `InvalidReference`
- error will be returned.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addBindingFromSelection(bindingType: BindingType, id: string): Binding;'
- parameters:
- - id: bindingType
- description: Type of binding. See `ExcelScript.BindingType`.
- type: ''
- - id: id
- description: Name of the binding.
- type: string
- return:
- type: ''
- description: ''
- - name: 'addComment(cellAddress, content, contentType)'
- uid: 'ExcelScript!ExcelScript.Workbook#addComment:member(1)'
- package: ExcelScript!
- fullName: 'addComment(cellAddress, content, contentType)'
- summary: >-
- Creates a new comment with the given content on the given cell. An `InvalidArgument` error is thrown if the
- provided range is larger than one cell.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- addComment(
- cellAddress: Range | string,
- content: CommentRichContent | string,
- contentType?: ContentType
- ): Comment;
- parameters:
- - id: cellAddress
- description: >-
- The cell to which the comment is added. This can be a `Range` object or a string. If it's a string, it must
- contain the full address, including the sheet name. An `InvalidArgument` error is thrown if the provided
- range is larger than one cell.
- type: ' | string'
- - id: content
- description: >-
- The comment's content. This can be either a string or `CommentRichContent` object. Strings are used for
- plain text. `CommentRichContent` objects allow for other comment features, such as mentions.
- type: ' | string'
- - id: contentType
- description: >-
- Optional. The type of content contained within the comment. The default value is enum
- `ContentType.Plain`.
- type: ''
- return:
- type: ''
- description: ''
- - name: addCustomXmlPart(xml)
- uid: 'ExcelScript!ExcelScript.Workbook#addCustomXmlPart:member(1)'
- package: ExcelScript!
- fullName: addCustomXmlPart(xml)
- summary: Adds a new custom XML part to the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addCustomXmlPart(xml: string): CustomXmlPart;'
- parameters:
- - id: xml
- description: XML content. Must be a valid XML fragment.
- type: string
- return:
- type: ''
- description: ''
- - name: 'addNamedItem(name, reference, comment)'
- uid: 'ExcelScript!ExcelScript.Workbook#addNamedItem:member(1)'
- package: ExcelScript!
- fullName: 'addNamedItem(name, reference, comment)'
- summary: Adds a new name to the collection of the given scope.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- addNamedItem(
- name: string,
- reference: Range | string,
- comment?: string
- ): NamedItem;
- parameters:
- - id: name
- description: The name of the named item.
- type: string
- - id: reference
- description: The formula or the range that the name will refer to.
- type: ' | string'
- - id: comment
- description: Optional. The comment associated with the named item.
- type: string
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a named formula and uses it in another part of the workbook.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Create a named item for a formula.
- // This formula is the sum of the cells F2:F21 on Sheet1.
- const namedItem: ExcelScript.NamedItem = workbook.addNamedItem(
- "GrandTotal",
- "=SUM(Sheet1!$F$2:$F$21)",
- "The sum of table sums."
- );
-
- // Add this named formula to a new sheet in the workbook.
- const otherSheet = workbook.addWorksheet();
- otherSheet.getRange("A1").setFormula(namedItem.getFormula());
-
- // Switch to the new worksheet.
- otherSheet.activate();
- }
- ```
- - name: 'addNamedItemFormulaLocal(name, formula, comment)'
- uid: 'ExcelScript!ExcelScript.Workbook#addNamedItemFormulaLocal:member(1)'
- package: ExcelScript!
- fullName: 'addNamedItemFormulaLocal(name, formula, comment)'
- summary: Adds a new name to the collection of the given scope using the user's locale for the formula.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- addNamedItemFormulaLocal(
- name: string,
- formula: string,
- comment?: string
- ): NamedItem;
- parameters:
- - id: name
- description: The name of the named item.
- type: string
- - id: formula
- description: The formula in the user's locale that the name will refer to.
- type: string
- - id: comment
- description: Optional. The comment associated with the named item.
- type: string
- return:
- type: ''
- description: ''
- - name: 'addPivotTable(name, source, destination)'
- uid: 'ExcelScript!ExcelScript.Workbook#addPivotTable:member(1)'
- package: ExcelScript!
- fullName: 'addPivotTable(name, source, destination)'
- summary: Add a PivotTable based on the specified source data and insert it at the top-left cell of the destination range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- addPivotTable(
- name: string,
- source: Range | string | Table,
- destination: Range | string
- ): PivotTable;
- parameters:
- - id: name
- description: The name of the new PivotTable.
- type: string
- - id: source
- description: >-
- The source data for the new PivotTable, this can either be a range (or string address including the
- worksheet name) or a table.
- type: >-
- | string |
- - id: destination
- description: >-
- The cell in the upper-left corner of the PivotTable report's destination range (the range on the worksheet
- where the resulting report will be placed).
- type: ' | string'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a PivotTable from an existing table and adds it to an existing worksheet.
- * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
- * It also assumes there is a worksheet named "PivotSheet".
- */
- function main(workbook: ExcelScript.Workbook) {
- // Create a PivotTable based on a table in the current worksheet.
- let sheet = workbook.getActiveWorksheet();
- let table = sheet.getTables()[0];
- let pivotTable = workbook.addPivotTable("My Pivot", table, "PivotSheet!A1");
-
- // Add fields to the PivotTable to show "Sales" per "Type".
- pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
- pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
- }
- ```
- - name: 'addPivotTableStyle(name, makeUniqueName)'
- uid: 'ExcelScript!ExcelScript.Workbook#addPivotTableStyle:member(1)'
- package: ExcelScript!
- fullName: 'addPivotTableStyle(name, makeUniqueName)'
- summary: Creates a blank `PivotTableStyle` with the specified name.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- addPivotTableStyle(
- name: string,
- makeUniqueName?: boolean
- ): PivotTableStyle;
- parameters:
- - id: name
- description: >-
- The unique name for the new PivotTable style. Will throw an `InvalidArgument` error if the name is already
- in use.
- type: string
- - id: makeUniqueName
- description: >-
- Optional. Defaults to `false`. If `true`, will append numbers to the name in order to make
- it unique, if needed.
- type: boolean
- return:
- type: ''
- description: ''
- - name: addPredefinedCellStyle(name)
- uid: 'ExcelScript!ExcelScript.Workbook#addPredefinedCellStyle:member(1)'
- package: ExcelScript!
- fullName: addPredefinedCellStyle(name)
- summary: Adds a new style to the collection.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addPredefinedCellStyle(name: string): void;'
- parameters:
- - id: name
- description: Name of the style to be added.
- type: string
- return:
- type: void
- description: ''
- - name: 'addSlicer(slicerSource, sourceField, slicerDestination)'
- uid: 'ExcelScript!ExcelScript.Workbook#addSlicer:member(1)'
- package: ExcelScript!
- fullName: 'addSlicer(slicerSource, sourceField, slicerDestination)'
- summary: Adds a new slicer to the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- addSlicer(
- slicerSource: string | PivotTable | Table,
- sourceField: string | PivotField | number | TableColumn,
- slicerDestination?: string | Worksheet
- ): Slicer;
- parameters:
- - id: slicerSource
- description: >-
- The data source that the new slicer will be based on. It can be a `PivotTable` object, a `Table` object, or
- a string. When a PivotTable object is passed, the data source is the source of the `PivotTable` object. When
- a `Table` object is passed, the data source is the `Table` object. When a string is passed, it is
- interpreted as the name or ID of a PivotTable or table.
- type: >-
- string | |
- - id: sourceField
- description: >-
- The field in the data source to filter by. It can be a `PivotField` object, a `TableColumn` object, the ID
- of a `PivotField` or the name or ID of a `TableColumn`.
- type: >-
- string | | number |
- - id: slicerDestination
- description: >-
- Optional. The worksheet in which the new slicer will be created. It can be a `Worksheet` object or the name
- or ID of a worksheet. This parameter can be omitted if the slicer collection is retrieved from a worksheet.
- type: 'string | '
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a slicer for an existing PivotTable.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the PivotTable named "Farm Pivot".
- const farmPivot = workbook.getPivotTable("Farm Pivot");
-
- // Create the slicer.
- // Note that this assumes "Type" is already added as a hierarchy to the PivotTable.
- const fruitSlicer: ExcelScript.Slicer = workbook.addSlicer(
- farmPivot, /* The table or PivotTale to be sliced. */
- farmPivot.getHierarchy("Type").getFields()[0] /* What source field to use as the slicer options. */
- );
-
- // Select the items to display.
- fruitSlicer.selectItems(["Lemon", "Lime"]);
-
- // Set the left margin of the slicer.
- fruitSlicer.setLeft(400);
- }
- ```
- - name: 'addSlicerStyle(name, makeUniqueName)'
- uid: 'ExcelScript!ExcelScript.Workbook#addSlicerStyle:member(1)'
- package: ExcelScript!
- fullName: 'addSlicerStyle(name, makeUniqueName)'
- summary: Creates a blank slicer style with the specified name.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addSlicerStyle(name: string, makeUniqueName?: boolean): SlicerStyle;'
- parameters:
- - id: name
- description: >-
- The unique name for the new slicer style. Will throw an `InvalidArgument` exception if the name is already
- in use.
- type: string
- - id: makeUniqueName
- description: >-
- Optional. Defaults to `false`. If `true`, will append numbers to the name in order to make
- it unique, if needed.
- type: boolean
- return:
- type: ''
- description: ''
- - name: 'addTable(address, hasHeaders)'
- uid: 'ExcelScript!ExcelScript.Workbook#addTable:member(1)'
- package: ExcelScript!
- fullName: 'addTable(address, hasHeaders)'
- summary: >-
- Creates a new table. The range object or source address determines the worksheet under which the table will be
- added. If the table cannot be added (e.g., because the address is invalid, or the table would overlap with another
- table), an error will be thrown.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addTable(address: Range | string, hasHeaders: boolean): Table;'
- parameters:
- - id: address
- description: >-
- A `Range` object, or a string address or name of the range representing the data source. If the address does
- not contain a sheet name, the currently-active sheet is used.
- type: ' | string'
- - id: hasHeaders
- description: >-
- A boolean value that indicates whether the data being imported has column labels. If the source does not
- contain headers (i.e., when this property set to `false`), Excel will automatically generate a
- header and shift the data down by one row.
- type: boolean
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample converts the information in the first worksheet
- * into a table with headers.
- */
- function main(workbook: ExcelScript.Workbook) {
- // This assumes there is one contiguous range in the first worksheet.
- const dataRange = workbook.getFirstWorksheet().getUsedRange();
-
- // Add a table at the workbook level.
- workbook.addTable(dataRange.getAddress(), true);
- }
- ```
- - name: 'addTableStyle(name, makeUniqueName)'
- uid: 'ExcelScript!ExcelScript.Workbook#addTableStyle:member(1)'
- package: ExcelScript!
- fullName: 'addTableStyle(name, makeUniqueName)'
- summary: Creates a blank `TableStyle` with the specified name.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addTableStyle(name: string, makeUniqueName?: boolean): TableStyle;'
- parameters:
- - id: name
- description: >-
- The unique name for the new table style. Will throw an `InvalidArgument` error if the name is already in
- use.
- type: string
- - id: makeUniqueName
- description: >-
- Optional. Defaults to `false`. If `true`, will append numbers to the name in order to make
- it unique, if needed.
- type: boolean
- return:
- type: ''
- description: ''
- - name: 'addTimelineStyle(name, makeUniqueName)'
- uid: 'ExcelScript!ExcelScript.Workbook#addTimelineStyle:member(1)'
- package: ExcelScript!
- fullName: 'addTimelineStyle(name, makeUniqueName)'
- summary: Creates a blank `TimelineStyle` with the specified name.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addTimelineStyle(name: string, makeUniqueName?: boolean): TimelineStyle;'
- parameters:
- - id: name
- description: >-
- The unique name for the new timeline style. Will throw an `InvalidArgument` error if the name is already in
- use.
- type: string
- - id: makeUniqueName
- description: >-
- Optional. Defaults to `false`. If `true`, will append numbers to the name in order to make
- it unique, if needed.
- type: boolean
- return:
- type: ''
- description: ''
- - name: addWorksheet(name)
- uid: 'ExcelScript!ExcelScript.Workbook#addWorksheet:member(1)'
- package: ExcelScript!
- fullName: addWorksheet(name)
- summary: >-
- Adds a new worksheet to the workbook. The worksheet will be added at the end of existing worksheets. If you wish
- to activate the newly added worksheet, call `.activate()` on it.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addWorksheet(name?: string): Worksheet;'
- parameters:
- - id: name
- description: >-
- Optional. The name of the worksheet to be added. If specified, the name should be unique. If not specified,
- Excel determines the name of the new worksheet.
- type: string
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a new worksheet named "Data" to the workbook.
- * If a worksheet with that name already exists, the script logs a note.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Check if the "Data" worksheet already exists.
- if (workbook.getWorksheet("Data")) {
- console.log("The Data worksheet is already in the workbook.");
- } else {
- // Add a new worksheet.
- let worksheet = workbook.addWorksheet("Data");
- }
- }
- ```
- - name: breakAllLinksToLinkedWorkbooks()
- uid: 'ExcelScript!ExcelScript.Workbook#breakAllLinksToLinkedWorkbooks:member(1)'
- package: ExcelScript!
- fullName: breakAllLinksToLinkedWorkbooks()
- summary: >-
- Breaks all the links to the linked workbooks. Once the links are broken, any formulas referencing workbook links
- are removed entirely and replaced with the most recently retrieved values.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'breakAllLinksToLinkedWorkbooks(): void;'
- return:
- type: void
- description: ''
- - name: getActiveCell()
- uid: 'ExcelScript!ExcelScript.Workbook#getActiveCell:member(1)'
- package: ExcelScript!
- fullName: getActiveCell()
- summary: Gets the currently active cell from the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getActiveCell(): Range;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script logs the value of the current active cell.
- * If multiple cells are selected, the top-leftmost cell will be logged.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current active cell in the workbook.
- let cell = workbook.getActiveCell();
- console.log(`The current cell's value is ${cell.getValue()}`);
- }
- ```
- - name: getActiveChart()
- uid: 'ExcelScript!ExcelScript.Workbook#getActiveChart:member(1)'
- package: ExcelScript!
- fullName: getActiveChart()
- summary: >-
- Gets the currently active chart in the workbook. If there is no active chart, then this method returns
- `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getActiveChart(): Chart;'
- return:
- type: ''
- description: ''
- - name: getActiveSlicer()
- uid: 'ExcelScript!ExcelScript.Workbook#getActiveSlicer:member(1)'
- package: ExcelScript!
- fullName: getActiveSlicer()
- summary: >-
- Gets the currently active slicer in the workbook. If there is no active slicer, then this method returns
- `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getActiveSlicer(): Slicer;'
- return:
- type: ''
- description: ''
- - name: getActiveWorksheet()
- uid: 'ExcelScript!ExcelScript.Workbook#getActiveWorksheet:member(1)'
- package: ExcelScript!
- fullName: getActiveWorksheet()
- summary: Gets the currently active worksheet in the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getActiveWorksheet(): Worksheet;'
- return:
- type: ''
- description: ''
- - name: getApplication()
- uid: 'ExcelScript!ExcelScript.Workbook#getApplication:member(1)'
- package: ExcelScript!
- fullName: getApplication()
- summary: Represents the Excel application instance that contains this workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getApplication(): Application;'
- return:
- type: ''
- description: ''
- - name: getAutoSave()
- uid: 'ExcelScript!ExcelScript.Workbook#getAutoSave:member(1)'
- package: ExcelScript!
- fullName: getAutoSave()
- summary: Specifies if the workbook is in AutoSave mode.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAutoSave(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getBinding(id)
- uid: 'ExcelScript!ExcelScript.Workbook#getBinding:member(1)'
- package: ExcelScript!
- fullName: getBinding(id)
- summary: 'Gets a binding object by ID. If the binding object does not exist, then this method returns `undefined`.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBinding(id: string): Binding | undefined;'
- parameters:
- - id: id
- description: ID of the binding object to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getBindings()
- uid: 'ExcelScript!ExcelScript.Workbook#getBindings:member(1)'
- package: ExcelScript!
- fullName: getBindings()
- summary: Represents a collection of bindings that are part of the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBindings(): Binding[];'
- return:
- type: '[]'
- description: ''
- - name: getCalculationEngineVersion()
- uid: 'ExcelScript!ExcelScript.Workbook#getCalculationEngineVersion:member(1)'
- package: ExcelScript!
- fullName: getCalculationEngineVersion()
- summary: Returns a number about the version of Excel Calculation Engine.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCalculationEngineVersion(): number;'
- return:
- type: number
- description: ''
- - name: getChartDataPointTrack()
- uid: 'ExcelScript!ExcelScript.Workbook#getChartDataPointTrack:member(1)'
- package: ExcelScript!
- fullName: getChartDataPointTrack()
- summary: >-
- True if all charts in the workbook are tracking the actual data points to which they are attached. False if the
- charts track the index of the data points.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getChartDataPointTrack(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getComment(commentId)
- uid: 'ExcelScript!ExcelScript.Workbook#getComment:member(1)'
- package: ExcelScript!
- fullName: getComment(commentId)
- summary: >-
- Gets a comment from the collection based on its ID. If the comment object does not exist, then this method returns
- `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getComment(commentId: string): Comment | undefined;'
- parameters:
- - id: commentId
- description: The identifier for the comment.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getCommentByCell(cellAddress)
- uid: 'ExcelScript!ExcelScript.Workbook#getCommentByCell:member(1)'
- package: ExcelScript!
- fullName: getCommentByCell(cellAddress)
- summary: 'Gets the comment from the specified cell. If there is no comment in the cell, an error is thrown.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCommentByCell(cellAddress: Range | string): Comment;'
- parameters:
- - id: cellAddress
- description: >-
- The cell which the comment is on. This can be a `Range` object or a string. If it's a string, it must
- contain the full address, including the sheet name. An `InvalidArgument` error is thrown if the provided
- range is larger than one cell.
- type: ' | string'
- return:
- type: ''
- description: ''
- - name: getCommentByReplyId(replyId)
- uid: 'ExcelScript!ExcelScript.Workbook#getCommentByReplyId:member(1)'
- package: ExcelScript!
- fullName: getCommentByReplyId(replyId)
- summary: Gets the comment to which the given reply is connected.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCommentByReplyId(replyId: string): Comment;'
- parameters:
- - id: replyId
- description: The identifier of comment reply.
- type: string
- return:
- type: ''
- description: ''
- - name: getComments()
- uid: 'ExcelScript!ExcelScript.Workbook#getComments:member(1)'
- package: ExcelScript!
- fullName: getComments()
- summary: Represents a collection of comments associated with the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getComments(): Comment[];'
- return:
- type: '[]'
- description: ''
- - name: getCustomXmlPart(id)
- uid: 'ExcelScript!ExcelScript.Workbook#getCustomXmlPart:member(1)'
- package: ExcelScript!
- fullName: getCustomXmlPart(id)
- summary: >-
- Gets a custom XML part based on its ID. If the `CustomXmlPart` does not exist, then this method returns
- `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCustomXmlPart(id: string): CustomXmlPart | undefined;'
- parameters:
- - id: id
- description: ID of the object to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getCustomXmlPartByNamespace(namespaceUri)
- uid: 'ExcelScript!ExcelScript.Workbook#getCustomXmlPartByNamespace:member(1)'
- package: ExcelScript!
- fullName: getCustomXmlPartByNamespace(namespaceUri)
- summary: Gets a new collection of custom XML parts whose namespaces match the given namespace.
- remarks: ''
- isPreview: false
- isDeprecated: true
- customDeprecatedMessage: Use `getCustomXmlPartsByNamespace` instead.
- syntax:
- content: 'getCustomXmlPartByNamespace(namespaceUri: string): CustomXmlPart[];'
- parameters:
- - id: namespaceUri
- description: 'This must be a fully qualified schema URI; for example, "http://schemas.contoso.com/review/1.0".'
- type: string
- return:
- type: '[]'
- description: ''
- - name: getCustomXmlParts()
- uid: 'ExcelScript!ExcelScript.Workbook#getCustomXmlParts:member(1)'
- package: ExcelScript!
- fullName: getCustomXmlParts()
- summary: Represents the collection of custom XML parts contained by this workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCustomXmlParts(): CustomXmlPart[];'
- return:
- type: '[]'
- description: ''
- - name: getCustomXmlPartsByNamespace(namespaceUri)
- uid: 'ExcelScript!ExcelScript.Workbook#getCustomXmlPartsByNamespace:member(1)'
- package: ExcelScript!
- fullName: getCustomXmlPartsByNamespace(namespaceUri)
- summary: Gets a new collection of custom XML parts whose namespaces match the given namespace.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCustomXmlPartsByNamespace(namespaceUri: string): CustomXmlPart[];'
- parameters:
- - id: namespaceUri
- description: 'This must be a fully qualified schema URI; for example, "http://schemas.contoso.com/review/1.0".'
- type: string
- return:
- type: '[]'
- description: ''
- - name: getDefaultPivotTableStyle()
- uid: 'ExcelScript!ExcelScript.Workbook#getDefaultPivotTableStyle:member(1)'
- package: ExcelScript!
- fullName: getDefaultPivotTableStyle()
- summary: Gets the default PivotTable style for the parent object's scope.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDefaultPivotTableStyle(): PivotTableStyle;'
- return:
- type: ''
- description: ''
- - name: getDefaultSlicerStyle()
- uid: 'ExcelScript!ExcelScript.Workbook#getDefaultSlicerStyle:member(1)'
- package: ExcelScript!
- fullName: getDefaultSlicerStyle()
- summary: Gets the default `SlicerStyle` for the parent object's scope.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDefaultSlicerStyle(): SlicerStyle;'
- return:
- type: ''
- description: ''
- - name: getDefaultTableStyle()
- uid: 'ExcelScript!ExcelScript.Workbook#getDefaultTableStyle:member(1)'
- package: ExcelScript!
- fullName: getDefaultTableStyle()
- summary: Gets the default table style for the parent object's scope.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDefaultTableStyle(): TableStyle;'
- return:
- type: ''
- description: ''
- - name: getDefaultTimelineStyle()
- uid: 'ExcelScript!ExcelScript.Workbook#getDefaultTimelineStyle:member(1)'
- package: ExcelScript!
- fullName: getDefaultTimelineStyle()
- summary: Gets the default timeline style for the parent object's scope.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDefaultTimelineStyle(): TimelineStyle;'
- return:
- type: ''
- description: ''
- - name: getFirstWorksheet(visibleOnly)
- uid: 'ExcelScript!ExcelScript.Workbook#getFirstWorksheet:member(1)'
- package: ExcelScript!
- fullName: getFirstWorksheet(visibleOnly)
- summary: Gets the first worksheet in the collection.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFirstWorksheet(visibleOnly?: boolean): Worksheet;'
- parameters:
- - id: visibleOnly
- description: 'Optional. If `true`, considers only visible worksheets, skipping over any hidden ones.'
- type: boolean
- return:
- type: ''
- description: ''
- - name: getIsDirty()
- uid: 'ExcelScript!ExcelScript.Workbook#getIsDirty:member(1)'
- package: ExcelScript!
- fullName: getIsDirty()
- summary: >-
- Specifies if changes have been made since the workbook was last saved. You can set this property to `true` if you
- want to close a modified workbook without either saving it or being prompted to save it.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIsDirty(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getLastWorksheet(visibleOnly)
- uid: 'ExcelScript!ExcelScript.Workbook#getLastWorksheet:member(1)'
- package: ExcelScript!
- fullName: getLastWorksheet(visibleOnly)
- summary: Gets the last worksheet in the collection.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLastWorksheet(visibleOnly?: boolean): Worksheet;'
- parameters:
- - id: visibleOnly
- description: 'Optional. If `true`, considers only visible worksheets, skipping over any hidden ones.'
- type: boolean
- return:
- type: ''
- description: ''
- - name: getLinkedWorkbookByUrl(key)
- uid: 'ExcelScript!ExcelScript.Workbook#getLinkedWorkbookByUrl:member(1)'
- package: ExcelScript!
- fullName: getLinkedWorkbookByUrl(key)
- summary: >-
- Gets information about a linked workbook by its URL. If the workbook does not exist, then this method returns
- `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLinkedWorkbookByUrl(key: string): LinkedWorkbook | undefined;'
- parameters:
- - id: key
- description: The URL of the linked workbook.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getLinkedWorkbookRefreshMode()
- uid: 'ExcelScript!ExcelScript.Workbook#getLinkedWorkbookRefreshMode:member(1)'
- package: ExcelScript!
- fullName: getLinkedWorkbookRefreshMode()
- summary: >-
- Represents the update mode of the workbook links. The mode is same for all of the workbook links present in the
- workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLinkedWorkbookRefreshMode(): WorkbookLinksRefreshMode;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script refreshes all the links to external workbooks,
- * if the linked workbook refresh mode is set to manual.
- * To learn about linked workbooks, see https://support.microsoft.com/office/c98d1803-dd75-4668-ac6a-d7cca2a9b95f.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Check the refresh mode.
- if (workbook.getLinkedWorkbookRefreshMode() === ExcelScript.WorkbookLinksRefreshMode.manual) {
- console.log("Refreshing workbook links");
-
- // Trigger a refresh of linked workbook content.
- workbook.refreshAllLinksToLinkedWorkbooks();
- }
- ```
- - name: getLinkedWorkbooks()
- uid: 'ExcelScript!ExcelScript.Workbook#getLinkedWorkbooks:member(1)'
- package: ExcelScript!
- fullName: getLinkedWorkbooks()
- summary: >-
- Returns a collection of linked workbooks. In formulas, the workbook links can be used to reference data (cell
- values and names) outside of the current workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLinkedWorkbooks(): LinkedWorkbook[];'
- return:
- type: '[]'
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script removes all links to other workbooks.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get all the linked workbook references.
- const externalWorkbooks: ExcelScript.LinkedWorkbook[] = workbook.getLinkedWorkbooks();
- console.log(`There are ${externalWorkbooks.length} other workbooks linked to from this workbook.`);
-
- // Remove all the links to those workbooks.
- // This changes the value of cells with workbook links to "#CONNECT!".
- externalWorkbooks.forEach((workbookLink) => {
- workbookLink.breakLinks();
- });
- }
- ```
- - name: getName()
- uid: 'ExcelScript!ExcelScript.Workbook#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: Gets the workbook name.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script logs the name of the workbook without the ".xlsx" extension.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the workbook's name.
- let name = workbook.getName();
-
- // Remove the file extension.
- name = name.substring(0, name.lastIndexOf(".xlsx"));
-
- // Display the name in the console.
- console.log(name);
- }
- ```
- - name: getNamedItem(name)
- uid: 'ExcelScript!ExcelScript.Workbook#getNamedItem:member(1)'
- package: ExcelScript!
- fullName: getNamedItem(name)
- summary: >-
- Gets a `NamedItem` object using its name. If the object does not exist, then this method returns `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNamedItem(name: string): NamedItem | undefined;'
- parameters:
- - id: name
- description: Nameditem name.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getNames()
- uid: 'ExcelScript!ExcelScript.Workbook#getNames:member(1)'
- package: ExcelScript!
- fullName: getNames()
- summary: Represents a collection of workbook-scoped named items (named ranges and constants).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNames(): NamedItem[];'
- return:
- type: '[]'
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script looks for every named range with "Review" in the name
- * and marks the range with a yellow fill.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Look at every named item in the workbook.
- workbook.getNames().forEach((namedItem) => {
- // Find names containing "Review".
- if (namedItem.getName().includes("Review")) {
- // Only change the fill color if the named item is a range (not a formula).
- let itemType: ExcelScript.NamedItemType = namedItem.getType();
- if (itemType === ExcelScript.NamedItemType.range) {
- // Set the range's fill color to yellow.
- namedItem.getRange().getFormat().getFill().setColor("yellow");
- }
- }
- });
- }
- ```
- - name: getPivotTable(name)
- uid: 'ExcelScript!ExcelScript.Workbook#getPivotTable:member(1)'
- package: ExcelScript!
- fullName: getPivotTable(name)
- summary: 'Gets a PivotTable by name. If the PivotTable does not exist, then this method returns `undefined`.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPivotTable(name: string): PivotTable | undefined;'
- parameters:
- - id: name
- description: Name of the PivotTable to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getPivotTables()
- uid: 'ExcelScript!ExcelScript.Workbook#getPivotTables:member(1)'
- package: ExcelScript!
- fullName: getPivotTables()
- summary: Represents a collection of PivotTables associated with the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPivotTables(): PivotTable[];'
- return:
- type: '[]'
- description: ''
- - name: getPivotTableStyle(name)
- uid: 'ExcelScript!ExcelScript.Workbook#getPivotTableStyle:member(1)'
- package: ExcelScript!
- fullName: getPivotTableStyle(name)
- summary: >-
- Gets a `PivotTableStyle` by name. If the `PivotTableStyle` does not exist, then this method returns
- `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPivotTableStyle(name: string): PivotTableStyle | undefined;'
- parameters:
- - id: name
- description: Name of the PivotTable style to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getPivotTableStyles()
- uid: 'ExcelScript!ExcelScript.Workbook#getPivotTableStyles:member(1)'
- package: ExcelScript!
- fullName: getPivotTableStyles()
- summary: Represents a collection of PivotTableStyles associated with the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPivotTableStyles(): PivotTableStyle[];'
- return:
- type: '[]'
- description: ''
- - name: getPredefinedCellStyle(name)
- uid: 'ExcelScript!ExcelScript.Workbook#getPredefinedCellStyle:member(1)'
- package: ExcelScript!
- fullName: getPredefinedCellStyle(name)
- summary: 'Gets a style by name. If the style object does not exist, then this method returns `undefined`.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPredefinedCellStyle(name: string): PredefinedCellStyle | undefined;'
- parameters:
- - id: name
- description: Name of the style to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getPredefinedCellStyles()
- uid: 'ExcelScript!ExcelScript.Workbook#getPredefinedCellStyles:member(1)'
- package: ExcelScript!
- fullName: getPredefinedCellStyles()
- summary: Represents a collection of styles associated with the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPredefinedCellStyles(): PredefinedCellStyle[];'
- return:
- type: '[]'
- description: ''
- - name: getPreviouslySaved()
- uid: 'ExcelScript!ExcelScript.Workbook#getPreviouslySaved:member(1)'
- package: ExcelScript!
- fullName: getPreviouslySaved()
- summary: Specifies if the workbook has ever been saved locally or online.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPreviouslySaved(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getProperties()
- uid: 'ExcelScript!ExcelScript.Workbook#getProperties:member(1)'
- package: ExcelScript!
- fullName: getProperties()
- summary: Gets the workbook properties.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getProperties(): DocumentProperties;'
- return:
- type: ''
- description: ''
- - name: getProtection()
- uid: 'ExcelScript!ExcelScript.Workbook#getProtection:member(1)'
- package: ExcelScript!
- fullName: getProtection()
- summary: Returns the protection object for a workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getProtection(): WorkbookProtection;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script protects the workbook with a password, if it isn't already protected.
- * The password is provided by the user through a prompt.
- */
- function main(workbook: ExcelScript.Workbook, password?: string) {
- // Get the workbook-level protection object.
- const protection = workbook.getProtection();
-
- // Check if the workbook is already protected.
- if (!protection.getProtected()) {
- // Protect the workbook with the given password.
- // If the optional password was omitted,
- // no password will be needed to unprotect the workbook.
- protection.protect(password);
- }
- }
- ```
- - name: getQueries()
- uid: 'ExcelScript!ExcelScript.Workbook#getQueries:member(1)'
- package: ExcelScript!
- fullName: getQueries()
- summary: Returns a collection of Power Query queries that are part of the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getQueries(): Query[];'
- return:
- type: '[]'
- description: ''
- - name: getQuery(key)
- uid: 'ExcelScript!ExcelScript.Workbook#getQuery:member(1)'
- package: ExcelScript!
- fullName: getQuery(key)
- summary: Gets a query from the collection based on its name.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getQuery(key: string): Query;'
- parameters:
- - id: key
- description: The name of the query case-insensitive.
- type: string
- return:
- type: ''
- description: ''
- - name: getReadOnly()
- uid: 'ExcelScript!ExcelScript.Workbook#getReadOnly:member(1)'
- package: ExcelScript!
- fullName: getReadOnly()
- summary: Returns `true` if the workbook is open in read-only mode.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getReadOnly(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getSelectedRange()
- uid: 'ExcelScript!ExcelScript.Workbook#getSelectedRange:member(1)'
- package: ExcelScript!
- fullName: getSelectedRange()
- summary: >-
- Gets the currently selected single range from the workbook. If there are multiple ranges selected, this method
- will throw an error.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSelectedRange(): Range;'
- return:
- type: ''
- description: ''
- - name: getSelectedRanges()
- uid: 'ExcelScript!ExcelScript.Workbook#getSelectedRanges:member(1)'
- package: ExcelScript!
- fullName: getSelectedRanges()
- summary: >-
- Gets the currently selected one or more ranges from the workbook. Unlike `getSelectedRange()`, this method
- returns a `RangeAreas` object that represents all the selected ranges.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSelectedRanges(): RangeAreas;'
- return:
- type: ''
- description: ''
- - name: getSlicer(key)
- uid: 'ExcelScript!ExcelScript.Workbook#getSlicer:member(1)'
- package: ExcelScript!
- fullName: getSlicer(key)
- summary: 'Gets a slicer using its name or ID. If the slicer doesn''t exist, then this method returns `undefined`.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSlicer(key: string): Slicer | undefined;'
- parameters:
- - id: key
- description: Name or ID of the slicer to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getSlicers()
- uid: 'ExcelScript!ExcelScript.Workbook#getSlicers:member(1)'
- package: ExcelScript!
- fullName: getSlicers()
- summary: Represents a collection of slicers associated with the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSlicers(): Slicer[];'
- return:
- type: '[]'
- description: ''
- - name: getSlicerStyle(name)
- uid: 'ExcelScript!ExcelScript.Workbook#getSlicerStyle:member(1)'
- package: ExcelScript!
- fullName: getSlicerStyle(name)
- summary: 'Gets a `SlicerStyle` by name. If the slicer style doesn''t exist, then this method returns `undefined`.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSlicerStyle(name: string): SlicerStyle | undefined;'
- parameters:
- - id: name
- description: Name of the slicer style to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getSlicerStyles()
- uid: 'ExcelScript!ExcelScript.Workbook#getSlicerStyles:member(1)'
- package: ExcelScript!
- fullName: getSlicerStyles()
- summary: Represents a collection of SlicerStyles associated with the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSlicerStyles(): SlicerStyle[];'
- return:
- type: '[]'
- description: ''
- - name: getTable(key)
- uid: 'ExcelScript!ExcelScript.Workbook#getTable:member(1)'
- package: ExcelScript!
- fullName: getTable(key)
- summary: 'Gets a table by name or ID. If the table doesn''t exist, then this method returns `undefined`.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTable(key: string): Table | undefined;'
- parameters:
- - id: key
- description: Name or ID of the table to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getTables()
- uid: 'ExcelScript!ExcelScript.Workbook#getTables:member(1)'
- package: ExcelScript!
- fullName: getTables()
- summary: Represents a collection of tables associated with the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTables(): Table[];'
- return:
- type: '[]'
- description: ''
- - name: getTableStyle(name)
- uid: 'ExcelScript!ExcelScript.Workbook#getTableStyle:member(1)'
- package: ExcelScript!
- fullName: getTableStyle(name)
- summary: 'Gets a `TableStyle` by name. If the table style does not exist, then this method returns `undefined`.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTableStyle(name: string): TableStyle | undefined;'
- parameters:
- - id: name
- description: Name of the table style to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getTableStyles()
- uid: 'ExcelScript!ExcelScript.Workbook#getTableStyles:member(1)'
- package: ExcelScript!
- fullName: getTableStyles()
- summary: Represents a collection of TableStyles associated with the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTableStyles(): TableStyle[];'
- return:
- type: '[]'
- description: ''
- - name: getTimelineStyle(name)
- uid: 'ExcelScript!ExcelScript.Workbook#getTimelineStyle:member(1)'
- package: ExcelScript!
- fullName: getTimelineStyle(name)
- summary: 'Gets a `TimelineStyle` by name. If the timeline style doesn''t exist, then this method returns `undefined`.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTimelineStyle(name: string): TimelineStyle | undefined;'
- parameters:
- - id: name
- description: Name of the timeline style to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getTimelineStyles()
- uid: 'ExcelScript!ExcelScript.Workbook#getTimelineStyles:member(1)'
- package: ExcelScript!
- fullName: getTimelineStyles()
- summary: Represents a collection of TimelineStyles associated with the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTimelineStyles(): TimelineStyle[];'
- return:
- type: '[]'
- description: ''
- - name: getUsePrecisionAsDisplayed()
- uid: 'ExcelScript!ExcelScript.Workbook#getUsePrecisionAsDisplayed:member(1)'
- package: ExcelScript!
- fullName: getUsePrecisionAsDisplayed()
- summary: >-
- True if calculations in this workbook will be done using only the precision of the numbers as they're displayed.
- Data will permanently lose accuracy when switching this property from `false` to `true`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getUsePrecisionAsDisplayed(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getWorksheet(key)
- uid: 'ExcelScript!ExcelScript.Workbook#getWorksheet:member(1)'
- package: ExcelScript!
- fullName: getWorksheet(key)
- summary: >-
- Gets a worksheet object using its name or ID. If the worksheet does not exist, then this method returns
- `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWorksheet(key: string): Worksheet | undefined;'
- parameters:
- - id: key
- description: The name or ID of the worksheet.
- type: string
- return:
- type: ' | undefined'
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script switches the active view to a worksheet named "Data", if it exists.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Check if the "Data" worksheet exists.
- let dataWorksheet = workbook.getWorksheet("Data");
- if (dataWorksheet) {
- // Switch to the "Data" worksheet.
- dataWorksheet.activate();
- } else {
- console.log(`No worksheet named "Data" in this workbook.`);
- }
- }
- ```
- - name: getWorksheets()
- uid: 'ExcelScript!ExcelScript.Workbook#getWorksheets:member(1)'
- package: ExcelScript!
- fullName: getWorksheets()
- summary: Represents a collection of worksheets associated with the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getWorksheets(): Worksheet[];'
- return:
- type: '[]'
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script logs the names of all the worksheets in the workbook.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get all the worksheets in the workbook.
- let sheets = workbook.getWorksheets();
-
- // Get a list of all the worksheet names.
- let names = sheets.map ((sheet) => sheet.getName());
-
- // Write in the console all the worksheet names and the total count.
- console.log(names);
- console.log(`Total worksheets inside of this workbook: ${sheets.length}`);
- }
- ```
- - name: refreshAllDataConnections()
- uid: 'ExcelScript!ExcelScript.Workbook#refreshAllDataConnections:member(1)'
- package: ExcelScript!
- fullName: refreshAllDataConnections()
- summary: Refreshes all the Data Connections.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'refreshAllDataConnections(): void;'
- return:
- type: void
- description: ''
- - name: refreshAllLinksToLinkedWorkbooks()
- uid: 'ExcelScript!ExcelScript.Workbook#refreshAllLinksToLinkedWorkbooks:member(1)'
- package: ExcelScript!
- fullName: refreshAllLinksToLinkedWorkbooks()
- summary: Makes a request to refresh all the workbook links.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'refreshAllLinksToLinkedWorkbooks(): void;'
- return:
- type: void
- description: ''
- - name: refreshAllPivotTables()
- uid: 'ExcelScript!ExcelScript.Workbook#refreshAllPivotTables:member(1)'
- package: ExcelScript!
- fullName: refreshAllPivotTables()
- summary: Refreshes all the pivot tables in the collection.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'refreshAllPivotTables(): void;'
- return:
- type: void
- description: ''
- - name: setChartDataPointTrack(chartDataPointTrack)
- uid: 'ExcelScript!ExcelScript.Workbook#setChartDataPointTrack:member(1)'
- package: ExcelScript!
- fullName: setChartDataPointTrack(chartDataPointTrack)
- summary: >-
- True if all charts in the workbook are tracking the actual data points to which they are attached. False if the
- charts track the index of the data points.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setChartDataPointTrack(chartDataPointTrack: boolean): void;'
- parameters:
- - id: chartDataPointTrack
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setDefaultPivotTableStyle(newDefaultStyle)
- uid: 'ExcelScript!ExcelScript.Workbook#setDefaultPivotTableStyle:member(1)'
- package: ExcelScript!
- fullName: setDefaultPivotTableStyle(newDefaultStyle)
- summary: Sets the default PivotTable style for use in the parent object's scope.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setDefaultPivotTableStyle(
- newDefaultStyle: PivotTableStyle | string
- ): void;
- parameters:
- - id: newDefaultStyle
- description: 'The `PivotTableStyle` object, or name of the `PivotTableStyle` object, that should be the new default.'
- type: ' | string'
- return:
- type: void
- description: ''
- - name: setDefaultSlicerStyle(newDefaultStyle)
- uid: 'ExcelScript!ExcelScript.Workbook#setDefaultSlicerStyle:member(1)'
- package: ExcelScript!
- fullName: setDefaultSlicerStyle(newDefaultStyle)
- summary: Sets the default slicer style for use in the parent object's scope.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setDefaultSlicerStyle(newDefaultStyle: SlicerStyle | string): void;'
- parameters:
- - id: newDefaultStyle
- description: 'The `SlicerStyle` object, or name of the `SlicerStyle` object, that should be the new default.'
- type: ' | string'
- return:
- type: void
- description: ''
- - name: setDefaultTableStyle(newDefaultStyle)
- uid: 'ExcelScript!ExcelScript.Workbook#setDefaultTableStyle:member(1)'
- package: ExcelScript!
- fullName: setDefaultTableStyle(newDefaultStyle)
- summary: Sets the default table style for use in the parent object's scope.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setDefaultTableStyle(newDefaultStyle: TableStyle | string): void;'
- parameters:
- - id: newDefaultStyle
- description: 'The `TableStyle` object, or name of the `TableStyle` object, that should be the new default.'
- type: ' | string'
- return:
- type: void
- description: ''
- - name: setDefaultTimelineStyle(newDefaultStyle)
- uid: 'ExcelScript!ExcelScript.Workbook#setDefaultTimelineStyle:member(1)'
- package: ExcelScript!
- fullName: setDefaultTimelineStyle(newDefaultStyle)
- summary: Sets the default timeline style for use in the parent object's scope.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setDefaultTimelineStyle(newDefaultStyle: TimelineStyle | string): void;'
- parameters:
- - id: newDefaultStyle
- description: 'The `TimelineStyle` object, or name of the `TimelineStyle` object, that should be the new default.'
- type: ' | string'
- return:
- type: void
- description: ''
- - name: setIsDirty(isDirty)
- uid: 'ExcelScript!ExcelScript.Workbook#setIsDirty:member(1)'
- package: ExcelScript!
- fullName: setIsDirty(isDirty)
- summary: >-
- Specifies if changes have been made since the workbook was last saved. You can set this property to `true` if you
- want to close a modified workbook without either saving it or being prompted to save it.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setIsDirty(isDirty: boolean): void;'
- parameters:
- - id: isDirty
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setLinkedWorkbookRefreshMode(linkedWorkbookRefreshMode)
- uid: 'ExcelScript!ExcelScript.Workbook#setLinkedWorkbookRefreshMode:member(1)'
- package: ExcelScript!
- fullName: setLinkedWorkbookRefreshMode(linkedWorkbookRefreshMode)
- summary: >-
- Represents the update mode of the workbook links. The mode is same for all of the workbook links present in the
- workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setLinkedWorkbookRefreshMode(
- linkedWorkbookRefreshMode: WorkbookLinksRefreshMode
- ): void;
- parameters:
- - id: linkedWorkbookRefreshMode
- description: ''
- type: ''
- return:
- type: void
- description: ''
- - name: setUsePrecisionAsDisplayed(usePrecisionAsDisplayed)
- uid: 'ExcelScript!ExcelScript.Workbook#setUsePrecisionAsDisplayed:member(1)'
- package: ExcelScript!
- fullName: setUsePrecisionAsDisplayed(usePrecisionAsDisplayed)
- summary: >-
- True if calculations in this workbook will be done using only the precision of the numbers as they're displayed.
- Data will permanently lose accuracy when switching this property from `false` to `true`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setUsePrecisionAsDisplayed(usePrecisionAsDisplayed: boolean): void;'
- parameters:
- - id: usePrecisionAsDisplayed
- description: ''
- type: boolean
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.Workbook
+uid: 'ExcelScript!ExcelScript.Workbook:interface'
+package: ExcelScript!
+fullName: ExcelScript.Workbook
+summary: 'Workbook is the top level object which contains related workbook objects such as worksheets, tables, and ranges.'
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a new worksheet to the workbook, then switches to it.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Add a new worksheet with the default name.
+ let worksheet = workbook.addWorksheet();
+
+ // Switch focus to the new worksheet.
+ worksheet.activate();
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: 'addBinding(range, bindingType, id)'
+ uid: 'ExcelScript!ExcelScript.Workbook#addBinding:member(1)'
+ package: ExcelScript!
+ fullName: 'addBinding(range, bindingType, id)'
+ summary: Add a new binding to a particular Range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ addBinding(
+ range: Range | string,
+ bindingType: BindingType,
+ id: string
+ ): Binding;
+ parameters:
+ - id: range
+ description: >-
+ Range to bind the binding to. May be a `Range` object or a string. If string, must contain the full address,
+ including the sheet name
+ type: ' | string'
+ - id: bindingType
+ description: Type of binding. See `ExcelScript.BindingType`.
+ type: ''
+ - id: id
+ description: Name of the binding.
+ type: string
+ return:
+ type: ''
+ description: ''
+ - name: 'addBindingFromNamedItem(name, bindingType, id)'
+ uid: 'ExcelScript!ExcelScript.Workbook#addBindingFromNamedItem:member(1)'
+ package: ExcelScript!
+ fullName: 'addBindingFromNamedItem(name, bindingType, id)'
+ summary: >-
+ Add a new binding based on a named item in the workbook. If the named item references to multiple areas, the
+ `InvalidReference` error will be returned.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ addBindingFromNamedItem(
+ name: string,
+ bindingType: BindingType,
+ id: string
+ ): Binding;
+ parameters:
+ - id: name
+ description: Name from which to create binding.
+ type: string
+ - id: bindingType
+ description: Type of binding. See `ExcelScript.BindingType`.
+ type: ''
+ - id: id
+ description: Name of the binding.
+ type: string
+ return:
+ type: ''
+ description: ''
+ - name: 'addBindingFromSelection(bindingType, id)'
+ uid: 'ExcelScript!ExcelScript.Workbook#addBindingFromSelection:member(1)'
+ package: ExcelScript!
+ fullName: 'addBindingFromSelection(bindingType, id)'
+ summary: >-
+ Add a new binding based on the current selection. If the selection has multiple areas, the `InvalidReference`
+ error will be returned.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addBindingFromSelection(bindingType: BindingType, id: string): Binding;'
+ parameters:
+ - id: bindingType
+ description: Type of binding. See `ExcelScript.BindingType`.
+ type: ''
+ - id: id
+ description: Name of the binding.
+ type: string
+ return:
+ type: ''
+ description: ''
+ - name: 'addComment(cellAddress, content, contentType)'
+ uid: 'ExcelScript!ExcelScript.Workbook#addComment:member(1)'
+ package: ExcelScript!
+ fullName: 'addComment(cellAddress, content, contentType)'
+ summary: >-
+ Creates a new comment with the given content on the given cell. An `InvalidArgument` error is thrown if the
+ provided range is larger than one cell.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ addComment(
+ cellAddress: Range | string,
+ content: CommentRichContent | string,
+ contentType?: ContentType
+ ): Comment;
+ parameters:
+ - id: cellAddress
+ description: >-
+ The cell to which the comment is added. This can be a `Range` object or a string. If it's a string, it must
+ contain the full address, including the sheet name. An `InvalidArgument` error is thrown if the provided
+ range is larger than one cell.
+ type: ' | string'
+ - id: content
+ description: >-
+ The comment's content. This can be either a string or `CommentRichContent` object. Strings are used for
+ plain text. `CommentRichContent` objects allow for other comment features, such as mentions.
+ type: ' | string'
+ - id: contentType
+ description: >-
+ Optional. The type of content contained within the comment. The default value is enum
+ `ContentType.Plain`.
+ type: ''
+ return:
+ type: ''
+ description: ''
+ - name: addCustomXmlPart(xml)
+ uid: 'ExcelScript!ExcelScript.Workbook#addCustomXmlPart:member(1)'
+ package: ExcelScript!
+ fullName: addCustomXmlPart(xml)
+ summary: Adds a new custom XML part to the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addCustomXmlPart(xml: string): CustomXmlPart;'
+ parameters:
+ - id: xml
+ description: XML content. Must be a valid XML fragment.
+ type: string
+ return:
+ type: ''
+ description: ''
+ - name: 'addNamedItem(name, reference, comment)'
+ uid: 'ExcelScript!ExcelScript.Workbook#addNamedItem:member(1)'
+ package: ExcelScript!
+ fullName: 'addNamedItem(name, reference, comment)'
+ summary: Adds a new name to the collection of the given scope.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ addNamedItem(
+ name: string,
+ reference: Range | string,
+ comment?: string
+ ): NamedItem;
+ parameters:
+ - id: name
+ description: The name of the named item.
+ type: string
+ - id: reference
+ description: The formula or the range that the name will refer to.
+ type: ' | string'
+ - id: comment
+ description: Optional. The comment associated with the named item.
+ type: string
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a named formula and uses it in another part of the workbook.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Create a named item for a formula.
+ // This formula is the sum of the cells F2:F21 on Sheet1.
+ const namedItem: ExcelScript.NamedItem = workbook.addNamedItem(
+ "GrandTotal",
+ "=SUM(Sheet1!$F$2:$F$21)",
+ "The sum of table sums."
+ );
+
+ // Add this named formula to a new sheet in the workbook.
+ const otherSheet = workbook.addWorksheet();
+ otherSheet.getRange("A1").setFormula(namedItem.getFormula());
+
+ // Switch to the new worksheet.
+ otherSheet.activate();
+ }
+ ```
+ - name: 'addNamedItemFormulaLocal(name, formula, comment)'
+ uid: 'ExcelScript!ExcelScript.Workbook#addNamedItemFormulaLocal:member(1)'
+ package: ExcelScript!
+ fullName: 'addNamedItemFormulaLocal(name, formula, comment)'
+ summary: Adds a new name to the collection of the given scope using the user's locale for the formula.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ addNamedItemFormulaLocal(
+ name: string,
+ formula: string,
+ comment?: string
+ ): NamedItem;
+ parameters:
+ - id: name
+ description: The name of the named item.
+ type: string
+ - id: formula
+ description: The formula in the user's locale that the name will refer to.
+ type: string
+ - id: comment
+ description: Optional. The comment associated with the named item.
+ type: string
+ return:
+ type: ''
+ description: ''
+ - name: 'addPivotTable(name, source, destination)'
+ uid: 'ExcelScript!ExcelScript.Workbook#addPivotTable:member(1)'
+ package: ExcelScript!
+ fullName: 'addPivotTable(name, source, destination)'
+ summary: Add a PivotTable based on the specified source data and insert it at the top-left cell of the destination range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ addPivotTable(
+ name: string,
+ source: Range | string | Table,
+ destination: Range | string
+ ): PivotTable;
+ parameters:
+ - id: name
+ description: The name of the new PivotTable.
+ type: string
+ - id: source
+ description: >-
+ The source data for the new PivotTable, this can either be a range (or string address including the
+ worksheet name) or a table.
+ type: >-
+ | string |
+ - id: destination
+ description: >-
+ The cell in the upper-left corner of the PivotTable report's destination range (the range on the worksheet
+ where the resulting report will be placed).
+ type: ' | string'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a PivotTable from an existing table and adds it to an existing worksheet.
+ * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
+ * It also assumes there is a worksheet named "PivotSheet".
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Create a PivotTable based on a table in the current worksheet.
+ let sheet = workbook.getActiveWorksheet();
+ let table = sheet.getTables()[0];
+ let pivotTable = workbook.addPivotTable("My Pivot", table, "PivotSheet!A1");
+
+ // Add fields to the PivotTable to show "Sales" per "Type".
+ pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
+ pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
+ }
+ ```
+ - name: 'addPivotTableStyle(name, makeUniqueName)'
+ uid: 'ExcelScript!ExcelScript.Workbook#addPivotTableStyle:member(1)'
+ package: ExcelScript!
+ fullName: 'addPivotTableStyle(name, makeUniqueName)'
+ summary: Creates a blank `PivotTableStyle` with the specified name.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ addPivotTableStyle(
+ name: string,
+ makeUniqueName?: boolean
+ ): PivotTableStyle;
+ parameters:
+ - id: name
+ description: >-
+ The unique name for the new PivotTable style. Will throw an `InvalidArgument` error if the name is already
+ in use.
+ type: string
+ - id: makeUniqueName
+ description: >-
+ Optional. Defaults to `false`. If `true`, will append numbers to the name in order to make
+ it unique, if needed.
+ type: boolean
+ return:
+ type: ''
+ description: ''
+ - name: addPredefinedCellStyle(name)
+ uid: 'ExcelScript!ExcelScript.Workbook#addPredefinedCellStyle:member(1)'
+ package: ExcelScript!
+ fullName: addPredefinedCellStyle(name)
+ summary: Adds a new style to the collection.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addPredefinedCellStyle(name: string): void;'
+ parameters:
+ - id: name
+ description: Name of the style to be added.
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: 'addSlicer(slicerSource, sourceField, slicerDestination)'
+ uid: 'ExcelScript!ExcelScript.Workbook#addSlicer:member(1)'
+ package: ExcelScript!
+ fullName: 'addSlicer(slicerSource, sourceField, slicerDestination)'
+ summary: Adds a new slicer to the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ addSlicer(
+ slicerSource: string | PivotTable | Table,
+ sourceField: string | PivotField | number | TableColumn,
+ slicerDestination?: string | Worksheet
+ ): Slicer;
+ parameters:
+ - id: slicerSource
+ description: >-
+ The data source that the new slicer will be based on. It can be a `PivotTable` object, a `Table` object, or
+ a string. When a PivotTable object is passed, the data source is the source of the `PivotTable` object. When
+ a `Table` object is passed, the data source is the `Table` object. When a string is passed, it is
+ interpreted as the name or ID of a PivotTable or table.
+ type: >-
+ string | |
+ - id: sourceField
+ description: >-
+ The field in the data source to filter by. It can be a `PivotField` object, a `TableColumn` object, the ID
+ of a `PivotField` or the name or ID of a `TableColumn`.
+ type: >-
+ string | | number |
+ - id: slicerDestination
+ description: >-
+ Optional. The worksheet in which the new slicer will be created. It can be a `Worksheet` object or the name
+ or ID of a worksheet. This parameter can be omitted if the slicer collection is retrieved from a worksheet.
+ type: 'string | '
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a slicer for an existing PivotTable.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the PivotTable named "Farm Pivot".
+ const farmPivot = workbook.getPivotTable("Farm Pivot");
+
+ // Create the slicer.
+ // Note that this assumes "Type" is already added as a hierarchy to the PivotTable.
+ const fruitSlicer: ExcelScript.Slicer = workbook.addSlicer(
+ farmPivot, /* The table or PivotTale to be sliced. */
+ farmPivot.getHierarchy("Type").getFields()[0] /* What source field to use as the slicer options. */
+ );
+
+ // Select the items to display.
+ fruitSlicer.selectItems(["Lemon", "Lime"]);
+
+ // Set the left margin of the slicer.
+ fruitSlicer.setLeft(400);
+ }
+ ```
+ - name: 'addSlicerStyle(name, makeUniqueName)'
+ uid: 'ExcelScript!ExcelScript.Workbook#addSlicerStyle:member(1)'
+ package: ExcelScript!
+ fullName: 'addSlicerStyle(name, makeUniqueName)'
+ summary: Creates a blank slicer style with the specified name.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addSlicerStyle(name: string, makeUniqueName?: boolean): SlicerStyle;'
+ parameters:
+ - id: name
+ description: >-
+ The unique name for the new slicer style. Will throw an `InvalidArgument` exception if the name is already
+ in use.
+ type: string
+ - id: makeUniqueName
+ description: >-
+ Optional. Defaults to `false`. If `true`, will append numbers to the name in order to make
+ it unique, if needed.
+ type: boolean
+ return:
+ type: ''
+ description: ''
+ - name: 'addTable(address, hasHeaders)'
+ uid: 'ExcelScript!ExcelScript.Workbook#addTable:member(1)'
+ package: ExcelScript!
+ fullName: 'addTable(address, hasHeaders)'
+ summary: >-
+ Creates a new table. The range object or source address determines the worksheet under which the table will be
+ added. If the table cannot be added (e.g., because the address is invalid, or the table would overlap with another
+ table), an error will be thrown.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addTable(address: Range | string, hasHeaders: boolean): Table;'
+ parameters:
+ - id: address
+ description: >-
+ A `Range` object, or a string address or name of the range representing the data source. If the address does
+ not contain a sheet name, the currently-active sheet is used.
+ type: ' | string'
+ - id: hasHeaders
+ description: >-
+ A boolean value that indicates whether the data being imported has column labels. If the source does not
+ contain headers (i.e., when this property set to `false`), Excel will automatically generate a
+ header and shift the data down by one row.
+ type: boolean
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample converts the information in the first worksheet
+ * into a table with headers.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // This assumes there is one contiguous range in the first worksheet.
+ const dataRange = workbook.getFirstWorksheet().getUsedRange();
+
+ // Add a table at the workbook level.
+ workbook.addTable(dataRange.getAddress(), true);
+ }
+ ```
+ - name: 'addTableStyle(name, makeUniqueName)'
+ uid: 'ExcelScript!ExcelScript.Workbook#addTableStyle:member(1)'
+ package: ExcelScript!
+ fullName: 'addTableStyle(name, makeUniqueName)'
+ summary: Creates a blank `TableStyle` with the specified name.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addTableStyle(name: string, makeUniqueName?: boolean): TableStyle;'
+ parameters:
+ - id: name
+ description: >-
+ The unique name for the new table style. Will throw an `InvalidArgument` error if the name is already in
+ use.
+ type: string
+ - id: makeUniqueName
+ description: >-
+ Optional. Defaults to `false`. If `true`, will append numbers to the name in order to make
+ it unique, if needed.
+ type: boolean
+ return:
+ type: ''
+ description: ''
+ - name: 'addTimelineStyle(name, makeUniqueName)'
+ uid: 'ExcelScript!ExcelScript.Workbook#addTimelineStyle:member(1)'
+ package: ExcelScript!
+ fullName: 'addTimelineStyle(name, makeUniqueName)'
+ summary: Creates a blank `TimelineStyle` with the specified name.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addTimelineStyle(name: string, makeUniqueName?: boolean): TimelineStyle;'
+ parameters:
+ - id: name
+ description: >-
+ The unique name for the new timeline style. Will throw an `InvalidArgument` error if the name is already in
+ use.
+ type: string
+ - id: makeUniqueName
+ description: >-
+ Optional. Defaults to `false`. If `true`, will append numbers to the name in order to make
+ it unique, if needed.
+ type: boolean
+ return:
+ type: ''
+ description: ''
+ - name: addWorksheet(name)
+ uid: 'ExcelScript!ExcelScript.Workbook#addWorksheet:member(1)'
+ package: ExcelScript!
+ fullName: addWorksheet(name)
+ summary: >-
+ Adds a new worksheet to the workbook. The worksheet will be added at the end of existing worksheets. If you wish
+ to activate the newly added worksheet, call `.activate()` on it.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addWorksheet(name?: string): Worksheet;'
+ parameters:
+ - id: name
+ description: >-
+ Optional. The name of the worksheet to be added. If specified, the name should be unique. If not specified,
+ Excel determines the name of the new worksheet.
+ type: string
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a new worksheet named "Data" to the workbook.
+ * If a worksheet with that name already exists, the script logs a note.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Check if the "Data" worksheet already exists.
+ if (workbook.getWorksheet("Data")) {
+ console.log("The Data worksheet is already in the workbook.");
+ } else {
+ // Add a new worksheet.
+ let worksheet = workbook.addWorksheet("Data");
+ }
+ }
+ ```
+ - name: breakAllLinksToLinkedWorkbooks()
+ uid: 'ExcelScript!ExcelScript.Workbook#breakAllLinksToLinkedWorkbooks:member(1)'
+ package: ExcelScript!
+ fullName: breakAllLinksToLinkedWorkbooks()
+ summary: >-
+ Breaks all the links to the linked workbooks. Once the links are broken, any formulas referencing workbook links
+ are removed entirely and replaced with the most recently retrieved values.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'breakAllLinksToLinkedWorkbooks(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getActiveCell()
+ uid: 'ExcelScript!ExcelScript.Workbook#getActiveCell:member(1)'
+ package: ExcelScript!
+ fullName: getActiveCell()
+ summary: Gets the currently active cell from the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getActiveCell(): Range;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script logs the value of the current active cell.
+ * If multiple cells are selected, the top-leftmost cell will be logged.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current active cell in the workbook.
+ let cell = workbook.getActiveCell();
+ console.log(`The current cell's value is ${cell.getValue()}`);
+ }
+ ```
+ - name: getActiveChart()
+ uid: 'ExcelScript!ExcelScript.Workbook#getActiveChart:member(1)'
+ package: ExcelScript!
+ fullName: getActiveChart()
+ summary: >-
+ Gets the currently active chart in the workbook. If there is no active chart, then this method returns
+ `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getActiveChart(): Chart;'
+ return:
+ type: ''
+ description: ''
+ - name: getActiveSlicer()
+ uid: 'ExcelScript!ExcelScript.Workbook#getActiveSlicer:member(1)'
+ package: ExcelScript!
+ fullName: getActiveSlicer()
+ summary: >-
+ Gets the currently active slicer in the workbook. If there is no active slicer, then this method returns
+ `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getActiveSlicer(): Slicer;'
+ return:
+ type: ''
+ description: ''
+ - name: getActiveWorksheet()
+ uid: 'ExcelScript!ExcelScript.Workbook#getActiveWorksheet:member(1)'
+ package: ExcelScript!
+ fullName: getActiveWorksheet()
+ summary: Gets the currently active worksheet in the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getActiveWorksheet(): Worksheet;'
+ return:
+ type: ''
+ description: ''
+ - name: getApplication()
+ uid: 'ExcelScript!ExcelScript.Workbook#getApplication:member(1)'
+ package: ExcelScript!
+ fullName: getApplication()
+ summary: Represents the Excel application instance that contains this workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getApplication(): Application;'
+ return:
+ type: ''
+ description: ''
+ - name: getAutoSave()
+ uid: 'ExcelScript!ExcelScript.Workbook#getAutoSave:member(1)'
+ package: ExcelScript!
+ fullName: getAutoSave()
+ summary: Specifies if the workbook is in AutoSave mode.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAutoSave(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getBinding(id)
+ uid: 'ExcelScript!ExcelScript.Workbook#getBinding:member(1)'
+ package: ExcelScript!
+ fullName: getBinding(id)
+ summary: 'Gets a binding object by ID. If the binding object does not exist, then this method returns `undefined`.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBinding(id: string): Binding | undefined;'
+ parameters:
+ - id: id
+ description: ID of the binding object to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getBindings()
+ uid: 'ExcelScript!ExcelScript.Workbook#getBindings:member(1)'
+ package: ExcelScript!
+ fullName: getBindings()
+ summary: Represents a collection of bindings that are part of the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBindings(): Binding[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getCalculationEngineVersion()
+ uid: 'ExcelScript!ExcelScript.Workbook#getCalculationEngineVersion:member(1)'
+ package: ExcelScript!
+ fullName: getCalculationEngineVersion()
+ summary: Returns a number about the version of Excel Calculation Engine.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCalculationEngineVersion(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getChartDataPointTrack()
+ uid: 'ExcelScript!ExcelScript.Workbook#getChartDataPointTrack:member(1)'
+ package: ExcelScript!
+ fullName: getChartDataPointTrack()
+ summary: >-
+ True if all charts in the workbook are tracking the actual data points to which they are attached. False if the
+ charts track the index of the data points.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getChartDataPointTrack(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getComment(commentId)
+ uid: 'ExcelScript!ExcelScript.Workbook#getComment:member(1)'
+ package: ExcelScript!
+ fullName: getComment(commentId)
+ summary: >-
+ Gets a comment from the collection based on its ID. If the comment object does not exist, then this method returns
+ `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getComment(commentId: string): Comment | undefined;'
+ parameters:
+ - id: commentId
+ description: The identifier for the comment.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getCommentByCell(cellAddress)
+ uid: 'ExcelScript!ExcelScript.Workbook#getCommentByCell:member(1)'
+ package: ExcelScript!
+ fullName: getCommentByCell(cellAddress)
+ summary: 'Gets the comment from the specified cell. If there is no comment in the cell, an error is thrown.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCommentByCell(cellAddress: Range | string): Comment;'
+ parameters:
+ - id: cellAddress
+ description: >-
+ The cell which the comment is on. This can be a `Range` object or a string. If it's a string, it must
+ contain the full address, including the sheet name. An `InvalidArgument` error is thrown if the provided
+ range is larger than one cell.
+ type: ' | string'
+ return:
+ type: ''
+ description: ''
+ - name: getCommentByReplyId(replyId)
+ uid: 'ExcelScript!ExcelScript.Workbook#getCommentByReplyId:member(1)'
+ package: ExcelScript!
+ fullName: getCommentByReplyId(replyId)
+ summary: Gets the comment to which the given reply is connected.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCommentByReplyId(replyId: string): Comment;'
+ parameters:
+ - id: replyId
+ description: The identifier of comment reply.
+ type: string
+ return:
+ type: ''
+ description: ''
+ - name: getComments()
+ uid: 'ExcelScript!ExcelScript.Workbook#getComments:member(1)'
+ package: ExcelScript!
+ fullName: getComments()
+ summary: Represents a collection of comments associated with the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getComments(): Comment[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getCustomXmlPart(id)
+ uid: 'ExcelScript!ExcelScript.Workbook#getCustomXmlPart:member(1)'
+ package: ExcelScript!
+ fullName: getCustomXmlPart(id)
+ summary: >-
+ Gets a custom XML part based on its ID. If the `CustomXmlPart` does not exist, then this method returns
+ `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCustomXmlPart(id: string): CustomXmlPart | undefined;'
+ parameters:
+ - id: id
+ description: ID of the object to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getCustomXmlPartByNamespace(namespaceUri)
+ uid: 'ExcelScript!ExcelScript.Workbook#getCustomXmlPartByNamespace:member(1)'
+ package: ExcelScript!
+ fullName: getCustomXmlPartByNamespace(namespaceUri)
+ summary: Gets a new collection of custom XML parts whose namespaces match the given namespace.
+ remarks: ''
+ isPreview: false
+ isDeprecated: true
+ customDeprecatedMessage: Use `getCustomXmlPartsByNamespace` instead.
+ syntax:
+ content: 'getCustomXmlPartByNamespace(namespaceUri: string): CustomXmlPart[];'
+ parameters:
+ - id: namespaceUri
+ description: 'This must be a fully qualified schema URI; for example, "http://schemas.contoso.com/review/1.0".'
+ type: string
+ return:
+ type: '[]'
+ description: ''
+ - name: getCustomXmlParts()
+ uid: 'ExcelScript!ExcelScript.Workbook#getCustomXmlParts:member(1)'
+ package: ExcelScript!
+ fullName: getCustomXmlParts()
+ summary: Represents the collection of custom XML parts contained by this workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCustomXmlParts(): CustomXmlPart[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getCustomXmlPartsByNamespace(namespaceUri)
+ uid: 'ExcelScript!ExcelScript.Workbook#getCustomXmlPartsByNamespace:member(1)'
+ package: ExcelScript!
+ fullName: getCustomXmlPartsByNamespace(namespaceUri)
+ summary: Gets a new collection of custom XML parts whose namespaces match the given namespace.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCustomXmlPartsByNamespace(namespaceUri: string): CustomXmlPart[];'
+ parameters:
+ - id: namespaceUri
+ description: 'This must be a fully qualified schema URI; for example, "http://schemas.contoso.com/review/1.0".'
+ type: string
+ return:
+ type: '[]'
+ description: ''
+ - name: getDefaultPivotTableStyle()
+ uid: 'ExcelScript!ExcelScript.Workbook#getDefaultPivotTableStyle:member(1)'
+ package: ExcelScript!
+ fullName: getDefaultPivotTableStyle()
+ summary: Gets the default PivotTable style for the parent object's scope.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDefaultPivotTableStyle(): PivotTableStyle;'
+ return:
+ type: ''
+ description: ''
+ - name: getDefaultSlicerStyle()
+ uid: 'ExcelScript!ExcelScript.Workbook#getDefaultSlicerStyle:member(1)'
+ package: ExcelScript!
+ fullName: getDefaultSlicerStyle()
+ summary: Gets the default `SlicerStyle` for the parent object's scope.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDefaultSlicerStyle(): SlicerStyle;'
+ return:
+ type: ''
+ description: ''
+ - name: getDefaultTableStyle()
+ uid: 'ExcelScript!ExcelScript.Workbook#getDefaultTableStyle:member(1)'
+ package: ExcelScript!
+ fullName: getDefaultTableStyle()
+ summary: Gets the default table style for the parent object's scope.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDefaultTableStyle(): TableStyle;'
+ return:
+ type: ''
+ description: ''
+ - name: getDefaultTimelineStyle()
+ uid: 'ExcelScript!ExcelScript.Workbook#getDefaultTimelineStyle:member(1)'
+ package: ExcelScript!
+ fullName: getDefaultTimelineStyle()
+ summary: Gets the default timeline style for the parent object's scope.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDefaultTimelineStyle(): TimelineStyle;'
+ return:
+ type: ''
+ description: ''
+ - name: getFirstWorksheet(visibleOnly)
+ uid: 'ExcelScript!ExcelScript.Workbook#getFirstWorksheet:member(1)'
+ package: ExcelScript!
+ fullName: getFirstWorksheet(visibleOnly)
+ summary: Gets the first worksheet in the collection.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFirstWorksheet(visibleOnly?: boolean): Worksheet;'
+ parameters:
+ - id: visibleOnly
+ description: 'Optional. If `true`, considers only visible worksheets, skipping over any hidden ones.'
+ type: boolean
+ return:
+ type: ''
+ description: ''
+ - name: getIsDirty()
+ uid: 'ExcelScript!ExcelScript.Workbook#getIsDirty:member(1)'
+ package: ExcelScript!
+ fullName: getIsDirty()
+ summary: >-
+ Specifies if changes have been made since the workbook was last saved. You can set this property to `true` if you
+ want to close a modified workbook without either saving it or being prompted to save it.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIsDirty(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getLastWorksheet(visibleOnly)
+ uid: 'ExcelScript!ExcelScript.Workbook#getLastWorksheet:member(1)'
+ package: ExcelScript!
+ fullName: getLastWorksheet(visibleOnly)
+ summary: Gets the last worksheet in the collection.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLastWorksheet(visibleOnly?: boolean): Worksheet;'
+ parameters:
+ - id: visibleOnly
+ description: 'Optional. If `true`, considers only visible worksheets, skipping over any hidden ones.'
+ type: boolean
+ return:
+ type: ''
+ description: ''
+ - name: getLinkedWorkbookByUrl(key)
+ uid: 'ExcelScript!ExcelScript.Workbook#getLinkedWorkbookByUrl:member(1)'
+ package: ExcelScript!
+ fullName: getLinkedWorkbookByUrl(key)
+ summary: >-
+ Gets information about a linked workbook by its URL. If the workbook does not exist, then this method returns
+ `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLinkedWorkbookByUrl(key: string): LinkedWorkbook | undefined;'
+ parameters:
+ - id: key
+ description: The URL of the linked workbook.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getLinkedWorkbookRefreshMode()
+ uid: 'ExcelScript!ExcelScript.Workbook#getLinkedWorkbookRefreshMode:member(1)'
+ package: ExcelScript!
+ fullName: getLinkedWorkbookRefreshMode()
+ summary: >-
+ Represents the update mode of the workbook links. The mode is same for all of the workbook links present in the
+ workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLinkedWorkbookRefreshMode(): WorkbookLinksRefreshMode;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script refreshes all the links to external workbooks,
+ * if the linked workbook refresh mode is set to manual.
+ * To learn about linked workbooks, see https://support.microsoft.com/office/c98d1803-dd75-4668-ac6a-d7cca2a9b95f.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Check the refresh mode.
+ if (workbook.getLinkedWorkbookRefreshMode() === ExcelScript.WorkbookLinksRefreshMode.manual) {
+ console.log("Refreshing workbook links");
+
+ // Trigger a refresh of linked workbook content.
+ workbook.refreshAllLinksToLinkedWorkbooks();
+ }
+ ```
+ - name: getLinkedWorkbooks()
+ uid: 'ExcelScript!ExcelScript.Workbook#getLinkedWorkbooks:member(1)'
+ package: ExcelScript!
+ fullName: getLinkedWorkbooks()
+ summary: >-
+ Returns a collection of linked workbooks. In formulas, the workbook links can be used to reference data (cell
+ values and names) outside of the current workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLinkedWorkbooks(): LinkedWorkbook[];'
+ return:
+ type: '[]'
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script removes all links to other workbooks.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get all the linked workbook references.
+ const externalWorkbooks: ExcelScript.LinkedWorkbook[] = workbook.getLinkedWorkbooks();
+ console.log(`There are ${externalWorkbooks.length} other workbooks linked to from this workbook.`);
+
+ // Remove all the links to those workbooks.
+ // This changes the value of cells with workbook links to "#CONNECT!".
+ externalWorkbooks.forEach((workbookLink) => {
+ workbookLink.breakLinks();
+ });
+ }
+ ```
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.Workbook#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: Gets the workbook name.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script logs the name of the workbook without the ".xlsx" extension.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the workbook's name.
+ let name = workbook.getName();
+
+ // Remove the file extension.
+ name = name.substring(0, name.lastIndexOf(".xlsx"));
+
+ // Display the name in the console.
+ console.log(name);
+ }
+ ```
+ - name: getNamedItem(name)
+ uid: 'ExcelScript!ExcelScript.Workbook#getNamedItem:member(1)'
+ package: ExcelScript!
+ fullName: getNamedItem(name)
+ summary: >-
+ Gets a `NamedItem` object using its name. If the object does not exist, then this method returns `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNamedItem(name: string): NamedItem | undefined;'
+ parameters:
+ - id: name
+ description: Nameditem name.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getNames()
+ uid: 'ExcelScript!ExcelScript.Workbook#getNames:member(1)'
+ package: ExcelScript!
+ fullName: getNames()
+ summary: Represents a collection of workbook-scoped named items (named ranges and constants).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNames(): NamedItem[];'
+ return:
+ type: '[]'
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script looks for every named range with "Review" in the name
+ * and marks the range with a yellow fill.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Look at every named item in the workbook.
+ workbook.getNames().forEach((namedItem) => {
+ // Find names containing "Review".
+ if (namedItem.getName().includes("Review")) {
+ // Only change the fill color if the named item is a range (not a formula).
+ let itemType: ExcelScript.NamedItemType = namedItem.getType();
+ if (itemType === ExcelScript.NamedItemType.range) {
+ // Set the range's fill color to yellow.
+ namedItem.getRange().getFormat().getFill().setColor("yellow");
+ }
+ }
+ });
+ }
+ ```
+ - name: getPivotTable(name)
+ uid: 'ExcelScript!ExcelScript.Workbook#getPivotTable:member(1)'
+ package: ExcelScript!
+ fullName: getPivotTable(name)
+ summary: 'Gets a PivotTable by name. If the PivotTable does not exist, then this method returns `undefined`.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPivotTable(name: string): PivotTable | undefined;'
+ parameters:
+ - id: name
+ description: Name of the PivotTable to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getPivotTables()
+ uid: 'ExcelScript!ExcelScript.Workbook#getPivotTables:member(1)'
+ package: ExcelScript!
+ fullName: getPivotTables()
+ summary: Represents a collection of PivotTables associated with the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPivotTables(): PivotTable[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getPivotTableStyle(name)
+ uid: 'ExcelScript!ExcelScript.Workbook#getPivotTableStyle:member(1)'
+ package: ExcelScript!
+ fullName: getPivotTableStyle(name)
+ summary: >-
+ Gets a `PivotTableStyle` by name. If the `PivotTableStyle` does not exist, then this method returns
+ `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPivotTableStyle(name: string): PivotTableStyle | undefined;'
+ parameters:
+ - id: name
+ description: Name of the PivotTable style to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getPivotTableStyles()
+ uid: 'ExcelScript!ExcelScript.Workbook#getPivotTableStyles:member(1)'
+ package: ExcelScript!
+ fullName: getPivotTableStyles()
+ summary: Represents a collection of PivotTableStyles associated with the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPivotTableStyles(): PivotTableStyle[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getPredefinedCellStyle(name)
+ uid: 'ExcelScript!ExcelScript.Workbook#getPredefinedCellStyle:member(1)'
+ package: ExcelScript!
+ fullName: getPredefinedCellStyle(name)
+ summary: 'Gets a style by name. If the style object does not exist, then this method returns `undefined`.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPredefinedCellStyle(name: string): PredefinedCellStyle | undefined;'
+ parameters:
+ - id: name
+ description: Name of the style to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getPredefinedCellStyles()
+ uid: 'ExcelScript!ExcelScript.Workbook#getPredefinedCellStyles:member(1)'
+ package: ExcelScript!
+ fullName: getPredefinedCellStyles()
+ summary: Represents a collection of styles associated with the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPredefinedCellStyles(): PredefinedCellStyle[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getPreviouslySaved()
+ uid: 'ExcelScript!ExcelScript.Workbook#getPreviouslySaved:member(1)'
+ package: ExcelScript!
+ fullName: getPreviouslySaved()
+ summary: Specifies if the workbook has ever been saved locally or online.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPreviouslySaved(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getProperties()
+ uid: 'ExcelScript!ExcelScript.Workbook#getProperties:member(1)'
+ package: ExcelScript!
+ fullName: getProperties()
+ summary: Gets the workbook properties.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getProperties(): DocumentProperties;'
+ return:
+ type: ''
+ description: ''
+ - name: getProtection()
+ uid: 'ExcelScript!ExcelScript.Workbook#getProtection:member(1)'
+ package: ExcelScript!
+ fullName: getProtection()
+ summary: Returns the protection object for a workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getProtection(): WorkbookProtection;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script protects the workbook with a password, if it isn't already protected.
+ * The password is provided by the user through a prompt.
+ */
+ function main(workbook: ExcelScript.Workbook, password?: string) {
+ // Get the workbook-level protection object.
+ const protection = workbook.getProtection();
+
+ // Check if the workbook is already protected.
+ if (!protection.getProtected()) {
+ // Protect the workbook with the given password.
+ // If the optional password was omitted,
+ // no password will be needed to unprotect the workbook.
+ protection.protect(password);
+ }
+ }
+ ```
+ - name: getQueries()
+ uid: 'ExcelScript!ExcelScript.Workbook#getQueries:member(1)'
+ package: ExcelScript!
+ fullName: getQueries()
+ summary: Returns a collection of Power Query queries that are part of the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getQueries(): Query[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getQuery(key)
+ uid: 'ExcelScript!ExcelScript.Workbook#getQuery:member(1)'
+ package: ExcelScript!
+ fullName: getQuery(key)
+ summary: Gets a query from the collection based on its name.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getQuery(key: string): Query;'
+ parameters:
+ - id: key
+ description: The name of the query case-insensitive.
+ type: string
+ return:
+ type: ''
+ description: ''
+ - name: getReadOnly()
+ uid: 'ExcelScript!ExcelScript.Workbook#getReadOnly:member(1)'
+ package: ExcelScript!
+ fullName: getReadOnly()
+ summary: Returns `true` if the workbook is open in read-only mode.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getReadOnly(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getSelectedRange()
+ uid: 'ExcelScript!ExcelScript.Workbook#getSelectedRange:member(1)'
+ package: ExcelScript!
+ fullName: getSelectedRange()
+ summary: >-
+ Gets the currently selected single range from the workbook. If there are multiple ranges selected, this method
+ will throw an error.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSelectedRange(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: getSelectedRanges()
+ uid: 'ExcelScript!ExcelScript.Workbook#getSelectedRanges:member(1)'
+ package: ExcelScript!
+ fullName: getSelectedRanges()
+ summary: >-
+ Gets the currently selected one or more ranges from the workbook. Unlike `getSelectedRange()`, this method
+ returns a `RangeAreas` object that represents all the selected ranges.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSelectedRanges(): RangeAreas;'
+ return:
+ type: ''
+ description: ''
+ - name: getSlicer(key)
+ uid: 'ExcelScript!ExcelScript.Workbook#getSlicer:member(1)'
+ package: ExcelScript!
+ fullName: getSlicer(key)
+ summary: 'Gets a slicer using its name or ID. If the slicer doesn''t exist, then this method returns `undefined`.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSlicer(key: string): Slicer | undefined;'
+ parameters:
+ - id: key
+ description: Name or ID of the slicer to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getSlicers()
+ uid: 'ExcelScript!ExcelScript.Workbook#getSlicers:member(1)'
+ package: ExcelScript!
+ fullName: getSlicers()
+ summary: Represents a collection of slicers associated with the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSlicers(): Slicer[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getSlicerStyle(name)
+ uid: 'ExcelScript!ExcelScript.Workbook#getSlicerStyle:member(1)'
+ package: ExcelScript!
+ fullName: getSlicerStyle(name)
+ summary: 'Gets a `SlicerStyle` by name. If the slicer style doesn''t exist, then this method returns `undefined`.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSlicerStyle(name: string): SlicerStyle | undefined;'
+ parameters:
+ - id: name
+ description: Name of the slicer style to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getSlicerStyles()
+ uid: 'ExcelScript!ExcelScript.Workbook#getSlicerStyles:member(1)'
+ package: ExcelScript!
+ fullName: getSlicerStyles()
+ summary: Represents a collection of SlicerStyles associated with the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSlicerStyles(): SlicerStyle[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getTable(key)
+ uid: 'ExcelScript!ExcelScript.Workbook#getTable:member(1)'
+ package: ExcelScript!
+ fullName: getTable(key)
+ summary: 'Gets a table by name or ID. If the table doesn''t exist, then this method returns `undefined`.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTable(key: string): Table | undefined;'
+ parameters:
+ - id: key
+ description: Name or ID of the table to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getTables()
+ uid: 'ExcelScript!ExcelScript.Workbook#getTables:member(1)'
+ package: ExcelScript!
+ fullName: getTables()
+ summary: Represents a collection of tables associated with the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTables(): Table[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getTableStyle(name)
+ uid: 'ExcelScript!ExcelScript.Workbook#getTableStyle:member(1)'
+ package: ExcelScript!
+ fullName: getTableStyle(name)
+ summary: 'Gets a `TableStyle` by name. If the table style does not exist, then this method returns `undefined`.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTableStyle(name: string): TableStyle | undefined;'
+ parameters:
+ - id: name
+ description: Name of the table style to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getTableStyles()
+ uid: 'ExcelScript!ExcelScript.Workbook#getTableStyles:member(1)'
+ package: ExcelScript!
+ fullName: getTableStyles()
+ summary: Represents a collection of TableStyles associated with the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTableStyles(): TableStyle[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getTimelineStyle(name)
+ uid: 'ExcelScript!ExcelScript.Workbook#getTimelineStyle:member(1)'
+ package: ExcelScript!
+ fullName: getTimelineStyle(name)
+ summary: 'Gets a `TimelineStyle` by name. If the timeline style doesn''t exist, then this method returns `undefined`.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTimelineStyle(name: string): TimelineStyle | undefined;'
+ parameters:
+ - id: name
+ description: Name of the timeline style to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getTimelineStyles()
+ uid: 'ExcelScript!ExcelScript.Workbook#getTimelineStyles:member(1)'
+ package: ExcelScript!
+ fullName: getTimelineStyles()
+ summary: Represents a collection of TimelineStyles associated with the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTimelineStyles(): TimelineStyle[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getUsePrecisionAsDisplayed()
+ uid: 'ExcelScript!ExcelScript.Workbook#getUsePrecisionAsDisplayed:member(1)'
+ package: ExcelScript!
+ fullName: getUsePrecisionAsDisplayed()
+ summary: >-
+ True if calculations in this workbook will be done using only the precision of the numbers as they're displayed.
+ Data will permanently lose accuracy when switching this property from `false` to `true`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getUsePrecisionAsDisplayed(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getWorksheet(key)
+ uid: 'ExcelScript!ExcelScript.Workbook#getWorksheet:member(1)'
+ package: ExcelScript!
+ fullName: getWorksheet(key)
+ summary: >-
+ Gets a worksheet object using its name or ID. If the worksheet does not exist, then this method returns
+ `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWorksheet(key: string): Worksheet | undefined;'
+ parameters:
+ - id: key
+ description: The name or ID of the worksheet.
+ type: string
+ return:
+ type: ' | undefined'
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script switches the active view to a worksheet named "Data", if it exists.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Check if the "Data" worksheet exists.
+ let dataWorksheet = workbook.getWorksheet("Data");
+ if (dataWorksheet) {
+ // Switch to the "Data" worksheet.
+ dataWorksheet.activate();
+ } else {
+ console.log(`No worksheet named "Data" in this workbook.`);
+ }
+ }
+ ```
+ - name: getWorksheets()
+ uid: 'ExcelScript!ExcelScript.Workbook#getWorksheets:member(1)'
+ package: ExcelScript!
+ fullName: getWorksheets()
+ summary: Represents a collection of worksheets associated with the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getWorksheets(): Worksheet[];'
+ return:
+ type: '[]'
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script logs the names of all the worksheets in the workbook.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get all the worksheets in the workbook.
+ let sheets = workbook.getWorksheets();
+
+ // Get a list of all the worksheet names.
+ let names = sheets.map ((sheet) => sheet.getName());
+
+ // Write in the console all the worksheet names and the total count.
+ console.log(names);
+ console.log(`Total worksheets inside of this workbook: ${sheets.length}`);
+ }
+ ```
+ - name: refreshAllDataConnections()
+ uid: 'ExcelScript!ExcelScript.Workbook#refreshAllDataConnections:member(1)'
+ package: ExcelScript!
+ fullName: refreshAllDataConnections()
+ summary: Refreshes all the Data Connections.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'refreshAllDataConnections(): void;'
+ return:
+ type: void
+ description: ''
+ - name: refreshAllLinksToLinkedWorkbooks()
+ uid: 'ExcelScript!ExcelScript.Workbook#refreshAllLinksToLinkedWorkbooks:member(1)'
+ package: ExcelScript!
+ fullName: refreshAllLinksToLinkedWorkbooks()
+ summary: Makes a request to refresh all the workbook links.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'refreshAllLinksToLinkedWorkbooks(): void;'
+ return:
+ type: void
+ description: ''
+ - name: refreshAllPivotTables()
+ uid: 'ExcelScript!ExcelScript.Workbook#refreshAllPivotTables:member(1)'
+ package: ExcelScript!
+ fullName: refreshAllPivotTables()
+ summary: Refreshes all the pivot tables in the collection.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'refreshAllPivotTables(): void;'
+ return:
+ type: void
+ description: ''
+ - name: setChartDataPointTrack(chartDataPointTrack)
+ uid: 'ExcelScript!ExcelScript.Workbook#setChartDataPointTrack:member(1)'
+ package: ExcelScript!
+ fullName: setChartDataPointTrack(chartDataPointTrack)
+ summary: >-
+ True if all charts in the workbook are tracking the actual data points to which they are attached. False if the
+ charts track the index of the data points.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setChartDataPointTrack(chartDataPointTrack: boolean): void;'
+ parameters:
+ - id: chartDataPointTrack
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setDefaultPivotTableStyle(newDefaultStyle)
+ uid: 'ExcelScript!ExcelScript.Workbook#setDefaultPivotTableStyle:member(1)'
+ package: ExcelScript!
+ fullName: setDefaultPivotTableStyle(newDefaultStyle)
+ summary: Sets the default PivotTable style for use in the parent object's scope.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setDefaultPivotTableStyle(
+ newDefaultStyle: PivotTableStyle | string
+ ): void;
+ parameters:
+ - id: newDefaultStyle
+ description: 'The `PivotTableStyle` object, or name of the `PivotTableStyle` object, that should be the new default.'
+ type: ' | string'
+ return:
+ type: void
+ description: ''
+ - name: setDefaultSlicerStyle(newDefaultStyle)
+ uid: 'ExcelScript!ExcelScript.Workbook#setDefaultSlicerStyle:member(1)'
+ package: ExcelScript!
+ fullName: setDefaultSlicerStyle(newDefaultStyle)
+ summary: Sets the default slicer style for use in the parent object's scope.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setDefaultSlicerStyle(newDefaultStyle: SlicerStyle | string): void;'
+ parameters:
+ - id: newDefaultStyle
+ description: 'The `SlicerStyle` object, or name of the `SlicerStyle` object, that should be the new default.'
+ type: ' | string'
+ return:
+ type: void
+ description: ''
+ - name: setDefaultTableStyle(newDefaultStyle)
+ uid: 'ExcelScript!ExcelScript.Workbook#setDefaultTableStyle:member(1)'
+ package: ExcelScript!
+ fullName: setDefaultTableStyle(newDefaultStyle)
+ summary: Sets the default table style for use in the parent object's scope.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setDefaultTableStyle(newDefaultStyle: TableStyle | string): void;'
+ parameters:
+ - id: newDefaultStyle
+ description: 'The `TableStyle` object, or name of the `TableStyle` object, that should be the new default.'
+ type: ' | string'
+ return:
+ type: void
+ description: ''
+ - name: setDefaultTimelineStyle(newDefaultStyle)
+ uid: 'ExcelScript!ExcelScript.Workbook#setDefaultTimelineStyle:member(1)'
+ package: ExcelScript!
+ fullName: setDefaultTimelineStyle(newDefaultStyle)
+ summary: Sets the default timeline style for use in the parent object's scope.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setDefaultTimelineStyle(newDefaultStyle: TimelineStyle | string): void;'
+ parameters:
+ - id: newDefaultStyle
+ description: 'The `TimelineStyle` object, or name of the `TimelineStyle` object, that should be the new default.'
+ type: ' | string'
+ return:
+ type: void
+ description: ''
+ - name: setIsDirty(isDirty)
+ uid: 'ExcelScript!ExcelScript.Workbook#setIsDirty:member(1)'
+ package: ExcelScript!
+ fullName: setIsDirty(isDirty)
+ summary: >-
+ Specifies if changes have been made since the workbook was last saved. You can set this property to `true` if you
+ want to close a modified workbook without either saving it or being prompted to save it.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setIsDirty(isDirty: boolean): void;'
+ parameters:
+ - id: isDirty
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setLinkedWorkbookRefreshMode(linkedWorkbookRefreshMode)
+ uid: 'ExcelScript!ExcelScript.Workbook#setLinkedWorkbookRefreshMode:member(1)'
+ package: ExcelScript!
+ fullName: setLinkedWorkbookRefreshMode(linkedWorkbookRefreshMode)
+ summary: >-
+ Represents the update mode of the workbook links. The mode is same for all of the workbook links present in the
+ workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setLinkedWorkbookRefreshMode(
+ linkedWorkbookRefreshMode: WorkbookLinksRefreshMode
+ ): void;
+ parameters:
+ - id: linkedWorkbookRefreshMode
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: ''
+ - name: setUsePrecisionAsDisplayed(usePrecisionAsDisplayed)
+ uid: 'ExcelScript!ExcelScript.Workbook#setUsePrecisionAsDisplayed:member(1)'
+ package: ExcelScript!
+ fullName: setUsePrecisionAsDisplayed(usePrecisionAsDisplayed)
+ summary: >-
+ True if calculations in this workbook will be done using only the precision of the numbers as they're displayed.
+ Data will permanently lose accuracy when switching this property from `false` to `true`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setUsePrecisionAsDisplayed(usePrecisionAsDisplayed: boolean): void;'
+ parameters:
+ - id: usePrecisionAsDisplayed
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.workbooklinksrefreshmode.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.workbooklinksrefreshmode.yml
index 0d79f7fd..54df3209 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.workbooklinksrefreshmode.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.workbooklinksrefreshmode.yml
@@ -1,38 +1,38 @@
-### YamlMime:TSEnum
-name: ExcelScript.WorkbookLinksRefreshMode
-uid: 'ExcelScript!ExcelScript.WorkbookLinksRefreshMode:enum'
-package: ExcelScript!
-fullName: ExcelScript.WorkbookLinksRefreshMode
-summary: Represents the refresh mode of the workbook links.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script refreshes all the links to external workbooks,
- * if the linked workbook refresh mode is set to manual.
- * To learn about linked workbooks, see https://support.microsoft.com/office/c98d1803-dd75-4668-ac6a-d7cca2a9b95f.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Check the refresh mode.
- if (workbook.getLinkedWorkbookRefreshMode() === ExcelScript.WorkbookLinksRefreshMode.manual) {
- console.log("Refreshing workbook links");
-
- // Trigger a refresh of linked workbook content.
- workbook.refreshAllLinksToLinkedWorkbooks();
- }
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: automatic
- uid: 'ExcelScript!ExcelScript.WorkbookLinksRefreshMode.automatic:member'
- package: ExcelScript!
- summary: The workbook links are updated at a set interval determined by the Excel application.
- - name: manual
- uid: 'ExcelScript!ExcelScript.WorkbookLinksRefreshMode.manual:member'
- package: ExcelScript!
- summary: The workbook links are updated manually.
+### YamlMime:TSEnum
+name: ExcelScript.WorkbookLinksRefreshMode
+uid: 'ExcelScript!ExcelScript.WorkbookLinksRefreshMode:enum'
+package: ExcelScript!
+fullName: ExcelScript.WorkbookLinksRefreshMode
+summary: Represents the refresh mode of the workbook links.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script refreshes all the links to external workbooks,
+ * if the linked workbook refresh mode is set to manual.
+ * To learn about linked workbooks, see https://support.microsoft.com/office/c98d1803-dd75-4668-ac6a-d7cca2a9b95f.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Check the refresh mode.
+ if (workbook.getLinkedWorkbookRefreshMode() === ExcelScript.WorkbookLinksRefreshMode.manual) {
+ console.log("Refreshing workbook links");
+
+ // Trigger a refresh of linked workbook content.
+ workbook.refreshAllLinksToLinkedWorkbooks();
+ }
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: automatic
+ uid: 'ExcelScript!ExcelScript.WorkbookLinksRefreshMode.automatic:member'
+ package: ExcelScript!
+ summary: The workbook links are updated at a set interval determined by the Excel application.
+ - name: manual
+ uid: 'ExcelScript!ExcelScript.WorkbookLinksRefreshMode.manual:member'
+ package: ExcelScript!
+ summary: The workbook links are updated manually.
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.workbookprotection.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.workbookprotection.yml
index a8161069..bc0ee23b 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.workbookprotection.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.workbookprotection.yml
@@ -1,111 +1,111 @@
-### YamlMime:TSType
-name: ExcelScript.WorkbookProtection
-uid: 'ExcelScript!ExcelScript.WorkbookProtection:interface'
-package: ExcelScript!
-fullName: ExcelScript.WorkbookProtection
-summary: Represents the protection of a workbook object.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getProtected()
- uid: 'ExcelScript!ExcelScript.WorkbookProtection#getProtected:member(1)'
- package: ExcelScript!
- fullName: getProtected()
- summary: Specifies if the workbook is protected.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getProtected(): boolean;'
- return:
- type: boolean
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script protects the workbook with a default password, if there is not already protection.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the workbook-level protection object.
- const protection = workbook.getProtection();
-
- // Check if the workbook is already protected.
- if (!protection.getProtected()) {
- // Apply a default password.
- protection.protect("1234");
- }
- }
- ```
- - name: protect(password)
- uid: 'ExcelScript!ExcelScript.WorkbookProtection#protect:member(1)'
- package: ExcelScript!
- fullName: protect(password)
- summary: Protects the workbook. Fails if the workbook has been protected.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'protect(password?: string): void;'
- parameters:
- - id: password
- description: Workbook protection password.
- type: string
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script protects the workbook using a password given in a user prompt.
- */
- function main(workbook: ExcelScript.Workbook, password?: string) {
- // Get the workbook-level protection object.
- const protection = workbook.getProtection();
-
- // Protect the workbook with the given password.
- // If the optional password was omitted,
- // no password will be needed to unprotect the workbook.
- protection.protect(password);
- }
- ```
- - name: unprotect(password)
- uid: 'ExcelScript!ExcelScript.WorkbookProtection#unprotect:member(1)'
- package: ExcelScript!
- fullName: unprotect(password)
- summary: Unprotects the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'unprotect(password?: string): void;'
- parameters:
- - id: password
- description: Workbook protection password.
- type: string
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script removes protection from the workbook using a password given in a user prompt.
- */
- function main(workbook: ExcelScript.Workbook, password?: string) {
- // Get the workbook-level protection object.
- const protection = workbook.getProtection();
-
- // Unprotect the workbook with the given password.
- protection.unprotect(password);
- }
- ```
+### YamlMime:TSType
+name: ExcelScript.WorkbookProtection
+uid: 'ExcelScript!ExcelScript.WorkbookProtection:interface'
+package: ExcelScript!
+fullName: ExcelScript.WorkbookProtection
+summary: Represents the protection of a workbook object.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getProtected()
+ uid: 'ExcelScript!ExcelScript.WorkbookProtection#getProtected:member(1)'
+ package: ExcelScript!
+ fullName: getProtected()
+ summary: Specifies if the workbook is protected.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getProtected(): boolean;'
+ return:
+ type: boolean
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script protects the workbook with a default password, if there is not already protection.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the workbook-level protection object.
+ const protection = workbook.getProtection();
+
+ // Check if the workbook is already protected.
+ if (!protection.getProtected()) {
+ // Apply a default password.
+ protection.protect("1234");
+ }
+ }
+ ```
+ - name: protect(password)
+ uid: 'ExcelScript!ExcelScript.WorkbookProtection#protect:member(1)'
+ package: ExcelScript!
+ fullName: protect(password)
+ summary: Protects the workbook. Fails if the workbook has been protected.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'protect(password?: string): void;'
+ parameters:
+ - id: password
+ description: Workbook protection password.
+ type: string
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script protects the workbook using a password given in a user prompt.
+ */
+ function main(workbook: ExcelScript.Workbook, password?: string) {
+ // Get the workbook-level protection object.
+ const protection = workbook.getProtection();
+
+ // Protect the workbook with the given password.
+ // If the optional password was omitted,
+ // no password will be needed to unprotect the workbook.
+ protection.protect(password);
+ }
+ ```
+ - name: unprotect(password)
+ uid: 'ExcelScript!ExcelScript.WorkbookProtection#unprotect:member(1)'
+ package: ExcelScript!
+ fullName: unprotect(password)
+ summary: Unprotects the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'unprotect(password?: string): void;'
+ parameters:
+ - id: password
+ description: Workbook protection password.
+ type: string
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script removes protection from the workbook using a password given in a user prompt.
+ */
+ function main(workbook: ExcelScript.Workbook, password?: string) {
+ // Get the workbook-level protection object.
+ const protection = workbook.getProtection();
+
+ // Unprotect the workbook with the given password.
+ protection.unprotect(password);
+ }
+ ```
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.workbookrangeareas.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.workbookrangeareas.yml
index 330086c2..7745af06 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.workbookrangeareas.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.workbookrangeareas.yml
@@ -1,96 +1,96 @@
-### YamlMime:TSType
-name: ExcelScript.WorkbookRangeAreas
-uid: 'ExcelScript!ExcelScript.WorkbookRangeAreas:interface'
-package: ExcelScript!
-fullName: ExcelScript.WorkbookRangeAreas
-summary: Represents a collection of one or more rectangular ranges in multiple worksheets.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script finds the direct precedents of the active cell.
- * It changes the font and color of those precedent cells.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the active cell.
- const selected = workbook.getActiveCell();
-
- // Get the cells that are direct precedents of the current cell.
- const precedents : ExcelScript.WorkbookRangeAreas = selected.getDirectPrecedents();
-
- // Set the font to bold and the fill color to orange for all the precedent cells.
- precedents.getRanges().forEach(range => {
- range.getFormat().getFill().setColor("orange");
- range.getFormat().getFont().setBold(true);
- });
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: getAddresses()
- uid: 'ExcelScript!ExcelScript.WorkbookRangeAreas#getAddresses:member(1)'
- package: ExcelScript!
- fullName: getAddresses()
- summary: >-
- Returns an array of addresses in A1-style. Address values contain the worksheet name for each rectangular block of
- cells (e.g., "Sheet1!A1:B4, Sheet1!D1:D4"). Read-only.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAddresses(): string[];'
- return:
- type: 'string[]'
- description: ''
- - name: getAreas()
- uid: 'ExcelScript!ExcelScript.WorkbookRangeAreas#getAreas:member(1)'
- package: ExcelScript!
- fullName: getAreas()
- summary: >-
- Returns the `RangeAreasCollection` object. Each `RangeAreas` in the collection represent one or more rectangle
- ranges in one worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAreas(): RangeAreas[];'
- return:
- type: '[]'
- description: ''
- - name: getRangeAreasBySheet(key)
- uid: 'ExcelScript!ExcelScript.WorkbookRangeAreas#getRangeAreasBySheet:member(1)'
- package: ExcelScript!
- fullName: getRangeAreasBySheet(key)
- summary: >-
- Returns the `RangeAreas` object based on worksheet name or ID in the collection. If the worksheet does not exist,
- then this method returns `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRangeAreasBySheet(key: string): RangeAreas;'
- parameters:
- - id: key
- description: The name or ID of the worksheet.
- type: string
- return:
- type: ''
- description: ''
- - name: getRanges()
- uid: 'ExcelScript!ExcelScript.WorkbookRangeAreas#getRanges:member(1)'
- package: ExcelScript!
- fullName: getRanges()
- summary: Returns ranges that comprise this object in a `RangeCollection` object.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRanges(): Range[];'
- return:
- type: '[]'
- description: ''
+### YamlMime:TSType
+name: ExcelScript.WorkbookRangeAreas
+uid: 'ExcelScript!ExcelScript.WorkbookRangeAreas:interface'
+package: ExcelScript!
+fullName: ExcelScript.WorkbookRangeAreas
+summary: Represents a collection of one or more rectangular ranges in multiple worksheets.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script finds the direct precedents of the active cell.
+ * It changes the font and color of those precedent cells.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the active cell.
+ const selected = workbook.getActiveCell();
+
+ // Get the cells that are direct precedents of the current cell.
+ const precedents : ExcelScript.WorkbookRangeAreas = selected.getDirectPrecedents();
+
+ // Set the font to bold and the fill color to orange for all the precedent cells.
+ precedents.getRanges().forEach(range => {
+ range.getFormat().getFill().setColor("orange");
+ range.getFormat().getFont().setBold(true);
+ });
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: getAddresses()
+ uid: 'ExcelScript!ExcelScript.WorkbookRangeAreas#getAddresses:member(1)'
+ package: ExcelScript!
+ fullName: getAddresses()
+ summary: >-
+ Returns an array of addresses in A1-style. Address values contain the worksheet name for each rectangular block of
+ cells (e.g., "Sheet1!A1:B4, Sheet1!D1:D4"). Read-only.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAddresses(): string[];'
+ return:
+ type: 'string[]'
+ description: ''
+ - name: getAreas()
+ uid: 'ExcelScript!ExcelScript.WorkbookRangeAreas#getAreas:member(1)'
+ package: ExcelScript!
+ fullName: getAreas()
+ summary: >-
+ Returns the `RangeAreasCollection` object. Each `RangeAreas` in the collection represent one or more rectangle
+ ranges in one worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAreas(): RangeAreas[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getRangeAreasBySheet(key)
+ uid: 'ExcelScript!ExcelScript.WorkbookRangeAreas#getRangeAreasBySheet:member(1)'
+ package: ExcelScript!
+ fullName: getRangeAreasBySheet(key)
+ summary: >-
+ Returns the `RangeAreas` object based on worksheet name or ID in the collection. If the worksheet does not exist,
+ then this method returns `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRangeAreasBySheet(key: string): RangeAreas;'
+ parameters:
+ - id: key
+ description: The name or ID of the worksheet.
+ type: string
+ return:
+ type: ''
+ description: ''
+ - name: getRanges()
+ uid: 'ExcelScript!ExcelScript.WorkbookRangeAreas#getRanges:member(1)'
+ package: ExcelScript!
+ fullName: getRanges()
+ summary: Returns ranges that comprise this object in a `RangeCollection` object.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRanges(): Range[];'
+ return:
+ type: '[]'
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheet.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheet.yml
index ff6ca1e3..5a5df1a6 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheet.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheet.yml
@@ -1,1954 +1,1985 @@
-### YamlMime:TSType
-name: ExcelScript.Worksheet
-uid: 'ExcelScript!ExcelScript.Worksheet:interface'
-package: ExcelScript!
-fullName: ExcelScript.Worksheet
-summary: 'An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc.'
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a new worksheet named "Plum" and sets its tab color to purple.
- */
- function main(workbook: ExcelScript.Workbook) {
- const newSheet = workbook.addWorksheet("Plum")
- newSheet.setTabColor("purple");
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: activate()
- uid: 'ExcelScript!ExcelScript.Worksheet#activate:member(1)'
- package: ExcelScript!
- fullName: activate()
- summary: Activate the worksheet in the Excel UI.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'activate(): void;'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script switches the active view to a worksheet named "Data", if it exists.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Check if the "Data" worksheet exists.
- let dataWorksheet = workbook.getWorksheet("Data");
- if (dataWorksheet) {
- // Switch to the "Data" worksheet.
- dataWorksheet.activate();
- } else {
- console.log(`No worksheet named "Data" in this workbook.`);
- }
- }
- ```
- - name: 'addChart(type, sourceData, seriesBy)'
- uid: 'ExcelScript!ExcelScript.Worksheet#addChart:member(1)'
- package: ExcelScript!
- fullName: 'addChart(type, sourceData, seriesBy)'
- summary: Creates a new chart.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- addChart(
- type: ChartType,
- sourceData: Range,
- seriesBy?: ChartSeriesBy
- ): Chart;
- parameters:
- - id: type
- description: Represents the type of a chart. See `ExcelScript.ChartType` for details.
- type: ''
- - id: sourceData
- description: The `Range` object corresponding to the source data.
- type: ''
- - id: seriesBy
- description: >-
- Optional. Specifies the way columns or rows are used as data series on the chart. See
- `ExcelScript.ChartSeriesBy` for details.
- type: ''
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample creates a column-clustered chart based on the current worksheet's data.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Get the data range.
- let range = selectedSheet.getUsedRange();
-
- // Insert a chart using the data on the current worksheet.
- let chart = selectedSheet.addChart(ExcelScript.ChartType.columnClustered, range);
-
- // Name the chart for easy access in other scripts.
- chart.setName("ColumnChart");
- }
- ```
- - name: 'addComment(cellAddress, content, contentType)'
- uid: 'ExcelScript!ExcelScript.Worksheet#addComment:member(1)'
- package: ExcelScript!
- fullName: 'addComment(cellAddress, content, contentType)'
- summary: >-
- Creates a new comment with the given content on the given cell. An `InvalidArgument` error is thrown if the
- provided range is larger than one cell.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- addComment(
- cellAddress: Range | string,
- content: CommentRichContent | string,
- contentType?: ContentType
- ): Comment;
- parameters:
- - id: cellAddress
- description: >-
- The cell to which the comment is added. This can be a `Range` object or a string. If it's a string, it must
- contain the full address, including the sheet name. An `InvalidArgument` error is thrown if the provided
- range is larger than one cell.
- type: ' | string'
- - id: content
- description: >-
- The comment's content. This can be either a string or `CommentRichContent` object. Strings are used for
- plain text. `CommentRichContent` objects allow for other comment features, such as mentions.
- type: ' | string'
- - id: contentType
- description: >-
- Optional. The type of content contained within the comment. The default value is enum
- `ContentType.Plain`.
- type: ''
- return:
- type: ''
- description: ''
- - name: addGeometricShape(geometricShapeType)
- uid: 'ExcelScript!ExcelScript.Worksheet#addGeometricShape:member(1)'
- package: ExcelScript!
- fullName: addGeometricShape(geometricShapeType)
- summary: Adds a geometric shape to the worksheet. Returns a `Shape` object that represents the new shape.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addGeometricShape(geometricShapeType: GeometricShapeType): Shape;'
- parameters:
- - id: geometricShapeType
- description: Represents the type of the geometric shape. See `ExcelScript.GeometricShapeType` for details.
- type: ''
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a hexagon shape on the current worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- const currentSheet = workbook.getActiveWorksheet();
- const hexagon: ExcelScript.Shape =
- currentSheet.addGeometricShape(ExcelScript.GeometricShapeType.hexagon);
-
- // Set the hexagon size to 40x40 pixels.
- hexagon.setHeight(40);
- hexagon.setWidth(40);
-
- // Position the hexagon at [100,100] pixels.
- hexagon.setLeft(100);
- hexagon.setTop(100);
- }
- ```
- - name: addGroup(values)
- uid: 'ExcelScript!ExcelScript.Worksheet#addGroup:member(1)'
- package: ExcelScript!
- fullName: addGroup(values)
- summary: >-
- Groups a subset of shapes in this collection's worksheet. Returns a `Shape` object that represents the new group
- of shapes.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addGroup(values: Array): Shape;'
- parameters:
- - id: values
- description: An array of shape IDs or shape objects.
- type: 'Array<string | >'
- return:
- type: ''
- description: ''
- - name: addHorizontalPageBreak(pageBreakRange)
- uid: 'ExcelScript!ExcelScript.Worksheet#addHorizontalPageBreak:member(1)'
- package: ExcelScript!
- fullName: addHorizontalPageBreak(pageBreakRange)
- summary: Adds a page break before the top-left cell of the range specified.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addHorizontalPageBreak(pageBreakRange: Range | string): PageBreak;'
- parameters:
- - id: pageBreakRange
- description: The range immediately after the page break to be added.
- type: ' | string'
- return:
- type: ''
- description: ''
- - name: addImage(base64ImageString)
- uid: 'ExcelScript!ExcelScript.Worksheet#addImage:member(1)'
- package: ExcelScript!
- fullName: addImage(base64ImageString)
- summary: >-
- Creates an image from a base64-encoded string and adds it to the worksheet. Returns the `Shape` object that
- represents the new image.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addImage(base64ImageString: string): Shape;'
- parameters:
- - id: base64ImageString
- description: A base64-encoded string representing an image in either JPEG or PNG format.
- type: string
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample copies an image from a URL.
- * This could be used to copy photos that a colleague stored in a shared folder to a related workbook.
- */
- async function main(workbook: ExcelScript.Workbook) {
- // Fetch the image from a URL.
- const link = "https://raw.githubusercontent.com/OfficeDev/office-scripts-docs/master/docs/images/git-octocat.png";
- const response = await fetch(link);
-
- // Store the response as an ArrayBuffer, since it is a raw image file.
- const data = await response.arrayBuffer();
-
- // Convert the image data into a base64-encoded string.
- const image = convertToBase64(data);
-
- // Add the image to the current worksheet.
- workbook.getActiveWorksheet().addImage(image);
- }
-
- /**
- * Converts an ArrayBuffer containing a .png image into a base64-encoded string.
- */
- function convertToBase64(input: ArrayBuffer) {
- const uInt8Array = new Uint8Array(input);
- const count = uInt8Array.length;
-
- // Allocate the necessary space up front.
- const charCodeArray = new Array(count)
-
- // Convert every entry in the array to a character.
- for (let i = count; i >= 0; i--) {
- charCodeArray[i] = String.fromCharCode(uInt8Array[i]);
- }
-
- // Convert the characters to base64.
- const base64 = btoa(charCodeArray.join(''));
- return base64;
- }
- ```
- - name: 'addLine(startLeft, startTop, endLeft, endTop, connectorType)'
- uid: 'ExcelScript!ExcelScript.Worksheet#addLine:member(1)'
- package: ExcelScript!
- fullName: 'addLine(startLeft, startTop, endLeft, endTop, connectorType)'
- summary: Adds a line to worksheet. Returns a `Shape` object that represents the new line.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- addLine(
- startLeft: number,
- startTop: number,
- endLeft: number,
- endTop: number,
- connectorType?: ConnectorType
- ): Shape;
- parameters:
- - id: startLeft
- description: 'The distance, in points, from the start of the line to the left side of the worksheet.'
- type: number
- - id: startTop
- description: 'The distance, in points, from the start of the line to the top of the worksheet.'
- type: number
- - id: endLeft
- description: 'The distance, in points, from the end of the line to the left of the worksheet.'
- type: number
- - id: endTop
- description: 'The distance, in points, from the end of the line to the top of the worksheet.'
- type: number
- - id: connectorType
- description: Represents the connector type. See `ExcelScript.ConnectorType` for details.
- type: ''
- return:
- type: ''
- description: ''
- - name: 'addNamedItem(name, reference, comment)'
- uid: 'ExcelScript!ExcelScript.Worksheet#addNamedItem:member(1)'
- package: ExcelScript!
- fullName: 'addNamedItem(name, reference, comment)'
- summary: Adds a new name to the collection of the given scope.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- addNamedItem(
- name: string,
- reference: Range | string,
- comment?: string
- ): NamedItem;
- parameters:
- - id: name
- description: The name of the named item.
- type: string
- - id: reference
- description: The formula or the range that the name will refer to.
- type: ' | string'
- - id: comment
- description: Optional. The comment associated with the named item.
- type: string
- return:
- type: ''
- description: ''
- - name: 'addNamedItemFormulaLocal(name, formula, comment)'
- uid: 'ExcelScript!ExcelScript.Worksheet#addNamedItemFormulaLocal:member(1)'
- package: ExcelScript!
- fullName: 'addNamedItemFormulaLocal(name, formula, comment)'
- summary: Adds a new name to the collection of the given scope using the user's locale for the formula.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- addNamedItemFormulaLocal(
- name: string,
- formula: string,
- comment?: string
- ): NamedItem;
- parameters:
- - id: name
- description: The name of the named item.
- type: string
- - id: formula
- description: The formula in the user's locale that the name will refer to.
- type: string
- - id: comment
- description: Optional. The comment associated with the named item.
- type: string
- return:
- type: ''
- description: ''
- - name: addNamedSheetView(name)
- uid: 'ExcelScript!ExcelScript.Worksheet#addNamedSheetView:member(1)'
- package: ExcelScript!
- fullName: addNamedSheetView(name)
- summary: Creates a new sheet view with the given name.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addNamedSheetView(name: string): NamedSheetView;'
- parameters:
- - id: name
- description: >-
- The name of the sheet view to be created. Throws an error when the provided name already exists, is empty,
- or is a name reserved by the worksheet.
- type: string
- return:
- type: ''
- description: ''
- - name: 'addPivotTable(name, source, destination)'
- uid: 'ExcelScript!ExcelScript.Worksheet#addPivotTable:member(1)'
- package: ExcelScript!
- fullName: 'addPivotTable(name, source, destination)'
- summary: Add a PivotTable based on the specified source data and insert it at the top-left cell of the destination range.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- addPivotTable(
- name: string,
- source: Range | string | Table,
- destination: Range | string
- ): PivotTable;
- parameters:
- - id: name
- description: The name of the new PivotTable.
- type: string
- - id: source
- description: >-
- The source data for the new PivotTable, this can either be a range (or string address including the
- worksheet name) or a table.
- type: >-
- | string |
- - id: destination
- description: >-
- The cell in the upper-left corner of the PivotTable report's destination range (the range on the worksheet
- where the resulting report will be placed).
- type: ' | string'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates a PivotTable from an existing table and adds it to a new worksheet.
- * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
- */
- function main(workbook: ExcelScript.Workbook) {
- // Create a PivotTable based on a table in the current worksheet.
- let sheet = workbook.getActiveWorksheet();
- let table = sheet.getTables()[0];
-
- // Add the PivotTable to a new worksheet.
- let newSheet = workbook.addWorksheet("Pivot");
- let pivotTable = newSheet.addPivotTable("My Pivot", table, "A1");
-
- // Add fields to the PivotTable to show "Sales" per "Type".
- pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
- pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
-
- // Switch to the new worksheet.
- newSheet.activate();
- }
- ```
- - name: 'addSlicer(slicerSource, sourceField, slicerDestination)'
- uid: 'ExcelScript!ExcelScript.Worksheet#addSlicer:member(1)'
- package: ExcelScript!
- fullName: 'addSlicer(slicerSource, sourceField, slicerDestination)'
- summary: Adds a new slicer to the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- addSlicer(
- slicerSource: string | PivotTable | Table,
- sourceField: string | PivotField | number | TableColumn,
- slicerDestination?: string | Worksheet
- ): Slicer;
- parameters:
- - id: slicerSource
- description: >-
- The data source that the new slicer will be based on. It can be a `PivotTable` object, a `Table` object, or
- a string. When a PivotTable object is passed, the data source is the source of the `PivotTable` object. When
- a `Table` object is passed, the data source is the `Table` object. When a string is passed, it is
- interpreted as the name or ID of a PivotTable or table.
- type: >-
- string | |
- - id: sourceField
- description: >-
- The field in the data source to filter by. It can be a `PivotField` object, a `TableColumn` object, the ID
- of a `PivotField` or the name or ID of a `TableColumn`.
- type: >-
- string | | number |
- - id: slicerDestination
- description: >-
- Optional. The worksheet in which the new slicer will be created. It can be a `Worksheet` object or the name
- or ID of a worksheet. This parameter can be omitted if the slicer collection is retrieved from a worksheet.
- type: 'string | '
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a slicer for an existing PivotTable on the current worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first PivotTable from the current worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const pivot = currentSheet.getPivotTables()[0];
-
- // Create the slicer.
- // Note that this assumes "Type" is already added as a hierarchy to the PivotTable.
- const slicer = currentSheet.addSlicer(
- pivot, /* The table or PivotTale to be sliced. */
- pivot.getHierarchy("Type").getFields()[0] /* What source field to use as the slicer options. */
- );
-
- // Select the items to display.
- slicer.selectItems(["Lemon", "Lime"]);
-
- // Set the left margin of the slicer.
- slicer.setLeft(400);
- }
- ```
- - name: 'addTable(address, hasHeaders)'
- uid: 'ExcelScript!ExcelScript.Worksheet#addTable:member(1)'
- package: ExcelScript!
- fullName: 'addTable(address, hasHeaders)'
- summary: >-
- Creates a new table. The range object or source address determines the worksheet under which the table will be
- added. If the table cannot be added (e.g., because the address is invalid, or the table would overlap with another
- table), an error will be thrown.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addTable(address: Range | string, hasHeaders: boolean): Table;'
- parameters:
- - id: address
- description: >-
- A `Range` object, or a string address or name of the range representing the data source. If the address does
- not contain a sheet name, the currently-active sheet is used.
- type: ' | string'
- - id: hasHeaders
- description: >-
- A boolean value that indicates whether the data being imported has column labels. If the source does not
- contain headers (i.e., when this property set to `false`), Excel will automatically generate a
- header and shift the data down by one row.
- type: boolean
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample creates a table from the current worksheet's used range, then sorts it based on the first column.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Create a table with the used cells.
- let usedRange = selectedSheet.getUsedRange();
- let newTable = selectedSheet.addTable(usedRange, true);
-
- // Sort the table using the first column.
- newTable.getSort().apply([{ key: 0, ascending: true }]);
- }
- ```
- - name: addTextBox(text)
- uid: 'ExcelScript!ExcelScript.Worksheet#addTextBox:member(1)'
- package: ExcelScript!
- fullName: addTextBox(text)
- summary: >-
- Adds a text box to the worksheet with the provided text as the content. Returns a `Shape` object that represents
- the new text box.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addTextBox(text?: string): Shape;'
- parameters:
- - id: text
- description: Represents the text that will be shown in the created text box.
- type: string
- return:
- type: ''
- description: ''
- - name: addVerticalPageBreak(pageBreakRange)
- uid: 'ExcelScript!ExcelScript.Worksheet#addVerticalPageBreak:member(1)'
- package: ExcelScript!
- fullName: addVerticalPageBreak(pageBreakRange)
- summary: Adds a page break before the top-left cell of the range specified.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addVerticalPageBreak(pageBreakRange: Range | string): PageBreak;'
- parameters:
- - id: pageBreakRange
- description: The range immediately after the page break to be added.
- type: ' | string'
- return:
- type: ''
- description: ''
- - name: 'addWorksheetCustomProperty(key, value)'
- uid: 'ExcelScript!ExcelScript.Worksheet#addWorksheetCustomProperty:member(1)'
- package: ExcelScript!
- fullName: 'addWorksheetCustomProperty(key, value)'
- summary: >-
- Adds a new custom property that maps to the provided key. This overwrites existing custom properties with that
- key.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- addWorksheetCustomProperty(
- key: string,
- value: string
- ): WorksheetCustomProperty;
- parameters:
- - id: key
- description: >-
- The key that identifies the custom property object. It is case-insensitive.The key is limited to 255
- characters (larger values will cause an `InvalidArgument` error to be thrown.)
- type: string
- - id: value
- description: The value of this custom property.
- type: string
- return:
- type: ''
- description: ''
- - name: calculate(markAllDirty)
- uid: 'ExcelScript!ExcelScript.Worksheet#calculate:member(1)'
- package: ExcelScript!
- fullName: calculate(markAllDirty)
- summary: Calculates all cells on a worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'calculate(markAllDirty: boolean): void;'
- parameters:
- - id: markAllDirty
- description: 'True, to mark all as dirty.'
- type: boolean
- return:
- type: void
- description: ''
- - name: 'copy(positionType, relativeTo)'
- uid: 'ExcelScript!ExcelScript.Worksheet#copy:member(1)'
- package: ExcelScript!
- fullName: 'copy(positionType, relativeTo)'
- summary: Copies a worksheet and places it at the specified position.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- copy(
- positionType?: WorksheetPositionType,
- relativeTo?: Worksheet
- ): Worksheet;
- parameters:
- - id: positionType
- description: >-
- The location in the workbook to place the newly created worksheet. The default value is "None", which
- inserts the worksheet at the beginning of the worksheet.
- type: ''
- - id: relativeTo
- description: >-
- The existing worksheet which determines the newly created worksheet's position. This is only needed if
- `positionType` is "Before" or "After".
- type: ''
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script duplicates a worksheet named "Template".
- * The new worksheet is added after the template.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the worksheet named "Template".
- let template = workbook.getWorksheet("Template");
-
- // Copy the worksheet.
- let newSheet = template.copy(
- ExcelScript.WorksheetPositionType.after,
- template
- );
-
- // Name the worksheet using the current date.
- let date = new Date(Date.now());
- newSheet.setName(`${date.toDateString()}`);
- }
- ```
- - name: delete()
- uid: 'ExcelScript!ExcelScript.Worksheet#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: >-
- Deletes the worksheet from the workbook. Note that if the worksheet's visibility is set to "VeryHidden", the
- delete operation will fail with an `InvalidOperation` exception. You should first change its visibility to hidden
- or visible before deleting it.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * The following scripts removes the first worksheet in the workbook.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first worksheet.
- let sheet = workbook.getWorksheets()[0];
-
- // Remove that worksheet from the workbook.
- sheet.delete();
- }
- ```
- - name: enterTemporaryNamedSheetView()
- uid: 'ExcelScript!ExcelScript.Worksheet#enterTemporaryNamedSheetView:member(1)'
- package: ExcelScript!
- fullName: enterTemporaryNamedSheetView()
- summary: >-
- Creates and activates a new temporary sheet view. Temporary views are removed when closing the application,
- exiting the temporary view with the exit method, or switching to another sheet view. The temporary sheet view can
- also be accessed with the empty string (""), if the temporary view exists.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'enterTemporaryNamedSheetView(): NamedSheetView;'
- return:
- type: ''
- description: ''
- - name: exitActiveNamedSheetView()
- uid: 'ExcelScript!ExcelScript.Worksheet#exitActiveNamedSheetView:member(1)'
- package: ExcelScript!
- fullName: exitActiveNamedSheetView()
- summary: Exits the currently active sheet view.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'exitActiveNamedSheetView(): void;'
- return:
- type: void
- description: ''
- - name: 'findAll(text, criteria)'
- uid: 'ExcelScript!ExcelScript.Worksheet#findAll:member(1)'
- package: ExcelScript!
- fullName: 'findAll(text, criteria)'
- summary: >-
- Finds all occurrences of the given string based on the criteria specified and returns them as a `RangeAreas`
- object, comprising one or more rectangular ranges.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'findAll(text: string, criteria: WorksheetSearchCriteria): RangeAreas;'
- parameters:
- - id: text
- description: The string to find.
- type: string
- - id: criteria
- description: >-
- Additional search criteria, including whether the search needs to match the entire cell or be
- case-sensitive.
- type: ''
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script searches through a worksheet and finds cells containing "No".
- * Those cells are filled with the color red.
- * Use Range.find instead of Worksheet.findAll when you want to limit the search to a specific range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current, active worksheet.
- let worksheet = workbook.getActiveWorksheet();
- let noCells = worksheet.findAll("No", { completeMatch: true });
-
- // Set the fill color to red.
- noCells.getFormat().getFill().setColor("red");
- }
- ```
- - name: getActiveNamedSheetView()
- uid: 'ExcelScript!ExcelScript.Worksheet#getActiveNamedSheetView:member(1)'
- package: ExcelScript!
- fullName: getActiveNamedSheetView()
- summary: Gets the worksheet's currently active sheet view.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getActiveNamedSheetView(): NamedSheetView;'
- return:
- type: ''
- description: ''
- - name: getAutoFilter()
- uid: 'ExcelScript!ExcelScript.Worksheet#getAutoFilter:member(1)'
- package: ExcelScript!
- fullName: getAutoFilter()
- summary: Represents the `AutoFilter` object of the worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAutoFilter(): AutoFilter;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script creates an autoFilter on the worksheet that filters out rows based on column values.
- * The autoFilter filters to only include rows that have a value in column D in the top 10 percentile
- * (of column D values).
- */
- function main(workbook: ExcelScript.Workbook) {
- const currentSheet = workbook.getActiveWorksheet();
- const dataRange = currentSheet.getUsedRange();
-
- // Add a filter that will only show the rows with the top 10% of values in column D
- // (index 3, assuming the used range spans from at least A:D).
- currentSheet.getAutoFilter().apply(dataRange, 3, {
- criterion1: "10",
- filterOn: ExcelScript.FilterOn.topPercent
- });
- }
- ```
- - name: 'getCell(row, column)'
- uid: 'ExcelScript!ExcelScript.Worksheet#getCell:member(1)'
- package: ExcelScript!
- fullName: 'getCell(row, column)'
- summary: >-
- Gets the `Range` object containing the single cell based on row and column numbers. The cell can be outside the
- bounds of its parent range, so long as it stays within the worksheet grid.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCell(row: number, column: number): Range;'
- parameters:
- - id: row
- description: The row number of the cell to be retrieved. Zero-indexed.
- type: number
- - id: column
- description: The column number of the cell to be retrieved. Zero-indexed.
- type: number
- return:
- type: ''
- description: ''
- - name: getChart(name)
- uid: 'ExcelScript!ExcelScript.Worksheet#getChart:member(1)'
- package: ExcelScript!
- fullName: getChart(name)
- summary: >-
- Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned. If
- the chart doesn't exist, then this method returns `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getChart(name: string): Chart | undefined;'
- parameters:
- - id: name
- description: Name of the chart to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample moves an existing chart to a specific place on the worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Get an existing chart named "ColumnChart".
- let chart = selectedSheet.getChart("ColumnChart");
-
- // Place the chart over the range "F1:L13".
- chart.setPosition("F1", "L13");
- }
- ```
- - name: getCharts()
- uid: 'ExcelScript!ExcelScript.Worksheet#getCharts:member(1)'
- package: ExcelScript!
- fullName: getCharts()
- summary: Returns a collection of charts that are part of the worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCharts(): Chart[];'
- return:
- type: '[]'
- description: ''
- - name: getComment(commentId)
- uid: 'ExcelScript!ExcelScript.Worksheet#getComment:member(1)'
- package: ExcelScript!
- fullName: getComment(commentId)
- summary: >-
- Gets a comment from the collection based on its ID. If the comment object does not exist, then this method returns
- `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getComment(commentId: string): Comment | undefined;'
- parameters:
- - id: commentId
- description: The identifier for the comment.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getCommentByCell(cellAddress)
- uid: 'ExcelScript!ExcelScript.Worksheet#getCommentByCell:member(1)'
- package: ExcelScript!
- fullName: getCommentByCell(cellAddress)
- summary: 'Gets the comment from the specified cell. If there is no comment in the cell, an error is thrown.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCommentByCell(cellAddress: Range | string): Comment;'
- parameters:
- - id: cellAddress
- description: >-
- The cell which the comment is on. This can be a `Range` object or a string. If it's a string, it must
- contain the full address, including the sheet name. An `InvalidArgument` error is thrown if the provided
- range is larger than one cell.
- type: ' | string'
- return:
- type: ''
- description: ''
- - name: getCommentByReplyId(replyId)
- uid: 'ExcelScript!ExcelScript.Worksheet#getCommentByReplyId:member(1)'
- package: ExcelScript!
- fullName: getCommentByReplyId(replyId)
- summary: Gets the comment to which the given reply is connected.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCommentByReplyId(replyId: string): Comment;'
- parameters:
- - id: replyId
- description: The identifier of comment reply.
- type: string
- return:
- type: ''
- description: ''
- - name: getComments()
- uid: 'ExcelScript!ExcelScript.Worksheet#getComments:member(1)'
- package: ExcelScript!
- fullName: getComments()
- summary: Returns a collection of all the Comments objects on the worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getComments(): Comment[];'
- return:
- type: '[]'
- description: ''
- - name: getCustomProperties()
- uid: 'ExcelScript!ExcelScript.Worksheet#getCustomProperties:member(1)'
- package: ExcelScript!
- fullName: getCustomProperties()
- summary: Gets a collection of worksheet-level custom properties.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCustomProperties(): WorksheetCustomProperty[];'
- return:
- type: '[]'
- description: ''
- - name: getEnableCalculation()
- uid: 'ExcelScript!ExcelScript.Worksheet#getEnableCalculation:member(1)'
- package: ExcelScript!
- fullName: getEnableCalculation()
- summary: >-
- Determines if Excel should recalculate the worksheet when necessary. True if Excel recalculates the worksheet when
- necessary. False if Excel doesn't recalculate the sheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getEnableCalculation(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getFreezePanes()
- uid: 'ExcelScript!ExcelScript.Worksheet#getFreezePanes:member(1)'
- package: ExcelScript!
- fullName: getFreezePanes()
- summary: Gets an object that can be used to manipulate frozen panes on the worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFreezePanes(): WorksheetFreezePanes;'
- return:
- type: ''
- description: ''
- - name: getHorizontalPageBreaks()
- uid: 'ExcelScript!ExcelScript.Worksheet#getHorizontalPageBreaks:member(1)'
- package: ExcelScript!
- fullName: getHorizontalPageBreaks()
- summary: Gets the horizontal page break collection for the worksheet. This collection only contains manual page breaks.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHorizontalPageBreaks(): PageBreak[];'
- return:
- type: '[]'
- description: ''
- - name: getId()
- uid: 'ExcelScript!ExcelScript.Worksheet#getId:member(1)'
- package: ExcelScript!
- fullName: getId()
- summary: >-
- Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains
- the same even when the worksheet is renamed or moved.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getId(): string;'
- return:
- type: string
- description: ''
- - name: getName()
- uid: 'ExcelScript!ExcelScript.Worksheet#getName:member(1)'
- package: ExcelScript!
- fullName: getName()
- summary: The display name of the worksheet. The name must be fewer than 32 characters.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample gets all the worksheet names in the workbook.
- * It then logs those names to the console.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Create an array to hold the worksheet names.
- let worksheetNames = [];
-
- // Iterate over the worksheet collection in the workbook.
- for (let worksheet of workbook.getWorksheets()) {
- worksheetNames.push(worksheet.getName());
- }
-
- // Log the array of worksheet names.
- console.log(worksheetNames);
- }
- ```
- - name: getNamedItem(name)
- uid: 'ExcelScript!ExcelScript.Worksheet#getNamedItem:member(1)'
- package: ExcelScript!
- fullName: getNamedItem(name)
- summary: >-
- Gets a `NamedItem` object using its name. If the object does not exist, then this method returns `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNamedItem(name: string): NamedItem | undefined;'
- parameters:
- - id: name
- description: Nameditem name.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getNamedSheetView(key)
- uid: 'ExcelScript!ExcelScript.Worksheet#getNamedSheetView:member(1)'
- package: ExcelScript!
- fullName: getNamedSheetView(key)
- summary: >-
- Gets a sheet view using its name. If the sheet view object does not exist, then this method returns
- `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNamedSheetView(key: string): NamedSheetView | undefined;'
- parameters:
- - id: key
- description: >-
- The case-sensitive name of the sheet view. Use the empty string ("") to get the temporary sheet view, if the
- temporary view exists.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getNamedSheetViews()
- uid: 'ExcelScript!ExcelScript.Worksheet#getNamedSheetViews:member(1)'
- package: ExcelScript!
- fullName: getNamedSheetViews()
- summary: Returns a collection of sheet views that are present in the worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNamedSheetViews(): NamedSheetView[];'
- return:
- type: '[]'
- description: ''
- - name: getNames()
- uid: 'ExcelScript!ExcelScript.Worksheet#getNames:member(1)'
- package: ExcelScript!
- fullName: getNames()
- summary: Collection of names scoped to the current worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNames(): NamedItem[];'
- return:
- type: '[]'
- description: ''
- - name: getNext(visibleOnly)
- uid: 'ExcelScript!ExcelScript.Worksheet#getNext:member(1)'
- package: ExcelScript!
- fullName: getNext(visibleOnly)
- summary: >-
- Gets the worksheet that follows this one. If there are no worksheets following this one, then this method returns
- `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getNext(visibleOnly?: boolean): Worksheet;'
- parameters:
- - id: visibleOnly
- description: 'Optional. If `true`, considers only visible worksheets, skipping over any hidden ones.'
- type: boolean
- return:
- type: ''
- description: ''
- - name: getPageLayout()
- uid: 'ExcelScript!ExcelScript.Worksheet#getPageLayout:member(1)'
- package: ExcelScript!
- fullName: getPageLayout()
- summary: Gets the `PageLayout` object of the worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPageLayout(): PageLayout;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the printing orientation for the entire workbook.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Go to each worksheet so the print settings are consistent.
- workbook.getWorksheets().forEach((sheet) => {
- const pageLayout = sheet.getPageLayout();
-
- // Print every page with a landscape orientation.
- pageLayout.setOrientation(ExcelScript.PageOrientation.landscape);
- });
- }
- ```
- - name: getPivotTable(name)
- uid: 'ExcelScript!ExcelScript.Worksheet#getPivotTable:member(1)'
- package: ExcelScript!
- fullName: getPivotTable(name)
- summary: 'Gets a PivotTable by name. If the PivotTable does not exist, then this method returns `undefined`.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPivotTable(name: string): PivotTable | undefined;'
- parameters:
- - id: name
- description: Name of the PivotTable to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getPivotTables()
- uid: 'ExcelScript!ExcelScript.Worksheet#getPivotTables:member(1)'
- package: ExcelScript!
- fullName: getPivotTables()
- summary: Collection of PivotTables that are part of the worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPivotTables(): PivotTable[];'
- return:
- type: '[]'
- description: ''
- - name: getPosition()
- uid: 'ExcelScript!ExcelScript.Worksheet#getPosition:member(1)'
- package: ExcelScript!
- fullName: getPosition()
- summary: The zero-based position of the worksheet within the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPosition(): number;'
- return:
- type: number
- description: ''
- - name: getPrevious(visibleOnly)
- uid: 'ExcelScript!ExcelScript.Worksheet#getPrevious:member(1)'
- package: ExcelScript!
- fullName: getPrevious(visibleOnly)
- summary: >-
- Gets the worksheet that precedes this one. If there are no previous worksheets, then this method returns
- `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPrevious(visibleOnly?: boolean): Worksheet;'
- parameters:
- - id: visibleOnly
- description: 'Optional. If `true`, considers only visible worksheets, skipping over any hidden ones.'
- type: boolean
- return:
- type: ''
- description: ''
- - name: getProtection()
- uid: 'ExcelScript!ExcelScript.Worksheet#getProtection:member(1)'
- package: ExcelScript!
- fullName: getProtection()
- summary: Returns the sheet protection object for a worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getProtection(): WorksheetProtection;'
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script protects cells from being selected on the current worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the protection settings for the current worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const sheetProtection = currentSheet.getProtection();
-
- // Create a new WorksheetProtectionOptions object with the selectionMode property set to `none`.
- let protectionOptions : ExcelScript.WorksheetProtectionOptions = {
- selectionMode: ExcelScript.ProtectionSelectionMode.none
- }
-
- // Apply the given protection options.
- sheetProtection.protect(protectionOptions);
- }
- ```
- - name: getRange(address)
- uid: 'ExcelScript!ExcelScript.Worksheet#getRange:member(1)'
- package: ExcelScript!
- fullName: getRange(address)
- summary: 'Gets the `Range` object, representing a single rectangular block of cells, specified by the address or name.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRange(address?: string): Range;'
- parameters:
- - id: address
- description: >-
- Optional. The string representing the address or name of the range. For example, "A1:B2". If not specified,
- the entire worksheet range is returned.
- type: string
- return:
- type: ''
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample reads the value of A1 and prints it to the console.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Get the value of cell A1.
- let range = selectedSheet.getRange("A1");
-
- // Print the value of A1.
- console.log(range.getValue());
- }
- ```
- - name: 'getRangeByIndexes(startRow, startColumn, rowCount, columnCount)'
- uid: 'ExcelScript!ExcelScript.Worksheet#getRangeByIndexes:member(1)'
- package: ExcelScript!
- fullName: 'getRangeByIndexes(startRow, startColumn, rowCount, columnCount)'
- summary: >-
- Gets the `Range` object beginning at a particular row index and column index, and spanning a certain number of
- rows and columns.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- getRangeByIndexes(
- startRow: number,
- startColumn: number,
- rowCount: number,
- columnCount: number
- ): Range;
- parameters:
- - id: startRow
- description: Start row (zero-indexed).
- type: number
- - id: startColumn
- description: Start column (zero-indexed).
- type: number
- - id: rowCount
- description: Number of rows to include in the range.
- type: number
- - id: columnCount
- description: Number of columns to include in the range.
- type: number
- return:
- type: ''
- description: ''
- - name: getRanges(address)
- uid: 'ExcelScript!ExcelScript.Worksheet#getRanges:member(1)'
- package: ExcelScript!
- fullName: getRanges(address)
- summary: >-
- Gets the `RangeAreas` object, representing one or more blocks of rectangular ranges, specified by the address or
- name.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getRanges(address?: string): RangeAreas;'
- parameters:
- - id: address
- description: >-
- Optional. A string containing the comma-separated or semicolon-separated addresses or names of the
- individual ranges. For example, "A1:B2, A5:B5" or "A1:B2; A5:B5". If not specified, a `RangeAreas` object
- for the entire worksheet is returned.
- type: string
- return:
- type: ''
- description: ''
- - name: getShape(key)
- uid: 'ExcelScript!ExcelScript.Worksheet#getShape:member(1)'
- package: ExcelScript!
- fullName: getShape(key)
- summary: >-
- Gets a shape using its name or ID. If the shape object does not exist, then this method returns `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShape(key: string): Shape | undefined;'
- parameters:
- - id: key
- description: The name or ID of the shape to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getShapes()
- uid: 'ExcelScript!ExcelScript.Worksheet#getShapes:member(1)'
- package: ExcelScript!
- fullName: getShapes()
- summary: Returns the collection of all the Shape objects on the worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShapes(): Shape[];'
- return:
- type: '[]'
- description: ''
- - name: getShowGridlines()
- uid: 'ExcelScript!ExcelScript.Worksheet#getShowGridlines:member(1)'
- package: ExcelScript!
- fullName: getShowGridlines()
- summary: Specifies if gridlines are visible to the user.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowGridlines(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowHeadings()
- uid: 'ExcelScript!ExcelScript.Worksheet#getShowHeadings:member(1)'
- package: ExcelScript!
- fullName: getShowHeadings()
- summary: Specifies if headings are visible to the user.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowHeadings(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getSlicer(key)
- uid: 'ExcelScript!ExcelScript.Worksheet#getSlicer:member(1)'
- package: ExcelScript!
- fullName: getSlicer(key)
- summary: 'Gets a slicer using its name or ID. If the slicer doesn''t exist, then this method returns `undefined`.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSlicer(key: string): Slicer | undefined;'
- parameters:
- - id: key
- description: Name or ID of the slicer to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getSlicers()
- uid: 'ExcelScript!ExcelScript.Worksheet#getSlicers:member(1)'
- package: ExcelScript!
- fullName: getSlicers()
- summary: Returns a collection of slicers that are part of the worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSlicers(): Slicer[];'
- return:
- type: '[]'
- description: ''
- - name: getStandardHeight()
- uid: 'ExcelScript!ExcelScript.Worksheet#getStandardHeight:member(1)'
- package: ExcelScript!
- fullName: getStandardHeight()
- summary: 'Returns the standard (default) height of all the rows in the worksheet, in points.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getStandardHeight(): number;'
- return:
- type: number
- description: ''
- - name: getStandardWidth()
- uid: 'ExcelScript!ExcelScript.Worksheet#getStandardWidth:member(1)'
- package: ExcelScript!
- fullName: getStandardWidth()
- summary: >-
- Specifies the standard (default) width of all the columns in the worksheet. One unit of column width is equal to
- the width of one character in the Normal style. For proportional fonts, the width of the character 0 (zero) is
- used.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getStandardWidth(): number;'
- return:
- type: number
- description: ''
- - name: getTabColor()
- uid: 'ExcelScript!ExcelScript.Worksheet#getTabColor:member(1)'
- package: ExcelScript!
- fullName: getTabColor()
- summary: >-
- The tab color of the worksheet. When retrieving the tab color, if the worksheet is invisible, the value will be
- `null`. If the worksheet is visible but the tab color is set to auto, an empty string will be returned.
- Otherwise, the property will be set to a color, in the form \#RRGGBB (e.g., "FFA500"). When setting the color, use
- an empty-string to set an "auto" color, or a real color otherwise.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTabColor(): string;'
- return:
- type: string
- description: ''
- - name: getTabId()
- uid: 'ExcelScript!ExcelScript.Worksheet#getTabId:member(1)'
- package: ExcelScript!
- fullName: getTabId()
- summary: >-
- Returns a value representing this worksheet that can be read by Open Office XML. This is an integer value, which
- is different from `worksheet.id` (which returns a globally unique identifier) and `worksheet.name` (which returns
- a value such as "Sheet1").
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTabId(): number;'
- return:
- type: number
- description: ''
- - name: getTable(key)
- uid: 'ExcelScript!ExcelScript.Worksheet#getTable:member(1)'
- package: ExcelScript!
- fullName: getTable(key)
- summary: 'Gets a table by name or ID. If the table doesn''t exist, then this method returns `undefined`.'
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTable(key: string): Table | undefined;'
- parameters:
- - id: key
- description: Name or ID of the table to be retrieved.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getTables()
- uid: 'ExcelScript!ExcelScript.Worksheet#getTables:member(1)'
- package: ExcelScript!
- fullName: getTables()
- summary: Collection of tables that are part of the worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTables(): Table[];'
- return:
- type: '[]'
- description: ''
- - name: getUsedRange(valuesOnly)
- uid: 'ExcelScript!ExcelScript.Worksheet#getUsedRange:member(1)'
- package: ExcelScript!
- fullName: getUsedRange(valuesOnly)
- summary: ''
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getUsedRange(valuesOnly?: boolean): Range;'
- parameters:
- - id: valuesOnly
- description: Optional. Considers only cells with values as used cells.
- type: boolean
- return:
- type: ''
- description: ''
- - name: getVerticalPageBreaks()
- uid: 'ExcelScript!ExcelScript.Worksheet#getVerticalPageBreaks:member(1)'
- package: ExcelScript!
- fullName: getVerticalPageBreaks()
- summary: Gets the vertical page break collection for the worksheet. This collection only contains manual page breaks.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVerticalPageBreaks(): PageBreak[];'
- return:
- type: '[]'
- description: ''
- - name: getVisibility()
- uid: 'ExcelScript!ExcelScript.Worksheet#getVisibility:member(1)'
- package: ExcelScript!
- fullName: getVisibility()
- summary: The visibility of the worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVisibility(): SheetVisibility;'
- return:
- type: ''
- description: ''
- - name: getWorksheetCustomProperty(key)
- uid: 'ExcelScript!ExcelScript.Worksheet#getWorksheetCustomProperty:member(1)'
- package: ExcelScript!
- fullName: getWorksheetCustomProperty(key)
- summary: >-
- Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then
- this method returns `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- getWorksheetCustomProperty(
- key: string
- ): WorksheetCustomProperty | undefined;
- parameters:
- - id: key
- description: The key that identifies the custom property object. It is case-insensitive.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: refreshAllPivotTables()
- uid: 'ExcelScript!ExcelScript.Worksheet#refreshAllPivotTables:member(1)'
- package: ExcelScript!
- fullName: refreshAllPivotTables()
- summary: Refreshes all the pivot tables in the collection.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'refreshAllPivotTables(): void;'
- return:
- type: void
- description: ''
- - name: removeAllHorizontalPageBreaks()
- uid: 'ExcelScript!ExcelScript.Worksheet#removeAllHorizontalPageBreaks:member(1)'
- package: ExcelScript!
- fullName: removeAllHorizontalPageBreaks()
- summary: Resets all manual page breaks in the collection.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'removeAllHorizontalPageBreaks(): void;'
- return:
- type: void
- description: ''
- - name: removeAllVerticalPageBreaks()
- uid: 'ExcelScript!ExcelScript.Worksheet#removeAllVerticalPageBreaks:member(1)'
- package: ExcelScript!
- fullName: removeAllVerticalPageBreaks()
- summary: Resets all manual page breaks in the collection.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'removeAllVerticalPageBreaks(): void;'
- return:
- type: void
- description: ''
- - name: 'replaceAll(text, replacement, criteria)'
- uid: 'ExcelScript!ExcelScript.Worksheet#replaceAll:member(1)'
- package: ExcelScript!
- fullName: 'replaceAll(text, replacement, criteria)'
- summary: Finds and replaces the given string based on the criteria specified within the current worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- replaceAll(
- text: string,
- replacement: string,
- criteria: ReplaceCriteria
- ): number;
- parameters:
- - id: text
- description: String to find.
- type: string
- - id: replacement
- description: The string that replaces the original string.
- type: string
- - id: criteria
- description: Additional replacement criteria.
- type: ''
- return:
- type: number
- description: ''
- - name: setEnableCalculation(enableCalculation)
- uid: 'ExcelScript!ExcelScript.Worksheet#setEnableCalculation:member(1)'
- package: ExcelScript!
- fullName: setEnableCalculation(enableCalculation)
- summary: >-
- Determines if Excel should recalculate the worksheet when necessary. True if Excel recalculates the worksheet when
- necessary. False if Excel doesn't recalculate the sheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setEnableCalculation(enableCalculation: boolean): void;'
- parameters:
- - id: enableCalculation
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setName(name)
- uid: 'ExcelScript!ExcelScript.Worksheet#setName:member(1)'
- package: ExcelScript!
- fullName: setName(name)
- summary: The display name of the worksheet. The name must be fewer than 32 characters.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setName(name: string): void;'
- parameters:
- - id: name
- description: ''
- type: string
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample renames a worksheet from "Sheet1" to "SALES".
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get a worksheet named "Sheet1".
- const sheet = workbook.getWorksheet('Sheet1');
-
- // Set its name to SALES.
- sheet.setName('SALES');
- }
- ```
- - name: setPosition(position)
- uid: 'ExcelScript!ExcelScript.Worksheet#setPosition:member(1)'
- package: ExcelScript!
- fullName: setPosition(position)
- summary: The zero-based position of the worksheet within the workbook.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPosition(position: number): void;'
- parameters:
- - id: position
- description: ''
- type: number
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample sets the worksheet named "SALES" as the first sheet in the workbook.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get a worksheet named "SALES".
- const sheet = workbook.getWorksheet('SALES');
- // Position the worksheet at the beginning of the workbook.
- sheet.setPosition(0);
- }
- ```
- - name: setShowGridlines(showGridlines)
- uid: 'ExcelScript!ExcelScript.Worksheet#setShowGridlines:member(1)'
- package: ExcelScript!
- fullName: setShowGridlines(showGridlines)
- summary: Specifies if gridlines are visible to the user.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowGridlines(showGridlines: boolean): void;'
- parameters:
- - id: showGridlines
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowHeadings(showHeadings)
- uid: 'ExcelScript!ExcelScript.Worksheet#setShowHeadings:member(1)'
- package: ExcelScript!
- fullName: setShowHeadings(showHeadings)
- summary: Specifies if headings are visible to the user.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowHeadings(showHeadings: boolean): void;'
- parameters:
- - id: showHeadings
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setStandardWidth(standardWidth)
- uid: 'ExcelScript!ExcelScript.Worksheet#setStandardWidth:member(1)'
- package: ExcelScript!
- fullName: setStandardWidth(standardWidth)
- summary: >-
- Specifies the standard (default) width of all the columns in the worksheet. One unit of column width is equal to
- the width of one character in the Normal style. For proportional fonts, the width of the character 0 (zero) is
- used.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setStandardWidth(standardWidth: number): void;'
- parameters:
- - id: standardWidth
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setTabColor(tabColor)
- uid: 'ExcelScript!ExcelScript.Worksheet#setTabColor:member(1)'
- package: ExcelScript!
- fullName: setTabColor(tabColor)
- summary: >-
- The tab color of the worksheet. When retrieving the tab color, if the worksheet is invisible, the value will be
- `null`. If the worksheet is visible but the tab color is set to auto, an empty string will be returned.
- Otherwise, the property will be set to a color, in the form \#RRGGBB (e.g., "FFA500"). When setting the color, use
- an empty-string to set an "auto" color, or a real color otherwise.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setTabColor(tabColor: string): void;'
- parameters:
- - id: tabColor
- description: ''
- type: string
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script sets the tab color of every worksheet in the workbook to red.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get all the worksheets in the workbook.
- let sheets = workbook.getWorksheets();
-
- // Set the tab color of each worksheet to a random color.
- for (let sheet of sheets) {
- // Set the color of the current worksheet's tab to red.
- sheet.setTabColor("red");
- }
- }
- ```
- - name: setVisibility(visibility)
- uid: 'ExcelScript!ExcelScript.Worksheet#setVisibility:member(1)'
- package: ExcelScript!
- fullName: setVisibility(visibility)
- summary: The visibility of the worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setVisibility(visibility: SheetVisibility): void;'
- parameters:
- - id: visibility
- description: ''
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script unhides all the worksheets in the workbook.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Iterate over each worksheet.
- workbook.getWorksheets().forEach((worksheet) => {
- // Set the worksheet visibility to visible.
- worksheet.setVisibility(ExcelScript.SheetVisibility.visible);
- });
- }
- ```
- - name: 'showOutlineLevels(rowLevels, columnLevels)'
- uid: 'ExcelScript!ExcelScript.Worksheet#showOutlineLevels:member(1)'
- package: ExcelScript!
- fullName: 'showOutlineLevels(rowLevels, columnLevels)'
- summary: >-
- Shows row or column groups by their outline levels. Outlines groups and summarizes a list of data in the
- worksheet. The `rowLevels` and `columnLevels` parameters specify how many levels of the outline will be displayed.
- The acceptable argument range is between 0 and 8. A value of 0 does not change the current display. A value
- greater than the current number of levels displays all the levels.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'showOutlineLevels(rowLevels: number, columnLevels: number): void;'
- parameters:
- - id: rowLevels
- description: The number of row levels of an outline to display.
- type: number
- - id: columnLevels
- description: The number of column levels of an outline to display.
- type: number
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.Worksheet
+uid: 'ExcelScript!ExcelScript.Worksheet:interface'
+package: ExcelScript!
+fullName: ExcelScript.Worksheet
+summary: 'An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc.'
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a new worksheet named "Plum" and sets its tab color to purple.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ const newSheet = workbook.addWorksheet("Plum")
+ newSheet.setTabColor("purple");
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: activate()
+ uid: 'ExcelScript!ExcelScript.Worksheet#activate:member(1)'
+ package: ExcelScript!
+ fullName: activate()
+ summary: Activate the worksheet in the Excel UI.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'activate(): void;'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script switches the active view to a worksheet named "Data", if it exists.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Check if the "Data" worksheet exists.
+ let dataWorksheet = workbook.getWorksheet("Data");
+ if (dataWorksheet) {
+ // Switch to the "Data" worksheet.
+ dataWorksheet.activate();
+ } else {
+ console.log(`No worksheet named "Data" in this workbook.`);
+ }
+ }
+ ```
+ - name: 'addChart(type, sourceData, seriesBy)'
+ uid: 'ExcelScript!ExcelScript.Worksheet#addChart:member(1)'
+ package: ExcelScript!
+ fullName: 'addChart(type, sourceData, seriesBy)'
+ summary: Creates a new chart.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ addChart(
+ type: ChartType,
+ sourceData: Range,
+ seriesBy?: ChartSeriesBy
+ ): Chart;
+ parameters:
+ - id: type
+ description: Represents the type of a chart. See `ExcelScript.ChartType` for details.
+ type: ''
+ - id: sourceData
+ description: The `Range` object corresponding to the source data.
+ type: ''
+ - id: seriesBy
+ description: >-
+ Optional. Specifies the way columns or rows are used as data series on the chart. See
+ `ExcelScript.ChartSeriesBy` for details.
+ type: ''
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample creates a column-clustered chart based on the current worksheet's data.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Get the data range.
+ let range = selectedSheet.getUsedRange();
+
+ // Insert a chart using the data on the current worksheet.
+ let chart = selectedSheet.addChart(ExcelScript.ChartType.columnClustered, range);
+
+ // Name the chart for easy access in other scripts.
+ chart.setName("ColumnChart");
+ }
+ ```
+ - name: 'addComment(cellAddress, content, contentType)'
+ uid: 'ExcelScript!ExcelScript.Worksheet#addComment:member(1)'
+ package: ExcelScript!
+ fullName: 'addComment(cellAddress, content, contentType)'
+ summary: >-
+ Creates a new comment with the given content on the given cell. An `InvalidArgument` error is thrown if the
+ provided range is larger than one cell.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ addComment(
+ cellAddress: Range | string,
+ content: CommentRichContent | string,
+ contentType?: ContentType
+ ): Comment;
+ parameters:
+ - id: cellAddress
+ description: >-
+ The cell to which the comment is added. This can be a `Range` object or a string. If it's a string, it must
+ contain the full address, including the sheet name. An `InvalidArgument` error is thrown if the provided
+ range is larger than one cell.
+ type: ' | string'
+ - id: content
+ description: >-
+ The comment's content. This can be either a string or `CommentRichContent` object. Strings are used for
+ plain text. `CommentRichContent` objects allow for other comment features, such as mentions.
+ type: ' | string'
+ - id: contentType
+ description: >-
+ Optional. The type of content contained within the comment. The default value is enum
+ `ContentType.Plain`.
+ type: ''
+ return:
+ type: ''
+ description: ''
+ - name: addGeometricShape(geometricShapeType)
+ uid: 'ExcelScript!ExcelScript.Worksheet#addGeometricShape:member(1)'
+ package: ExcelScript!
+ fullName: addGeometricShape(geometricShapeType)
+ summary: Adds a geometric shape to the worksheet. Returns a `Shape` object that represents the new shape.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addGeometricShape(geometricShapeType: GeometricShapeType): Shape;'
+ parameters:
+ - id: geometricShapeType
+ description: Represents the type of the geometric shape. See `ExcelScript.GeometricShapeType` for details.
+ type: ''
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a hexagon shape on the current worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ const currentSheet = workbook.getActiveWorksheet();
+ const hexagon: ExcelScript.Shape =
+ currentSheet.addGeometricShape(ExcelScript.GeometricShapeType.hexagon);
+
+ // Set the hexagon size to 40x40 pixels.
+ hexagon.setHeight(40);
+ hexagon.setWidth(40);
+
+ // Position the hexagon at [100,100] pixels.
+ hexagon.setLeft(100);
+ hexagon.setTop(100);
+ }
+ ```
+ - name: addGroup(values)
+ uid: 'ExcelScript!ExcelScript.Worksheet#addGroup:member(1)'
+ package: ExcelScript!
+ fullName: addGroup(values)
+ summary: >-
+ Groups a subset of shapes in this collection's worksheet. Returns a `Shape` object that represents the new group
+ of shapes.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addGroup(values: Array): Shape;'
+ parameters:
+ - id: values
+ description: An array of shape IDs or shape objects.
+ type: 'Array<string | >'
+ return:
+ type: ''
+ description: ''
+ - name: addHorizontalPageBreak(pageBreakRange)
+ uid: 'ExcelScript!ExcelScript.Worksheet#addHorizontalPageBreak:member(1)'
+ package: ExcelScript!
+ fullName: addHorizontalPageBreak(pageBreakRange)
+ summary: Adds a page break before the top-left cell of the range specified.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addHorizontalPageBreak(pageBreakRange: Range | string): PageBreak;'
+ parameters:
+ - id: pageBreakRange
+ description: The range immediately after the page break to be added.
+ type: ' | string'
+ return:
+ type: ''
+ description: ''
+ - name: addImage(base64ImageString)
+ uid: 'ExcelScript!ExcelScript.Worksheet#addImage:member(1)'
+ package: ExcelScript!
+ fullName: addImage(base64ImageString)
+ summary: >-
+ Creates an image from a Base64-encoded string and adds it to the worksheet. Returns the `Shape` object that
+ represents the new image.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addImage(base64ImageString: string): Shape;'
+ parameters:
+ - id: base64ImageString
+ description: A Base64-encoded string representing an image in either JPEG or PNG format.
+ type: string
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample copies an image from a URL.
+ * This could be used to copy photos that a colleague stored in a shared folder to a related workbook.
+ */
+ async function main(workbook: ExcelScript.Workbook) {
+ // Fetch the image from a URL.
+ const link = "https://raw.githubusercontent.com/OfficeDev/office-scripts-docs/master/docs/images/git-octocat.png";
+ const response = await fetch(link);
+
+ // Store the response as an ArrayBuffer, since it is a raw image file.
+ const data = await response.arrayBuffer();
+
+ // Convert the image data into a base64-encoded string.
+ const image = convertToBase64(data);
+
+ // Add the image to the current worksheet.
+ workbook.getActiveWorksheet().addImage(image);
+ }
+
+ /**
+ * Converts an ArrayBuffer containing a .png image into a base64-encoded string.
+ */
+ function convertToBase64(input: ArrayBuffer) {
+ const uInt8Array = new Uint8Array(input);
+ const count = uInt8Array.length;
+
+ // Allocate the necessary space up front.
+ const charCodeArray = new Array(count)
+
+ // Convert every entry in the array to a character.
+ for (let i = count; i >= 0; i--) {
+ charCodeArray[i] = String.fromCharCode(uInt8Array[i]);
+ }
+
+ // Convert the characters to base64.
+ const base64 = btoa(charCodeArray.join(''));
+ return base64;
+ }
+ ```
+ - name: 'addLine(startLeft, startTop, endLeft, endTop, connectorType)'
+ uid: 'ExcelScript!ExcelScript.Worksheet#addLine:member(1)'
+ package: ExcelScript!
+ fullName: 'addLine(startLeft, startTop, endLeft, endTop, connectorType)'
+ summary: Adds a line to worksheet. Returns a `Shape` object that represents the new line.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ addLine(
+ startLeft: number,
+ startTop: number,
+ endLeft: number,
+ endTop: number,
+ connectorType?: ConnectorType
+ ): Shape;
+ parameters:
+ - id: startLeft
+ description: 'The distance, in points, from the start of the line to the left side of the worksheet.'
+ type: number
+ - id: startTop
+ description: 'The distance, in points, from the start of the line to the top of the worksheet.'
+ type: number
+ - id: endLeft
+ description: 'The distance, in points, from the end of the line to the left of the worksheet.'
+ type: number
+ - id: endTop
+ description: 'The distance, in points, from the end of the line to the top of the worksheet.'
+ type: number
+ - id: connectorType
+ description: Represents the connector type. See `ExcelScript.ConnectorType` for details.
+ type: ''
+ return:
+ type: ''
+ description: ''
+ - name: 'addNamedItem(name, reference, comment)'
+ uid: 'ExcelScript!ExcelScript.Worksheet#addNamedItem:member(1)'
+ package: ExcelScript!
+ fullName: 'addNamedItem(name, reference, comment)'
+ summary: Adds a new name to the collection of the given scope.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ addNamedItem(
+ name: string,
+ reference: Range | string,
+ comment?: string
+ ): NamedItem;
+ parameters:
+ - id: name
+ description: The name of the named item.
+ type: string
+ - id: reference
+ description: The formula or the range that the name will refer to.
+ type: ' | string'
+ - id: comment
+ description: Optional. The comment associated with the named item.
+ type: string
+ return:
+ type: ''
+ description: ''
+ - name: 'addNamedItemFormulaLocal(name, formula, comment)'
+ uid: 'ExcelScript!ExcelScript.Worksheet#addNamedItemFormulaLocal:member(1)'
+ package: ExcelScript!
+ fullName: 'addNamedItemFormulaLocal(name, formula, comment)'
+ summary: Adds a new name to the collection of the given scope using the user's locale for the formula.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ addNamedItemFormulaLocal(
+ name: string,
+ formula: string,
+ comment?: string
+ ): NamedItem;
+ parameters:
+ - id: name
+ description: The name of the named item.
+ type: string
+ - id: formula
+ description: The formula in the user's locale that the name will refer to.
+ type: string
+ - id: comment
+ description: Optional. The comment associated with the named item.
+ type: string
+ return:
+ type: ''
+ description: ''
+ - name: addNamedSheetView(name)
+ uid: 'ExcelScript!ExcelScript.Worksheet#addNamedSheetView:member(1)'
+ package: ExcelScript!
+ fullName: addNamedSheetView(name)
+ summary: Creates a new sheet view with the given name.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addNamedSheetView(name: string): NamedSheetView;'
+ parameters:
+ - id: name
+ description: >-
+ The name of the sheet view to be created. Throws an error when the provided name already exists, is empty,
+ or is a name reserved by the worksheet.
+ type: string
+ return:
+ type: ''
+ description: ''
+ - name: 'addPivotTable(name, source, destination)'
+ uid: 'ExcelScript!ExcelScript.Worksheet#addPivotTable:member(1)'
+ package: ExcelScript!
+ fullName: 'addPivotTable(name, source, destination)'
+ summary: Add a PivotTable based on the specified source data and insert it at the top-left cell of the destination range.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ addPivotTable(
+ name: string,
+ source: Range | string | Table,
+ destination: Range | string
+ ): PivotTable;
+ parameters:
+ - id: name
+ description: The name of the new PivotTable.
+ type: string
+ - id: source
+ description: >-
+ The source data for the new PivotTable, this can either be a range (or string address including the
+ worksheet name) or a table.
+ type: >-
+ | string |
+ - id: destination
+ description: >-
+ The cell in the upper-left corner of the PivotTable report's destination range (the range on the worksheet
+ where the resulting report will be placed).
+ type: ' | string'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates a PivotTable from an existing table and adds it to a new worksheet.
+ * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Create a PivotTable based on a table in the current worksheet.
+ let sheet = workbook.getActiveWorksheet();
+ let table = sheet.getTables()[0];
+
+ // Add the PivotTable to a new worksheet.
+ let newSheet = workbook.addWorksheet("Pivot");
+ let pivotTable = newSheet.addPivotTable("My Pivot", table, "A1");
+
+ // Add fields to the PivotTable to show "Sales" per "Type".
+ pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
+ pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
+
+ // Switch to the new worksheet.
+ newSheet.activate();
+ }
+ ```
+ - name: 'addSlicer(slicerSource, sourceField, slicerDestination)'
+ uid: 'ExcelScript!ExcelScript.Worksheet#addSlicer:member(1)'
+ package: ExcelScript!
+ fullName: 'addSlicer(slicerSource, sourceField, slicerDestination)'
+ summary: Adds a new slicer to the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ addSlicer(
+ slicerSource: string | PivotTable | Table,
+ sourceField: string | PivotField | number | TableColumn,
+ slicerDestination?: string | Worksheet
+ ): Slicer;
+ parameters:
+ - id: slicerSource
+ description: >-
+ The data source that the new slicer will be based on. It can be a `PivotTable` object, a `Table` object, or
+ a string. When a PivotTable object is passed, the data source is the source of the `PivotTable` object. When
+ a `Table` object is passed, the data source is the `Table` object. When a string is passed, it is
+ interpreted as the name or ID of a PivotTable or table.
+ type: >-
+ string | |
+ - id: sourceField
+ description: >-
+ The field in the data source to filter by. It can be a `PivotField` object, a `TableColumn` object, the ID
+ of a `PivotField` or the name or ID of a `TableColumn`.
+ type: >-
+ string | | number |
+ - id: slicerDestination
+ description: >-
+ Optional. The worksheet in which the new slicer will be created. It can be a `Worksheet` object or the name
+ or ID of a worksheet. This parameter can be omitted if the slicer collection is retrieved from a worksheet.
+ type: 'string | '
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a slicer for an existing PivotTable on the current worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first PivotTable from the current worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const pivot = currentSheet.getPivotTables()[0];
+
+ // Create the slicer.
+ // Note that this assumes "Type" is already added as a hierarchy to the PivotTable.
+ const slicer = currentSheet.addSlicer(
+ pivot, /* The table or PivotTale to be sliced. */
+ pivot.getHierarchy("Type").getFields()[0] /* What source field to use as the slicer options. */
+ );
+
+ // Select the items to display.
+ slicer.selectItems(["Lemon", "Lime"]);
+
+ // Set the left margin of the slicer.
+ slicer.setLeft(400);
+ }
+ ```
+ - name: 'addTable(address, hasHeaders)'
+ uid: 'ExcelScript!ExcelScript.Worksheet#addTable:member(1)'
+ package: ExcelScript!
+ fullName: 'addTable(address, hasHeaders)'
+ summary: >-
+ Creates a new table. The range object or source address determines the worksheet under which the table will be
+ added. If the table cannot be added (e.g., because the address is invalid, or the table would overlap with another
+ table), an error will be thrown.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addTable(address: Range | string, hasHeaders: boolean): Table;'
+ parameters:
+ - id: address
+ description: >-
+ A `Range` object, or a string address or name of the range representing the data source. If the address does
+ not contain a sheet name, the currently-active sheet is used.
+ type: ' | string'
+ - id: hasHeaders
+ description: >-
+ A boolean value that indicates whether the data being imported has column labels. If the source does not
+ contain headers (i.e., when this property set to `false`), Excel will automatically generate a
+ header and shift the data down by one row.
+ type: boolean
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample creates a table from the current worksheet's used range, then sorts it based on the first column.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Create a table with the used cells.
+ let usedRange = selectedSheet.getUsedRange();
+ let newTable = selectedSheet.addTable(usedRange, true);
+
+ // Sort the table using the first column.
+ newTable.getSort().apply([{ key: 0, ascending: true }]);
+ }
+ ```
+ - name: addTextBox(text)
+ uid: 'ExcelScript!ExcelScript.Worksheet#addTextBox:member(1)'
+ package: ExcelScript!
+ fullName: addTextBox(text)
+ summary: >-
+ Adds a text box to the worksheet with the provided text as the content. Returns a `Shape` object that represents
+ the new text box.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addTextBox(text?: string): Shape;'
+ parameters:
+ - id: text
+ description: Represents the text that will be shown in the created text box.
+ type: string
+ return:
+ type: ''
+ description: ''
+ - name: addVerticalPageBreak(pageBreakRange)
+ uid: 'ExcelScript!ExcelScript.Worksheet#addVerticalPageBreak:member(1)'
+ package: ExcelScript!
+ fullName: addVerticalPageBreak(pageBreakRange)
+ summary: Adds a page break before the top-left cell of the range specified.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addVerticalPageBreak(pageBreakRange: Range | string): PageBreak;'
+ parameters:
+ - id: pageBreakRange
+ description: The range immediately after the page break to be added.
+ type: ' | string'
+ return:
+ type: ''
+ description: ''
+ - name: 'addWorksheetCustomProperty(key, value)'
+ uid: 'ExcelScript!ExcelScript.Worksheet#addWorksheetCustomProperty:member(1)'
+ package: ExcelScript!
+ fullName: 'addWorksheetCustomProperty(key, value)'
+ summary: >-
+ Adds a new custom property that maps to the provided key. This overwrites existing custom properties with that
+ key.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ addWorksheetCustomProperty(
+ key: string,
+ value: string
+ ): WorksheetCustomProperty;
+ parameters:
+ - id: key
+ description: >-
+ The key that identifies the custom property object. It is case-insensitive.The key is limited to 255
+ characters (larger values will cause an `InvalidArgument` error to be thrown.)
+ type: string
+ - id: value
+ description: The value of this custom property.
+ type: string
+ return:
+ type: ''
+ description: ''
+ - name: calculate(markAllDirty)
+ uid: 'ExcelScript!ExcelScript.Worksheet#calculate:member(1)'
+ package: ExcelScript!
+ fullName: calculate(markAllDirty)
+ summary: Calculates all cells on a worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'calculate(markAllDirty: boolean): void;'
+ parameters:
+ - id: markAllDirty
+ description: 'True, to mark all as dirty.'
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: 'copy(positionType, relativeTo)'
+ uid: 'ExcelScript!ExcelScript.Worksheet#copy:member(1)'
+ package: ExcelScript!
+ fullName: 'copy(positionType, relativeTo)'
+ summary: Copies a worksheet and places it at the specified position.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ copy(
+ positionType?: WorksheetPositionType,
+ relativeTo?: Worksheet
+ ): Worksheet;
+ parameters:
+ - id: positionType
+ description: >-
+ The location in the workbook to place the newly created worksheet. The default value is "None", which
+ inserts the worksheet at the beginning of the worksheet.
+ type: ''
+ - id: relativeTo
+ description: >-
+ The existing worksheet which determines the newly created worksheet's position. This is only needed if
+ `positionType` is "Before" or "After".
+ type: ''
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script duplicates a worksheet named "Template".
+ * The new worksheet is added after the template.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the worksheet named "Template".
+ let template = workbook.getWorksheet("Template");
+
+ // Copy the worksheet.
+ let newSheet = template.copy(
+ ExcelScript.WorksheetPositionType.after,
+ template
+ );
+
+ // Name the worksheet using the current date.
+ let date = new Date(Date.now());
+ newSheet.setName(`${date.toDateString()}`);
+ }
+ ```
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.Worksheet#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: >-
+ Deletes the worksheet from the workbook. Note that if the worksheet's visibility is set to "VeryHidden", the
+ delete operation will fail with an `InvalidOperation` exception. You should first change its visibility to hidden
+ or visible before deleting it.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * The following scripts removes the first worksheet in the workbook.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first worksheet.
+ let sheet = workbook.getWorksheets()[0];
+
+ // Remove that worksheet from the workbook.
+ sheet.delete();
+ }
+ ```
+ - name: enterTemporaryNamedSheetView()
+ uid: 'ExcelScript!ExcelScript.Worksheet#enterTemporaryNamedSheetView:member(1)'
+ package: ExcelScript!
+ fullName: enterTemporaryNamedSheetView()
+ summary: >-
+ Creates and activates a new temporary sheet view. Temporary views are removed when closing the application,
+ exiting the temporary view with the exit method, or switching to another sheet view. The temporary sheet view can
+ also be accessed with the empty string (""), if the temporary view exists.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'enterTemporaryNamedSheetView(): NamedSheetView;'
+ return:
+ type: ''
+ description: ''
+ - name: exitActiveNamedSheetView()
+ uid: 'ExcelScript!ExcelScript.Worksheet#exitActiveNamedSheetView:member(1)'
+ package: ExcelScript!
+ fullName: exitActiveNamedSheetView()
+ summary: Exits the currently active sheet view.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'exitActiveNamedSheetView(): void;'
+ return:
+ type: void
+ description: ''
+ - name: 'findAll(text, criteria)'
+ uid: 'ExcelScript!ExcelScript.Worksheet#findAll:member(1)'
+ package: ExcelScript!
+ fullName: 'findAll(text, criteria)'
+ summary: >-
+ Finds all occurrences of the given string based on the criteria specified and returns them as a `RangeAreas`
+ object, comprising one or more rectangular ranges.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'findAll(text: string, criteria: WorksheetSearchCriteria): RangeAreas;'
+ parameters:
+ - id: text
+ description: The string to find.
+ type: string
+ - id: criteria
+ description: >-
+ Additional search criteria, including whether the search needs to match the entire cell or be
+ case-sensitive.
+ type: ''
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script searches through a worksheet and finds cells containing "No".
+ * Those cells are filled with the color red.
+ * Use Range.find instead of Worksheet.findAll when you want to limit the search to a specific range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current, active worksheet.
+ let worksheet = workbook.getActiveWorksheet();
+ let noCells = worksheet.findAll("No", { completeMatch: true });
+
+ // Set the fill color to red.
+ noCells.getFormat().getFill().setColor("red");
+ }
+ ```
+ - name: getActiveNamedSheetView()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getActiveNamedSheetView:member(1)'
+ package: ExcelScript!
+ fullName: getActiveNamedSheetView()
+ summary: Gets the worksheet's currently active sheet view.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getActiveNamedSheetView(): NamedSheetView;'
+ return:
+ type: ''
+ description: ''
+ - name: getAutoFilter()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getAutoFilter:member(1)'
+ package: ExcelScript!
+ fullName: getAutoFilter()
+ summary: Represents the `AutoFilter` object of the worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAutoFilter(): AutoFilter;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script creates an autoFilter on the worksheet that filters out rows based on column values.
+ * The autoFilter filters to only include rows that have a value in column D in the top 10 percentile
+ * (of column D values).
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ const currentSheet = workbook.getActiveWorksheet();
+ const dataRange = currentSheet.getUsedRange();
+
+ // Add a filter that will only show the rows with the top 10% of values in column D
+ // (index 3, assuming the used range spans from at least A:D).
+ currentSheet.getAutoFilter().apply(dataRange, 3, {
+ criterion1: "10",
+ filterOn: ExcelScript.FilterOn.topPercent
+ });
+ }
+ ```
+ - name: 'getCell(row, column)'
+ uid: 'ExcelScript!ExcelScript.Worksheet#getCell:member(1)'
+ package: ExcelScript!
+ fullName: 'getCell(row, column)'
+ summary: >-
+ Gets the `Range` object containing the single cell based on row and column numbers. The cell can be outside the
+ bounds of its parent range, so long as it stays within the worksheet grid.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCell(row: number, column: number): Range;'
+ parameters:
+ - id: row
+ description: The row number of the cell to be retrieved. Zero-indexed.
+ type: number
+ - id: column
+ description: The column number of the cell to be retrieved. Zero-indexed.
+ type: number
+ return:
+ type: ''
+ description: ''
+ - name: getChart(name)
+ uid: 'ExcelScript!ExcelScript.Worksheet#getChart:member(1)'
+ package: ExcelScript!
+ fullName: getChart(name)
+ summary: >-
+ Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned. If
+ the chart doesn't exist, then this method returns `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getChart(name: string): Chart | undefined;'
+ parameters:
+ - id: name
+ description: Name of the chart to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample moves an existing chart to a specific place on the worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Get an existing chart named "ColumnChart".
+ let chart = selectedSheet.getChart("ColumnChart");
+
+ // Place the chart over the range "F1:L13".
+ chart.setPosition("F1", "L13");
+ }
+ ```
+ - name: getCharts()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getCharts:member(1)'
+ package: ExcelScript!
+ fullName: getCharts()
+ summary: Returns a collection of charts that are part of the worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCharts(): Chart[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getComment(commentId)
+ uid: 'ExcelScript!ExcelScript.Worksheet#getComment:member(1)'
+ package: ExcelScript!
+ fullName: getComment(commentId)
+ summary: >-
+ Gets a comment from the collection based on its ID. If the comment object does not exist, then this method returns
+ `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getComment(commentId: string): Comment | undefined;'
+ parameters:
+ - id: commentId
+ description: The identifier for the comment.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getCommentByCell(cellAddress)
+ uid: 'ExcelScript!ExcelScript.Worksheet#getCommentByCell:member(1)'
+ package: ExcelScript!
+ fullName: getCommentByCell(cellAddress)
+ summary: 'Gets the comment from the specified cell. If there is no comment in the cell, an error is thrown.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCommentByCell(cellAddress: Range | string): Comment;'
+ parameters:
+ - id: cellAddress
+ description: >-
+ The cell which the comment is on. This can be a `Range` object or a string. If it's a string, it must
+ contain the full address, including the sheet name. An `InvalidArgument` error is thrown if the provided
+ range is larger than one cell.
+ type: ' | string'
+ return:
+ type: ''
+ description: ''
+ - name: getCommentByReplyId(replyId)
+ uid: 'ExcelScript!ExcelScript.Worksheet#getCommentByReplyId:member(1)'
+ package: ExcelScript!
+ fullName: getCommentByReplyId(replyId)
+ summary: Gets the comment to which the given reply is connected.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCommentByReplyId(replyId: string): Comment;'
+ parameters:
+ - id: replyId
+ description: The identifier of comment reply.
+ type: string
+ return:
+ type: ''
+ description: ''
+ - name: getComments()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getComments:member(1)'
+ package: ExcelScript!
+ fullName: getComments()
+ summary: Returns a collection of all the Comments objects on the worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getComments(): Comment[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getCustomProperties()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getCustomProperties:member(1)'
+ package: ExcelScript!
+ fullName: getCustomProperties()
+ summary: Gets a collection of worksheet-level custom properties.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCustomProperties(): WorksheetCustomProperty[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getEnableCalculation()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getEnableCalculation:member(1)'
+ package: ExcelScript!
+ fullName: getEnableCalculation()
+ summary: >-
+ Determines if Excel should recalculate the worksheet when necessary. True if Excel recalculates the worksheet when
+ necessary. False if Excel doesn't recalculate the sheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getEnableCalculation(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getFreezePanes()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getFreezePanes:member(1)'
+ package: ExcelScript!
+ fullName: getFreezePanes()
+ summary: Gets an object that can be used to manipulate frozen panes on the worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFreezePanes(): WorksheetFreezePanes;'
+ return:
+ type: ''
+ description: ''
+ - name: getHorizontalPageBreaks()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getHorizontalPageBreaks:member(1)'
+ package: ExcelScript!
+ fullName: getHorizontalPageBreaks()
+ summary: Gets the horizontal page break collection for the worksheet. This collection only contains manual page breaks.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHorizontalPageBreaks(): PageBreak[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getId()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getId:member(1)'
+ package: ExcelScript!
+ fullName: getId()
+ summary: >-
+ Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains
+ the same even when the worksheet is renamed or moved.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getId(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getName()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getName:member(1)'
+ package: ExcelScript!
+ fullName: getName()
+ summary: The display name of the worksheet. The name must be fewer than 32 characters.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample gets all the worksheet names in the workbook.
+ * It then logs those names to the console.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Create an array to hold the worksheet names.
+ let worksheetNames = [];
+
+ // Iterate over the worksheet collection in the workbook.
+ for (let worksheet of workbook.getWorksheets()) {
+ worksheetNames.push(worksheet.getName());
+ }
+
+ // Log the array of worksheet names.
+ console.log(worksheetNames);
+ }
+ ```
+ - name: getNamedItem(name)
+ uid: 'ExcelScript!ExcelScript.Worksheet#getNamedItem:member(1)'
+ package: ExcelScript!
+ fullName: getNamedItem(name)
+ summary: >-
+ Gets a `NamedItem` object using its name. If the object does not exist, then this method returns `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNamedItem(name: string): NamedItem | undefined;'
+ parameters:
+ - id: name
+ description: Nameditem name.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getNamedSheetView(key)
+ uid: 'ExcelScript!ExcelScript.Worksheet#getNamedSheetView:member(1)'
+ package: ExcelScript!
+ fullName: getNamedSheetView(key)
+ summary: >-
+ Gets a sheet view using its name. If the sheet view object does not exist, then this method returns an object with
+ its `isNullObject` property set to `true`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNamedSheetView(key: string): NamedSheetView | undefined;'
+ parameters:
+ - id: key
+ description: >-
+ The case-sensitive name of the sheet view. Use the empty string ("") to get the temporary sheet view, if the
+ temporary view exists.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getNamedSheetViews()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getNamedSheetViews:member(1)'
+ package: ExcelScript!
+ fullName: getNamedSheetViews()
+ summary: Returns a collection of sheet views that are present in the worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNamedSheetViews(): NamedSheetView[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getNames()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getNames:member(1)'
+ package: ExcelScript!
+ fullName: getNames()
+ summary: Collection of names scoped to the current worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNames(): NamedItem[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getNext(visibleOnly)
+ uid: 'ExcelScript!ExcelScript.Worksheet#getNext:member(1)'
+ package: ExcelScript!
+ fullName: getNext(visibleOnly)
+ summary: >-
+ Gets the worksheet that follows this one. If there are no worksheets following this one, then this method returns
+ `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getNext(visibleOnly?: boolean): Worksheet;'
+ parameters:
+ - id: visibleOnly
+ description: 'Optional. If `true`, considers only visible worksheets, skipping over any hidden ones.'
+ type: boolean
+ return:
+ type: ''
+ description: ''
+ - name: getPageLayout()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getPageLayout:member(1)'
+ package: ExcelScript!
+ fullName: getPageLayout()
+ summary: Gets the `PageLayout` object of the worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPageLayout(): PageLayout;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the printing orientation for the entire workbook.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Go to each worksheet so the print settings are consistent.
+ workbook.getWorksheets().forEach((sheet) => {
+ const pageLayout = sheet.getPageLayout();
+
+ // Print every page with a landscape orientation.
+ pageLayout.setOrientation(ExcelScript.PageOrientation.landscape);
+ });
+ }
+ ```
+ - name: getPivotTable(name)
+ uid: 'ExcelScript!ExcelScript.Worksheet#getPivotTable:member(1)'
+ package: ExcelScript!
+ fullName: getPivotTable(name)
+ summary: 'Gets a PivotTable by name. If the PivotTable does not exist, then this method returns `undefined`.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPivotTable(name: string): PivotTable | undefined;'
+ parameters:
+ - id: name
+ description: Name of the PivotTable to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getPivotTables()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getPivotTables:member(1)'
+ package: ExcelScript!
+ fullName: getPivotTables()
+ summary: Collection of PivotTables that are part of the worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPivotTables(): PivotTable[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getPosition()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getPosition:member(1)'
+ package: ExcelScript!
+ fullName: getPosition()
+ summary: The zero-based position of the worksheet within the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPosition(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getPrevious(visibleOnly)
+ uid: 'ExcelScript!ExcelScript.Worksheet#getPrevious:member(1)'
+ package: ExcelScript!
+ fullName: getPrevious(visibleOnly)
+ summary: >-
+ Gets the worksheet that precedes this one. If there are no previous worksheets, then this method returns
+ `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPrevious(visibleOnly?: boolean): Worksheet;'
+ parameters:
+ - id: visibleOnly
+ description: 'Optional. If `true`, considers only visible worksheets, skipping over any hidden ones.'
+ type: boolean
+ return:
+ type: ''
+ description: ''
+ - name: getProtection()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getProtection:member(1)'
+ package: ExcelScript!
+ fullName: getProtection()
+ summary: Returns the sheet protection object for a worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getProtection(): WorksheetProtection;'
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script protects cells from being selected on the current worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the protection settings for the current worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const sheetProtection = currentSheet.getProtection();
+
+ // Create a new WorksheetProtectionOptions object with the selectionMode property set to `none`.
+ let protectionOptions : ExcelScript.WorksheetProtectionOptions = {
+ selectionMode: ExcelScript.ProtectionSelectionMode.none
+ }
+
+ // Apply the given protection options.
+ sheetProtection.protect(protectionOptions);
+ }
+ ```
+ - name: getRange(address)
+ uid: 'ExcelScript!ExcelScript.Worksheet#getRange:member(1)'
+ package: ExcelScript!
+ fullName: getRange(address)
+ summary: 'Gets the `Range` object, representing a single rectangular block of cells, specified by the address or name.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRange(address?: string): Range;'
+ parameters:
+ - id: address
+ description: >-
+ Optional. The string representing the address or name of the range. For example, "A1:B2". If not specified,
+ the entire worksheet range is returned. The `address` has a limit of 8192 characters. If the address exceeds
+ the character limit, this method returns an `InvalidArgument` error.
+ type: string
+ return:
+ type: ''
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample reads the value of A1 and prints it to the console.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Get the value of cell A1.
+ let range = selectedSheet.getRange("A1");
+
+ // Print the value of A1.
+ console.log(range.getValue());
+ }
+ ```
+ - name: 'getRangeByIndexes(startRow, startColumn, rowCount, columnCount)'
+ uid: 'ExcelScript!ExcelScript.Worksheet#getRangeByIndexes:member(1)'
+ package: ExcelScript!
+ fullName: 'getRangeByIndexes(startRow, startColumn, rowCount, columnCount)'
+ summary: >-
+ Gets the `Range` object beginning at a particular row index and column index, and spanning a certain number of
+ rows and columns.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ getRangeByIndexes(
+ startRow: number,
+ startColumn: number,
+ rowCount: number,
+ columnCount: number
+ ): Range;
+ parameters:
+ - id: startRow
+ description: Start row (zero-indexed).
+ type: number
+ - id: startColumn
+ description: Start column (zero-indexed).
+ type: number
+ - id: rowCount
+ description: Number of rows to include in the range.
+ type: number
+ - id: columnCount
+ description: Number of columns to include in the range.
+ type: number
+ return:
+ type: ''
+ description: ''
+ - name: getRanges(address)
+ uid: 'ExcelScript!ExcelScript.Worksheet#getRanges:member(1)'
+ package: ExcelScript!
+ fullName: getRanges(address)
+ summary: >-
+ Gets the `RangeAreas` object, representing one or more blocks of rectangular ranges, specified by the address or
+ name.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getRanges(address?: string): RangeAreas;'
+ parameters:
+ - id: address
+ description: >-
+ Optional. A string containing the comma-separated or semicolon-separated addresses or names of the
+ individual ranges. For example, "A1:B2, A5:B5" or "A1:B2; A5:B5". If not specified, a `RangeAreas` object
+ for the entire worksheet is returned.
+ type: string
+ return:
+ type: ''
+ description: ''
+ - name: getShape(key)
+ uid: 'ExcelScript!ExcelScript.Worksheet#getShape:member(1)'
+ package: ExcelScript!
+ fullName: getShape(key)
+ summary: >-
+ Gets a shape using its name or ID. If the shape object does not exist, then this method returns `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShape(key: string): Shape | undefined;'
+ parameters:
+ - id: key
+ description: The name or ID of the shape to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getShapes()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getShapes:member(1)'
+ package: ExcelScript!
+ fullName: getShapes()
+ summary: Returns the collection of all the Shape objects on the worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShapes(): Shape[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getShowDataTypeIcons()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getShowDataTypeIcons:member(1)'
+ package: ExcelScript!
+ fullName: getShowDataTypeIcons()
+ summary: 'Specifies if data type icons are visible on the worksheet. By default, data type icons are visible.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowDataTypeIcons(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowGridlines()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getShowGridlines:member(1)'
+ package: ExcelScript!
+ fullName: getShowGridlines()
+ summary: Specifies if gridlines are visible to the user.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowGridlines(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowHeadings()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getShowHeadings:member(1)'
+ package: ExcelScript!
+ fullName: getShowHeadings()
+ summary: Specifies if headings are visible to the user.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowHeadings(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getSlicer(key)
+ uid: 'ExcelScript!ExcelScript.Worksheet#getSlicer:member(1)'
+ package: ExcelScript!
+ fullName: getSlicer(key)
+ summary: 'Gets a slicer using its name or ID. If the slicer doesn''t exist, then this method returns `undefined`.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSlicer(key: string): Slicer | undefined;'
+ parameters:
+ - id: key
+ description: Name or ID of the slicer to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getSlicers()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getSlicers:member(1)'
+ package: ExcelScript!
+ fullName: getSlicers()
+ summary: Returns a collection of slicers that are part of the worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSlicers(): Slicer[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getStandardHeight()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getStandardHeight:member(1)'
+ package: ExcelScript!
+ fullName: getStandardHeight()
+ summary: 'Returns the standard (default) height of all the rows in the worksheet, in points.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getStandardHeight(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getStandardWidth()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getStandardWidth:member(1)'
+ package: ExcelScript!
+ fullName: getStandardWidth()
+ summary: >-
+ Specifies the standard (default) width of all the columns in the worksheet. One unit of column width is equal to
+ the width of one character in the Normal style. For proportional fonts, the width of the character 0 (zero) is
+ used.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getStandardWidth(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getTabColor()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getTabColor:member(1)'
+ package: ExcelScript!
+ fullName: getTabColor()
+ summary: >-
+ The tab color of the worksheet. When retrieving the tab color, if the worksheet is invisible, the value will be
+ `null`. If the worksheet is visible but the tab color is set to auto, an empty string will be returned.
+ Otherwise, the property will be set to a color, in the form \#RRGGBB (e.g., "FFA500"). When setting the color, use
+ an empty-string to set an "auto" color, or a real color otherwise.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTabColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getTabId()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getTabId:member(1)'
+ package: ExcelScript!
+ fullName: getTabId()
+ summary: >-
+ Returns a value representing this worksheet that can be read by Open Office XML. This is an integer value, which
+ is different from `worksheet.id` (which returns a globally unique identifier) and `worksheet.name` (which returns
+ a value such as "Sheet1").
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTabId(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getTable(key)
+ uid: 'ExcelScript!ExcelScript.Worksheet#getTable:member(1)'
+ package: ExcelScript!
+ fullName: getTable(key)
+ summary: 'Gets a table by name or ID. If the table doesn''t exist, then this method returns `undefined`.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTable(key: string): Table | undefined;'
+ parameters:
+ - id: key
+ description: Name or ID of the table to be retrieved.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getTables()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getTables:member(1)'
+ package: ExcelScript!
+ fullName: getTables()
+ summary: Collection of tables that are part of the worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTables(): Table[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getUsedRange(valuesOnly)
+ uid: 'ExcelScript!ExcelScript.Worksheet#getUsedRange:member(1)'
+ package: ExcelScript!
+ fullName: getUsedRange(valuesOnly)
+ summary: ''
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getUsedRange(valuesOnly?: boolean): Range;'
+ parameters:
+ - id: valuesOnly
+ description: Optional. Considers only cells with values as used cells.
+ type: boolean
+ return:
+ type: ''
+ description: ''
+ - name: getVerticalPageBreaks()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getVerticalPageBreaks:member(1)'
+ package: ExcelScript!
+ fullName: getVerticalPageBreaks()
+ summary: Gets the vertical page break collection for the worksheet. This collection only contains manual page breaks.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVerticalPageBreaks(): PageBreak[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getVisibility()
+ uid: 'ExcelScript!ExcelScript.Worksheet#getVisibility:member(1)'
+ package: ExcelScript!
+ fullName: getVisibility()
+ summary: The visibility of the worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVisibility(): SheetVisibility;'
+ return:
+ type: ''
+ description: ''
+ - name: getWorksheetCustomProperty(key)
+ uid: 'ExcelScript!ExcelScript.Worksheet#getWorksheetCustomProperty:member(1)'
+ package: ExcelScript!
+ fullName: getWorksheetCustomProperty(key)
+ summary: >-
+ Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then
+ this method returns `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ getWorksheetCustomProperty(
+ key: string
+ ): WorksheetCustomProperty | undefined;
+ parameters:
+ - id: key
+ description: The key that identifies the custom property object. It is case-insensitive.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: refreshAllPivotTables()
+ uid: 'ExcelScript!ExcelScript.Worksheet#refreshAllPivotTables:member(1)'
+ package: ExcelScript!
+ fullName: refreshAllPivotTables()
+ summary: Refreshes all the pivot tables in the collection.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'refreshAllPivotTables(): void;'
+ return:
+ type: void
+ description: ''
+ - name: removeAllHorizontalPageBreaks()
+ uid: 'ExcelScript!ExcelScript.Worksheet#removeAllHorizontalPageBreaks:member(1)'
+ package: ExcelScript!
+ fullName: removeAllHorizontalPageBreaks()
+ summary: Resets all manual page breaks in the collection.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'removeAllHorizontalPageBreaks(): void;'
+ return:
+ type: void
+ description: ''
+ - name: removeAllVerticalPageBreaks()
+ uid: 'ExcelScript!ExcelScript.Worksheet#removeAllVerticalPageBreaks:member(1)'
+ package: ExcelScript!
+ fullName: removeAllVerticalPageBreaks()
+ summary: Resets all manual page breaks in the collection.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'removeAllVerticalPageBreaks(): void;'
+ return:
+ type: void
+ description: ''
+ - name: 'replaceAll(text, replacement, criteria)'
+ uid: 'ExcelScript!ExcelScript.Worksheet#replaceAll:member(1)'
+ package: ExcelScript!
+ fullName: 'replaceAll(text, replacement, criteria)'
+ summary: Finds and replaces the given string based on the criteria specified within the current worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ replaceAll(
+ text: string,
+ replacement: string,
+ criteria: ReplaceCriteria
+ ): number;
+ parameters:
+ - id: text
+ description: String to find.
+ type: string
+ - id: replacement
+ description: The string that replaces the original string.
+ type: string
+ - id: criteria
+ description: Additional replacement criteria.
+ type: ''
+ return:
+ type: number
+ description: ''
+ - name: setEnableCalculation(enableCalculation)
+ uid: 'ExcelScript!ExcelScript.Worksheet#setEnableCalculation:member(1)'
+ package: ExcelScript!
+ fullName: setEnableCalculation(enableCalculation)
+ summary: >-
+ Determines if Excel should recalculate the worksheet when necessary. True if Excel recalculates the worksheet when
+ necessary. False if Excel doesn't recalculate the sheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setEnableCalculation(enableCalculation: boolean): void;'
+ parameters:
+ - id: enableCalculation
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setName(name)
+ uid: 'ExcelScript!ExcelScript.Worksheet#setName:member(1)'
+ package: ExcelScript!
+ fullName: setName(name)
+ summary: The display name of the worksheet. The name must be fewer than 32 characters.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setName(name: string): void;'
+ parameters:
+ - id: name
+ description: ''
+ type: string
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample renames a worksheet from "Sheet1" to "SALES".
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get a worksheet named "Sheet1".
+ const sheet = workbook.getWorksheet('Sheet1');
+
+ // Set its name to SALES.
+ sheet.setName('SALES');
+ }
+ ```
+ - name: setPosition(position)
+ uid: 'ExcelScript!ExcelScript.Worksheet#setPosition:member(1)'
+ package: ExcelScript!
+ fullName: setPosition(position)
+ summary: The zero-based position of the worksheet within the workbook.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPosition(position: number): void;'
+ parameters:
+ - id: position
+ description: ''
+ type: number
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample sets the worksheet named "SALES" as the first sheet in the workbook.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get a worksheet named "SALES".
+ const sheet = workbook.getWorksheet('SALES');
+ // Position the worksheet at the beginning of the workbook.
+ sheet.setPosition(0);
+ }
+ ```
+ - name: setShowDataTypeIcons(showDataTypeIcons)
+ uid: 'ExcelScript!ExcelScript.Worksheet#setShowDataTypeIcons:member(1)'
+ package: ExcelScript!
+ fullName: setShowDataTypeIcons(showDataTypeIcons)
+ summary: 'Specifies if data type icons are visible on the worksheet. By default, data type icons are visible.'
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowDataTypeIcons(showDataTypeIcons: boolean): void;'
+ parameters:
+ - id: showDataTypeIcons
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowGridlines(showGridlines)
+ uid: 'ExcelScript!ExcelScript.Worksheet#setShowGridlines:member(1)'
+ package: ExcelScript!
+ fullName: setShowGridlines(showGridlines)
+ summary: Specifies if gridlines are visible to the user.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowGridlines(showGridlines: boolean): void;'
+ parameters:
+ - id: showGridlines
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowHeadings(showHeadings)
+ uid: 'ExcelScript!ExcelScript.Worksheet#setShowHeadings:member(1)'
+ package: ExcelScript!
+ fullName: setShowHeadings(showHeadings)
+ summary: Specifies if headings are visible to the user.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowHeadings(showHeadings: boolean): void;'
+ parameters:
+ - id: showHeadings
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setStandardWidth(standardWidth)
+ uid: 'ExcelScript!ExcelScript.Worksheet#setStandardWidth:member(1)'
+ package: ExcelScript!
+ fullName: setStandardWidth(standardWidth)
+ summary: >-
+ Specifies the standard (default) width of all the columns in the worksheet. One unit of column width is equal to
+ the width of one character in the Normal style. For proportional fonts, the width of the character 0 (zero) is
+ used.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setStandardWidth(standardWidth: number): void;'
+ parameters:
+ - id: standardWidth
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setTabColor(tabColor)
+ uid: 'ExcelScript!ExcelScript.Worksheet#setTabColor:member(1)'
+ package: ExcelScript!
+ fullName: setTabColor(tabColor)
+ summary: >-
+ The tab color of the worksheet. When retrieving the tab color, if the worksheet is invisible, the value will be
+ `null`. If the worksheet is visible but the tab color is set to auto, an empty string will be returned.
+ Otherwise, the property will be set to a color, in the form \#RRGGBB (e.g., "FFA500"). When setting the color, use
+ an empty-string to set an "auto" color, or a real color otherwise.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setTabColor(tabColor: string): void;'
+ parameters:
+ - id: tabColor
+ description: ''
+ type: string
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script sets the tab color of every worksheet in the workbook to red.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get all the worksheets in the workbook.
+ let sheets = workbook.getWorksheets();
+
+ // Set the tab color of each worksheet to a random color.
+ for (let sheet of sheets) {
+ // Set the color of the current worksheet's tab to red.
+ sheet.setTabColor("red");
+ }
+ }
+ ```
+ - name: setVisibility(visibility)
+ uid: 'ExcelScript!ExcelScript.Worksheet#setVisibility:member(1)'
+ package: ExcelScript!
+ fullName: setVisibility(visibility)
+ summary: The visibility of the worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setVisibility(visibility: SheetVisibility): void;'
+ parameters:
+ - id: visibility
+ description: ''
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script unhides all the worksheets in the workbook.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Iterate over each worksheet.
+ workbook.getWorksheets().forEach((worksheet) => {
+ // Set the worksheet visibility to visible.
+ worksheet.setVisibility(ExcelScript.SheetVisibility.visible);
+ });
+ }
+ ```
+ - name: 'showOutlineLevels(rowLevels, columnLevels)'
+ uid: 'ExcelScript!ExcelScript.Worksheet#showOutlineLevels:member(1)'
+ package: ExcelScript!
+ fullName: 'showOutlineLevels(rowLevels, columnLevels)'
+ summary: >-
+ Shows row or column groups by their outline levels. Outlines groups and summarizes a list of data in the
+ worksheet. The `rowLevels` and `columnLevels` parameters specify how many levels of the outline will be displayed.
+ The acceptable argument range is between 0 and 8. A value of 0 does not change the current display. A value
+ greater than the current number of levels displays all the levels.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'showOutlineLevels(rowLevels: number, columnLevels: number): void;'
+ parameters:
+ - id: rowLevels
+ description: The number of row levels of an outline to display.
+ type: number
+ - id: columnLevels
+ description: The number of column levels of an outline to display.
+ type: number
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetcustomproperty.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetcustomproperty.yml
index a3bf9e23..dbf530b6 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetcustomproperty.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetcustomproperty.yml
@@ -1,69 +1,69 @@
-### YamlMime:TSType
-name: ExcelScript.WorksheetCustomProperty
-uid: 'ExcelScript!ExcelScript.WorksheetCustomProperty:interface'
-package: ExcelScript!
-fullName: ExcelScript.WorksheetCustomProperty
-summary: Represents a worksheet-level custom property.
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: delete()
- uid: 'ExcelScript!ExcelScript.WorksheetCustomProperty#delete:member(1)'
- package: ExcelScript!
- fullName: delete()
- summary: Deletes the custom property.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: ''
- - name: getKey()
- uid: 'ExcelScript!ExcelScript.WorksheetCustomProperty#getKey:member(1)'
- package: ExcelScript!
- fullName: getKey()
- summary: >-
- Gets the key of the custom property. Custom property keys are case-insensitive. The key is limited to 255
- characters (larger values will cause an `InvalidArgument` error to be thrown.)
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getKey(): string;'
- return:
- type: string
- description: ''
- - name: getValue()
- uid: 'ExcelScript!ExcelScript.WorksheetCustomProperty#getValue:member(1)'
- package: ExcelScript!
- fullName: getValue()
- summary: Gets or sets the value of the custom property.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getValue(): string;'
- return:
- type: string
- description: ''
- - name: setValue(value)
- uid: 'ExcelScript!ExcelScript.WorksheetCustomProperty#setValue:member(1)'
- package: ExcelScript!
- fullName: setValue(value)
- summary: Gets or sets the value of the custom property.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setValue(value: string): void;'
- parameters:
- - id: value
- description: ''
- type: string
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.WorksheetCustomProperty
+uid: 'ExcelScript!ExcelScript.WorksheetCustomProperty:interface'
+package: ExcelScript!
+fullName: ExcelScript.WorksheetCustomProperty
+summary: Represents a worksheet-level custom property.
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: delete()
+ uid: 'ExcelScript!ExcelScript.WorksheetCustomProperty#delete:member(1)'
+ package: ExcelScript!
+ fullName: delete()
+ summary: Deletes the custom property.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getKey()
+ uid: 'ExcelScript!ExcelScript.WorksheetCustomProperty#getKey:member(1)'
+ package: ExcelScript!
+ fullName: getKey()
+ summary: >-
+ Gets the key of the custom property. Custom property keys are case-insensitive. The key is limited to 255
+ characters (larger values will cause an `InvalidArgument` error to be thrown.)
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getKey(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getValue()
+ uid: 'ExcelScript!ExcelScript.WorksheetCustomProperty#getValue:member(1)'
+ package: ExcelScript!
+ fullName: getValue()
+ summary: Specifies the value of the custom property.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getValue(): string;'
+ return:
+ type: string
+ description: ''
+ - name: setValue(value)
+ uid: 'ExcelScript!ExcelScript.WorksheetCustomProperty#setValue:member(1)'
+ package: ExcelScript!
+ fullName: setValue(value)
+ summary: Specifies the value of the custom property.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setValue(value: string): void;'
+ parameters:
+ - id: value
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetfreezepanes.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetfreezepanes.yml
index 6b38ec37..f66890b5 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetfreezepanes.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetfreezepanes.yml
@@ -1,93 +1,93 @@
-### YamlMime:TSType
-name: ExcelScript.WorksheetFreezePanes
-uid: 'ExcelScript!ExcelScript.WorksheetFreezePanes:interface'
-package: ExcelScript!
-fullName: ExcelScript.WorksheetFreezePanes
-summary: ''
-remarks: ''
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: freezeAt(frozenRange)
- uid: 'ExcelScript!ExcelScript.WorksheetFreezePanes#freezeAt:member(1)'
- package: ExcelScript!
- fullName: freezeAt(frozenRange)
- summary: >-
- Sets the frozen cells in the active worksheet view. The range provided corresponds to cells that will be frozen in
- the top- and left-most pane.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'freezeAt(frozenRange: Range | string): void;'
- parameters:
- - id: frozenRange
- description: 'A range that represents the cells to be frozen, or `null` to remove all frozen panes.'
- type: ' | string'
- return:
- type: void
- description: ''
- - name: freezeColumns(count)
- uid: 'ExcelScript!ExcelScript.WorksheetFreezePanes#freezeColumns:member(1)'
- package: ExcelScript!
- fullName: freezeColumns(count)
- summary: Freeze the first column or columns of the worksheet in place.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'freezeColumns(count?: number): void;'
- parameters:
- - id: count
- description: 'Optional number of columns to freeze, or zero to unfreeze all columns'
- type: number
- return:
- type: void
- description: ''
- - name: freezeRows(count)
- uid: 'ExcelScript!ExcelScript.WorksheetFreezePanes#freezeRows:member(1)'
- package: ExcelScript!
- fullName: freezeRows(count)
- summary: Freeze the top row or rows of the worksheet in place.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'freezeRows(count?: number): void;'
- parameters:
- - id: count
- description: 'Optional number of rows to freeze, or zero to unfreeze all rows'
- type: number
- return:
- type: void
- description: ''
- - name: getLocation()
- uid: 'ExcelScript!ExcelScript.WorksheetFreezePanes#getLocation:member(1)'
- package: ExcelScript!
- fullName: getLocation()
- summary: >-
- Gets a range that describes the frozen cells in the active worksheet view. The frozen range corresponds to cells
- that are frozen in the top- and left-most pane. If there is no frozen pane, then this method returns
- `undefined`.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getLocation(): Range;'
- return:
- type: ''
- description: ''
- - name: unfreeze()
- uid: 'ExcelScript!ExcelScript.WorksheetFreezePanes#unfreeze:member(1)'
- package: ExcelScript!
- fullName: unfreeze()
- summary: Removes all frozen panes in the worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'unfreeze(): void;'
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.WorksheetFreezePanes
+uid: 'ExcelScript!ExcelScript.WorksheetFreezePanes:interface'
+package: ExcelScript!
+fullName: ExcelScript.WorksheetFreezePanes
+summary: ''
+remarks: ''
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: freezeAt(frozenRange)
+ uid: 'ExcelScript!ExcelScript.WorksheetFreezePanes#freezeAt:member(1)'
+ package: ExcelScript!
+ fullName: freezeAt(frozenRange)
+ summary: >-
+ Sets the frozen cells in the active worksheet view. The range provided corresponds to cells that will be frozen in
+ the top- and left-most pane.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'freezeAt(frozenRange: Range | string): void;'
+ parameters:
+ - id: frozenRange
+ description: 'A range that represents the cells to be frozen, or `null` to remove all frozen panes.'
+ type: ' | string'
+ return:
+ type: void
+ description: ''
+ - name: freezeColumns(count)
+ uid: 'ExcelScript!ExcelScript.WorksheetFreezePanes#freezeColumns:member(1)'
+ package: ExcelScript!
+ fullName: freezeColumns(count)
+ summary: Freeze the first column or columns of the worksheet in place.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'freezeColumns(count?: number): void;'
+ parameters:
+ - id: count
+ description: 'Optional number of columns to freeze, or zero to unfreeze all columns'
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: freezeRows(count)
+ uid: 'ExcelScript!ExcelScript.WorksheetFreezePanes#freezeRows:member(1)'
+ package: ExcelScript!
+ fullName: freezeRows(count)
+ summary: Freeze the top row or rows of the worksheet in place.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'freezeRows(count?: number): void;'
+ parameters:
+ - id: count
+ description: 'Optional number of rows to freeze, or zero to unfreeze all rows'
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: getLocation()
+ uid: 'ExcelScript!ExcelScript.WorksheetFreezePanes#getLocation:member(1)'
+ package: ExcelScript!
+ fullName: getLocation()
+ summary: >-
+ Gets a range that describes the frozen cells in the active worksheet view. The frozen range corresponds to cells
+ that are frozen in the top- and left-most pane. If there is no frozen pane, then this method returns
+ `undefined`.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLocation(): Range;'
+ return:
+ type: ''
+ description: ''
+ - name: unfreeze()
+ uid: 'ExcelScript!ExcelScript.WorksheetFreezePanes#unfreeze:member(1)'
+ package: ExcelScript!
+ fullName: unfreeze()
+ summary: Removes all frozen panes in the worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'unfreeze(): void;'
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetpositiontype.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetpositiontype.yml
index 4068e1a2..8430319a 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetpositiontype.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetpositiontype.yml
@@ -1,54 +1,54 @@
-### YamlMime:TSEnum
-name: ExcelScript.WorksheetPositionType
-uid: 'ExcelScript!ExcelScript.WorksheetPositionType:enum'
-package: ExcelScript!
-fullName: ExcelScript.WorksheetPositionType
-summary: The position of a worksheet relative to another worksheet or the entire worksheet collection.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script duplicates a worksheet named "Template".
- * The new worksheet is added after the template.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the worksheet named "Template".
- let template = workbook.getWorksheet("Template");
-
- // Copy the worksheet.
- let newSheet = template.copy(
- ExcelScript.WorksheetPositionType.after,
- template
- );
-
- // Name the worksheet using the current date.
- let date = new Date(Date.now());
- newSheet.setName(`${date.toDateString()}`);
- }
- ```
-isPreview: false
-isDeprecated: false
-fields:
- - name: after
- uid: 'ExcelScript!ExcelScript.WorksheetPositionType.after:member'
- package: ExcelScript!
- summary: ''
- - name: before
- uid: 'ExcelScript!ExcelScript.WorksheetPositionType.before:member'
- package: ExcelScript!
- summary: ''
- - name: beginning
- uid: 'ExcelScript!ExcelScript.WorksheetPositionType.beginning:member'
- package: ExcelScript!
- summary: ''
- - name: end
- uid: 'ExcelScript!ExcelScript.WorksheetPositionType.end:member'
- package: ExcelScript!
- summary: ''
- - name: none
- uid: 'ExcelScript!ExcelScript.WorksheetPositionType.none:member'
- package: ExcelScript!
- summary: ''
+### YamlMime:TSEnum
+name: ExcelScript.WorksheetPositionType
+uid: 'ExcelScript!ExcelScript.WorksheetPositionType:enum'
+package: ExcelScript!
+fullName: ExcelScript.WorksheetPositionType
+summary: The position of a worksheet relative to another worksheet or the entire worksheet collection.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script duplicates a worksheet named "Template".
+ * The new worksheet is added after the template.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the worksheet named "Template".
+ let template = workbook.getWorksheet("Template");
+
+ // Copy the worksheet.
+ let newSheet = template.copy(
+ ExcelScript.WorksheetPositionType.after,
+ template
+ );
+
+ // Name the worksheet using the current date.
+ let date = new Date(Date.now());
+ newSheet.setName(`${date.toDateString()}`);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+fields:
+ - name: after
+ uid: 'ExcelScript!ExcelScript.WorksheetPositionType.after:member'
+ package: ExcelScript!
+ summary: ''
+ - name: before
+ uid: 'ExcelScript!ExcelScript.WorksheetPositionType.before:member'
+ package: ExcelScript!
+ summary: ''
+ - name: beginning
+ uid: 'ExcelScript!ExcelScript.WorksheetPositionType.beginning:member'
+ package: ExcelScript!
+ summary: ''
+ - name: end
+ uid: 'ExcelScript!ExcelScript.WorksheetPositionType.end:member'
+ package: ExcelScript!
+ summary: ''
+ - name: none
+ uid: 'ExcelScript!ExcelScript.WorksheetPositionType.none:member'
+ package: ExcelScript!
+ summary: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetprotection.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetprotection.yml
index adee8a17..ade31d10 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetprotection.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetprotection.yml
@@ -1,388 +1,388 @@
-### YamlMime:TSType
-name: ExcelScript.WorksheetProtection
-uid: 'ExcelScript!ExcelScript.WorksheetProtection:interface'
-package: ExcelScript!
-fullName: ExcelScript.WorksheetProtection
-summary: Represents the protection of a worksheet object.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script pauses the protection of a worksheet by using the provided password.
- * This password could come from a Power Automate flow.
- */
- function main(workbook: ExcelScript.Workbook, password: string) {
- // Get the worksheet named "Sales".
- const sheet = workbook.getWorksheet("Sales");
- const protection: ExcelScript.WorksheetProtection = sheet.getProtection();
-
- // Check if the provided password works.
- if (protection.checkPassword(password)) {
- protection.pauseProtection(password);
-
- // Edit the worksheet...
-
- protection.resumeProtection();
- } else {
- console.log("Incorrect password");
- }
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: 'addAllowEditRange(title, rangeAddress, options)'
- uid: 'ExcelScript!ExcelScript.WorksheetProtection#addAllowEditRange:member(1)'
- package: ExcelScript!
- fullName: 'addAllowEditRange(title, rangeAddress, options)'
- summary: >-
- Adds an `AllowEditRange` object to the worksheet. Worksheet protection must be disabled or paused for this method
- to work properly. If worksheet protection is enabled and not paused, then this method throws an `AccessDenied`
- error and the add operation fails.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- addAllowEditRange(
- title: string,
- rangeAddress: string,
- options?: AllowEditRangeOptions
- ): void;
- parameters:
- - id: title
- description: The title string of the `AllowEditRange` object to be added.
- type: string
- - id: rangeAddress
- description: The range address of the `AllowEditRange` object to be added.
- type: string
- - id: options
- description: 'Additional options to be added to the `AllowEditRange` object, such as the password.'
- type: ''
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds a password-protected, editable range
- * to an otherwise protected worksheet.
- */
- function main(workbook: ExcelScript.Workbook, password: string) {
- // Get the protection object for the "Data" worksheet.
- const dataSheet = workbook.getWorksheet("Data");
- const sheetProtection = dataSheet.getProtection();
-
- // Set the password needed to edit the range to be the user provided string.
- const editRangeProperties : ExcelScript.AllowEditRangeOptions = {
- password: password
- };
-
- // Set range "D2:D6" to be editable if the password is provided.
- sheetProtection.addAllowEditRange("Notes Section", "D2:D6", editRangeProperties);
-
- // Protect the worksheet.
- sheetProtection.protect();
- }
- ```
- - name: checkPassword(password)
- uid: 'ExcelScript!ExcelScript.WorksheetProtection#checkPassword:member(1)'
- package: ExcelScript!
- fullName: checkPassword(password)
- summary: >-
- Specifies if the password can be used to unlock worksheet protection. This method doesn't change the worksheet
- protection state. If a password is entered but no password is required to unlock worksheet protection, this method
- will return false.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'checkPassword(password?: string): boolean;'
- parameters:
- - id: password
- description: The password to check against the protected worksheet.
- type: string
- return:
- type: boolean
- description: ''
- - name: getAllowEditRange(key)
- uid: 'ExcelScript!ExcelScript.WorksheetProtection#getAllowEditRange:member(1)'
- package: ExcelScript!
- fullName: getAllowEditRange(key)
- summary: Gets the `AllowEditRange` object by its title.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAllowEditRange(key: string): AllowEditRange | undefined;'
- parameters:
- - id: key
- description: The title of the `AllowEditRange`.
- type: string
- return:
- type: ' | undefined'
- description: ''
- - name: getAllowEditRanges()
- uid: 'ExcelScript!ExcelScript.WorksheetProtection#getAllowEditRanges:member(1)'
- package: ExcelScript!
- fullName: getAllowEditRanges()
- summary: >-
- Specifies the `AllowEditRangeCollection` object found in this worksheet. This is a collection of `AllowEditRange`
- objects, which work 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.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAllowEditRanges(): AllowEditRange[];'
- return:
- type: '[]'
- description: ''
- - name: getCanPauseProtection()
- uid: 'ExcelScript!ExcelScript.WorksheetProtection#getCanPauseProtection:member(1)'
- package: ExcelScript!
- fullName: getCanPauseProtection()
- summary: Specifies if protection can be paused for this worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getCanPauseProtection(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getIsPasswordProtected()
- uid: 'ExcelScript!ExcelScript.WorksheetProtection#getIsPasswordProtected:member(1)'
- package: ExcelScript!
- fullName: getIsPasswordProtected()
- summary: Specifies if the sheet is password protected.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIsPasswordProtected(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getIsPaused()
- uid: 'ExcelScript!ExcelScript.WorksheetProtection#getIsPaused:member(1)'
- package: ExcelScript!
- fullName: getIsPaused()
- summary: Specifies if worksheet protection is paused.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getIsPaused(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getOptions()
- uid: 'ExcelScript!ExcelScript.WorksheetProtection#getOptions:member(1)'
- package: ExcelScript!
- fullName: getOptions()
- summary: Specifies the protection options for the worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getOptions(): WorksheetProtectionOptions;'
- return:
- type: ''
- description: ''
- - name: getProtected()
- uid: 'ExcelScript!ExcelScript.WorksheetProtection#getProtected:member(1)'
- package: ExcelScript!
- fullName: getProtected()
- summary: Specifies if the worksheet is protected.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getProtected(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getSavedOptions()
- uid: 'ExcelScript!ExcelScript.WorksheetProtection#getSavedOptions:member(1)'
- package: ExcelScript!
- fullName: getSavedOptions()
- summary: >-
- Specifies the protection options saved in the worksheet. This will return the same `WorksheetProtectionOptions`
- object regardless of the worksheet protection state.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSavedOptions(): WorksheetProtectionOptions;'
- return:
- type: ''
- description: ''
- - name: pauseProtection(password)
- uid: 'ExcelScript!ExcelScript.WorksheetProtection#pauseProtection:member(1)'
- package: ExcelScript!
- fullName: pauseProtection(password)
- summary: >-
- Pauses worksheet protection for the given worksheet object for the user in the current session. This method does
- nothing if worksheet protection isn't enabled or is already paused. If the password is incorrect, then this method
- throws an `InvalidArgument` error and fails to pause protection. This method does not change the protection state
- if worksheet protection is not enabled or already paused.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'pauseProtection(password?: string): void;'
- parameters:
- - id: password
- description: The password associated with the protected worksheet.
- type: string
- return:
- type: void
- description: ''
- - name: pauseProtectionForAllAllowEditRanges(password)
- uid: 'ExcelScript!ExcelScript.WorksheetProtection#pauseProtectionForAllAllowEditRanges:member(1)'
- package: ExcelScript!
- fullName: pauseProtectionForAllAllowEditRanges(password)
- summary: >-
- Pauses worksheet protection for all `AllowEditRange` objects found in this worksheet that have the given password
- for the user in the current session. This method does nothing if worksheet protection isn't enabled or is paused.
- If worksheet protection cannot be paused, this method throws an `UnsupportedOperation` error and fails to pause
- protection for the range. If the password does not match any `AllowEditRange` objects in the collection, then this
- method throws a `BadPassword` error and fails to pause protection for any range in the collection.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'pauseProtectionForAllAllowEditRanges(password: string): void;'
- parameters:
- - id: password
- description: The password to pause protection on the `AllowEditRange` objects.
- type: string
- return:
- type: void
- description: ''
- - name: 'protect(options, password)'
- uid: 'ExcelScript!ExcelScript.WorksheetProtection#protect:member(1)'
- package: ExcelScript!
- fullName: 'protect(options, password)'
- summary: Protects a worksheet. Fails if the worksheet has already been protected.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'protect(options?: WorksheetProtectionOptions, password?: string): void;'
- parameters:
- - id: options
- description: Optional. Sheet protection options.
- type: ''
- - id: password
- description: Optional. Sheet protection password.
- type: string
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script protects cells from being selected on the current worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the protection settings for the current worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const sheetProtection = currentSheet.getProtection();
-
- // Create a new WorksheetProtectionOptions object with the selectionMode property set to `none`.
- let protectionOptions : ExcelScript.WorksheetProtectionOptions = {
- selectionMode: ExcelScript.ProtectionSelectionMode.none
- }
-
- // Apply the given protection options.
- sheetProtection.protect(protectionOptions);
- }
- ```
- - name: resumeProtection()
- uid: 'ExcelScript!ExcelScript.WorksheetProtection#resumeProtection:member(1)'
- package: ExcelScript!
- fullName: resumeProtection()
- summary: >-
- Resumes worksheet protection for the given worksheet object for the user in a given session. Worksheet protection
- must be paused for this method to work. If worksheet protection is not paused, then this method will not change
- the protection state of the worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'resumeProtection(): void;'
- return:
- type: void
- description: ''
- - name: setPassword(password)
- uid: 'ExcelScript!ExcelScript.WorksheetProtection#setPassword:member(1)'
- package: ExcelScript!
- fullName: setPassword(password)
- summary: >-
- Changes the password associated with the `WorksheetProtection` object. Setting the password as an empty string
- ("") or as `null` will remove password protection from the `WorksheetProtection` object. Worksheet protection must
- be enabled and paused for this method to work properly. If worksheet protection is disabled, this method throws an
- `InvalidOperation` error and fails to change the password. If worksheet protection is enabled and not paused, this
- method throws an `AccessDenied` error and fails to change the password.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPassword(password?: string): void;'
- parameters:
- - id: password
- description: The password associated with the `WorksheetProtection` object.
- type: string
- return:
- type: void
- description: ''
- - name: unprotect(password)
- uid: 'ExcelScript!ExcelScript.WorksheetProtection#unprotect:member(1)'
- package: ExcelScript!
- fullName: unprotect(password)
- summary: Unprotects a worksheet.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'unprotect(password?: string): void;'
- parameters:
- - id: password
- description: Sheet protection password.
- type: string
- return:
- type: void
- description: ''
- - name: updateOptions(options)
- uid: 'ExcelScript!ExcelScript.WorksheetProtection#updateOptions:member(1)'
- package: ExcelScript!
- fullName: updateOptions(options)
- summary: >-
- Change the worksheet protection options associated with the `WorksheetProtection` object. Worksheet protection
- must be disabled or paused for this method to work properly. If worksheet protection is enabled and not paused,
- this method throws an `AccessDenied` error and fails to change the worksheet protection options.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'updateOptions(options: WorksheetProtectionOptions): void;'
- parameters:
- - id: options
- description: The options interface associated with the `WorksheetProtection` object.
- type: ''
- return:
- type: void
- description: ''
+### YamlMime:TSType
+name: ExcelScript.WorksheetProtection
+uid: 'ExcelScript!ExcelScript.WorksheetProtection:interface'
+package: ExcelScript!
+fullName: ExcelScript.WorksheetProtection
+summary: Represents the protection of a worksheet object.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script pauses the protection of a worksheet by using the provided password.
+ * This password could come from a Power Automate flow.
+ */
+ function main(workbook: ExcelScript.Workbook, password: string) {
+ // Get the worksheet named "Sales".
+ const sheet = workbook.getWorksheet("Sales");
+ const protection: ExcelScript.WorksheetProtection = sheet.getProtection();
+
+ // Check if the provided password works.
+ if (protection.checkPassword(password)) {
+ protection.pauseProtection(password);
+
+ // Edit the worksheet...
+
+ protection.resumeProtection();
+ } else {
+ console.log("Incorrect password");
+ }
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: 'addAllowEditRange(title, rangeAddress, options)'
+ uid: 'ExcelScript!ExcelScript.WorksheetProtection#addAllowEditRange:member(1)'
+ package: ExcelScript!
+ fullName: 'addAllowEditRange(title, rangeAddress, options)'
+ summary: >-
+ Adds an `AllowEditRange` object to the worksheet. Worksheet protection must be disabled or paused for this method
+ to work properly. If worksheet protection is enabled and not paused, then this method throws an `AccessDenied`
+ error and the add operation fails.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ addAllowEditRange(
+ title: string,
+ rangeAddress: string,
+ options?: AllowEditRangeOptions
+ ): void;
+ parameters:
+ - id: title
+ description: The title string of the `AllowEditRange` object to be added.
+ type: string
+ - id: rangeAddress
+ description: The range address of the `AllowEditRange` object to be added.
+ type: string
+ - id: options
+ description: 'Additional options to be added to the `AllowEditRange` object, such as the password.'
+ type: ''
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds a password-protected, editable range
+ * to an otherwise protected worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook, password: string) {
+ // Get the protection object for the "Data" worksheet.
+ const dataSheet = workbook.getWorksheet("Data");
+ const sheetProtection = dataSheet.getProtection();
+
+ // Set the password needed to edit the range to be the user provided string.
+ const editRangeProperties : ExcelScript.AllowEditRangeOptions = {
+ password: password
+ };
+
+ // Set range "D2:D6" to be editable if the password is provided.
+ sheetProtection.addAllowEditRange("Notes Section", "D2:D6", editRangeProperties);
+
+ // Protect the worksheet.
+ sheetProtection.protect();
+ }
+ ```
+ - name: checkPassword(password)
+ uid: 'ExcelScript!ExcelScript.WorksheetProtection#checkPassword:member(1)'
+ package: ExcelScript!
+ fullName: checkPassword(password)
+ summary: >-
+ Specifies if the password can be used to unlock worksheet protection. This method doesn't change the worksheet
+ protection state. If a password is entered but no password is required to unlock worksheet protection, this method
+ will return false.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'checkPassword(password?: string): boolean;'
+ parameters:
+ - id: password
+ description: The password to check against the protected worksheet.
+ type: string
+ return:
+ type: boolean
+ description: ''
+ - name: getAllowEditRange(key)
+ uid: 'ExcelScript!ExcelScript.WorksheetProtection#getAllowEditRange:member(1)'
+ package: ExcelScript!
+ fullName: getAllowEditRange(key)
+ summary: Gets the `AllowEditRange` object by its title.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAllowEditRange(key: string): AllowEditRange | undefined;'
+ parameters:
+ - id: key
+ description: The title of the `AllowEditRange`.
+ type: string
+ return:
+ type: ' | undefined'
+ description: ''
+ - name: getAllowEditRanges()
+ uid: 'ExcelScript!ExcelScript.WorksheetProtection#getAllowEditRanges:member(1)'
+ package: ExcelScript!
+ fullName: getAllowEditRanges()
+ summary: >-
+ Specifies the `AllowEditRangeCollection` object found in this worksheet. This is a collection of `AllowEditRange`
+ objects, which work 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.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAllowEditRanges(): AllowEditRange[];'
+ return:
+ type: '[]'
+ description: ''
+ - name: getCanPauseProtection()
+ uid: 'ExcelScript!ExcelScript.WorksheetProtection#getCanPauseProtection:member(1)'
+ package: ExcelScript!
+ fullName: getCanPauseProtection()
+ summary: Specifies if protection can be paused for this worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCanPauseProtection(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getIsPasswordProtected()
+ uid: 'ExcelScript!ExcelScript.WorksheetProtection#getIsPasswordProtected:member(1)'
+ package: ExcelScript!
+ fullName: getIsPasswordProtected()
+ summary: Specifies if the sheet is password protected.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIsPasswordProtected(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getIsPaused()
+ uid: 'ExcelScript!ExcelScript.WorksheetProtection#getIsPaused:member(1)'
+ package: ExcelScript!
+ fullName: getIsPaused()
+ summary: Specifies if worksheet protection is paused.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getIsPaused(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getOptions()
+ uid: 'ExcelScript!ExcelScript.WorksheetProtection#getOptions:member(1)'
+ package: ExcelScript!
+ fullName: getOptions()
+ summary: Specifies the protection options for the worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getOptions(): WorksheetProtectionOptions;'
+ return:
+ type: ''
+ description: ''
+ - name: getProtected()
+ uid: 'ExcelScript!ExcelScript.WorksheetProtection#getProtected:member(1)'
+ package: ExcelScript!
+ fullName: getProtected()
+ summary: Specifies if the worksheet is protected.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getProtected(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getSavedOptions()
+ uid: 'ExcelScript!ExcelScript.WorksheetProtection#getSavedOptions:member(1)'
+ package: ExcelScript!
+ fullName: getSavedOptions()
+ summary: >-
+ Specifies the protection options saved in the worksheet. This will return the same `WorksheetProtectionOptions`
+ object regardless of the worksheet protection state.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSavedOptions(): WorksheetProtectionOptions;'
+ return:
+ type: ''
+ description: ''
+ - name: pauseProtection(password)
+ uid: 'ExcelScript!ExcelScript.WorksheetProtection#pauseProtection:member(1)'
+ package: ExcelScript!
+ fullName: pauseProtection(password)
+ summary: >-
+ Pauses worksheet protection for the given worksheet object for the user in the current session. This method does
+ nothing if worksheet protection isn't enabled or is already paused. If the password is incorrect, then this method
+ throws an `InvalidArgument` error and fails to pause protection. This method does not change the protection state
+ if worksheet protection is not enabled or already paused.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'pauseProtection(password?: string): void;'
+ parameters:
+ - id: password
+ description: The password associated with the protected worksheet.
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: pauseProtectionForAllAllowEditRanges(password)
+ uid: 'ExcelScript!ExcelScript.WorksheetProtection#pauseProtectionForAllAllowEditRanges:member(1)'
+ package: ExcelScript!
+ fullName: pauseProtectionForAllAllowEditRanges(password)
+ summary: >-
+ Pauses worksheet protection for all `AllowEditRange` objects found in this worksheet that have the given password
+ for the user in the current session. This method does nothing if worksheet protection isn't enabled or is paused.
+ If worksheet protection cannot be paused, this method throws an `UnsupportedOperation` error and fails to pause
+ protection for the range. If the password does not match any `AllowEditRange` objects in the collection, then this
+ method throws a `BadPassword` error and fails to pause protection for any range in the collection.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'pauseProtectionForAllAllowEditRanges(password: string): void;'
+ parameters:
+ - id: password
+ description: The password to pause protection on the `AllowEditRange` objects.
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: 'protect(options, password)'
+ uid: 'ExcelScript!ExcelScript.WorksheetProtection#protect:member(1)'
+ package: ExcelScript!
+ fullName: 'protect(options, password)'
+ summary: Protects a worksheet. Fails if the worksheet has already been protected.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'protect(options?: WorksheetProtectionOptions, password?: string): void;'
+ parameters:
+ - id: options
+ description: Optional. Sheet protection options.
+ type: ''
+ - id: password
+ description: Optional. Sheet protection password.
+ type: string
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script protects cells from being selected on the current worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the protection settings for the current worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const sheetProtection = currentSheet.getProtection();
+
+ // Create a new WorksheetProtectionOptions object with the selectionMode property set to `none`.
+ let protectionOptions : ExcelScript.WorksheetProtectionOptions = {
+ selectionMode: ExcelScript.ProtectionSelectionMode.none
+ }
+
+ // Apply the given protection options.
+ sheetProtection.protect(protectionOptions);
+ }
+ ```
+ - name: resumeProtection()
+ uid: 'ExcelScript!ExcelScript.WorksheetProtection#resumeProtection:member(1)'
+ package: ExcelScript!
+ fullName: resumeProtection()
+ summary: >-
+ Resumes worksheet protection for the given worksheet object for the user in a given session. Worksheet protection
+ must be paused for this method to work. If worksheet protection is not paused, then this method will not change
+ the protection state of the worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'resumeProtection(): void;'
+ return:
+ type: void
+ description: ''
+ - name: setPassword(password)
+ uid: 'ExcelScript!ExcelScript.WorksheetProtection#setPassword:member(1)'
+ package: ExcelScript!
+ fullName: setPassword(password)
+ summary: >-
+ Changes the password associated with the `WorksheetProtection` object. Setting the password as an empty string
+ ("") or as `null` will remove password protection from the `WorksheetProtection` object. Worksheet protection must
+ be enabled and paused for this method to work properly. If worksheet protection is disabled, this method throws an
+ `InvalidOperation` error and fails to change the password. If worksheet protection is enabled and not paused, this
+ method throws an `AccessDenied` error and fails to change the password.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPassword(password?: string): void;'
+ parameters:
+ - id: password
+ description: The password associated with the `WorksheetProtection` object.
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: unprotect(password)
+ uid: 'ExcelScript!ExcelScript.WorksheetProtection#unprotect:member(1)'
+ package: ExcelScript!
+ fullName: unprotect(password)
+ summary: Unprotects a worksheet.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'unprotect(password?: string): void;'
+ parameters:
+ - id: password
+ description: Sheet protection password.
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: updateOptions(options)
+ uid: 'ExcelScript!ExcelScript.WorksheetProtection#updateOptions:member(1)'
+ package: ExcelScript!
+ fullName: updateOptions(options)
+ summary: >-
+ Change the worksheet protection options associated with the `WorksheetProtection` object. Worksheet protection
+ must be disabled or paused for this method to work properly. If worksheet protection is enabled and not paused,
+ this method throws an `AccessDenied` error and fails to change the worksheet protection options.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'updateOptions(options: WorksheetProtectionOptions): void;'
+ parameters:
+ - id: options
+ description: The options interface associated with the `WorksheetProtection` object.
+ type: ''
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetprotectionoptions.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetprotectionoptions.yml
index 15ab7237..6413278e 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetprotectionoptions.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetprotectionoptions.yml
@@ -1,201 +1,201 @@
-### YamlMime:TSType
-name: ExcelScript.WorksheetProtectionOptions
-uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions:interface'
-package: ExcelScript!
-fullName: ExcelScript.WorksheetProtectionOptions
-summary: Represents the options in sheet protection.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script protects cells from being selected on the current worksheet.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the protection settings for the current worksheet.
- const currentSheet = workbook.getActiveWorksheet();
- const sheetProtection = currentSheet.getProtection();
-
- // Create a new WorksheetProtectionOptions object with the selectionMode property set to `none`.
- let protectionOptions : ExcelScript.WorksheetProtectionOptions = {
- selectionMode: ExcelScript.ProtectionSelectionMode.none
- }
-
- // Apply the given protection options.
- sheetProtection.protect(protectionOptions);
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: allowAutoFilter
- uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowAutoFilter:member'
- package: ExcelScript!
- fullName: allowAutoFilter
- summary: Represents the worksheet protection option allowing use of the AutoFilter feature.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'allowAutoFilter?: boolean;'
- return:
- type: boolean
- - name: allowDeleteColumns
- uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowDeleteColumns:member'
- package: ExcelScript!
- fullName: allowDeleteColumns
- summary: Represents the worksheet protection option allowing deleting of columns.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'allowDeleteColumns?: boolean;'
- return:
- type: boolean
- - name: allowDeleteRows
- uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowDeleteRows:member'
- package: ExcelScript!
- fullName: allowDeleteRows
- summary: Represents the worksheet protection option allowing deleting of rows.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'allowDeleteRows?: boolean;'
- return:
- type: boolean
- - name: allowEditObjects
- uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowEditObjects:member'
- package: ExcelScript!
- fullName: allowEditObjects
- summary: Represents the worksheet protection option allowing editing of objects.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'allowEditObjects?: boolean;'
- return:
- type: boolean
- - name: allowEditScenarios
- uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowEditScenarios:member'
- package: ExcelScript!
- fullName: allowEditScenarios
- summary: Represents the worksheet protection option allowing editing of scenarios.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'allowEditScenarios?: boolean;'
- return:
- type: boolean
- - name: allowFormatCells
- uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowFormatCells:member'
- package: ExcelScript!
- fullName: allowFormatCells
- summary: Represents the worksheet protection option allowing formatting of cells.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'allowFormatCells?: boolean;'
- return:
- type: boolean
- - name: allowFormatColumns
- uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowFormatColumns:member'
- package: ExcelScript!
- fullName: allowFormatColumns
- summary: Represents the worksheet protection option allowing formatting of columns.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'allowFormatColumns?: boolean;'
- return:
- type: boolean
- - name: allowFormatRows
- uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowFormatRows:member'
- package: ExcelScript!
- fullName: allowFormatRows
- summary: Represents the worksheet protection option allowing formatting of rows.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'allowFormatRows?: boolean;'
- return:
- type: boolean
- - name: allowInsertColumns
- uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowInsertColumns:member'
- package: ExcelScript!
- fullName: allowInsertColumns
- summary: Represents the worksheet protection option allowing inserting of columns.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'allowInsertColumns?: boolean;'
- return:
- type: boolean
- - name: allowInsertHyperlinks
- uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowInsertHyperlinks:member'
- package: ExcelScript!
- fullName: allowInsertHyperlinks
- summary: Represents the worksheet protection option allowing inserting of hyperlinks.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'allowInsertHyperlinks?: boolean;'
- return:
- type: boolean
- - name: allowInsertRows
- uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowInsertRows:member'
- package: ExcelScript!
- fullName: allowInsertRows
- summary: Represents the worksheet protection option allowing inserting of rows.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'allowInsertRows?: boolean;'
- return:
- type: boolean
- - name: allowPivotTables
- uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowPivotTables:member'
- package: ExcelScript!
- fullName: allowPivotTables
- summary: Represents the worksheet protection option allowing use of the PivotTable feature.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'allowPivotTables?: boolean;'
- return:
- type: boolean
- - name: allowSort
- uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowSort:member'
- package: ExcelScript!
- fullName: allowSort
- summary: Represents the worksheet protection option allowing use of the sort feature.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'allowSort?: boolean;'
- return:
- type: boolean
- - name: selectionMode
- uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#selectionMode:member'
- package: ExcelScript!
- fullName: selectionMode
- summary: Represents the worksheet protection option of selection mode.
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'selectionMode?: ProtectionSelectionMode;'
- return:
- type: ''
+### YamlMime:TSType
+name: ExcelScript.WorksheetProtectionOptions
+uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions:interface'
+package: ExcelScript!
+fullName: ExcelScript.WorksheetProtectionOptions
+summary: Represents the options in sheet protection.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script protects cells from being selected on the current worksheet.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the protection settings for the current worksheet.
+ const currentSheet = workbook.getActiveWorksheet();
+ const sheetProtection = currentSheet.getProtection();
+
+ // Create a new WorksheetProtectionOptions object with the selectionMode property set to `none`.
+ let protectionOptions : ExcelScript.WorksheetProtectionOptions = {
+ selectionMode: ExcelScript.ProtectionSelectionMode.none
+ }
+
+ // Apply the given protection options.
+ sheetProtection.protect(protectionOptions);
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: allowAutoFilter
+ uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowAutoFilter:member'
+ package: ExcelScript!
+ fullName: allowAutoFilter
+ summary: Represents the worksheet protection option allowing use of the AutoFilter feature.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'allowAutoFilter?: boolean;'
+ return:
+ type: boolean
+ - name: allowDeleteColumns
+ uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowDeleteColumns:member'
+ package: ExcelScript!
+ fullName: allowDeleteColumns
+ summary: Represents the worksheet protection option allowing deleting of columns.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'allowDeleteColumns?: boolean;'
+ return:
+ type: boolean
+ - name: allowDeleteRows
+ uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowDeleteRows:member'
+ package: ExcelScript!
+ fullName: allowDeleteRows
+ summary: Represents the worksheet protection option allowing deleting of rows.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'allowDeleteRows?: boolean;'
+ return:
+ type: boolean
+ - name: allowEditObjects
+ uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowEditObjects:member'
+ package: ExcelScript!
+ fullName: allowEditObjects
+ summary: Represents the worksheet protection option allowing editing of objects.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'allowEditObjects?: boolean;'
+ return:
+ type: boolean
+ - name: allowEditScenarios
+ uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowEditScenarios:member'
+ package: ExcelScript!
+ fullName: allowEditScenarios
+ summary: Represents the worksheet protection option allowing editing of scenarios.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'allowEditScenarios?: boolean;'
+ return:
+ type: boolean
+ - name: allowFormatCells
+ uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowFormatCells:member'
+ package: ExcelScript!
+ fullName: allowFormatCells
+ summary: Represents the worksheet protection option allowing formatting of cells.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'allowFormatCells?: boolean;'
+ return:
+ type: boolean
+ - name: allowFormatColumns
+ uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowFormatColumns:member'
+ package: ExcelScript!
+ fullName: allowFormatColumns
+ summary: Represents the worksheet protection option allowing formatting of columns.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'allowFormatColumns?: boolean;'
+ return:
+ type: boolean
+ - name: allowFormatRows
+ uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowFormatRows:member'
+ package: ExcelScript!
+ fullName: allowFormatRows
+ summary: Represents the worksheet protection option allowing formatting of rows.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'allowFormatRows?: boolean;'
+ return:
+ type: boolean
+ - name: allowInsertColumns
+ uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowInsertColumns:member'
+ package: ExcelScript!
+ fullName: allowInsertColumns
+ summary: Represents the worksheet protection option allowing inserting of columns.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'allowInsertColumns?: boolean;'
+ return:
+ type: boolean
+ - name: allowInsertHyperlinks
+ uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowInsertHyperlinks:member'
+ package: ExcelScript!
+ fullName: allowInsertHyperlinks
+ summary: Represents the worksheet protection option allowing inserting of hyperlinks.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'allowInsertHyperlinks?: boolean;'
+ return:
+ type: boolean
+ - name: allowInsertRows
+ uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowInsertRows:member'
+ package: ExcelScript!
+ fullName: allowInsertRows
+ summary: Represents the worksheet protection option allowing inserting of rows.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'allowInsertRows?: boolean;'
+ return:
+ type: boolean
+ - name: allowPivotTables
+ uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowPivotTables:member'
+ package: ExcelScript!
+ fullName: allowPivotTables
+ summary: Represents the worksheet protection option allowing use of the PivotTable feature.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'allowPivotTables?: boolean;'
+ return:
+ type: boolean
+ - name: allowSort
+ uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#allowSort:member'
+ package: ExcelScript!
+ fullName: allowSort
+ summary: Represents the worksheet protection option allowing use of the sort feature.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'allowSort?: boolean;'
+ return:
+ type: boolean
+ - name: selectionMode
+ uid: 'ExcelScript!ExcelScript.WorksheetProtectionOptions#selectionMode:member'
+ package: ExcelScript!
+ fullName: selectionMode
+ summary: Represents the worksheet protection option of selection mode.
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'selectionMode?: ProtectionSelectionMode;'
+ return:
+ type: ''
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetsearchcriteria.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetsearchcriteria.yml
index 3463a2c5..35fdbb0e 100644
--- a/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetsearchcriteria.yml
+++ b/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheetsearchcriteria.yml
@@ -1,63 +1,63 @@
-### YamlMime:TSType
-name: ExcelScript.WorksheetSearchCriteria
-uid: 'ExcelScript!ExcelScript.WorksheetSearchCriteria:interface'
-package: ExcelScript!
-fullName: ExcelScript.WorksheetSearchCriteria
-summary: Represents the worksheet search criteria to be used.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script searches through a worksheet and finds cells containing "No".
- * Those cells are filled with the color red.
- * Use Range.find instead of Worksheet.findAll when you want to limit the search to a specific range.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current, active worksheet.
- const worksheet = workbook.getActiveWorksheet();
-
- // Get all the cells that exactly contain the string "No".
- const searchCriteria: ExcelScript.WorksheetSearchCriteria = {
- completeMatch: true,
- matchCase: true
- };
- const noCells = worksheet.findAll("No", searchCriteria);
-
- // Set the fill color to red.
- noCells.getFormat().getFill().setColor("red");
- }
- ```
-isPreview: false
-isDeprecated: false
-type: interface
-properties:
- - name: completeMatch
- uid: 'ExcelScript!ExcelScript.WorksheetSearchCriteria#completeMatch:member'
- package: ExcelScript!
- fullName: completeMatch
- summary: >-
- Specifies if the match needs to be complete or partial. A complete match matches the entire contents of the cell.
- A partial match matches a substring within the content of the cell (e.g., `cat` partially matches `caterpillar`
- and `scatter`). Default is `false` (partial).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'completeMatch?: boolean;'
- return:
- type: boolean
- - name: matchCase
- uid: 'ExcelScript!ExcelScript.WorksheetSearchCriteria#matchCase:member'
- package: ExcelScript!
- fullName: matchCase
- summary: Specifies if the match is case-sensitive. Default is `false` (case-insensitive).
- remarks: ''
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'matchCase?: boolean;'
- return:
- type: boolean
+### YamlMime:TSType
+name: ExcelScript.WorksheetSearchCriteria
+uid: 'ExcelScript!ExcelScript.WorksheetSearchCriteria:interface'
+package: ExcelScript!
+fullName: ExcelScript.WorksheetSearchCriteria
+summary: Represents the worksheet search criteria to be used.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script searches through a worksheet and finds cells containing "No".
+ * Those cells are filled with the color red.
+ * Use Range.find instead of Worksheet.findAll when you want to limit the search to a specific range.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current, active worksheet.
+ const worksheet = workbook.getActiveWorksheet();
+
+ // Get all the cells that exactly contain the string "No".
+ const searchCriteria: ExcelScript.WorksheetSearchCriteria = {
+ completeMatch: true,
+ matchCase: true
+ };
+ const noCells = worksheet.findAll("No", searchCriteria);
+
+ // Set the fill color to red.
+ noCells.getFormat().getFill().setColor("red");
+ }
+ ```
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: completeMatch
+ uid: 'ExcelScript!ExcelScript.WorksheetSearchCriteria#completeMatch:member'
+ package: ExcelScript!
+ fullName: completeMatch
+ summary: >-
+ Specifies if the match needs to be complete or partial. A complete match matches the entire contents of the cell.
+ A partial match matches a substring within the content of the cell (e.g., `cat` partially matches `caterpillar`
+ and `scatter`). Default is `false` (partial).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'completeMatch?: boolean;'
+ return:
+ type: boolean
+ - name: matchCase
+ uid: 'ExcelScript!ExcelScript.WorksheetSearchCriteria#matchCase:member'
+ package: ExcelScript!
+ fullName: matchCase
+ summary: Specifies if the match is case-sensitive. Default is `false` (case-insensitive).
+ remarks: ''
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'matchCase?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/excel/excelscript/global.officescript.emailattachment.yml b/docs/docs-ref-autogen/excel/excelscript/global.officescript.emailattachment.yml
new file mode 100644
index 00000000..64453a76
--- /dev/null
+++ b/docs/docs-ref-autogen/excel/excelscript/global.officescript.emailattachment.yml
@@ -0,0 +1,40 @@
+### YamlMime:TSType
+name: Global.OfficeScript.EmailAttachment
+uid: 'ExcelScript!Global.OfficeScript.EmailAttachment:interface'
+package: ExcelScript!
+fullName: Global.OfficeScript.EmailAttachment
+summary: >-
+ The attachment to send with the email. A value must be specified for at least one of the `to`, `cc`,
+ or `bcc` parameters. If no recipient is specified, the following error is shown: "The message has no recipient. Please
+ enter a value for at least one of the "to", "cc", or "bcc" parameters."
+remarks: ''
+isPreview: true
+isDeprecated: false
+type: interface
+properties:
+ - name: content
+ uid: 'ExcelScript!Global.OfficeScript.EmailAttachment#content:member'
+ package: ExcelScript!
+ fullName: content
+ summary: The contents of the file.
+ remarks: ''
+ isPreview: true
+ isDeprecated: false
+ syntax:
+ content: 'content: string;'
+ return:
+ type: string
+ - name: name
+ uid: 'ExcelScript!Global.OfficeScript.EmailAttachment#name:member'
+ package: ExcelScript!
+ fullName: name
+ summary: >-
+ The text that is displayed below the icon representing the attachment. This string doesn't need to match the file
+ name.
+ remarks: ''
+ isPreview: true
+ isDeprecated: false
+ syntax:
+ content: 'name: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/excel/excelscript/global.officescript.emailcontenttype.yml b/docs/docs-ref-autogen/excel/excelscript/global.officescript.emailcontenttype.yml
new file mode 100644
index 00000000..00712e79
--- /dev/null
+++ b/docs/docs-ref-autogen/excel/excelscript/global.officescript.emailcontenttype.yml
@@ -0,0 +1,20 @@
+### YamlMime:TSEnum
+name: Global.OfficeScript.EmailContentType
+uid: 'ExcelScript!Global.OfficeScript.EmailContentType:enum'
+package: ExcelScript!
+fullName: Global.OfficeScript.EmailContentType
+summary: The type of the content. Possible values are text or HTML.
+remarks: ''
+isPreview: true
+isDeprecated: false
+fields:
+ - name: html
+ uid: 'ExcelScript!Global.OfficeScript.EmailContentType.html:member'
+ package: ExcelScript!
+ summary: The email message body is in HTML format.
+ value: '"html"'
+ - name: text
+ uid: 'ExcelScript!Global.OfficeScript.EmailContentType.text:member'
+ package: ExcelScript!
+ summary: The email message body is in plain text format.
+ value: '"text"'
diff --git a/docs/docs-ref-autogen/excel/excelscript/global.officescript.emailimportance.yml b/docs/docs-ref-autogen/excel/excelscript/global.officescript.emailimportance.yml
new file mode 100644
index 00000000..bab97c72
--- /dev/null
+++ b/docs/docs-ref-autogen/excel/excelscript/global.officescript.emailimportance.yml
@@ -0,0 +1,27 @@
+### YamlMime:TSEnum
+name: Global.OfficeScript.EmailImportance
+uid: 'ExcelScript!Global.OfficeScript.EmailImportance:enum'
+package: ExcelScript!
+fullName: Global.OfficeScript.EmailImportance
+summary: >-
+ The importance value of the email. Corresponds to "high", "normal", and "low" importance values available in the
+ Outlook UI.
+remarks: ''
+isPreview: true
+isDeprecated: false
+fields:
+ - name: high
+ uid: 'ExcelScript!Global.OfficeScript.EmailImportance.high:member'
+ package: ExcelScript!
+ summary: Email is marked as high importance.
+ value: '"high"'
+ - name: low
+ uid: 'ExcelScript!Global.OfficeScript.EmailImportance.low:member'
+ package: ExcelScript!
+ summary: Email is marked as low importance.
+ value: '"low"'
+ - name: normal
+ uid: 'ExcelScript!Global.OfficeScript.EmailImportance.normal:member'
+ package: ExcelScript!
+ summary: Email does not have any importance specified.
+ value: '"normal"'
diff --git a/docs/docs-ref-autogen/excel/excelscript/global.officescript.mailproperties.yml b/docs/docs-ref-autogen/excel/excelscript/global.officescript.mailproperties.yml
new file mode 100644
index 00000000..7a0af1e4
--- /dev/null
+++ b/docs/docs-ref-autogen/excel/excelscript/global.officescript.mailproperties.yml
@@ -0,0 +1,111 @@
+### YamlMime:TSType
+name: Global.OfficeScript.MailProperties
+uid: 'ExcelScript!Global.OfficeScript.MailProperties:interface'
+package: ExcelScript!
+fullName: Global.OfficeScript.MailProperties
+summary: The properties of the email to be sent.
+remarks: ''
+isPreview: true
+isDeprecated: false
+type: interface
+properties:
+ - name: attachments
+ uid: 'ExcelScript!Global.OfficeScript.MailProperties#attachments:member'
+ package: ExcelScript!
+ fullName: attachments
+ summary: A file (such as a text file or Excel workbook) attached to a message. Optional.
+ remarks: ''
+ isPreview: true
+ isDeprecated: false
+ syntax:
+ content: 'attachments?: EmailAttachment | EmailAttachment[];'
+ return:
+ type: >-
+ | []
+ - name: bcc
+ uid: 'ExcelScript!Global.OfficeScript.MailProperties#bcc:member'
+ package: ExcelScript!
+ fullName: bcc
+ summary: The blind carbon copy (BCC) recipient or recipients of the email. Optional.
+ remarks: ''
+ isPreview: true
+ isDeprecated: false
+ syntax:
+ content: 'bcc?: string | string[];'
+ return:
+ type: 'string | string[]'
+ - name: cc
+ uid: 'ExcelScript!Global.OfficeScript.MailProperties#cc:member'
+ package: ExcelScript!
+ fullName: cc
+ summary: The carbon copy (CC) recipient or recipients of the email. Optional.
+ remarks: ''
+ isPreview: true
+ isDeprecated: false
+ syntax:
+ content: 'cc?: string | string[];'
+ return:
+ type: 'string | string[]'
+ - name: content
+ uid: 'ExcelScript!Global.OfficeScript.MailProperties#content:member'
+ package: ExcelScript!
+ fullName: content
+ summary: The content of the email. Optional.
+ remarks: ''
+ isPreview: true
+ isDeprecated: false
+ syntax:
+ content: 'content?: string;'
+ return:
+ type: string
+ - name: contentType
+ uid: 'ExcelScript!Global.OfficeScript.MailProperties#contentType:member'
+ package: ExcelScript!
+ fullName: contentType
+ summary: The type of the content in the email. Possible values are text or HTML. Optional.
+ remarks: ''
+ isPreview: true
+ isDeprecated: false
+ syntax:
+ content: 'contentType?: EmailContentType;'
+ return:
+ type: ''
+ - name: importance
+ uid: 'ExcelScript!Global.OfficeScript.MailProperties#importance:member'
+ package: ExcelScript!
+ fullName: importance
+ summary: >-
+ The importance of the email. The possible values are `low`, `normal`, and `high`. Default
+ value is `normal`. Optional.
+ remarks: ''
+ isPreview: true
+ isDeprecated: false
+ syntax:
+ content: 'importance?: EmailImportance;'
+ return:
+ type: ''
+ - name: subject
+ uid: 'ExcelScript!Global.OfficeScript.MailProperties#subject:member'
+ package: ExcelScript!
+ fullName: subject
+ summary: The subject of the email. Optional.
+ remarks: ''
+ isPreview: true
+ isDeprecated: false
+ syntax:
+ content: 'subject?: string;'
+ return:
+ type: string
+ - name: to
+ uid: 'ExcelScript!Global.OfficeScript.MailProperties#to:member'
+ package: ExcelScript!
+ fullName: to
+ summary: The direct recipient or recipients of the email. Optional.
+ remarks: ''
+ isPreview: true
+ isDeprecated: false
+ syntax:
+ content: 'to?: string | string[];'
+ return:
+ type: 'string | string[]'
diff --git a/docs/docs-ref-autogen/excel/toc.yml b/docs/docs-ref-autogen/excel/toc.yml
index 0e862a2e..11e760ff 100644
--- a/docs/docs-ref-autogen/excel/toc.yml
+++ b/docs/docs-ref-autogen/excel/toc.yml
@@ -35,6 +35,8 @@ items:
uid: ExcelScript!ExcelScript.CalculationState:enum
- name: CalculationType
uid: ExcelScript!ExcelScript.CalculationType:enum
+ - name: CellControlType
+ uid: ExcelScript!ExcelScript.CellControlType:enum
- name: ChartAxisCategoryType
uid: ExcelScript!ExcelScript.ChartAxisCategoryType:enum
- name: ChartAxisDisplayUnit
@@ -149,6 +151,8 @@ items:
uid: ExcelScript!ExcelScript.ConnectorType:enum
- name: ContentType
uid: ExcelScript!ExcelScript.ContentType:enum
+ - name: DataSourceType
+ uid: ExcelScript!ExcelScript.DataSourceType:enum
- name: DataValidationAlertStyle
uid: ExcelScript!ExcelScript.DataValidationAlertStyle:enum
- name: DataValidationOperator
@@ -299,6 +303,10 @@ items:
uid: ExcelScript!ExcelScript.WorkbookLinksRefreshMode:enum
- name: WorksheetPositionType
uid: ExcelScript!ExcelScript.WorksheetPositionType:enum
+ - name: EmailContentType
+ uid: ExcelScript!Global.OfficeScript.EmailContentType:enum
+ - name: EmailImportance
+ uid: ExcelScript!Global.OfficeScript.EmailImportance:enum
- name: AllowEditRange
uid: ExcelScript!ExcelScript.AllowEditRange:interface
- name: AllowEditRangeOptions
@@ -311,6 +319,8 @@ items:
uid: ExcelScript!ExcelScript.BasicDataValidation:interface
- name: Binding
uid: ExcelScript!ExcelScript.Binding:interface
+ - name: CellControl
+ uid: ExcelScript!ExcelScript.CellControl:type
- name: CellValueConditionalFormat
uid: ExcelScript!ExcelScript.CellValueConditionalFormat:interface
- name: Chart
@@ -335,6 +345,8 @@ items:
uid: ExcelScript!ExcelScript.ChartBoxwhiskerOptions:interface
- name: ChartDataLabel
uid: ExcelScript!ExcelScript.ChartDataLabel:interface
+ - name: ChartDataLabelAnchor
+ uid: ExcelScript!ExcelScript.ChartDataLabelAnchor:interface
- name: ChartDataLabelFormat
uid: ExcelScript!ExcelScript.ChartDataLabelFormat:interface
- name: ChartDataLabels
@@ -357,6 +369,10 @@ items:
uid: ExcelScript!ExcelScript.ChartGridlines:interface
- name: ChartGridlinesFormat
uid: ExcelScript!ExcelScript.ChartGridlinesFormat:interface
+ - name: ChartLeaderLines
+ uid: ExcelScript!ExcelScript.ChartLeaderLines:interface
+ - name: ChartLeaderLinesFormat
+ uid: ExcelScript!ExcelScript.ChartLeaderLinesFormat:interface
- name: ChartLegend
uid: ExcelScript!ExcelScript.ChartLegend:interface
- name: ChartLegendEntry
@@ -393,6 +409,8 @@ items:
uid: ExcelScript!ExcelScript.ChartTrendlineLabel:interface
- name: ChartTrendlineLabelFormat
uid: ExcelScript!ExcelScript.ChartTrendlineLabelFormat:interface
+ - name: CheckboxCellControl
+ uid: ExcelScript!ExcelScript.CheckboxCellControl:interface
- name: ColorScaleConditionalFormat
uid: ExcelScript!ExcelScript.ColorScaleConditionalFormat:interface
- name: Comment
@@ -463,6 +481,8 @@ items:
uid: ExcelScript!ExcelScript.DatetimeFormatInfo:interface
- name: DocumentProperties
uid: ExcelScript!ExcelScript.DocumentProperties:interface
+ - name: EmptyCellControl
+ uid: ExcelScript!ExcelScript.EmptyCellControl:interface
- name: Filter
uid: ExcelScript!ExcelScript.Filter:interface
- name: FilterCriteria
@@ -493,6 +513,8 @@ items:
uid: ExcelScript!ExcelScript.LinkedWorkbook:interface
- name: ListDataValidation
uid: ExcelScript!ExcelScript.ListDataValidation:interface
+ - name: MixedCellControl
+ uid: ExcelScript!ExcelScript.MixedCellControl:interface
- name: NamedItem
uid: ExcelScript!ExcelScript.NamedItem:interface
- name: NamedItemArrayValues
@@ -603,6 +625,8 @@ items:
uid: ExcelScript!ExcelScript.TimelineStyle:interface
- name: TopBottomConditionalFormat
uid: ExcelScript!ExcelScript.TopBottomConditionalFormat:interface
+ - name: UnknownCellControl
+ uid: ExcelScript!ExcelScript.UnknownCellControl:interface
- name: Workbook
uid: ExcelScript!ExcelScript.Workbook:interface
- name: WorkbookProtection
@@ -621,3 +645,7 @@ items:
uid: ExcelScript!ExcelScript.WorksheetProtectionOptions:interface
- name: WorksheetSearchCriteria
uid: ExcelScript!ExcelScript.WorksheetSearchCriteria:interface
+ - name: EmailAttachment
+ uid: ExcelScript!Global.OfficeScript.EmailAttachment:interface
+ - name: MailProperties
+ uid: ExcelScript!Global.OfficeScript.MailProperties:interface
diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv
index 965eb9b0..0399ed34 100644
--- a/generate-docs/API Coverage Report.csv
+++ b/generate-docs/API Coverage Report.csv
@@ -176,6 +176,12 @@ ExcelScript.CalculationType,N/A,Enum,Unknown,true
ExcelScript.CalculationType,"full",EnumField,Fine,false
ExcelScript.CalculationType,"fullRebuild",EnumField,Fine,false
ExcelScript.CalculationType,"recalculate",EnumField,Good,false
+ExcelScript.CellControl,N/A,TypeAlias,Fine,false
+ExcelScript.CellControlType,N/A,Enum,Unknown,false
+ExcelScript.CellControlType,"checkbox",EnumField,Poor,false
+ExcelScript.CellControlType,"empty",EnumField,Poor,false
+ExcelScript.CellControlType,"mixed",EnumField,Fine,false
+ExcelScript.CellControlType,"unknown",EnumField,Fine,false
ExcelScript.CellValueConditionalFormat,N/A,Interface,Unknown,true
ExcelScript.CellValueConditionalFormat,"getFormat()",Method,Excellent,false
ExcelScript.CellValueConditionalFormat,"getRule()",Method,Excellent,false
@@ -436,6 +442,7 @@ ExcelScript.ChartDataLabel,N/A,Interface,Unknown,false
ExcelScript.ChartDataLabel,"getAutoText()",Method,Excellent,false
ExcelScript.ChartDataLabel,"getFormat()",Method,Poor,false
ExcelScript.ChartDataLabel,"getFormula()",Method,Great,false
+ExcelScript.ChartDataLabel,"getGeometricShapeType()",Method,Excellent,false
ExcelScript.ChartDataLabel,"getHeight()",Method,Excellent,false
ExcelScript.ChartDataLabel,"getHorizontalAlignment()",Method,Great,false
ExcelScript.ChartDataLabel,"getLeft()",Method,Great,false
@@ -443,12 +450,15 @@ ExcelScript.ChartDataLabel,"getLinkNumberFormat()",Method,Excellent,false
ExcelScript.ChartDataLabel,"getNumberFormat()",Method,Great,false
ExcelScript.ChartDataLabel,"getPosition()",Method,Good,false
ExcelScript.ChartDataLabel,"getSeparator()",Method,Great,false
+ExcelScript.ChartDataLabel,"getShowAsStickyCallout()",Method,Great,false
ExcelScript.ChartDataLabel,"getShowBubbleSize()",Method,Great,false
ExcelScript.ChartDataLabel,"getShowCategoryName()",Method,Great,false
ExcelScript.ChartDataLabel,"getShowLegendKey()",Method,Good,false
ExcelScript.ChartDataLabel,"getShowPercentage()",Method,Good,false
ExcelScript.ChartDataLabel,"getShowSeriesName()",Method,Great,false
ExcelScript.ChartDataLabel,"getShowValue()",Method,Great,false
+ExcelScript.ChartDataLabel,"getSubstring(start, length)",Method,Great,false
+ExcelScript.ChartDataLabel,"getTailAnchor()",Method,Good,false
ExcelScript.ChartDataLabel,"getText()",Method,Good,false
ExcelScript.ChartDataLabel,"getTextOrientation()",Method,Great,false
ExcelScript.ChartDataLabel,"getTop()",Method,Great,false
@@ -456,6 +466,8 @@ ExcelScript.ChartDataLabel,"getVerticalAlignment()",Method,Great,false
ExcelScript.ChartDataLabel,"getWidth()",Method,Excellent,false
ExcelScript.ChartDataLabel,"setAutoText(autoText)",Method,Excellent,false
ExcelScript.ChartDataLabel,"setFormula(formula)",Method,Great,false
+ExcelScript.ChartDataLabel,"setGeometricShapeType(geometricShapeType)",Method,Excellent,false
+ExcelScript.ChartDataLabel,"setHeight(height)",Method,Poor,false
ExcelScript.ChartDataLabel,"setHorizontalAlignment(horizontalAlignment)",Method,Great,false
ExcelScript.ChartDataLabel,"setLeft(left)",Method,Great,false
ExcelScript.ChartDataLabel,"setLinkNumberFormat(linkNumberFormat)",Method,Excellent,false
@@ -472,6 +484,12 @@ ExcelScript.ChartDataLabel,"setText(text)",Method,Good,false
ExcelScript.ChartDataLabel,"setTextOrientation(textOrientation)",Method,Great,false
ExcelScript.ChartDataLabel,"setTop(top)",Method,Great,false
ExcelScript.ChartDataLabel,"setVerticalAlignment(verticalAlignment)",Method,Great,false
+ExcelScript.ChartDataLabel,"setWidth(width)",Method,Poor,false
+ExcelScript.ChartDataLabelAnchor,N/A,Interface,Unknown,false
+ExcelScript.ChartDataLabelAnchor,"getLeft()",Method,Excellent,false
+ExcelScript.ChartDataLabelAnchor,"getTop()",Method,Excellent,false
+ExcelScript.ChartDataLabelAnchor,"setLeft(left)",Method,Excellent,false
+ExcelScript.ChartDataLabelAnchor,"setTop(top)",Method,Excellent,false
ExcelScript.ChartDataLabelFormat,N/A,Interface,Unknown,false
ExcelScript.ChartDataLabelFormat,"getBorder()",Method,Fine,false
ExcelScript.ChartDataLabelFormat,"getFill()",Method,Fine,false
@@ -492,13 +510,17 @@ ExcelScript.ChartDataLabelPosition,"top",EnumField,Missing,false
ExcelScript.ChartDataLabels,N/A,Interface,Unknown,false
ExcelScript.ChartDataLabels,"getAutoText()",Method,Excellent,false
ExcelScript.ChartDataLabels,"getFormat()",Method,Great,false
+ExcelScript.ChartDataLabels,"getGeometricShapeType()",Method,Excellent,false
ExcelScript.ChartDataLabels,"getHorizontalAlignment()",Method,Excellent,false
+ExcelScript.ChartDataLabels,"getLeaderLines()",Method,Good,false
ExcelScript.ChartDataLabels,"getLinkNumberFormat()",Method,Excellent,false
ExcelScript.ChartDataLabels,"getNumberFormat()",Method,Good,false
ExcelScript.ChartDataLabels,"getPosition()",Method,Good,false
ExcelScript.ChartDataLabels,"getSeparator()",Method,Great,false
+ExcelScript.ChartDataLabels,"getShowAsStickyCallout()",Method,Great,false
ExcelScript.ChartDataLabels,"getShowBubbleSize()",Method,Great,false
ExcelScript.ChartDataLabels,"getShowCategoryName()",Method,Great,false
+ExcelScript.ChartDataLabels,"getShowLeaderLines()",Method,Excellent,false
ExcelScript.ChartDataLabels,"getShowLegendKey()",Method,Good,false
ExcelScript.ChartDataLabels,"getShowPercentage()",Method,Good,false
ExcelScript.ChartDataLabels,"getShowSeriesName()",Method,Great,false
@@ -506,6 +528,7 @@ ExcelScript.ChartDataLabels,"getShowValue()",Method,Great,false
ExcelScript.ChartDataLabels,"getTextOrientation()",Method,Great,false
ExcelScript.ChartDataLabels,"getVerticalAlignment()",Method,Great,false
ExcelScript.ChartDataLabels,"setAutoText(autoText)",Method,Excellent,false
+ExcelScript.ChartDataLabels,"setGeometricShapeType(geometricShapeType)",Method,Excellent,false
ExcelScript.ChartDataLabels,"setHorizontalAlignment(horizontalAlignment)",Method,Excellent,false
ExcelScript.ChartDataLabels,"setLinkNumberFormat(linkNumberFormat)",Method,Excellent,false
ExcelScript.ChartDataLabels,"setNumberFormat(numberFormat)",Method,Good,false
@@ -513,6 +536,7 @@ ExcelScript.ChartDataLabels,"setPosition(position)",Method,Good,false
ExcelScript.ChartDataLabels,"setSeparator(separator)",Method,Great,false
ExcelScript.ChartDataLabels,"setShowBubbleSize(showBubbleSize)",Method,Great,false
ExcelScript.ChartDataLabels,"setShowCategoryName(showCategoryName)",Method,Great,false
+ExcelScript.ChartDataLabels,"setShowLeaderLines(showLeaderLines)",Method,Excellent,false
ExcelScript.ChartDataLabels,"setShowLegendKey(showLegendKey)",Method,Good,false
ExcelScript.ChartDataLabels,"setShowPercentage(showPercentage)",Method,Good,false
ExcelScript.ChartDataLabels,"setShowSeriesName(showSeriesName)",Method,Great,false
@@ -598,6 +622,10 @@ ExcelScript.ChartGridlines,"getVisible()",Method,Good,false
ExcelScript.ChartGridlines,"setVisible(visible)",Method,Good,false
ExcelScript.ChartGridlinesFormat,N/A,Interface,Unknown,false
ExcelScript.ChartGridlinesFormat,"getLine()",Method,Poor,false
+ExcelScript.ChartLeaderLines,N/A,Interface,Unknown,false
+ExcelScript.ChartLeaderLines,"getFormat()",Method,Fine,false
+ExcelScript.ChartLeaderLinesFormat,N/A,Interface,Unknown,false
+ExcelScript.ChartLeaderLinesFormat,"getLine()",Method,Good,false
ExcelScript.ChartLegend,N/A,Interface,Unknown,false
ExcelScript.ChartLegend,"getFormat()",Method,Fine,false
ExcelScript.ChartLegend,"getHeight()",Method,Excellent,false
@@ -1051,12 +1079,15 @@ ExcelScript.ChartType,"xyscatterSmoothNoMarkers",EnumField,Missing,false
ExcelScript.ChartUnderlineStyle,N/A,Enum,Missing,false
ExcelScript.ChartUnderlineStyle,"none",EnumField,Missing,false
ExcelScript.ChartUnderlineStyle,"single",EnumField,Missing,false
+ExcelScript.CheckboxCellControl,N/A,Interface,Missing,false
+ExcelScript.CheckboxCellControl,"type",Property,Missing,false
ExcelScript.ClearApplyTo,N/A,Enum,Unknown,true
ExcelScript.ClearApplyTo,"all",EnumField,Poor,false
ExcelScript.ClearApplyTo,"contents",EnumField,Fine,false
ExcelScript.ClearApplyTo,"formats",EnumField,Good,false
ExcelScript.ClearApplyTo,"hyperlinks",EnumField,Fine,false
ExcelScript.ClearApplyTo,"removeHyperlinks",EnumField,Good,false
+ExcelScript.ClearApplyTo,"resetContents",EnumField,Great,false
ExcelScript.ColorScaleConditionalFormat,N/A,Interface,Great,false
ExcelScript.ColorScaleConditionalFormat,"getCriteria()",Method,Excellent,false
ExcelScript.ColorScaleConditionalFormat,"getThreeColorScale()",Method,Good,false
@@ -1150,7 +1181,15 @@ ExcelScript.ConditionalDataBarPositiveFormat,"setGradientFill(gradientFill)",Met
ExcelScript.ConditionalDataBarRule,N/A,Interface,Fine,true
ExcelScript.ConditionalDataBarRule,"formula",Property,Great,false
ExcelScript.ConditionalDataBarRule,"type",Property,Poor,false
-ExcelScript.ConditionalFormat,N/A,Interface,Unknown,false
+ExcelScript.ConditionalFormat,N/A,Interface,Great,false
+ExcelScript.ConditionalFormat,"changeRuleToCellValue(properties)",Method,Great,false
+ExcelScript.ConditionalFormat,"changeRuleToColorScale()",Method,Good,false
+ExcelScript.ConditionalFormat,"changeRuleToContainsText(properties)",Method,Good,false
+ExcelScript.ConditionalFormat,"changeRuleToCustom(formula)",Method,Fine,false
+ExcelScript.ConditionalFormat,"changeRuleToDataBar()",Method,Good,false
+ExcelScript.ConditionalFormat,"changeRuleToIconSet()",Method,Good,false
+ExcelScript.ConditionalFormat,"changeRuleToPresetCriteria(properties)",Method,Good,false
+ExcelScript.ConditionalFormat,"changeRuleToTopBottom(properties)",Method,Good,false
ExcelScript.ConditionalFormat,"delete()",Method,Good,false
ExcelScript.ConditionalFormat,"getCellValue()",Method,Excellent,true
ExcelScript.ConditionalFormat,"getColorScale()",Method,Excellent,true
@@ -1167,6 +1206,7 @@ ExcelScript.ConditionalFormat,"getTextComparison()",Method,Excellent,true
ExcelScript.ConditionalFormat,"getTopBottom()",Method,Excellent,true
ExcelScript.ConditionalFormat,"getType()",Method,Good,false
ExcelScript.ConditionalFormat,"setPriority(priority)",Method,Excellent,false
+ExcelScript.ConditionalFormat,"setRanges(ranges)",Method,Good,false
ExcelScript.ConditionalFormat,"setStopIfTrue(stopIfTrue)",Method,Excellent,false
ExcelScript.ConditionalFormatColorCriterionType,N/A,Enum,Missing,true
ExcelScript.ConditionalFormatColorCriterionType,"formula",EnumField,Missing,false
@@ -1286,6 +1326,7 @@ ExcelScript.ConditionalRangeFontUnderlineStyle,"double",EnumField,Missing,false
ExcelScript.ConditionalRangeFontUnderlineStyle,"none",EnumField,Missing,false
ExcelScript.ConditionalRangeFontUnderlineStyle,"single",EnumField,Missing,false
ExcelScript.ConditionalRangeFormat,N/A,Interface,Missing,true
+ExcelScript.ConditionalRangeFormat,"clearFormat()",Method,Great,false
ExcelScript.ConditionalRangeFormat,"getBorders()",Method,Great,false
ExcelScript.ConditionalRangeFormat,"getConditionalRangeBorder(index)",Method,Fine,false
ExcelScript.ConditionalRangeFormat,"getConditionalRangeBorderBottom()",Method,Poor,false
@@ -1371,6 +1412,10 @@ ExcelScript.DataPivotHierarchy,"setPosition(position)",Method,Poor,false
ExcelScript.DataPivotHierarchy,"setShowAs(showAs)",Method,Great,true
ExcelScript.DataPivotHierarchy,"setSummarizeBy(summarizeBy)",Method,Great,true
ExcelScript.DataPivotHierarchy,"setToDefault()",Method,Great,false
+ExcelScript.DataSourceType,N/A,Enum,Unknown,false
+ExcelScript.DataSourceType,"localRange",EnumField,Fine,false
+ExcelScript.DataSourceType,"localTable",EnumField,Fine,false
+ExcelScript.DataSourceType,"unknown",EnumField,Poor,false
ExcelScript.DataValidation,N/A,Interface,Unknown,false
ExcelScript.DataValidation,"clear()",Method,Poor,false
ExcelScript.DataValidation,"getErrorAlert()",Method,Great,false
@@ -1545,6 +1590,8 @@ ExcelScript.DynamicFilterCriteria,"tomorrow",EnumField,Missing,false
ExcelScript.DynamicFilterCriteria,"unknown",EnumField,Missing,false
ExcelScript.DynamicFilterCriteria,"yearToDate",EnumField,Missing,false
ExcelScript.DynamicFilterCriteria,"yesterday",EnumField,Missing,false
+ExcelScript.EmptyCellControl,N/A,Interface,Missing,false
+ExcelScript.EmptyCellControl,"type",Property,Missing,false
ExcelScript.FillPattern,N/A,Enum,Missing,true
ExcelScript.FillPattern,"checker",EnumField,Missing,false
ExcelScript.FillPattern,"crissCross",EnumField,Missing,false
@@ -1833,11 +1880,11 @@ ExcelScript.HeaderFooterGroup,"getEvenPages()",Method,Good,false
ExcelScript.HeaderFooterGroup,"getFirstPage()",Method,Good,false
ExcelScript.HeaderFooterGroup,"getOddPages()",Method,Good,false
ExcelScript.HeaderFooterGroup,"getState()",Method,Fine,false
-ExcelScript.HeaderFooterGroup,"getUseSheetMargins()",Method,Great,false
-ExcelScript.HeaderFooterGroup,"getUseSheetScale()",Method,Great,false
+ExcelScript.HeaderFooterGroup,"getUseSheetMargins()",Method,Excellent,false
+ExcelScript.HeaderFooterGroup,"getUseSheetScale()",Method,Excellent,false
ExcelScript.HeaderFooterGroup,"setState(state)",Method,Fine,false
-ExcelScript.HeaderFooterGroup,"setUseSheetMargins(useSheetMargins)",Method,Great,false
-ExcelScript.HeaderFooterGroup,"setUseSheetScale(useSheetScale)",Method,Great,false
+ExcelScript.HeaderFooterGroup,"setUseSheetMargins(useSheetMargins)",Method,Excellent,false
+ExcelScript.HeaderFooterGroup,"setUseSheetScale(useSheetScale)",Method,Excellent,false
ExcelScript.HeaderFooterState,N/A,Enum,Unknown,false
ExcelScript.HeaderFooterState,"default",EnumField,Good,false
ExcelScript.HeaderFooterState,"firstAndDefault",EnumField,Good,false
@@ -1953,8 +2000,9 @@ ExcelScript.LinkedDataTypeState,"disambiguationNeeded",EnumField,Missing,false
ExcelScript.LinkedDataTypeState,"fetchingData",EnumField,Missing,false
ExcelScript.LinkedDataTypeState,"none",EnumField,Missing,false
ExcelScript.LinkedDataTypeState,"validLinkedData",EnumField,Missing,false
-ExcelScript.LinkedWorkbook,N/A,Interface,Good,false
+ExcelScript.LinkedWorkbook,N/A,Interface,Unknown,false
ExcelScript.LinkedWorkbook,"breakLinks()",Method,Great,true
+ExcelScript.LinkedWorkbook,"getId()",Method,Fine,false
ExcelScript.LinkedWorkbook,"refreshLinks()",Method,Fine,false
ExcelScript.ListDataValidation,N/A,Interface,Unknown,true
ExcelScript.ListDataValidation,"inCellDropDown",Property,Excellent,false
@@ -1964,6 +2012,8 @@ ExcelScript.LoadToType,"connectionOnly",EnumField,Poor,false
ExcelScript.LoadToType,"pivotChart",EnumField,Missing,false
ExcelScript.LoadToType,"pivotTable",EnumField,Missing,false
ExcelScript.LoadToType,"table",EnumField,Missing,false
+ExcelScript.MixedCellControl,N/A,Interface,Missing,false
+ExcelScript.MixedCellControl,"type",Property,Missing,false
ExcelScript.NamedItem,N/A,Interface,Unknown,true
ExcelScript.NamedItem,"delete()",Method,Fine,false
ExcelScript.NamedItem,"getArrayValues()",Method,Excellent,false
@@ -1997,8 +2047,8 @@ ExcelScript.NamedSheetView,N/A,Interface,Unknown,false
ExcelScript.NamedSheetView,"activate()",Method,Fine,false
ExcelScript.NamedSheetView,"delete()",Method,Poor,false
ExcelScript.NamedSheetView,"duplicate(name)",Method,Fine,false
-ExcelScript.NamedSheetView,"getName()",Method,Great,false
-ExcelScript.NamedSheetView,"setName(name)",Method,Great,false
+ExcelScript.NamedSheetView,"getName()",Method,Excellent,false
+ExcelScript.NamedSheetView,"setName(name)",Method,Excellent,false
ExcelScript.NumberFormatCategory,N/A,Enum,Unknown,true
ExcelScript.NumberFormatCategory,"accounting",EnumField,Fine,false
ExcelScript.NumberFormatCategory,"currency",EnumField,Great,false
@@ -2012,13 +2062,15 @@ ExcelScript.NumberFormatCategory,"scientific",EnumField,Great,false
ExcelScript.NumberFormatCategory,"special",EnumField,Good,false
ExcelScript.NumberFormatCategory,"text",EnumField,Good,false
ExcelScript.NumberFormatCategory,"time",EnumField,Great,false
-ExcelScript.NumberFormatInfo,N/A,Interface,Unknown,false
+ExcelScript.NumberFormatInfo,N/A,Interface,Great,false
+ExcelScript.NumberFormatInfo,"getCurrencySymbol()",Method,Good,false
ExcelScript.NumberFormatInfo,"getNumberDecimalSeparator()",Method,Excellent,false
ExcelScript.NumberFormatInfo,"getNumberGroupSeparator()",Method,Excellent,false
ExcelScript.PageBreak,N/A,Interface,Unknown,false
ExcelScript.PageBreak,"delete()",Method,Good,false
ExcelScript.PageBreak,"getCellAfterBreak()",Method,Poor,false
ExcelScript.PageBreak,"getColumnIndex()",Method,Good,false
+ExcelScript.PageBreak,"getRowIndex()",Method,Good,false
ExcelScript.PageLayout,N/A,Interface,Unknown,true
ExcelScript.PageLayout,"getBlackAndWhite()",Method,Fine,false
ExcelScript.PageLayout,"getBottomMargin()",Method,Fine,false
@@ -2200,25 +2252,37 @@ ExcelScript.PivotLabelFilter,"lowerBound",Property,Excellent,false
ExcelScript.PivotLabelFilter,"substring",Property,Excellent,false
ExcelScript.PivotLabelFilter,"upperBound",Property,Excellent,false
ExcelScript.PivotLayout,N/A,Interface,Unknown,false
+ExcelScript.PivotLayout,"displayBlankLineAfterEachItem(display)",Method,Excellent,false
+ExcelScript.PivotLayout,"getAltTextDescription()",Method,Good,false
+ExcelScript.PivotLayout,"getAltTextTitle()",Method,Good,false
ExcelScript.PivotLayout,"getAutoFormat()",Method,Excellent,false
ExcelScript.PivotLayout,"getBodyAndTotalRange()",Method,Great,true
ExcelScript.PivotLayout,"getColumnLabelRange()",Method,Good,false
ExcelScript.PivotLayout,"getDataHierarchy(cell)",Method,Excellent,false
+ExcelScript.PivotLayout,"getEmptyCellText()",Method,Excellent,false
ExcelScript.PivotLayout,"getEnableFieldList()",Method,Excellent,false
+ExcelScript.PivotLayout,"getFillEmptyCells()",Method,Excellent,false
ExcelScript.PivotLayout,"getFilterAxisRange()",Method,Fine,false
ExcelScript.PivotLayout,"getLayoutType()",Method,Excellent,false
ExcelScript.PivotLayout,"getPreserveFormatting()",Method,Excellent,false
ExcelScript.PivotLayout,"getRange()",Method,Good,false
ExcelScript.PivotLayout,"getRowLabelRange()",Method,Good,false
ExcelScript.PivotLayout,"getShowColumnGrandTotals()",Method,Great,false
+ExcelScript.PivotLayout,"getShowFieldHeaders()",Method,Excellent,false
ExcelScript.PivotLayout,"getShowRowGrandTotals()",Method,Great,false
ExcelScript.PivotLayout,"getSubtotalLocation()",Method,Excellent,false
+ExcelScript.PivotLayout,"repeatAllItemLabels(repeatLabels)",Method,Good,false
+ExcelScript.PivotLayout,"setAltTextDescription(altTextDescription)",Method,Good,false
+ExcelScript.PivotLayout,"setAltTextTitle(altTextTitle)",Method,Good,false
ExcelScript.PivotLayout,"setAutoFormat(autoFormat)",Method,Excellent,false
ExcelScript.PivotLayout,"setAutoSortOnCell(cell, sortBy)",Method,Excellent,false
+ExcelScript.PivotLayout,"setEmptyCellText(emptyCellText)",Method,Excellent,false
ExcelScript.PivotLayout,"setEnableFieldList(enableFieldList)",Method,Excellent,false
+ExcelScript.PivotLayout,"setFillEmptyCells(fillEmptyCells)",Method,Excellent,false
ExcelScript.PivotLayout,"setLayoutType(layoutType)",Method,Excellent,true
ExcelScript.PivotLayout,"setPreserveFormatting(preserveFormatting)",Method,Excellent,false
ExcelScript.PivotLayout,"setShowColumnGrandTotals(showColumnGrandTotals)",Method,Great,false
+ExcelScript.PivotLayout,"setShowFieldHeaders(showFieldHeaders)",Method,Excellent,false
ExcelScript.PivotLayout,"setShowRowGrandTotals(showRowGrandTotals)",Method,Great,false
ExcelScript.PivotLayout,"setSubtotalLocation(subtotalLocation)",Method,Excellent,true
ExcelScript.PivotLayoutType,N/A,Enum,Good,true
@@ -2238,6 +2302,8 @@ ExcelScript.PivotTable,"getColumnHierarchies()",Method,Poor,false
ExcelScript.PivotTable,"getColumnHierarchy(name)",Method,Excellent,false
ExcelScript.PivotTable,"getDataHierarchies()",Method,Poor,false
ExcelScript.PivotTable,"getDataHierarchy(name)",Method,Excellent,false
+ExcelScript.PivotTable,"getDataSourceString()",Method,Excellent,false
+ExcelScript.PivotTable,"getDataSourceType()",Method,Fine,false
ExcelScript.PivotTable,"getEnableDataValueEditing()",Method,Excellent,false
ExcelScript.PivotTable,"getFilterHierarchies()",Method,Poor,false
ExcelScript.PivotTable,"getFilterHierarchy(name)",Method,Excellent,false
@@ -2368,6 +2434,7 @@ ExcelScript.Range,"autoFill(destinationRange, autoFillType)",Method,Good,true
ExcelScript.Range,"calculate()",Method,Fine,true
ExcelScript.Range,"clear(applyTo)",Method,Good,true
ExcelScript.Range,"clearAllConditionalFormats()",Method,Great,false
+ExcelScript.Range,"clearOrResetContents()",Method,Excellent,false
ExcelScript.Range,"convertDataTypeToText()",Method,Fine,false
ExcelScript.Range,"copyFrom(sourceRange, copyType, skipBlanks, transpose)",Method,Great,true
ExcelScript.Range,"delete(shift)",Method,Fine,true
@@ -2387,6 +2454,7 @@ ExcelScript.Range,"getColumnsAfter(count)",Method,Good,false
ExcelScript.Range,"getColumnsBefore(count)",Method,Good,false
ExcelScript.Range,"getConditionalFormat(id)",Method,Excellent,false
ExcelScript.Range,"getConditionalFormats()",Method,Good,false
+ExcelScript.Range,"getControl()",Method,Great,false
ExcelScript.Range,"getDataValidation()",Method,Good,true
ExcelScript.Range,"getDependents()",Method,Excellent,false
ExcelScript.Range,"getDirectDependents()",Method,Excellent,false
@@ -2461,6 +2529,7 @@ ExcelScript.Range,"removeDuplicates(columns, includesHeader)",Method,Great,true
ExcelScript.Range,"replaceAll(text, replacement, criteria)",Method,Excellent,true
ExcelScript.Range,"select()",Method,Fine,true
ExcelScript.Range,"setColumnHidden(columnHidden)",Method,Excellent,false
+ExcelScript.Range,"setControl(control)",Method,Great,false
ExcelScript.Range,"setDirty()",Method,Good,false
ExcelScript.Range,"setFormula(formula)",Method,Great,true
ExcelScript.Range,"setFormulaLocal(formulaLocal)",Method,Excellent,false
@@ -2486,6 +2555,7 @@ ExcelScript.RangeAreas,"addConditionalFormat(type)",Method,Good,false
ExcelScript.RangeAreas,"calculate()",Method,Fine,false
ExcelScript.RangeAreas,"clear(applyTo)",Method,Great,true
ExcelScript.RangeAreas,"clearAllConditionalFormats()",Method,Great,false
+ExcelScript.RangeAreas,"clearOrResetContents()",Method,Excellent,false
ExcelScript.RangeAreas,"convertDataTypeToText()",Method,Fine,false
ExcelScript.RangeAreas,"copyFrom(sourceRange, copyType, skipBlanks, transpose)",Method,Good,false
ExcelScript.RangeAreas,"getAddress()",Method,Great,false
@@ -2668,6 +2738,7 @@ ExcelScript.Shape,"getAltTextDescription()",Method,Excellent,false
ExcelScript.Shape,"getAltTextTitle()",Method,Excellent,false
ExcelScript.Shape,"getAsImage(format)",Method,Deprecated,true
ExcelScript.Shape,"getConnectionSiteCount()",Method,Good,false
+ExcelScript.Shape,"getDisplayName()",Method,Good,false
ExcelScript.Shape,"getFill()",Method,Fine,false
ExcelScript.Shape,"getGeometricShape()",Method,Excellent,false
ExcelScript.Shape,"getGeometricShapeType()",Method,Excellent,false
@@ -3097,6 +3168,8 @@ ExcelScript.TopBottomSelectionType,N/A,Enum,Good,false
ExcelScript.TopBottomSelectionType,"items",EnumField,Good,false
ExcelScript.TopBottomSelectionType,"percent",EnumField,Good,false
ExcelScript.TopBottomSelectionType,"sum",EnumField,Good,false
+ExcelScript.UnknownCellControl,N/A,Interface,Missing,false
+ExcelScript.UnknownCellControl,"type",Property,Missing,false
ExcelScript.ValueFilterCondition,N/A,Enum,Unknown,true
ExcelScript.ValueFilterCondition,"between",EnumField,Excellent,false
ExcelScript.ValueFilterCondition,"bottomN",EnumField,Great,false
@@ -3267,6 +3340,7 @@ ExcelScript.Worksheet,"getRangeByIndexes(startRow, startColumn, rowCount, column
ExcelScript.Worksheet,"getRanges(address)",Method,Great,false
ExcelScript.Worksheet,"getShape(key)",Method,Excellent,false
ExcelScript.Worksheet,"getShapes()",Method,Great,false
+ExcelScript.Worksheet,"getShowDataTypeIcons()",Method,Excellent,false
ExcelScript.Worksheet,"getShowGridlines()",Method,Good,false
ExcelScript.Worksheet,"getShowHeadings()",Method,Good,false
ExcelScript.Worksheet,"getSlicer(key)",Method,Excellent,false
@@ -3288,17 +3362,18 @@ ExcelScript.Worksheet,"replaceAll(text, replacement, criteria)",Method,Excellent
ExcelScript.Worksheet,"setEnableCalculation(enableCalculation)",Method,Excellent,false
ExcelScript.Worksheet,"setName(name)",Method,Fine,true
ExcelScript.Worksheet,"setPosition(position)",Method,Good,true
+ExcelScript.Worksheet,"setShowDataTypeIcons(showDataTypeIcons)",Method,Excellent,false
ExcelScript.Worksheet,"setShowGridlines(showGridlines)",Method,Good,false
ExcelScript.Worksheet,"setShowHeadings(showHeadings)",Method,Good,false
ExcelScript.Worksheet,"setStandardWidth(standardWidth)",Method,Excellent,false
ExcelScript.Worksheet,"setTabColor(tabColor)",Method,Excellent,true
ExcelScript.Worksheet,"setVisibility(visibility)",Method,Poor,true
ExcelScript.Worksheet,"showOutlineLevels(rowLevels, columnLevels)",Method,Excellent,false
-ExcelScript.WorksheetCustomProperty,N/A,Interface,Unknown,false
+ExcelScript.WorksheetCustomProperty,N/A,Interface,Great,false
ExcelScript.WorksheetCustomProperty,"delete()",Method,Good,false
ExcelScript.WorksheetCustomProperty,"getKey()",Method,Excellent,false
-ExcelScript.WorksheetCustomProperty,"getValue()",Method,Good,false
-ExcelScript.WorksheetCustomProperty,"setValue(value)",Method,Good,false
+ExcelScript.WorksheetCustomProperty,"getValue()",Method,Excellent,false
+ExcelScript.WorksheetCustomProperty,"setValue(value)",Method,Excellent,false
ExcelScript.WorksheetFreezePanes,N/A,Interface,Unknown,false
ExcelScript.WorksheetFreezePanes,"freezeAt(frozenRange)",Method,Fine,false
ExcelScript.WorksheetFreezePanes,"freezeColumns(count)",Method,Fine,false
@@ -3346,4 +3421,23 @@ ExcelScript.WorksheetProtectionOptions,"allowSort",Property,Good,false
ExcelScript.WorksheetProtectionOptions,"selectionMode",Property,Good,false
ExcelScript.WorksheetSearchCriteria,N/A,Interface,Unknown,true
ExcelScript.WorksheetSearchCriteria,"completeMatch",Property,Excellent,false
-ExcelScript.WorksheetSearchCriteria,"matchCase",Property,Excellent,false
\ No newline at end of file
+ExcelScript.WorksheetSearchCriteria,"matchCase",Property,Excellent,false
+Global.OfficeScript.EmailAttachment,N/A,Interface,Good,false
+Global.OfficeScript.EmailAttachment,"content",Property,Poor,false
+Global.OfficeScript.EmailAttachment,"name",Property,Good,false
+Global.OfficeScript.EmailContentType,N/A,Enum,Unknown,false
+Global.OfficeScript.EmailContentType,"html",EnumField,Poor,false
+Global.OfficeScript.EmailContentType,"text",EnumField,Poor,false
+Global.OfficeScript.EmailImportance,N/A,Enum,Unknown,false
+Global.OfficeScript.EmailImportance,"high",EnumField,Poor,false
+Global.OfficeScript.EmailImportance,"low",EnumField,Poor,false
+Global.OfficeScript.EmailImportance,"normal",EnumField,Fine,false
+Global.OfficeScript.MailProperties,N/A,Interface,Unknown,false
+Global.OfficeScript.MailProperties,"attachments",Property,Great,false
+Global.OfficeScript.MailProperties,"bcc",Property,Great,false
+Global.OfficeScript.MailProperties,"cc",Property,Great,false
+Global.OfficeScript.MailProperties,"content",Property,Good,false
+Global.OfficeScript.MailProperties,"contentType",Property,Excellent,false
+Global.OfficeScript.MailProperties,"importance",Property,Excellent,false
+Global.OfficeScript.MailProperties,"subject",Property,Good,false
+Global.OfficeScript.MailProperties,"to",Property,Great,false
\ No newline at end of file
diff --git a/generate-docs/api-extractor-inputs-excel/excel.d.ts b/generate-docs/api-extractor-inputs-excel/excel.d.ts
index 28b219f8..1964b26e 100644
--- a/generate-docs/api-extractor-inputs-excel/excel.d.ts
+++ b/generate-docs/api-extractor-inputs-excel/excel.d.ts
@@ -108,6 +108,11 @@ export declare namespace ExcelScript {
* In this scenario, the second workbook is called the "linked workbook".
*/
export interface LinkedWorkbook {
+ /**
+ * The original URL pointing to the linked workbook. It is unique across all linked workbooks in the collection.
+ */
+ getId(): string;
+
/**
* Makes a request to break the links pointing to the linked workbook.
* Links in formulas are replaced with the latest fetched data.
@@ -841,6 +846,16 @@ export declare namespace ExcelScript {
*/
getProtection(): WorksheetProtection;
+ /**
+ * Specifies if data type icons are visible on the worksheet. By default, data type icons are visible.
+ */
+ getShowDataTypeIcons(): boolean;
+
+ /**
+ * Specifies if data type icons are visible on the worksheet. By default, data type icons are visible.
+ */
+ setShowDataTypeIcons(showDataTypeIcons: boolean): void;
+
/**
* Specifies if gridlines are visible to the user.
*/
@@ -961,7 +976,7 @@ export declare namespace ExcelScript {
/**
* Gets the `Range` object, representing a single rectangular block of cells, specified by the address or name.
- * @param address - Optional. The string representing the address or name of the range. For example, "A1:B2". If not specified, the entire worksheet range is returned.
+ * @param address - Optional. The string representing the address or name of the range. For example, "A1:B2". If not specified, the entire worksheet range is returned. The `address` has a limit of 8192 characters. If the address exceeds the character limit, this method returns an `InvalidArgument` error.
*/
getRange(address?: string): Range;
@@ -1142,7 +1157,7 @@ export declare namespace ExcelScript {
/**
* Gets a sheet view using its name.
- * If the sheet view object does not exist, then this method returns `undefined`.
+ * If the sheet view object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
* @param key - The case-sensitive name of the sheet view.
* Use the empty string ("") to get the temporary sheet view, if the temporary view exists.
*/
@@ -1229,8 +1244,8 @@ export declare namespace ExcelScript {
addGroup(values: Array): Shape;
/**
- * Creates an image from a base64-encoded string and adds it to the worksheet. Returns the `Shape` object that represents the new image.
- * @param base64ImageString - A base64-encoded string representing an image in either JPEG or PNG format.
+ * Creates an image from a Base64-encoded string and adds it to the worksheet. Returns the `Shape` object that represents the new image.
+ * @param base64ImageString - A Base64-encoded string representing an image in either JPEG or PNG format.
*/
addImage(base64ImageString: string): Shape;
@@ -1518,6 +1533,18 @@ export declare namespace ExcelScript {
*/
getColumnIndex(): number;
+ /**
+ * Accesses the cell control applied to this range.
+ * If the range has multiple cell controls, this returns `EmptyCellControl`.
+ */
+ getControl(): CellControl;
+
+ /**
+ * Accesses the cell control applied to this range.
+ * If the range has multiple cell controls, this returns `EmptyCellControl`.
+ */
+ setControl(control: CellControl): void;
+
/**
* Returns a data validation object.
*/
@@ -1739,6 +1766,13 @@ export declare namespace ExcelScript {
*/
clear(applyTo?: ClearApplyTo): void;
+ /**
+ * Clears the values of the cells in the range, with special consideration given to cells containing controls.
+ * If the range contains only blank values and controls set to their default value, then the values and control formatting are removed.
+ * Otherwise, this sets the cells with controls to their default value and clears the values of the other cells in the range.
+ */
+ clearOrResetContents(): void;
+
/**
* Converts the range cells with data types into text.
*/
@@ -1819,16 +1853,19 @@ export declare namespace ExcelScript {
/**
* Returns a `WorkbookRangeAreas` object that represents the range containing all the dependent cells of a specified range in the same worksheet or across multiple worksheets.
+ * Note: This API returns an `ItemNotFound` error if no dependents are found.
*/
getDependents(): WorkbookRangeAreas;
/**
* Returns a `WorkbookRangeAreas` object that represents the range containing all the direct dependent cells of a specified range in the same worksheet or across multiple worksheets.
+ * Note: This API returns an `ItemNotFound` error if no dependents are found.
*/
getDirectDependents(): WorkbookRangeAreas;
/**
* Returns a `WorkbookRangeAreas` object that represents the range containing all the direct precedent cells of a specified range in the same worksheet or across multiple worksheets.
+ * Note: This API returns an `ItemNotFound` error if no precedents are found.
*/
getDirectPrecedents(): WorkbookRangeAreas;
@@ -1853,7 +1890,7 @@ export declare namespace ExcelScript {
): Range;
/**
- * Renders the range as a base64-encoded png image.
+ * Renders the range as a Base64-encoded PNG image.
*/
getImage(): string;
@@ -1898,6 +1935,7 @@ export declare namespace ExcelScript {
/**
* Returns a `WorkbookRangeAreas` object that represents the range containing all the precedent cells of a specified range in the same worksheet or across multiple worksheets.
+ * Note: This API returns an `ItemNotFound` error if no precedents are found.
*/
getPrecedents(): WorkbookRangeAreas;
@@ -2266,6 +2304,13 @@ export declare namespace ExcelScript {
*/
clear(applyTo?: ClearApplyTo): void;
+ /**
+ * Clears the values of the cells in the ranges, with special consideration given to cells containing controls.
+ * If the ranges contain only blank values and controls set to their default value, then the values and control formatting are removed.
+ * Otherwise, this sets the cells with controls to their default value and clears the values of the other cells in the ranges.
+ */
+ clearOrResetContents(): void;
+
/**
* Converts all cells in the `RangeAreas` with data types into text.
*/
@@ -3646,7 +3691,7 @@ export declare namespace ExcelScript {
getDataTable(): ChartDataTable;
/**
- * Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions.
+ * Renders the chart as a Base64-encoded image by scaling the chart to fit the specified dimensions.
* The aspect ratio is preserved as part of the resizing.
* @param height - Optional. The desired height of the resulting image.
* @param width - Optional. The desired width of the resulting image.
@@ -4850,6 +4895,18 @@ export declare namespace ExcelScript {
*/
getFormat(): ChartDataLabelFormat;
+ /**
+ * Specifies the geometric shape type of the data labels. See `ExcelScript.GeometricShapeType` for more details.
+ * Value is `null` if the data labels are not geometric shapes.
+ */
+ getGeometricShapeType(): GeometricShapeType;
+
+ /**
+ * Specifies the geometric shape type of the data labels. See `ExcelScript.GeometricShapeType` for more details.
+ * Value is `null` if the data labels are not geometric shapes.
+ */
+ setGeometricShapeType(geometricShapeType: GeometricShapeType): void;
+
/**
* Specifies the horizontal alignment for chart data label. See `ExcelScript.ChartTextHorizontalAlignment` for details.
* This property is valid only when the `TextOrientation` of data label is 0.
@@ -4864,6 +4921,11 @@ export declare namespace ExcelScript {
horizontalAlignment: ChartTextHorizontalAlignment
): void;
+ /**
+ * Gets an object that represents the leader lines of the data labels.
+ */
+ getLeaderLines(): ChartLeaderLines;
+
/**
* Specifies if the number format is linked to the cells. If `true`, the number format will change in the labels when it changes in the cells.
*/
@@ -4904,6 +4966,11 @@ export declare namespace ExcelScript {
*/
setSeparator(separator: string): void;
+ /**
+ * Gets a value that indicates whether the data labels are shown as a callout with the tail anchor attached to the data point. If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See Excel.GeometricShapeType for more details.
+ */
+ getShowAsStickyCallout(): boolean;
+
/**
* Specifies if the data label bubble size is visible.
*/
@@ -4924,6 +4991,16 @@ export declare namespace ExcelScript {
*/
setShowCategoryName(showCategoryName: boolean): void;
+ /**
+ * Specifies a value that indicates whether leader lines are displayed for the data labels. `true` if leader lines are shown; otherwise, `false`.
+ */
+ getShowLeaderLines(): boolean;
+
+ /**
+ * Specifies a value that indicates whether leader lines are displayed for the data labels. `true` if leader lines are shown; otherwise, `false`.
+ */
+ setShowLeaderLines(showLeaderLines: boolean): void;
+
/**
* Specifies if the data label legend key is visible.
*/
@@ -5018,6 +5095,18 @@ export declare namespace ExcelScript {
*/
setFormula(formula: string): void;
+ /**
+ * Specifies the geometric shape type of the data label. See `ExcelScript.GeometricShapeType` for more details.
+ * Value is `null` if the data label is not a geometric shape.
+ */
+ getGeometricShapeType(): GeometricShapeType;
+
+ /**
+ * Specifies the geometric shape type of the data label. See `ExcelScript.GeometricShapeType` for more details.
+ * Value is `null` if the data label is not a geometric shape.
+ */
+ setGeometricShapeType(geometricShapeType: GeometricShapeType): void;
+
/**
* Returns the height, in points, of the chart data label. Value is `null` if the chart data label is not visible.
*/
@@ -5087,6 +5176,11 @@ export declare namespace ExcelScript {
*/
setSeparator(separator: string): void;
+ /**
+ * Gets a value that indicates whether the data labels are shown as a callout with the tail anchor attached to the data point. If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See Excel.GeometricShapeType for more details.
+ */
+ getShowAsStickyCallout(): boolean;
+
/**
* Specifies if the data label bubble size is visible.
*/
@@ -5195,6 +5289,30 @@ export declare namespace ExcelScript {
* Returns the width, in points, of the chart data label. Value is `null` if the chart data label is not visible.
*/
getWidth(): number;
+
+ /**
+ * Returns a substring of the data label. The line break character '\n' counts as one character.
+ * @param start - The zero-based starting character position of a substring in the data label.
+ * @param length - Optional. The number of characters in the substring. If length is omitted, all the characters from start to the end of the data label are retrieved.
+ */
+ getSubstring(start: number, length?: number): ChartFormatString;
+
+ /**
+ * Returns the tail anchor of the data label which is shown as a sticky callout.
+ */
+ getTailAnchor(): ChartDataLabelAnchor;
+
+ /**
+ * Sets the height of the data label in points.
+ * @param height - The height of the data label in points.
+ */
+ setHeight(height: number): void;
+
+ /**
+ * Sets the width of the data label in points.
+ * @param width - The width of the data label in points.
+ */
+ setWidth(width: number): void;
}
/**
@@ -5217,6 +5335,31 @@ export declare namespace ExcelScript {
getFont(): ChartFont;
}
+ /**
+ * Represents the chart data label anchor.
+ */
+ export interface ChartDataLabelAnchor {
+ /**
+ * Represents the distance, in points, from the anchor to the left edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
+ */
+ getLeft(): number;
+
+ /**
+ * Represents the distance, in points, from the anchor to the left edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
+ */
+ setLeft(left: number): void;
+
+ /**
+ * Represents the distance, in points, from the anchor to the top edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
+ */
+ getTop(): number;
+
+ /**
+ * Represents the distance, in points, from the anchor to the top edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
+ */
+ setTop(top: number): void;
+ }
+
/**
* Represents the data table object of a chart.
*/
@@ -6425,6 +6568,26 @@ export declare namespace ExcelScript {
getFill(): ChartFill;
}
+ /**
+ * Gets an object that represents the formatting of chart leader lines.
+ */
+ export interface ChartLeaderLines {
+ /**
+ * Represents the formatting of leader lines of data labels in a series.
+ */
+ getFormat(): ChartLeaderLinesFormat;
+ }
+
+ /**
+ * Encapsulates the format properties for leader lines.
+ */
+ export interface ChartLeaderLinesFormat {
+ /**
+ * Gets an object that represents the line formatting of chart leader lines.
+ */
+ getLine(): ChartLineFormat;
+ }
+
/**
* Manages sorting operations on `Range` objects.
*/
@@ -6661,6 +6824,11 @@ export declare namespace ExcelScript {
* Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings.
*/
export interface NumberFormatInfo {
+ /**
+ * Gets the currency symbol for currency values. This is based on current system settings.
+ */
+ getCurrencySymbol(): string;
+
/**
* Gets the string used as the decimal separator for numeric values. This is based on current system settings.
*/
@@ -6799,6 +6967,17 @@ export declare namespace ExcelScript {
*/
delete(): void;
+ /**
+ * Returns the string representation of the data source for the PivotTable. This method currently supports string representations for table and range objects.
+ * Otherwise, it returns an empty string.
+ */
+ getDataSourceString(): string;
+
+ /**
+ * Gets the type of the data source for the PivotTable.
+ */
+ getDataSourceType(): DataSourceType;
+
/**
* Refreshes the PivotTable.
*/
@@ -6917,6 +7096,42 @@ export declare namespace ExcelScript {
* Represents the visual layout of the PivotTable.
*/
export interface PivotLayout {
+ /**
+ * The alt text description of the PivotTable.
+ *
+ * Alt text provides alternative, text-based representations of the information contained in the PivotTable.
+ * This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
+ * A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+ */
+ getAltTextDescription(): string;
+
+ /**
+ * The alt text description of the PivotTable.
+ *
+ * Alt text provides alternative, text-based representations of the information contained in the PivotTable.
+ * This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
+ * A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+ */
+ setAltTextDescription(altTextDescription: string): void;
+
+ /**
+ * The alt text title of the PivotTable.
+ *
+ * Alt text provides alternative, text-based representations of the information contained in the PivotTable.
+ * This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
+ * A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+ */
+ getAltTextTitle(): string;
+
+ /**
+ * The alt text title of the PivotTable.
+ *
+ * Alt text provides alternative, text-based representations of the information contained in the PivotTable.
+ * This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
+ * A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+ */
+ setAltTextTitle(altTextTitle: string): void;
+
/**
* Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved.
*/
@@ -6927,6 +7142,20 @@ export declare namespace ExcelScript {
*/
setAutoFormat(autoFormat: boolean): void;
+ /**
+ * The text that is automatically filled into any empty cell in the PivotTable if `fillEmptyCells == true`.
+ * Note that this value persists if `fillEmptyCells` is set to `false`, and that setting this value does not set that property to `true`.
+ * By default, this is an empty string.
+ */
+ getEmptyCellText(): string;
+
+ /**
+ * The text that is automatically filled into any empty cell in the PivotTable if `fillEmptyCells == true`.
+ * Note that this value persists if `fillEmptyCells` is set to `false`, and that setting this value does not set that property to `true`.
+ * By default, this is an empty string.
+ */
+ setEmptyCellText(emptyCellText: string): void;
+
/**
* Specifies if the field list can be shown in the UI.
*/
@@ -6937,6 +7166,18 @@ export declare namespace ExcelScript {
*/
setEnableFieldList(enableFieldList: boolean): void;
+ /**
+ * Specifies whether empty cells in the PivotTable should be populated with the `emptyCellText`. Default is `false`.
+ * Note that the value of `emptyCellText` persists when this property is set to `false`.
+ */
+ getFillEmptyCells(): boolean;
+
+ /**
+ * Specifies whether empty cells in the PivotTable should be populated with the `emptyCellText`. Default is `false`.
+ * Note that the value of `emptyCellText` persists when this property is set to `false`.
+ */
+ setFillEmptyCells(fillEmptyCells: boolean): void;
+
/**
* This property indicates the PivotLayoutType of all fields on the PivotTable. If fields have different states, this will be null.
*/
@@ -6967,6 +7208,16 @@ export declare namespace ExcelScript {
*/
setShowColumnGrandTotals(showColumnGrandTotals: boolean): void;
+ /**
+ * Specifies whether the PivotTable displays field headers (field captions and filter drop-downs).
+ */
+ getShowFieldHeaders(): boolean;
+
+ /**
+ * Specifies whether the PivotTable displays field headers (field captions and filter drop-downs).
+ */
+ setShowFieldHeaders(showFieldHeaders: boolean): void;
+
/**
* Specifies if the PivotTable report shows grand totals for rows.
*/
@@ -6987,6 +7238,13 @@ export declare namespace ExcelScript {
*/
setSubtotalLocation(subtotalLocation: SubtotalLocationType): void;
+ /**
+ * Sets whether or not to display a blank line after each item. This is set at the global level for the PivotTable and applied to individual PivotFields.
+ * This function overwrites the setting for all fields in the PivotTable to the value of `display` parameter.
+ * @param display - True turns on the blank-line display setting. False turns it off.
+ */
+ displayBlankLineAfterEachItem(display: boolean): void;
+
/**
* Returns the range where the PivotTable's column labels reside.
*/
@@ -7018,6 +7276,12 @@ export declare namespace ExcelScript {
*/
getRowLabelRange(): Range;
+ /**
+ * Sets the "repeat all item labels" setting across all fields in the PivotTable.
+ * @param repeatLabels - True turns on the label-repetition display setting. False turns it off.
+ */
+ repeatAllItemLabels(repeatLabels: boolean): void;
+
/**
* Sets the PivotTable to automatically sort using the specified cell to automatically select all necessary criteria and context. This behaves identically to applying an autosort from the UI.
* @param cell - A single cell to use get the criteria from for applying the autosort.
@@ -7381,12 +7645,12 @@ export declare namespace ExcelScript {
getKey(): string;
/**
- * Gets or sets the value of the custom property.
+ * Specifies the value of the custom property.
*/
getValue(): string;
/**
- * Gets or sets the value of the custom property.
+ * Specifies the value of the custom property.
*/
setValue(value: string): void;
@@ -7421,12 +7685,12 @@ export declare namespace ExcelScript {
setCategory(category: string): void;
/**
- * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbook.
+ * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook.
*/
getComments(): string;
/**
- * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbook.
+ * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook.
*/
setComments(comments: string): void;
@@ -7640,6 +7904,55 @@ export declare namespace ExcelScript {
*/
getType(): ConditionalFormatType;
+ /**
+ * Change the conditional format rule type to cell value.
+ * @param properties - The properties to set for the cell value conditional format rule.
+ */
+ changeRuleToCellValue(properties: ConditionalCellValueRule): void;
+
+ /**
+ * Change the conditional format rule type to color scale.
+ */
+ changeRuleToColorScale(): void;
+
+ /**
+ * Change the conditional format rule type to text comparison.
+ * @param properties - The properties to set for the text comparison conditional format rule.
+ */
+ changeRuleToContainsText(
+ properties: ConditionalTextComparisonRule
+ ): void;
+
+ /**
+ * Change the conditional format rule type to custom.
+ * @param formula - The formula to set for the custom conditional format rule.
+ */
+ changeRuleToCustom(formula: string): void;
+
+ /**
+ * Change the conditional format rule type to data bar.
+ */
+ changeRuleToDataBar(): void;
+
+ /**
+ * Change the conditional format rule type to icon set.
+ */
+ changeRuleToIconSet(): void;
+
+ /**
+ * Change the conditional format rule type to preset criteria.
+ * @param properties - The properties to set for the preset criteria conditional format rule.
+ */
+ changeRuleToPresetCriteria(
+ properties: ConditionalPresetCriteriaRule
+ ): void;
+
+ /**
+ * Change the conditional format rule type to top/bottom.
+ * @param properties - The properties to set for the top/bottom conditional format rule.
+ */
+ changeRuleToTopBottom(properties: ConditionalTopBottomRule): void;
+
/**
* Deletes this conditional format.
*/
@@ -7654,6 +7967,12 @@ export declare namespace ExcelScript {
* Returns the `RangeAreas`, comprising one or more rectangular ranges, to which the conditional format is applied.
*/
getRanges(): RangeAreas;
+
+ /**
+ * Set the ranges that the conditional format rule is applied to.
+ * @param ranges - Collection of one or more ranges for this rule to be applied to.
+ */
+ setRanges(ranges: Range | RangeAreas | string): void;
}
/**
@@ -8032,6 +8351,11 @@ export declare namespace ExcelScript {
*/
setNumberFormat(numberFormat: string): void;
+ /**
+ * Remove the format properties from a conditional format rule. This creates a rule with no format settings.
+ */
+ clearFormat(): void;
+
/**
* Collection of border objects that apply to the overall conditional format range.
*/
@@ -8880,22 +9204,22 @@ export declare namespace ExcelScript {
setState(state: HeaderFooterState): void;
/**
- * Gets or sets a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet.
+ * Specifies a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet.
*/
getUseSheetMargins(): boolean;
/**
- * Gets or sets a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet.
+ * Specifies a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet.
*/
setUseSheetMargins(useSheetMargins: boolean): void;
/**
- * Gets or sets a flag indicating if headers/footers should be scaled by the page percentage scale set in the page layout options for the worksheet.
+ * Specifies a flag indicating if headers/footers should be scaled by the page percentage scale set in the page layout options for the worksheet.
*/
getUseSheetScale(): boolean;
/**
- * Gets or sets a flag indicating if headers/footers should be scaled by the page percentage scale set in the page layout options for the worksheet.
+ * Specifies a flag indicating if headers/footers should be scaled by the page percentage scale set in the page layout options for the worksheet.
*/
setUseSheetScale(useSheetScale: boolean): void;
}
@@ -8906,6 +9230,11 @@ export declare namespace ExcelScript {
*/
getColumnIndex(): number;
+ /**
+ * Specifies the row index for the page break.
+ */
+ getRowIndex(): number;
+
/**
* Deletes a page break object.
*/
@@ -9120,6 +9449,13 @@ export declare namespace ExcelScript {
*/
getConnectionSiteCount(): number;
+ /**
+ * Gets the display name of the shape. A newly created shape has a generated name
+ * that is localized and may not match its `name`. In this scenario, you can use
+ * this API to get the name that is displayed in the UI.
+ */
+ getDisplayName(): string;
+
/**
* Returns the fill formatting of this shape.
*/
@@ -9301,7 +9637,7 @@ export declare namespace ExcelScript {
delete(): void;
/**
- * Converts the shape to an image and returns the image as a base64-encoded string. The DPI is 96. The only supported formats are `ExcelScript.PictureFormat.BMP`, `ExcelScript.PictureFormat.PNG`, `ExcelScript.PictureFormat.JPEG`, and `ExcelScript.PictureFormat.GIF`.
+ * Converts the shape to an image and returns the image as a Base64-encoded string. The DPI is 96. The only supported formats are `ExcelScript.PictureFormat.BMP`, `ExcelScript.PictureFormat.PNG`, `ExcelScript.PictureFormat.JPEG`, and `ExcelScript.PictureFormat.GIF`.
* @param format - Specifies the format of the image.
*/
getImageAsBase64(format: PictureFormat): string;
@@ -10079,13 +10415,13 @@ export declare namespace ExcelScript {
*/
export interface NamedSheetView {
/**
- * Gets or sets the name of the sheet view.
+ * Specifies the name of the sheet view.
* The temporary sheet view name is the empty string (""). Naming the view by using the name property causes the sheet view to be saved.
*/
getName(): string;
/**
- * Gets or sets the name of the sheet view.
+ * Specifies the name of the sheet view.
* The temporary sheet view name is the empty string (""). Naming the view by using the name property causes the sheet view to be saved.
*/
setName(name: string): void;
@@ -11109,6 +11445,26 @@ export declare namespace ExcelScript {
automatic,
}
+ /**
+ * Represents a command type of `DataConnection`.
+ */
+ enum DataSourceType {
+ /**
+ * The data source type is unknown or unsupported.
+ */
+ unknown,
+
+ /**
+ * The data source type is a range in the current workbook.
+ */
+ localRange,
+
+ /**
+ * The data source type is a table in the current workbook.
+ */
+ localTable,
+ }
+
/**
* 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.
@@ -11560,6 +11916,32 @@ export declare namespace ExcelScript {
bubbleSizes,
}
+ /**
+ * Represents the type of cell control.
+ */
+ enum CellControlType {
+ /**
+ * Type representing an unknown control.
+ * This represents a control that was added in a future version of Excel, and the current version of Excel doesn't know how to display this control.
+ */
+ unknown,
+
+ /**
+ * Type representing an empty control.
+ */
+ empty,
+
+ /**
+ * Type representing a query that results in a mix of control results.
+ */
+ mixed,
+
+ /**
+ * Type representing a checkbox control.
+ */
+ checkbox,
+ }
+
/**
* Represents the criteria for the top/bottom values filter.
*/
@@ -12843,6 +13225,13 @@ export declare namespace ExcelScript {
* Removes hyperlinks and formatting for the cell but leaves content, conditional formats, and data validation intact.
*/
removeHyperlinks,
+
+ /**
+ * Sets all cells in the range to their default state.
+ * Cells with cell controls are set to the default value defined by each control.
+ * Cells without cell controls are set to blank.
+ */
+ resetContents,
}
/**
@@ -14759,4 +15148,209 @@ export declare namespace ExcelScript {
//
// Type
//
+ /**
+ * Represents an unknown cell control.
+ * This represents a control that was added in a future version of Excel, and the current version of Excel doesn't know how to display this control.
+ */
+ export interface UnknownCellControl {
+ type: CellControlType.unknown;
+ }
+
+ /**
+ * Represents an empty cell control.
+ * This represents the state where a cell does not have a control.
+ */
+ export interface EmptyCellControl {
+ type: CellControlType.empty;
+ }
+
+ /**
+ * Represents the result of a query that resulted in multiple cell controls.
+ * If the result has multiple controls, then they can't be represented as a single result.
+ */
+ export interface MixedCellControl {
+ type: CellControlType.mixed;
+ }
+
+ /**
+ * Represents a checkbox. This is a cell control that allows a user to toggle the boolean value in a cell.
+ */
+ export interface CheckboxCellControl {
+ type: CellControlType.checkbox;
+ }
+
+ /**
+ * Represents an interactable control inside of a cell.
+ */
+ type CellControl =
+ | UnknownCellControl
+ | EmptyCellControl
+ | MixedCellControl
+ | CheckboxCellControl;
}
+
+export declare namespace Global {
+ export namespace OfficeScript {
+ /**
+ * Return the text encoding of the document as a PDF.
+ * If the document is empty, then the following error is shown: "We didn't find anything to print".
+ * @returns The content of the workbook as a string, in PDF format.
+ * @beta
+ */
+ export function convertToPdf(): string;
+
+ /**
+ * Downloads a specified file to the default download location specified by the local machine.
+ * @param name - The name of the file once downloaded. The file extension determines the type of the file. Supported extensions are ".txt" and ".pdf". Default is ".txt".
+ * @param content - The content of the file.
+ * @beta
+ */
+ export function downloadFile({
+ name,
+ content,
+ }: {
+ name: string;
+ content: string;
+ }): void;
+
+ /**
+ * Send an email with an Office Script. Use `MailProperties` to specify the content and recipients of the email.
+ * If the request body includes content, this method returns 400 Bad request.
+ * @param message - The properties that define the content and recipients of the email.
+ * @beta
+ */
+ export function sendMail(mailProperties: MailProperties): void;
+
+ /**
+ * The type of the content. Possible values are text or HTML.
+ * @beta
+ */
+ enum EmailContentType {
+ /**
+ * The email message body is in HTML format.
+ * @beta
+ */
+ html = "html",
+
+ /**
+ * The email message body is in plain text format.
+ * @beta
+ */
+ text = "text",
+ }
+
+ /**
+ * The importance value of the email. Corresponds to "high", "normal", and "low" importance values available in the Outlook UI.
+ * @beta
+ */
+ enum EmailImportance {
+ /**
+ * Email is marked as low importance.
+ * @beta
+ */
+ low = "low",
+
+ /**
+ * Email does not have any importance specified.
+ * @beta
+ */
+ normal = "normal",
+
+ /**
+ * Email is marked as high importance.
+ * @beta
+ */
+ high = "high",
+ }
+
+ /**
+ * The attachment to send with the email.
+ * A value must be specified for at least one of the `to`, `cc`, or `bcc` parameters.
+ * If no recipient is specified, the following error is shown: "The message has no recipient. Please enter a value for at least one of the "to", "cc", or "bcc" parameters."
+ * @beta
+ */
+ export interface EmailAttachment {
+ /**
+ * The text that is displayed below the icon representing the attachment. This string doesn't need to match the file name.
+ * @beta
+ */
+ name: string;
+ /**
+ * The contents of the file.
+ * @beta
+ */
+ content: string;
+ }
+
+ /**
+ * The properties of the email to be sent.
+ * @beta
+ */
+ export interface MailProperties {
+ /**
+ * The subject of the email. Optional.
+ * @beta
+ */
+ subject?: string;
+
+ /**
+ * The content of the email. Optional.
+ * @beta
+ */
+ content?: string;
+
+ /**
+ * The type of the content in the email. Possible values are text or HTML. Optional.
+ * @beta
+ */
+ contentType?: EmailContentType;
+
+ /**
+ * The importance of the email. The possible values are `low`, `normal`, and `high`. Default value is `normal`. Optional.
+ * @beta
+ */
+ importance?: EmailImportance;
+
+ /**
+ * The direct recipient or recipients of the email. Optional.
+ * @beta
+ */
+ to?: string | string[];
+
+ /**
+ * The carbon copy (CC) recipient or recipients of the email. Optional.
+ * @beta
+ */
+ cc?: string | string[];
+
+ /**
+ * The blind carbon copy (BCC) recipient or recipients of the email. Optional.
+ * @beta
+ */
+ bcc?: string | string[];
+
+ /**
+ * A file (such as a text file or Excel workbook) attached to a message. Optional.
+ * @beta
+ */
+ attachments?: EmailAttachment | EmailAttachment[];
+ }
+
+ /**
+ * Metadata about the script.
+ * @beta
+ */
+ export namespace Metadata {
+ /**
+ * Get the current executing scripts name.
+ * @beta
+ */
+ export function getScriptName(): string;
+ }
+ }
+}
+
+/**
+ * The Global OfficeScript namespace.
+ */
+import OfficeScript = Global.OfficeScript;
diff --git a/generate-docs/api-extractor-inputs-excel/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel/tsdoc-metadata.json
index 901e33ad..ecbde239 100644
--- a/generate-docs/api-extractor-inputs-excel/tsdoc-metadata.json
+++ b/generate-docs/api-extractor-inputs-excel/tsdoc-metadata.json
@@ -1,11 +1,11 @@
-// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
-// It should be published with your NPM package. It should not be tracked by Git.
-{
- "tsdocVersion": "0.12",
- "toolPackages": [
- {
- "packageName": "@microsoft/api-extractor",
- "packageVersion": "7.52.1"
- }
- ]
-}
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package. It should not be tracked by Git.
+{
+ "tsdocVersion": "0.12",
+ "toolPackages": [
+ {
+ "packageName": "@microsoft/api-extractor",
+ "packageVersion": "7.52.1"
+ }
+ ]
+}
diff --git a/generate-docs/script-inputs/excel.d.ts b/generate-docs/script-inputs/excel.d.ts
index b06df0de..a5d07874 100644
--- a/generate-docs/script-inputs/excel.d.ts
+++ b/generate-docs/script-inputs/excel.d.ts
@@ -108,6 +108,11 @@ declare namespace ExcelScript {
* In this scenario, the second workbook is called the "linked workbook".
*/
interface LinkedWorkbook {
+ /**
+ * The original URL pointing to the linked workbook. It is unique across all linked workbooks in the collection.
+ */
+ getId(): string;
+
/**
* Makes a request to break the links pointing to the linked workbook.
* Links in formulas are replaced with the latest fetched data.
@@ -841,6 +846,16 @@ declare namespace ExcelScript {
*/
getProtection(): WorksheetProtection;
+ /**
+ * Specifies if data type icons are visible on the worksheet. By default, data type icons are visible.
+ */
+ getShowDataTypeIcons(): boolean;
+
+ /**
+ * Specifies if data type icons are visible on the worksheet. By default, data type icons are visible.
+ */
+ setShowDataTypeIcons(showDataTypeIcons: boolean): void;
+
/**
* Specifies if gridlines are visible to the user.
*/
@@ -961,7 +976,7 @@ declare namespace ExcelScript {
/**
* Gets the `Range` object, representing a single rectangular block of cells, specified by the address or name.
- * @param address Optional. The string representing the address or name of the range. For example, "A1:B2". If not specified, the entire worksheet range is returned.
+ * @param address Optional. The string representing the address or name of the range. For example, "A1:B2". If not specified, the entire worksheet range is returned. The `address` has a limit of 8192 characters. If the address exceeds the character limit, this method returns an `InvalidArgument` error.
*/
getRange(address?: string): Range;
@@ -1142,7 +1157,7 @@ declare namespace ExcelScript {
/**
* Gets a sheet view using its name.
- * If the sheet view object does not exist, then this method returns `undefined`.
+ * If the sheet view object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
* @param key The case-sensitive name of the sheet view.
* Use the empty string ("") to get the temporary sheet view, if the temporary view exists.
*/
@@ -1229,8 +1244,8 @@ declare namespace ExcelScript {
addGroup(values: Array): Shape;
/**
- * Creates an image from a base64-encoded string and adds it to the worksheet. Returns the `Shape` object that represents the new image.
- * @param base64ImageString A base64-encoded string representing an image in either JPEG or PNG format.
+ * Creates an image from a Base64-encoded string and adds it to the worksheet. Returns the `Shape` object that represents the new image.
+ * @param base64ImageString A Base64-encoded string representing an image in either JPEG or PNG format.
*/
addImage(base64ImageString: string): Shape;
@@ -1518,6 +1533,18 @@ declare namespace ExcelScript {
*/
getColumnIndex(): number;
+ /**
+ * Accesses the cell control applied to this range.
+ * If the range has multiple cell controls, this returns `EmptyCellControl`.
+ */
+ getControl(): CellControl;
+
+ /**
+ * Accesses the cell control applied to this range.
+ * If the range has multiple cell controls, this returns `EmptyCellControl`.
+ */
+ setControl(control: CellControl): void;
+
/**
* Returns a data validation object.
*/
@@ -1739,6 +1766,13 @@ declare namespace ExcelScript {
*/
clear(applyTo?: ClearApplyTo): void;
+ /**
+ * Clears the values of the cells in the range, with special consideration given to cells containing controls.
+ * If the range contains only blank values and controls set to their default value, then the values and control formatting are removed.
+ * Otherwise, this sets the cells with controls to their default value and clears the values of the other cells in the range.
+ */
+ clearOrResetContents(): void;
+
/**
* Converts the range cells with data types into text.
*/
@@ -1819,16 +1853,19 @@ declare namespace ExcelScript {
/**
* Returns a `WorkbookRangeAreas` object that represents the range containing all the dependent cells of a specified range in the same worksheet or across multiple worksheets.
+ * Note: This API returns an `ItemNotFound` error if no dependents are found.
*/
getDependents(): WorkbookRangeAreas;
/**
* Returns a `WorkbookRangeAreas` object that represents the range containing all the direct dependent cells of a specified range in the same worksheet or across multiple worksheets.
+ * Note: This API returns an `ItemNotFound` error if no dependents are found.
*/
getDirectDependents(): WorkbookRangeAreas;
/**
* Returns a `WorkbookRangeAreas` object that represents the range containing all the direct precedent cells of a specified range in the same worksheet or across multiple worksheets.
+ * Note: This API returns an `ItemNotFound` error if no precedents are found.
*/
getDirectPrecedents(): WorkbookRangeAreas;
@@ -1853,7 +1890,7 @@ declare namespace ExcelScript {
): Range;
/**
- * Renders the range as a base64-encoded png image.
+ * Renders the range as a Base64-encoded PNG image.
*/
getImage(): string;
@@ -1898,6 +1935,7 @@ declare namespace ExcelScript {
/**
* Returns a `WorkbookRangeAreas` object that represents the range containing all the precedent cells of a specified range in the same worksheet or across multiple worksheets.
+ * Note: This API returns an `ItemNotFound` error if no precedents are found.
*/
getPrecedents(): WorkbookRangeAreas;
@@ -2266,6 +2304,13 @@ declare namespace ExcelScript {
*/
clear(applyTo?: ClearApplyTo): void;
+ /**
+ * Clears the values of the cells in the ranges, with special consideration given to cells containing controls.
+ * If the ranges contain only blank values and controls set to their default value, then the values and control formatting are removed.
+ * Otherwise, this sets the cells with controls to their default value and clears the values of the other cells in the ranges.
+ */
+ clearOrResetContents(): void;
+
/**
* Converts all cells in the `RangeAreas` with data types into text.
*/
@@ -3646,7 +3691,7 @@ declare namespace ExcelScript {
getDataTable(): ChartDataTable;
/**
- * Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions.
+ * Renders the chart as a Base64-encoded image by scaling the chart to fit the specified dimensions.
* The aspect ratio is preserved as part of the resizing.
* @param height Optional. The desired height of the resulting image.
* @param width Optional. The desired width of the resulting image.
@@ -4850,6 +4895,18 @@ declare namespace ExcelScript {
*/
getFormat(): ChartDataLabelFormat;
+ /**
+ * Specifies the geometric shape type of the data labels. See `ExcelScript.GeometricShapeType` for more details.
+ * Value is `null` if the data labels are not geometric shapes.
+ */
+ getGeometricShapeType(): GeometricShapeType;
+
+ /**
+ * Specifies the geometric shape type of the data labels. See `ExcelScript.GeometricShapeType` for more details.
+ * Value is `null` if the data labels are not geometric shapes.
+ */
+ setGeometricShapeType(geometricShapeType: GeometricShapeType): void;
+
/**
* Specifies the horizontal alignment for chart data label. See `ExcelScript.ChartTextHorizontalAlignment` for details.
* This property is valid only when the `TextOrientation` of data label is 0.
@@ -4864,6 +4921,11 @@ declare namespace ExcelScript {
horizontalAlignment: ChartTextHorizontalAlignment
): void;
+ /**
+ * Gets an object that represents the leader lines of the data labels.
+ */
+ getLeaderLines(): ChartLeaderLines;
+
/**
* Specifies if the number format is linked to the cells. If `true`, the number format will change in the labels when it changes in the cells.
*/
@@ -4904,6 +4966,11 @@ declare namespace ExcelScript {
*/
setSeparator(separator: string): void;
+ /**
+ * Gets a value that indicates whether the data labels are shown as a callout with the tail anchor attached to the data point. If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See Excel.GeometricShapeType for more details.
+ */
+ getShowAsStickyCallout(): boolean;
+
/**
* Specifies if the data label bubble size is visible.
*/
@@ -4924,6 +4991,16 @@ declare namespace ExcelScript {
*/
setShowCategoryName(showCategoryName: boolean): void;
+ /**
+ * Specifies a value that indicates whether leader lines are displayed for the data labels. `true` if leader lines are shown; otherwise, `false`.
+ */
+ getShowLeaderLines(): boolean;
+
+ /**
+ * Specifies a value that indicates whether leader lines are displayed for the data labels. `true` if leader lines are shown; otherwise, `false`.
+ */
+ setShowLeaderLines(showLeaderLines: boolean): void;
+
/**
* Specifies if the data label legend key is visible.
*/
@@ -5018,6 +5095,18 @@ declare namespace ExcelScript {
*/
setFormula(formula: string): void;
+ /**
+ * Specifies the geometric shape type of the data label. See `ExcelScript.GeometricShapeType` for more details.
+ * Value is `null` if the data label is not a geometric shape.
+ */
+ getGeometricShapeType(): GeometricShapeType;
+
+ /**
+ * Specifies the geometric shape type of the data label. See `ExcelScript.GeometricShapeType` for more details.
+ * Value is `null` if the data label is not a geometric shape.
+ */
+ setGeometricShapeType(geometricShapeType: GeometricShapeType): void;
+
/**
* Returns the height, in points, of the chart data label. Value is `null` if the chart data label is not visible.
*/
@@ -5087,6 +5176,11 @@ declare namespace ExcelScript {
*/
setSeparator(separator: string): void;
+ /**
+ * Gets a value that indicates whether the data labels are shown as a callout with the tail anchor attached to the data point. If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See Excel.GeometricShapeType for more details.
+ */
+ getShowAsStickyCallout(): boolean;
+
/**
* Specifies if the data label bubble size is visible.
*/
@@ -5195,6 +5289,30 @@ declare namespace ExcelScript {
* Returns the width, in points, of the chart data label. Value is `null` if the chart data label is not visible.
*/
getWidth(): number;
+
+ /**
+ * Returns a substring of the data label. The line break character '\n' counts as one character.
+ * @param start The zero-based starting character position of a substring in the data label.
+ * @param length Optional. The number of characters in the substring. If length is omitted, all the characters from start to the end of the data label are retrieved.
+ */
+ getSubstring(start: number, length?: number): ChartFormatString;
+
+ /**
+ * Returns the tail anchor of the data label which is shown as a sticky callout.
+ */
+ getTailAnchor(): ChartDataLabelAnchor;
+
+ /**
+ * Sets the height of the data label in points.
+ * @param height The height of the data label in points.
+ */
+ setHeight(height: number): void;
+
+ /**
+ * Sets the width of the data label in points.
+ * @param width The width of the data label in points.
+ */
+ setWidth(width: number): void;
}
/**
@@ -5217,6 +5335,31 @@ declare namespace ExcelScript {
getFont(): ChartFont;
}
+ /**
+ * Represents the chart data label anchor.
+ */
+ interface ChartDataLabelAnchor {
+ /**
+ * Represents the distance, in points, from the anchor to the left edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
+ */
+ getLeft(): number;
+
+ /**
+ * Represents the distance, in points, from the anchor to the left edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
+ */
+ setLeft(left: number): void;
+
+ /**
+ * Represents the distance, in points, from the anchor to the top edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
+ */
+ getTop(): number;
+
+ /**
+ * Represents the distance, in points, from the anchor to the top edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
+ */
+ setTop(top: number): void;
+ }
+
/**
* Represents the data table object of a chart.
*/
@@ -6425,6 +6568,26 @@ declare namespace ExcelScript {
getFill(): ChartFill;
}
+ /**
+ * Gets an object that represents the formatting of chart leader lines.
+ */
+ interface ChartLeaderLines {
+ /**
+ * Represents the formatting of leader lines of data labels in a series.
+ */
+ getFormat(): ChartLeaderLinesFormat;
+ }
+
+ /**
+ * Encapsulates the format properties for leader lines.
+ */
+ interface ChartLeaderLinesFormat {
+ /**
+ * Gets an object that represents the line formatting of chart leader lines.
+ */
+ getLine(): ChartLineFormat;
+ }
+
/**
* Manages sorting operations on `Range` objects.
*/
@@ -6661,6 +6824,11 @@ declare namespace ExcelScript {
* Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings.
*/
interface NumberFormatInfo {
+ /**
+ * Gets the currency symbol for currency values. This is based on current system settings.
+ */
+ getCurrencySymbol(): string;
+
/**
* Gets the string used as the decimal separator for numeric values. This is based on current system settings.
*/
@@ -6799,6 +6967,17 @@ declare namespace ExcelScript {
*/
delete(): void;
+ /**
+ * Returns the string representation of the data source for the PivotTable. This method currently supports string representations for table and range objects.
+ * Otherwise, it returns an empty string.
+ */
+ getDataSourceString(): string;
+
+ /**
+ * Gets the type of the data source for the PivotTable.
+ */
+ getDataSourceType(): DataSourceType;
+
/**
* Refreshes the PivotTable.
*/
@@ -6917,6 +7096,42 @@ declare namespace ExcelScript {
* Represents the visual layout of the PivotTable.
*/
interface PivotLayout {
+ /**
+ * The alt text description of the PivotTable.
+ *
+ * Alt text provides alternative, text-based representations of the information contained in the PivotTable.
+ * This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
+ * A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+ */
+ getAltTextDescription(): string;
+
+ /**
+ * The alt text description of the PivotTable.
+ *
+ * Alt text provides alternative, text-based representations of the information contained in the PivotTable.
+ * This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
+ * A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+ */
+ setAltTextDescription(altTextDescription: string): void;
+
+ /**
+ * The alt text title of the PivotTable.
+ *
+ * Alt text provides alternative, text-based representations of the information contained in the PivotTable.
+ * This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
+ * A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+ */
+ getAltTextTitle(): string;
+
+ /**
+ * The alt text title of the PivotTable.
+ *
+ * Alt text provides alternative, text-based representations of the information contained in the PivotTable.
+ * This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
+ * A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+ */
+ setAltTextTitle(altTextTitle: string): void;
+
/**
* Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved.
*/
@@ -6927,6 +7142,20 @@ declare namespace ExcelScript {
*/
setAutoFormat(autoFormat: boolean): void;
+ /**
+ * The text that is automatically filled into any empty cell in the PivotTable if `fillEmptyCells == true`.
+ * Note that this value persists if `fillEmptyCells` is set to `false`, and that setting this value does not set that property to `true`.
+ * By default, this is an empty string.
+ */
+ getEmptyCellText(): string;
+
+ /**
+ * The text that is automatically filled into any empty cell in the PivotTable if `fillEmptyCells == true`.
+ * Note that this value persists if `fillEmptyCells` is set to `false`, and that setting this value does not set that property to `true`.
+ * By default, this is an empty string.
+ */
+ setEmptyCellText(emptyCellText: string): void;
+
/**
* Specifies if the field list can be shown in the UI.
*/
@@ -6937,6 +7166,18 @@ declare namespace ExcelScript {
*/
setEnableFieldList(enableFieldList: boolean): void;
+ /**
+ * Specifies whether empty cells in the PivotTable should be populated with the `emptyCellText`. Default is `false`.
+ * Note that the value of `emptyCellText` persists when this property is set to `false`.
+ */
+ getFillEmptyCells(): boolean;
+
+ /**
+ * Specifies whether empty cells in the PivotTable should be populated with the `emptyCellText`. Default is `false`.
+ * Note that the value of `emptyCellText` persists when this property is set to `false`.
+ */
+ setFillEmptyCells(fillEmptyCells: boolean): void;
+
/**
* This property indicates the PivotLayoutType of all fields on the PivotTable. If fields have different states, this will be null.
*/
@@ -6967,6 +7208,16 @@ declare namespace ExcelScript {
*/
setShowColumnGrandTotals(showColumnGrandTotals: boolean): void;
+ /**
+ * Specifies whether the PivotTable displays field headers (field captions and filter drop-downs).
+ */
+ getShowFieldHeaders(): boolean;
+
+ /**
+ * Specifies whether the PivotTable displays field headers (field captions and filter drop-downs).
+ */
+ setShowFieldHeaders(showFieldHeaders: boolean): void;
+
/**
* Specifies if the PivotTable report shows grand totals for rows.
*/
@@ -6987,6 +7238,13 @@ declare namespace ExcelScript {
*/
setSubtotalLocation(subtotalLocation: SubtotalLocationType): void;
+ /**
+ * Sets whether or not to display a blank line after each item. This is set at the global level for the PivotTable and applied to individual PivotFields.
+ * This function overwrites the setting for all fields in the PivotTable to the value of `display` parameter.
+ * @param display True turns on the blank-line display setting. False turns it off.
+ */
+ displayBlankLineAfterEachItem(display: boolean): void;
+
/**
* Returns the range where the PivotTable's column labels reside.
*/
@@ -7018,6 +7276,12 @@ declare namespace ExcelScript {
*/
getRowLabelRange(): Range;
+ /**
+ * Sets the "repeat all item labels" setting across all fields in the PivotTable.
+ * @param repeatLabels True turns on the label-repetition display setting. False turns it off.
+ */
+ repeatAllItemLabels(repeatLabels: boolean): void;
+
/**
* Sets the PivotTable to automatically sort using the specified cell to automatically select all necessary criteria and context. This behaves identically to applying an autosort from the UI.
* @param cell A single cell to use get the criteria from for applying the autosort.
@@ -7381,12 +7645,12 @@ declare namespace ExcelScript {
getKey(): string;
/**
- * Gets or sets the value of the custom property.
+ * Specifies the value of the custom property.
*/
getValue(): string;
/**
- * Gets or sets the value of the custom property.
+ * Specifies the value of the custom property.
*/
setValue(value: string): void;
@@ -7421,12 +7685,12 @@ declare namespace ExcelScript {
setCategory(category: string): void;
/**
- * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbook.
+ * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook.
*/
getComments(): string;
/**
- * The comment field in the metadata of the workbook. These have no connection to comments by users made in the workbook.
+ * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook.
*/
setComments(comments: string): void;
@@ -7640,6 +7904,55 @@ declare namespace ExcelScript {
*/
getType(): ConditionalFormatType;
+ /**
+ * Change the conditional format rule type to cell value.
+ * @param properties The properties to set for the cell value conditional format rule.
+ */
+ changeRuleToCellValue(properties: ConditionalCellValueRule): void;
+
+ /**
+ * Change the conditional format rule type to color scale.
+ */
+ changeRuleToColorScale(): void;
+
+ /**
+ * Change the conditional format rule type to text comparison.
+ * @param properties The properties to set for the text comparison conditional format rule.
+ */
+ changeRuleToContainsText(
+ properties: ConditionalTextComparisonRule
+ ): void;
+
+ /**
+ * Change the conditional format rule type to custom.
+ * @param formula The formula to set for the custom conditional format rule.
+ */
+ changeRuleToCustom(formula: string): void;
+
+ /**
+ * Change the conditional format rule type to data bar.
+ */
+ changeRuleToDataBar(): void;
+
+ /**
+ * Change the conditional format rule type to icon set.
+ */
+ changeRuleToIconSet(): void;
+
+ /**
+ * Change the conditional format rule type to preset criteria.
+ * @param properties The properties to set for the preset criteria conditional format rule.
+ */
+ changeRuleToPresetCriteria(
+ properties: ConditionalPresetCriteriaRule
+ ): void;
+
+ /**
+ * Change the conditional format rule type to top/bottom.
+ * @param properties The properties to set for the top/bottom conditional format rule.
+ */
+ changeRuleToTopBottom(properties: ConditionalTopBottomRule): void;
+
/**
* Deletes this conditional format.
*/
@@ -7654,6 +7967,12 @@ declare namespace ExcelScript {
* Returns the `RangeAreas`, comprising one or more rectangular ranges, to which the conditional format is applied.
*/
getRanges(): RangeAreas;
+
+ /**
+ * Set the ranges that the conditional format rule is applied to.
+ * @param ranges Collection of one or more ranges for this rule to be applied to.
+ */
+ setRanges(ranges: Range | RangeAreas | string): void;
}
/**
@@ -8032,6 +8351,11 @@ declare namespace ExcelScript {
*/
setNumberFormat(numberFormat: string): void;
+ /**
+ * Remove the format properties from a conditional format rule. This creates a rule with no format settings.
+ */
+ clearFormat(): void;
+
/**
* Collection of border objects that apply to the overall conditional format range.
*/
@@ -8880,22 +9204,22 @@ declare namespace ExcelScript {
setState(state: HeaderFooterState): void;
/**
- * Gets or sets a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet.
+ * Specifies a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet.
*/
getUseSheetMargins(): boolean;
/**
- * Gets or sets a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet.
+ * Specifies a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet.
*/
setUseSheetMargins(useSheetMargins: boolean): void;
/**
- * Gets or sets a flag indicating if headers/footers should be scaled by the page percentage scale set in the page layout options for the worksheet.
+ * Specifies a flag indicating if headers/footers should be scaled by the page percentage scale set in the page layout options for the worksheet.
*/
getUseSheetScale(): boolean;
/**
- * Gets or sets a flag indicating if headers/footers should be scaled by the page percentage scale set in the page layout options for the worksheet.
+ * Specifies a flag indicating if headers/footers should be scaled by the page percentage scale set in the page layout options for the worksheet.
*/
setUseSheetScale(useSheetScale: boolean): void;
}
@@ -8906,6 +9230,11 @@ declare namespace ExcelScript {
*/
getColumnIndex(): number;
+ /**
+ * Specifies the row index for the page break.
+ */
+ getRowIndex(): number;
+
/**
* Deletes a page break object.
*/
@@ -9120,6 +9449,13 @@ declare namespace ExcelScript {
*/
getConnectionSiteCount(): number;
+ /**
+ * Gets the display name of the shape. A newly created shape has a generated name
+ * that is localized and may not match its `name`. In this scenario, you can use
+ * this API to get the name that is displayed in the UI.
+ */
+ getDisplayName(): string;
+
/**
* Returns the fill formatting of this shape.
*/
@@ -9301,7 +9637,7 @@ declare namespace ExcelScript {
delete(): void;
/**
- * Converts the shape to an image and returns the image as a base64-encoded string. The DPI is 96. The only supported formats are `ExcelScript.PictureFormat.BMP`, `ExcelScript.PictureFormat.PNG`, `ExcelScript.PictureFormat.JPEG`, and `ExcelScript.PictureFormat.GIF`.
+ * Converts the shape to an image and returns the image as a Base64-encoded string. The DPI is 96. The only supported formats are `ExcelScript.PictureFormat.BMP`, `ExcelScript.PictureFormat.PNG`, `ExcelScript.PictureFormat.JPEG`, and `ExcelScript.PictureFormat.GIF`.
* @param format Specifies the format of the image.
*/
getImageAsBase64(format: PictureFormat): string;
@@ -10079,13 +10415,13 @@ declare namespace ExcelScript {
*/
interface NamedSheetView {
/**
- * Gets or sets the name of the sheet view.
+ * Specifies the name of the sheet view.
* The temporary sheet view name is the empty string (""). Naming the view by using the name property causes the sheet view to be saved.
*/
getName(): string;
/**
- * Gets or sets the name of the sheet view.
+ * Specifies the name of the sheet view.
* The temporary sheet view name is the empty string (""). Naming the view by using the name property causes the sheet view to be saved.
*/
setName(name: string): void;
@@ -11109,6 +11445,26 @@ declare namespace ExcelScript {
automatic,
}
+ /**
+ * Represents a command type of `DataConnection`.
+ */
+ enum DataSourceType {
+ /**
+ * The data source type is unknown or unsupported.
+ */
+ unknown,
+
+ /**
+ * The data source type is a range in the current workbook.
+ */
+ localRange,
+
+ /**
+ * The data source type is a table in the current workbook.
+ */
+ localTable,
+ }
+
/**
* 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.
@@ -11560,6 +11916,32 @@ declare namespace ExcelScript {
bubbleSizes,
}
+ /**
+ * Represents the type of cell control.
+ */
+ enum CellControlType {
+ /**
+ * Type representing an unknown control.
+ * This represents a control that was added in a future version of Excel, and the current version of Excel doesn't know how to display this control.
+ */
+ unknown,
+
+ /**
+ * Type representing an empty control.
+ */
+ empty,
+
+ /**
+ * Type representing a query that results in a mix of control results.
+ */
+ mixed,
+
+ /**
+ * Type representing a checkbox control.
+ */
+ checkbox,
+ }
+
/**
* Represents the criteria for the top/bottom values filter.
*/
@@ -12843,6 +13225,13 @@ declare namespace ExcelScript {
* Removes hyperlinks and formatting for the cell but leaves content, conditional formats, and data validation intact.
*/
removeHyperlinks,
+
+ /**
+ * Sets all cells in the range to their default state.
+ * Cells with cell controls are set to the default value defined by each control.
+ * Cells without cell controls are set to blank.
+ */
+ resetContents,
}
/**
@@ -14759,4 +15148,209 @@ declare namespace ExcelScript {
//
// Type
//
+ /**
+ * Represents an unknown cell control.
+ * This represents a control that was added in a future version of Excel, and the current version of Excel doesn't know how to display this control.
+ */
+ interface UnknownCellControl {
+ type: CellControlType.unknown;
+ }
+
+ /**
+ * Represents an empty cell control.
+ * This represents the state where a cell does not have a control.
+ */
+ interface EmptyCellControl {
+ type: CellControlType.empty;
+ }
+
+ /**
+ * Represents the result of a query that resulted in multiple cell controls.
+ * If the result has multiple controls, then they can't be represented as a single result.
+ */
+ interface MixedCellControl {
+ type: CellControlType.mixed;
+ }
+
+ /**
+ * Represents a checkbox. This is a cell control that allows a user to toggle the boolean value in a cell.
+ */
+ interface CheckboxCellControl {
+ type: CellControlType.checkbox;
+ }
+
+ /**
+ * Represents an interactable control inside of a cell.
+ */
+ type CellControl =
+ | UnknownCellControl
+ | EmptyCellControl
+ | MixedCellControl
+ | CheckboxCellControl;
}
+
+declare namespace Global {
+ export namespace OfficeScript {
+ /**
+ * Return the text encoding of the document as a PDF.
+ * If the document is empty, then the following error is shown: "We didn't find anything to print".
+ * @returns The content of the workbook as a string, in PDF format.
+ * @beta
+ */
+ function convertToPdf(): string;
+
+ /**
+ * Downloads a specified file to the default download location specified by the local machine.
+ * @param name The name of the file once downloaded. The file extension determines the type of the file. Supported extensions are ".txt" and ".pdf". Default is ".txt".
+ * @param content - The content of the file.
+ * @beta
+ */
+ function downloadFile({
+ name,
+ content,
+ }: {
+ name: string;
+ content: string;
+ }): void;
+
+ /**
+ * Send an email with an Office Script. Use `MailProperties` to specify the content and recipients of the email.
+ * If the request body includes content, this method returns 400 Bad request.
+ * @param message The properties that define the content and recipients of the email.
+ * @beta
+ */
+ function sendMail(mailProperties: MailProperties): void;
+
+ /**
+ * The type of the content. Possible values are text or HTML.
+ * @beta
+ */
+ enum EmailContentType {
+ /**
+ * The email message body is in HTML format.
+ * @beta
+ */
+ html = "html",
+
+ /**
+ * The email message body is in plain text format.
+ * @beta
+ */
+ text = "text",
+ }
+
+ /**
+ * The importance value of the email. Corresponds to "high", "normal", and "low" importance values available in the Outlook UI.
+ * @beta
+ */
+ enum EmailImportance {
+ /**
+ * Email is marked as low importance.
+ * @beta
+ */
+ low = "low",
+
+ /**
+ * Email does not have any importance specified.
+ * @beta
+ */
+ normal = "normal",
+
+ /**
+ * Email is marked as high importance.
+ * @beta
+ */
+ high = "high",
+ }
+
+ /**
+ * The attachment to send with the email.
+ * A value must be specified for at least one of the `to`, `cc`, or `bcc` parameters.
+ * If no recipient is specified, the following error is shown: "The message has no recipient. Please enter a value for at least one of the "to", "cc", or "bcc" parameters."
+ * @beta
+ */
+ export interface EmailAttachment {
+ /**
+ * The text that is displayed below the icon representing the attachment. This string doesn't need to match the file name.
+ * @beta
+ */
+ name: string;
+ /**
+ * The contents of the file.
+ * @beta
+ */
+ content: string;
+ }
+
+ /**
+ * The properties of the email to be sent.
+ * @beta
+ */
+ export interface MailProperties {
+ /**
+ * The subject of the email. Optional.
+ * @beta
+ */
+ subject?: string;
+
+ /**
+ * The content of the email. Optional.
+ * @beta
+ */
+ content?: string;
+
+ /**
+ * The type of the content in the email. Possible values are text or HTML. Optional.
+ * @beta
+ */
+ contentType?: EmailContentType;
+
+ /**
+ * The importance of the email. The possible values are `low`, `normal`, and `high`. Default value is `normal`. Optional.
+ * @beta
+ */
+ importance?: EmailImportance;
+
+ /**
+ * The direct recipient or recipients of the email. Optional.
+ * @beta
+ */
+ to?: string | string[];
+
+ /**
+ * The carbon copy (CC) recipient or recipients of the email. Optional.
+ * @beta
+ */
+ cc?: string | string[];
+
+ /**
+ * The blind carbon copy (BCC) recipient or recipients of the email. Optional.
+ * @beta
+ */
+ bcc?: string | string[];
+
+ /**
+ * A file (such as a text file or Excel workbook) attached to a message. Optional.
+ * @beta
+ */
+ attachments?: EmailAttachment | EmailAttachment[];
+ }
+
+ /**
+ * Metadata about the script.
+ * @beta
+ */
+ namespace Metadata {
+ /**
+ * Get the current executing scripts name.
+ * @beta
+ */
+ function getScriptName(): string;
+ }
+ }
+}
+
+/**
+ * The Global OfficeScript namespace.
+ */
+import OfficeScript = Global.OfficeScript;