vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-10-04 14:57:10 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #33329 from AlexJerabek/AlexJ-CDNUpdate

Browse Source 
[office-js-preview] Updating Excel APIs
This commit is contained in:
Jesse Trinity
2019-02-26 13:34:15 -08:00
committed by GitHub
parent ef3fe6d83d 7c691f029e
commit 4bc268bd46
1 changed files with 587 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files
types/office-js-preview/index.d.ts
Vendored
+587 -40
View File
@@ -19336,6 +19336,47 @@ declare namespace Excel {
*/
type: "WorkbookAutoSaveSettingChanged";
}
/**
*
* Provide information about the detail of WorksheetChangedEvent/TableChangedEvent
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
interface ChangedEventDetail {
/**
*
* Represents the value after changed. The data returned could be of type string, number, or a boolean. Cells that contain an error will return the error string.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
valueAfter: any;
/**
*
* Represents the value before changed. The data returned could be of type string, number, or a boolean. Cells that contain an error will return the error string.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
valueBefore: any;
/**
*
* Represents the type of value after changed
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
valueTypeAfter: Excel.RangeValueType | "Unknown" | "Empty" | "String" | "Integer" | "Double" | "Boolean" | "Error" | "RichValue";
/**
*
* Represents the type of value before changed
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
valueTypeBefore: Excel.RangeValueType | "Unknown" | "Empty" | "String" | "Integer" | "Double" | "Boolean" | "Error" | "RichValue";
}
/**
*
* Provides information about the worksheet that raised the Changed event.
@@ -19357,6 +19398,13 @@ declare namespace Excel {
* [Api set: ExcelApi 1.7]
*/
changeType: Excel.DataChangeType | "Unknown" | "RangeEdited" | "RowInserted" | "RowDeleted" | "ColumnInserted" | "ColumnDeleted" | "CellInserted" | "CellDeleted";
/**
*
* Represents the information about the change detail
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
*/
details: Excel.ChangedEventDetail;
/**
*
* Gets the source of the event. See Excel.EventSource for details.
@@ -19497,6 +19545,13 @@ declare namespace Excel {
* [Api set: ExcelApi 1.7]
*/
worksheetId: string;
/**
*
* Represents the information about the change detail
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
*/
details: Excel.ChangedEventDetail;
/**
*
* Gets the range that represents the changed area of a table on a specific worksheet.
@@ -21907,7 +21962,28 @@ declare namespace Excel {
set(properties: Interfaces.RangeUpdateData, options?: OfficeExtension.UpdateOptions): void;
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
set(properties: Excel.Range): void;
/**
*
* Fills range from the current range to the destination range.
The destination range must extend the source either horizontally or vertically. Discontiguous ranges are not supported.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*
* @param destinationRange The destination range to autofill.
* @param autoFillType The type of autofill. Specifies how the destination range is to be filled, based on the contents of the current range. Default is "FillDefault".
*/
autoFill(destinationRange: Range | string, autoFillType?: Excel.AutoFillType): void;
/**
*
* Fills range from the current range to the destination range.
The destination range must extend the source either horizontally or vertically. Discontiguous ranges are not supported.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
*
* @param destinationRange The destination range to autofill.
* @param autoFillType The type of autofill. Specifies how the destination range is to be filled, based on the contents of the current range. Default is "FillDefault".
*/
autoFill(destinationRange: Range | string, autoFillType?: "FillDefault" | "FillCopy" | "FillSeries" | "FillFormats" | "FillValues" | "FillDays" | "FillWeekdays" | "FillMonths" | "FillYears" | "LinearTrend" | "GrowthTrend" | "FlashFill"): void;
/**
*
@@ -22025,6 +22101,14 @@ declare namespace Excel {
* @returns The Range which matched the search criteria.
*/
findOrNullObject(text: string, criteria: Excel.SearchCriteria): Excel.Range;
/**
*
* Does FlashFill to current range. Flash Fill will automatically fills data when it senses a pattern, so the range must be single column range and have data around in order to find pattern.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
flashFill(): void;
/**
*
* Gets a Range object with the same top-left cell as the current Range object, but with the specified numbers of rows and columns.
@@ -22234,7 +22318,7 @@ declare namespace Excel {
* @param cellType The type of cells to include.
* @param cellValueType 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.
*/
getSpecialCells(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Comments" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;
getSpecialCells(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;
/**
*
* Gets the RangeAreas object, comprising one or more ranges, that represents all the cells that match the specified type and value.
@@ -22257,7 +22341,7 @@ declare namespace Excel {
* @param cellType The type of cells to include.
* @param cellValueType 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.
*/
getSpecialCellsOrNullObject(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Comments" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;
getSpecialCellsOrNullObject(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;
/**
*
* Gets the range object containing the anchor cell for a cell getting spilled into. Fails if applied to a range with more than one cell. Read only.
@@ -22772,7 +22856,7 @@ declare namespace Excel {
* @param cellType The type of cells to include.
* @param cellValueType 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.
*/
getSpecialCells(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Comments" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;
getSpecialCells(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;
/**
*
* Returns a RangeAreas object that represents all the cells that match the specified type and value. Returns a null object if no special cells are found that match the criteria.
@@ -22794,7 +22878,7 @@ declare namespace Excel {
* @param cellType The type of cells to include.
* @param cellValueType 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.
*/
getSpecialCellsOrNullObject(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Comments" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;
getSpecialCellsOrNullObject(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;
/**
*
* Returns a scoped collection of tables that overlap with any range in this RangeAreas object.
@@ -35206,7 +35290,7 @@ declare namespace Excel {
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*
* @param index Index value of the object to be retrieved. Zero-indexed.
* @param index Index value of the style object to be retrieved. Zero-indexed.
*/
getItemAt(index: number): Excel.Style;
/**
@@ -36443,12 +36527,8 @@ declare namespace Excel {
* @beta
*
* @param geometricShapeType Represents the geometric type of the shape. See Excel.GeometricShapeType for details.
* @param left The distance, in points, from the left side of the shape to the left side of the worksheet.
* @param top The distance, in points, from the top edge of the shape to the top of the worksheet.
* @param width The width, in points, of the shape.
* @param height The height, in points, of the shape.
*/
addGeometricShape(geometricShapeType: Excel.GeometricShapeType, left: number, top: number, width: number, height: number): Excel.Shape;
addGeometricShape(geometricShapeType: Excel.GeometricShapeType): Excel.Shape;
/**
*
* Adds a geometric shape to worksheet. Returns a Shape object that represents the new shape.
@@ -36457,12 +36537,8 @@ declare namespace Excel {
* @beta
*
* @param geometricShapeType Represents the geometric type of the shape. See Excel.GeometricShapeType for details.
* @param left The distance, in points, from the left side of the shape to the left side of the worksheet.
* @param top The distance, in points, from the top edge of the shape to the top of the worksheet.
* @param width The width, in points, of the shape.
* @param height The height, in points, of the shape.
*/
addGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", left: number, top: number, width: number, height: number): Excel.Shape;
addGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"): Excel.Shape;
/**
*
* Group a subset of shapes in a worksheet. Returns a Shape object that represents the new group of shapes.
@@ -36673,6 +36749,14 @@ declare namespace Excel {
* @beta
*/
altTextTitle: string;
/**
*
* Returns the number of connection sites on the specified shape. Read-only.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
readonly connectionSiteCount: number;
/**
*
* Represents the geometric shape type of the specified shape. See Excel.GeometricShapeType for detail. Returns null if the shape is not geometric, for example, get GeometricShapeType of a line or a chart will return null.
@@ -37230,6 +37314,22 @@ declare namespace Excel {
class Line extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
context: RequestContext;
/**
*
* Represents the shape object that the beginning of the specified line is attached to. Read-only.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
readonly beginConnectedShape: Excel.Shape;
/**
*
* Represents the shape object that the end of the specified line is attached to. Read-only.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
readonly endConnectedShape: Excel.Shape;
/**
*
* Returns the shape object for the line. Read-only.
@@ -37238,6 +37338,70 @@ declare namespace Excel {
* @beta
*/
readonly shape: Excel.Shape;
/**
*
* Represents the length of the arrowhead at the beginning of the specified line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
beginArrowHeadLength: Excel.ArrowHeadLength | "Short" | "Medium" | "Long";
/**
*
* Represents the style of the arrowhead at the beginning of the specified line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
beginArrowHeadStyle: Excel.ArrowHeadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open";
/**
*
* Represents the width of the arrowhead at the beginning of the specified line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
beginArrowHeadWidth: Excel.ArrowHeadWidth | "Narrow" | "Medium" | "Wide";
/**
*
* Represents an integer that specifies the connection site that the beginning of a connector is connected to. Read-only. Returns null when the beginning of the line is not attached to any shape.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
readonly beginConnectedSite: number;
/**
*
* Represents the length of the arrowhead at the end of the specified line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
endArrowHeadLength: Excel.ArrowHeadLength | "Short" | "Medium" | "Long";
/**
*
* Represents the style of the arrowhead at the end of the specified line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
endArrowHeadStyle: Excel.ArrowHeadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open";
/**
*
* Represents the width of the arrowhead at the end of the specified line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
endArrowHeadWidth: Excel.ArrowHeadWidth | "Narrow" | "Medium" | "Wide";
/**
*
* Represents an integer that specifies the connection site that the end of a connector is connected to. Read-only. Returns null when the end of the line is not attached to any shape.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
readonly endConnectedSite: number;
/**
*
* Represents the shape identifier. Read-only.
@@ -37246,6 +37410,22 @@ declare namespace Excel {
* @beta
*/
readonly id: string;
/**
*
* Represents whether the beginning of the specified line is connected to a shape. Read-only.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
readonly isBeginConnected: boolean;
/**
*
* Represents whether the end of the specified line is connected to a shape. Read-only.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
readonly isEndConnected: boolean;
/**
*
* Represents the connector type for the line.
@@ -37268,6 +37448,44 @@ declare namespace Excel {
set(properties: Interfaces.LineUpdateData, options?: OfficeExtension.UpdateOptions): void;
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
set(properties: Excel.Line): void;
/**
*
* Attaches the beginning of the specified connector to a specified shape.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*
* @param shape The shape to attach the beginning of the connector to.
* @param connectionSite The connection site on the shape which the beginning of the connector attach to. Must be an integer between 0 and the connection site count(not included) of the specified shape.
*/
beginConnect(shape: Excel.Shape, connectionSite: number): void;
/**
*
* Detaches the beginning of the specified connector from the shape it's attached to.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
beginDisconnect(): void;
/**
*
* Attaches the end of the specified connector to a specified shape.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*
* @param shape The shape to attach the end of the connector to.
* @param connectionSite The connection site on the shape which the end of the connector attach to. Must be an integer between 0 and the connection site count(not included) of the specified shape.
*/
endConnect(shape: Excel.Shape, connectionSite: number): void;
/**
*
* Detaches the end of the specified connector from the shape it's attached to.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
endDisconnect(): void;
/**
* Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
*
@@ -37497,6 +37715,13 @@ declare namespace Excel {
class TextFrame extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
context: RequestContext;
/**
*
* Represents the text range in the text frame.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
readonly textRange: Excel.TextRange;
/**
*
@@ -37903,7 +38128,7 @@ declare namespace Excel {
nameInFormula: string;
/**
*
* Represents the sort order of the items in the slicer.
* Represents the sort order of the items in the slicer. Possible values are: DataSourceOrder, Ascending, Descending.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
@@ -37919,7 +38144,7 @@ declare namespace Excel {
style: string;
/**
*
* Represents the distance, in points, from the top edge of the slicer to the right of the worksheet.
* Represents the distance, in points, from the top edge of the slicer to the top of the worksheet.
Throws an invalid argument exception when set with negative value as input.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -37967,7 +38192,7 @@ declare namespace Excel {
delete(): void;
/**
*
* Returns an array of selected items' names. Read-only.
* Returns an array of selected items' keys. Read-only.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
@@ -37975,8 +38200,8 @@ declare namespace Excel {
getSelectedItems(): OfficeExtension.ClientResult<string[]>;
/**
*
* Select slicer items based on their names. Previous selection will be cleared.
All items will be deselected if the array is empty.
* Select slicer items based on their keys. Previous selection will be cleared.
All items will be selected by default if the array is empty.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
@@ -38118,7 +38343,9 @@ declare namespace Excel {
readonly hasData: boolean;
/**
*
* True if the slicer item is selected. Setting this value will not clear other SlicerItems' selected state.
* True if the slicer item is selected.
Setting this value will not clear other SlicerItems' selected state.
By default, if the slicer item is the only one selected, when it is deselected, all items will be selected.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
@@ -38963,6 +39190,36 @@ declare namespace Excel {
systemDot = "SystemDot",
systemDashDot = "SystemDashDot"
}
/**
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
enum ArrowHeadLength {
short = "Short",
medium = "Medium",
long = "Long"
}
/**
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
enum ArrowHeadStyle {
none = "None",
triangle = "Triangle",
stealth = "Stealth",
diamond = "Diamond",
oval = "Oval",
open = "Open"
}
/**
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
enum ArrowHeadWidth {
narrow = "Narrow",
medium = "Medium",
wide = "Wide"
}
/**
* [Api set: ExcelApi 1.1]
*/
@@ -39875,7 +40132,13 @@ declare namespace Excel {
*
*/
worksheetFormatChanged = "WorksheetFormatChanged",
wacoperationEvent = "WACOperationEvent"
wacoperationEvent = "WACOperationEvent",
/**
*
* RibbonCommandExecuted represents the type of event registered on ribbon, and occurs when user click on ribbon
*
*/
ribbonCommandExecuted = "RibbonCommandExecuted"
}
/**
* [Api set: ExcelApi 1.7]
@@ -40485,12 +40748,6 @@ declare namespace Excel {
*
*/
blanks = "Blanks",
/**
*
* Cells containing comments.
*
*/
comments = "Comments",
/**
*
* Cells containing constants.
@@ -40784,6 +41041,24 @@ declare namespace Excel {
ascending = "Ascending",
descending = "Descending"
}
/**
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
enum RibbonTab {
others = "Others",
home = "Home",
insert = "Insert",
draw = "Draw",
pageLayout = "PageLayout",
formulas = "Formulas",
data = "Data",
review = "Review",
view = "View",
developer = "Developer",
addIns = "AddIns",
help = "Help"
}
/**
*
* An object containing the result of a function-evaluation operation
@@ -48947,6 +49222,54 @@ declare namespace Excel {
}
/** An interface for updating data on the Line object, for use in "line.set({ ... })". */
interface LineUpdateData {
/**
*
* Represents the length of the arrowhead at the beginning of the specified line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
beginArrowHeadLength?: Excel.ArrowHeadLength | "Short" | "Medium" | "Long";
/**
*
* Represents the style of the arrowhead at the beginning of the specified line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
beginArrowHeadStyle?: Excel.ArrowHeadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open";
/**
*
* Represents the width of the arrowhead at the beginning of the specified line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
beginArrowHeadWidth?: Excel.ArrowHeadWidth | "Narrow" | "Medium" | "Wide";
/**
*
* Represents the length of the arrowhead at the end of the specified line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
endArrowHeadLength?: Excel.ArrowHeadLength | "Short" | "Medium" | "Long";
/**
*
* Represents the style of the arrowhead at the end of the specified line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
endArrowHeadStyle?: Excel.ArrowHeadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open";
/**
*
* Represents the width of the arrowhead at the end of the specified line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
endArrowHeadWidth?: Excel.ArrowHeadWidth | "Narrow" | "Medium" | "Wide";
/**
*
* Represents the connector type for the line.
@@ -49241,7 +49564,7 @@ declare namespace Excel {
nameInFormula?: string;
/**
*
* Represents the sort order of the items in the slicer.
* Represents the sort order of the items in the slicer. Possible values are: DataSourceOrder, Ascending, Descending.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
@@ -49257,7 +49580,7 @@ declare namespace Excel {
style?: string;
/**
*
* Represents the distance, in points, from the top edge of the slicer to the right of the worksheet.
* Represents the distance, in points, from the top edge of the slicer to the top of the worksheet.
Throws an invalid argument exception when set with negative value as input.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -49282,7 +49605,9 @@ declare namespace Excel {
interface SlicerItemUpdateData {
/**
*
* True if the slicer item is selected. Setting this value will not clear other SlicerItems' selected state.
* True if the slicer item is selected.
Setting this value will not clear other SlicerItems' selected state.
By default, if the slicer item is the only one selected, when it is deselected, all items will be selected.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
@@ -54665,6 +54990,14 @@ declare namespace Excel {
* @beta
*/
altTextTitle?: string;
/**
*
* Returns the number of connection sites on the specified shape. Read-only.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
connectionSiteCount?: number;
/**
*
* Represents the geometric shape type of the specified shape. See Excel.GeometricShapeType for detail. Returns null if the shape is not geometric, for example, get GeometricShapeType of a line or a chart will return null.
@@ -54837,6 +55170,70 @@ declare namespace Excel {
}
/** An interface describing the data returned by calling "line.toJSON()". */
interface LineData {
/**
*
* Represents the length of the arrowhead at the beginning of the specified line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
beginArrowHeadLength?: Excel.ArrowHeadLength | "Short" | "Medium" | "Long";
/**
*
* Represents the style of the arrowhead at the beginning of the specified line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
beginArrowHeadStyle?: Excel.ArrowHeadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open";
/**
*
* Represents the width of the arrowhead at the beginning of the specified line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
beginArrowHeadWidth?: Excel.ArrowHeadWidth | "Narrow" | "Medium" | "Wide";
/**
*
* Represents an integer that specifies the connection site that the beginning of a connector is connected to. Read-only. Returns null when the beginning of the line is not attached to any shape.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
beginConnectedSite?: number;
/**
*
* Represents the length of the arrowhead at the end of the specified line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
endArrowHeadLength?: Excel.ArrowHeadLength | "Short" | "Medium" | "Long";
/**
*
* Represents the style of the arrowhead at the end of the specified line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
endArrowHeadStyle?: Excel.ArrowHeadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open";
/**
*
* Represents the width of the arrowhead at the end of the specified line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
endArrowHeadWidth?: Excel.ArrowHeadWidth | "Narrow" | "Medium" | "Wide";
/**
*
* Represents an integer that specifies the connection site that the end of a connector is connected to. Read-only. Returns null when the end of the line is not attached to any shape.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
endConnectedSite?: number;
/**
*
* Represents the shape identifier. Read-only.
@@ -54845,6 +55242,22 @@ declare namespace Excel {
* @beta
*/
id?: string;
/**
*
* Represents whether the beginning of the specified line is connected to a shape. Read-only.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
isBeginConnected?: boolean;
/**
*
* Represents whether the end of the specified line is connected to a shape. Read-only.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
isEndConnected?: boolean;
/**
*
* Represents the connector type for the line.
@@ -55179,7 +55592,7 @@ declare namespace Excel {
nameInFormula?: string;
/**
*
* Represents the sort order of the items in the slicer.
* Represents the sort order of the items in the slicer. Possible values are: DataSourceOrder, Ascending, Descending.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
@@ -55195,7 +55608,7 @@ declare namespace Excel {
style?: string;
/**
*
* Represents the distance, in points, from the top edge of the slicer to the right of the worksheet.
* Represents the distance, in points, from the top edge of the slicer to the top of the worksheet.
Throws an invalid argument exception when set with negative value as input.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -55228,7 +55641,9 @@ declare namespace Excel {
hasData?: boolean;
/**
*
* True if the slicer item is selected. Setting this value will not clear other SlicerItems' selected state.
* True if the slicer item is selected.
Setting this value will not clear other SlicerItems' selected state.
By default, if the slicer item is the only one selected, when it is deselected, all items will be selected.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
@@ -63445,6 +63860,14 @@ declare namespace Excel {
* @beta
*/
altTextTitle?: boolean;
/**
*
* For EACH ITEM in the collection: Returns the number of connection sites on the specified shape. Read-only.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
connectionSiteCount?: boolean;
/**
*
* For EACH ITEM in the collection: Represents the geometric shape type of the specified shape. See Excel.GeometricShapeType for detail. Returns null if the shape is not geometric, for example, get GeometricShapeType of a line or a chart will return null.
@@ -63651,6 +64074,14 @@ declare namespace Excel {
* @beta
*/
altTextTitle?: boolean;
/**
*
* Returns the number of connection sites on the specified shape. Read-only.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
connectionSiteCount?: boolean;
/**
*
* Represents the geometric shape type of the specified shape. See Excel.GeometricShapeType for detail. Returns null if the shape is not geometric, for example, get GeometricShapeType of a line or a chart will return null.
@@ -63943,6 +64374,14 @@ declare namespace Excel {
* @beta
*/
altTextTitle?: boolean;
/**
*
* For EACH ITEM in the collection: Returns the number of connection sites on the specified shape. Read-only.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
connectionSiteCount?: boolean;
/**
*
* For EACH ITEM in the collection: Represents the geometric shape type of the specified shape. See Excel.GeometricShapeType for detail. Returns null if the shape is not geometric, for example, get GeometricShapeType of a line or a chart will return null.
@@ -64071,12 +64510,92 @@ declare namespace Excel {
$all?: boolean;
/**
*
* Represents the shape object that the beginning of the specified line is attached to.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
beginConnectedShape?: Excel.Interfaces.ShapeLoadOptions;
/**
*
* Represents the shape object that the end of the specified line is attached to.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
endConnectedShape?: Excel.Interfaces.ShapeLoadOptions;
/**
*
* Returns the shape object for the line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
shape?: Excel.Interfaces.ShapeLoadOptions;
/**
*
* Represents the length of the arrowhead at the beginning of the specified line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
beginArrowHeadLength?: boolean;
/**
*
* Represents the style of the arrowhead at the beginning of the specified line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
beginArrowHeadStyle?: boolean;
/**
*
* Represents the width of the arrowhead at the beginning of the specified line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
beginArrowHeadWidth?: boolean;
/**
*
* Represents an integer that specifies the connection site that the beginning of a connector is connected to. Read-only. Returns null when the beginning of the line is not attached to any shape.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
beginConnectedSite?: boolean;
/**
*
* Represents the length of the arrowhead at the end of the specified line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
endArrowHeadLength?: boolean;
/**
*
* Represents the style of the arrowhead at the end of the specified line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
endArrowHeadStyle?: boolean;
/**
*
* Represents the width of the arrowhead at the end of the specified line.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
endArrowHeadWidth?: boolean;
/**
*
* Represents an integer that specifies the connection site that the end of a connector is connected to. Read-only. Returns null when the end of the line is not attached to any shape.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
endConnectedSite?: boolean;
/**
*
* Represents the shape identifier. Read-only.
@@ -64085,6 +64604,22 @@ declare namespace Excel {
* @beta
*/
id?: boolean;
/**
*
* Represents whether the beginning of the specified line is connected to a shape. Read-only.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
isBeginConnected?: boolean;
/**
*
* Represents whether the end of the specified line is connected to a shape. Read-only.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
isEndConnected?: boolean;
/**
*
* Represents the connector type for the line.
@@ -64195,6 +64730,13 @@ declare namespace Excel {
*/
interface TextFrameLoadOptions {
$all?: boolean;
/**
*
* Represents the text range in the text frame.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*/
textRange?: Excel.Interfaces.TextRangeLoadOptions;
/**
*
@@ -64451,7 +64993,7 @@ declare namespace Excel {
nameInFormula?: boolean;
/**
*
* Represents the sort order of the items in the slicer.
* Represents the sort order of the items in the slicer. Possible values are: DataSourceOrder, Ascending, Descending.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
@@ -64467,7 +65009,7 @@ declare namespace Excel {
style?: boolean;
/**
*
* Represents the distance, in points, from the top edge of the slicer to the right of the worksheet.
* Represents the distance, in points, from the top edge of the slicer to the top of the worksheet.
Throws an invalid argument exception when set with negative value as input.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -64561,7 +65103,7 @@ declare namespace Excel {
nameInFormula?: boolean;
/**
*
* For EACH ITEM in the collection: Represents the sort order of the items in the slicer.
* For EACH ITEM in the collection: Represents the sort order of the items in the slicer. Possible values are: DataSourceOrder, Ascending, Descending.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
@@ -64577,7 +65119,7 @@ declare namespace Excel {
style?: boolean;
/**
*
* For EACH ITEM in the collection: Represents the distance, in points, from the top edge of the slicer to the right of the worksheet.
* For EACH ITEM in the collection: Represents the distance, in points, from the top edge of the slicer to the top of the worksheet.
Throws an invalid argument exception when set with negative value as input.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -64613,7 +65155,9 @@ declare namespace Excel {
hasData?: boolean;
/**
*
* True if the slicer item is selected. Setting this value will not clear other SlicerItems' selected state.
* True if the slicer item is selected.
Setting this value will not clear other SlicerItems' selected state.
By default, if the slicer item is the only one selected, when it is deselected, all items will be selected.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
@@ -64655,7 +65199,9 @@ declare namespace Excel {
hasData?: boolean;
/**
*
* For EACH ITEM in the collection: True if the slicer item is selected. Setting this value will not clear other SlicerItems' selected state.
* For EACH ITEM in the collection: True if the slicer item is selected.
Setting this value will not clear other SlicerItems' selected state.
By default, if the slicer item is the only one selected, when it is deselected, all items will be selected.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
@@ -64704,6 +65250,7 @@ declare namespace Excel {
}
}
////////////////////////////////////////////////////////////////
//////////////////////// End Excel APIs ////////////////////////
////////////////////////////////////////////////////////////////